Skip to content

Fix "Log" & "Info" commands showing for families #2284

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
+115 −208
Open

Fix "Log" & "Info" commands showing for families #2284

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
368cd28
Tidy
MetRonnie Aug 19, 2025
5ffef0c
Fix "Log" & "Info" commands showing for families
MetRonnie Aug 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 1 addition & 6 deletions src/components/cylc/commandMenu/Menu.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -335,13 +335,8 @@ export default {
// displayed in the menu (this is what the skeleton-loader is for)
this.isLoadingMutations = false
this.types = types
let type = this.node.type
if (type === 'family') {
// show the same mutation list for families as for tasks
type = 'task'
}
this.mutations = filterAssociations(
type,
this.node.type,
this.node.tokens,
mutations,
this.user.permissions
Expand Down
213 changes: 72 additions & 141 deletions src/utils/aotf.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,9 +50,9 @@ import {

import { Alert } from '@/model/Alert.model'
import { store } from '@/store/index'
import { Tokens } from '@/utils/uid'
import { detokenise, Tokens } from '@/utils/uid'
import { WorkflowState, WorkflowStateNames } from '@/model/WorkflowState.model'
import { isBoolean } from 'lodash-es'
import { isBoolean, startCase } from 'lodash-es'

/** @typedef {import('@apollo/client').ApolloClient} ApolloClient */
/** @typedef {import('graphql').IntrospectionInputType} IntrospectionInputType */
Expand All @@ -71,7 +71,7 @@ import { isBoolean } from 'lodash-es'
* @property {GQLType} type
* @property {?string} defaultValue
* @property {string=} _title
* @property {string=} _cylcObject
* @property {string=} _cylcObjects
* @property {string=} _cylcType
* @property {boolean=} _required
* @property {boolean=} _multiple
Expand Down Expand Up @@ -161,8 +161,8 @@ export const cylcObjects = Object.freeze({
User: 'user',
Workflow: 'workflow',
CyclePoint: 'cycle',
Namespace: 'task',
// Task: 'task',
Family: 'family',
Copy link
Member

@oliver-sanders oliver-sanders Aug 26, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Namespace is correct, it is ambiguous for task or family, e.g. see cylc broadcast -n & cylc graph -n and the GrpahQL "Namespace*" stuff.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We must have a way of distinguishing family commands from task commands.

Task: 'task',
Job: 'job'
})

Expand All @@ -183,36 +183,27 @@ export const primaryMutations = {
'hold',
'release',
'trigger',
'kill'
'kill',
'play',
],
[cylcObjects.Namespace]: [
[cylcObjects.Family]: [
'hold',
'release',
'trigger',
'kill',
'set',
],
[cylcObjects.Task]: [
'hold',
'release',
'trigger',
'kill',
'set',
'log',
'info',
'set'
]
],
}

// handle families the same as tasks
primaryMutations.family = primaryMutations[cylcObjects.Namespace]

/**
* Cylc "objects" in hierarchy order.
*
* Note, this is the order they would appear in a tree representation.
*/
const identifierOrder = [
cylcObjects.User,
cylcObjects.Workflow,
cylcObjects.CyclePoint,
cylcObjects.Namespace,
// cylcObjects.Task,
cylcObjects.Job
]

/**
* Mapping of mutation argument types to Cylc "objects" (workflow, cycle,
* task etc.).
Expand All @@ -221,52 +212,39 @@ const identifierOrder = [
* auto-populate the input element in the mutation form based on the object
* that was clicked on.
*
* object: [[typeName: String, impliesMultiple: Boolean]]
*/
export const mutationMapping = {
[cylcObjects.User]: [],
[cylcObjects.Workflow]: [
['WorkflowID', false]
],
[cylcObjects.CyclePoint]: [
['CyclePoint', false],
['CyclePointGlob', true]
],
[cylcObjects.Namespace]: [
['NamespaceName', false],
['NamespaceIDGlob', true]
],
// [cylcObjects.Task]: [
// ['TaskID', false]
// ],
[cylcObjects.Job]: [
['JobID', false]
]
const mutationMapping = {
WorkflowID: [cylcObjects.Workflow],
CyclePoint: [cylcObjects.CyclePoint],
CyclePointGlob: [cylcObjects.CyclePoint],
NamespaceName: [cylcObjects.Task, cylcObjects.Family],
NamespaceIDGlob: [cylcObjects.Task, cylcObjects.Family],
// TaskID: [cylcObjects.Task],
JobID: [cylcObjects.Job],
}

/** Argument types that imply multiple values. */
const impliesMultiple = Object.freeze([
'CyclePointGlob',
'NamespaceIDGlob',
])

/**
* Mutation argument types which are derived from more than one token.
*/
export const compoundFields = {
WorkflowID: (tokens) => {
if (tokens[cylcObjects.User]) {
return `~${tokens[cylcObjects.User]}/${tokens[cylcObjects.Workflow]}`
}
// don't provide user if not specified
// (will fallback to the UIs user)
return tokens[cylcObjects.Workflow]
},
WorkflowID: (tokens) => detokenise(tokens, { workflow: true }),
NamespaceIDGlob: (tokens) => (
// expand unspecified fields to '*'
(tokens[cylcObjects.CyclePoint] || '*') +
'/' +
(tokens[cylcObjects.Namespace] || '*')
(tokens[cylcObjects.Task] || '*')
),
TaskID: (tokens) => (
// expand unspecified fields to '*'
(tokens[cylcObjects.CyclePoint] || '*') +
'/' +
tokens[cylcObjects.Namespace]
tokens[cylcObjects.Task]
)
}

Expand Down Expand Up @@ -305,7 +283,7 @@ export const dummyMutations = [

This only applies for the cycle point of the chosen task/family instance.`,
args: [],
_appliesTo: [cylcObjects.Namespace, cylcObjects.CyclePoint],
_appliesTo: [cylcObjects.Task, cylcObjects.Family, cylcObjects.CyclePoint],
_requiresInfo: true,
_validStates: [WorkflowState.RUNNING.name, WorkflowState.PAUSED.name],
_dialogWidth: '1200px',
Expand All @@ -314,15 +292,15 @@ export const dummyMutations = [
name: 'log',
description: 'View the logs.',
args: [],
_appliesTo: [cylcObjects.Workflow, cylcObjects.Namespace, cylcObjects.Job],
_appliesTo: [cylcObjects.Workflow, cylcObjects.Task, cylcObjects.Job],
_requiresInfo: false,
_validStates: WorkflowStateNames,
},
{
name: 'info',
description: 'View task information.',
args: [],
_appliesTo: [cylcObjects.Namespace],
_appliesTo: [cylcObjects.Task],
_requiresInfo: false
},
]
Expand Down Expand Up @@ -358,33 +336,6 @@ export function tokenise (id) {
return ret
}

/**
* Return the lowest token in the hierarchy.
*
* @param {Object} tokens
* @returns {String}
* */
export function getType (tokens) {
let last = null
let item = null
for (const key of identifierOrder) {
item = tokens[key]
if (!item) {
break
}
last = key
}
return last
}

/**
* Convert camel case to words.
*/
export function camelToWords (camel) {
const result = (camel || '').replace(/([A-Z])/g, ' $1')
return result.charAt(0).toUpperCase() + result.slice(1)
}

/**
* Find the GraphQL object with the given name.
*
Expand Down Expand Up @@ -446,7 +397,7 @@ export function extractFields (type, fields, types) {
*/
export function processMutations (mutations, types) {
for (const mutation of mutations) {
mutation._title = camelToWords(mutation.name)
mutation._title = startCase(mutation.name)
mutation._icon = getMutationIcon(mutation.name)
mutation._shortDescription = getMutationShortDesc(mutation.description)
mutation._help = getMutationExtendedDesc(mutation.description)
Expand Down Expand Up @@ -501,8 +452,8 @@ export function getMutationExtendedDesc (text) {
* This adds some computed fields prefixed with an underscore for later use:
* _title:
* Human-readable name for the mutation.
* _cylcObject:
* The Cylc Object this field relates to if any (e.g. Cycle, Task etc.).
* _cylcObjects:
* The Cylc objects this field relates to if any (e.g. Cycle, Task etc.).
* _cylcType:
* The underlying GraphQL type that provides this relationship
* (e.g. taskID).
Expand All @@ -520,37 +471,25 @@ export function processArguments (mutation, types) {
for (const arg of mutation.args) {
let pointer = arg.type
let multiple = false
let cylcObject = null
let cylcType = null
let cylcObjects
let cylcType
const required = arg.type?.kind === 'NON_NULL'
while (pointer) {
// walk down the nested type tree
if (pointer.kind === 'LIST') {
multiple = true
} else if (pointer.kind !== 'NON_NULL' && pointer.name) {
cylcType = pointer.name
for (const objectName in mutationMapping) {
for (const [type, impliesMultiple] of mutationMapping[objectName]) {
if (pointer.name === type) {
cylcObject = objectName
if (impliesMultiple) {
multiple = true
}
break
}
}
if (cylcObject) {
break
}
}
if (cylcObject) {
cylcObjects = mutationMapping[cylcType]
multiple ||= impliesMultiple.includes(cylcType)
if (cylcObjects) {
break
}
}
pointer = pointer.ofType
}
arg._title = camelToWords(arg.name)
arg._cylcObject = cylcObject
arg._title = startCase(arg.name)
arg._cylcObjects = cylcObjects
arg._cylcType = cylcType
arg._multiple = multiple
arg._required = required
Expand Down Expand Up @@ -633,12 +572,12 @@ export function filterAssociations (cylcObject, tokens, mutations, permissions)
let requiresInfo = mutation._requiresInfo ?? false
let applies = mutation._appliesTo?.includes(cylcObject)
for (const arg of mutation.args) {
if (arg._cylcObject) {
if (arg._cylcObject === cylcObject) {
if (arg._cylcObjects) {
if (arg._cylcObjects.includes(cylcObject)) {
// this is the object type we are filtering for
applies = true
}
if (arg._required && !tokens[arg._cylcObject]) {
if (arg._required && !arg._cylcObjects.some((t) => tokens[t])) {
// this cannot be satisfied by the context
requiresInfo = true
}
Expand Down Expand Up @@ -855,39 +794,31 @@ export function constructQueryStr (query) {
* */
export function getMutationArgsFromTokens (mutation, tokens) {
const argspec = {}
let value
for (const arg of mutation.args) {
if (arg._cylcObject) {
const alternate = alternateFields[arg._cylcType]
for (let token in tokens) {
if ([token, alternate].includes(arg._cylcObject)) {
if (arg.name === 'cutoff') {
// Work around for a field we don't want filled in, see:
// * https://github.com/cylc/cylc-ui/issues/1222
// * https://github.com/cylc/cylc-ui/issues/1225
// TODO: Once #1225 is done the field type can be safely changed in
// the schema without creating a compatibility issue with the UIS.
continue
}
if (arg._cylcObject === alternate) {
token = alternate
}
if (arg._cylcType in compoundFields) {
value = compoundFields[arg._cylcType](tokens)
} else {
value = tokens[token]
}
if (arg._multiple) {
value = [value]
}
argspec[arg.name] = value
break
}
if (
arg._cylcObjects &&
// Work around for a field we don't want filled in, see:
// * https://github.com/cylc/cylc-ui/issues/1222
// * https://github.com/cylc/cylc-ui/issues/1225
// TODO: Once #1225 is done the field type can be safely changed in
// the schema without creating a compatibility issue with the UIS.
arg.name !== 'cutoff'
) {
let value
if (arg._cylcType in compoundFields) {
value = compoundFields[arg._cylcType](tokens)
} else {
const alternate = alternateFields[arg._cylcType]
const token = arg._cylcObjects.includes(alternate)
? alternate
: arg._cylcObjects.find((t) => tokens[t])
value = tokens[token]
}
if (value) {
argspec[arg.name] = arg._multiple ? [value] : value
}
}
if (!argspec[arg.name]) {
argspec[arg.name] = arg._default
}
argspec[arg.name] ||= arg._default
}
return argspec
}
Expand Down
Loading