Edit Runtime #1144

MetRonnie · 2022-11-18T16:53:23Z

These changes close #1104

Implement an "Edit Runtime" command that presents you with a form to see and edit the existing [runtime] settings for a task/family. Any edits made will be transmitted to the workflow via broadcast.
The form for editing a command now closes automatically on successful submission

Needs

Enable broadcast from UI Edit-Runtime form cylc-flow#5232

Requirements check-list

I have read CONTRIBUTING.md and added my name as a Code Contributor.
Contains logically grouped changes (else tidy your branch by rebase).
Does not contain off-topic changes (use other PRs for other changes).
Appropriate tests are included (unit and/or functional).
Appropriate change log entry included.
I have opened a documentation PR at cylc/cylc-doc/pull/XXXX.

- Allow a mutation argument type to be associated with a cylc object type (cycle, task etc.) without auto filling that object into the form input - Add icon for Edit Runtime

Uses introspection to expand fields of the query if none specified

Update introspection query response in mock service

…n component

Avoids need to manually reset state of form

Because that's the order they appear in the broadcast

Move properties that do not need to be reactive out of `data`

Simplify help icon logic - it now shows help on hover instead of click

Adapt AOTF's handling of 'INPUT_OBJECT' for 'OBJECT' seeing as the former is not used?

…m UIS schema

- Remain open with loading spinner in the submit button while awaiting the mutation response - Show error snackbar and stay open on failed submission - Show warning snackbar and stay open if the Edit-Runtime form does not have any changes on submission

MetRonnie · 2022-11-23T15:43:22Z

I had a go at deconflicting with graph view (#1108) here: https://github.com/MetRonnie/cylc-ui/tree/edit-runtime-deconflict

After #1108 is merged you may want to push this branch to the same commit as the deconflict branch

wxtim

Functional Review

Ran some workflows, and played with them.
Fixed broken scripts and triggered.
Triggered scripts on SPICE with different directives.
Had a look at the code FWIW

Questions

Does the pencil do anything different to clicking on this menu item? If not, can we ghost it?
Might I be able to control environment filters. This could be an add on. I'd also be happy not to - I'm not sure I'd want to encourage use of them.
I rather expected to be able to edit then trigger - is there a reason this isn't possible?
Has there been any thought to validation of any of the fields?

MetRonnie · 2022-11-24T15:00:58Z

Does the pencil do anything different to clicking on this menu item? If not, can we ghost it?

Like with other commands where the form is needed before submitting the mutation, there is no difference between clicking on the name and clicking on the pencil. I think this is fine.

Might I be able to control environment filters. This could be an add on. I'd also be happy not to - I'm not sure I'd want to encourage use of them.

Sorry, I'm not sure what environment filters are.

I rather expected to be able to edit then trigger - is there a reason this isn't possible?

It was decided triggering would be performed separately. I think we discussed this in October's videoconference. See #1104 (comment) although the reasoning isn't recorded there.

Has there been any thought to validation of any of the fields?

Not yet, but it can be added later.

wxtim · 2022-11-24T15:08:01Z

Sorry, I'm not sure what environment filters are.

Allow stuff through from the scheduler environment to the task env, or block it.

#notapriority

MetRonnie · 2022-11-24T15:11:16Z

Ah right, it's a runtime section. It isn't included in the GraphQL schema, so that's a cylc-flow question/issue.

MetRonnie · 2022-11-24T15:14:18Z

One problem I have just noticed is that if you open the mutations menu for a task, then wait for it to finish before clicking "edit runtime", then the form remains as a skeleton loader and you get in the console:

TypeError: Cannot read properties of null (reading 'runtime') ........ EditRuntimeForm.vue:138

Not a big problem though as you can just click cancel

oliver-sanders

Quite a lot of reviewing left to do but looking good so far. Functionality is pretty slick 👍

oliver-sanders · 2022-11-24T16:16:19Z

src/components/cylc/Mutation.vue

+      <!-- the mutation title -->
+      <h3
+      style="text-transform: capitalize;"
+      >


Some minor indentation niggles in this file:

Suggested change



<h3

style="text-transform: capitalize;"

>



<h3

style="text-transform: capitalize;"

>

oliver-sanders · 2022-11-24T16:20:10Z

src/components/cylc/cylcObject/Menu.vue

@@ -198,10 +202,13 @@ export default {
      }
      return this.mutations
    },
+    isFamily () {
+      // TODO: better way of checking if a 'task' is actually a family?


This isn't really safe but ATM all views request isHeld so it's fine for the mo.

As of the Graph View PR you can use node.type in all situations, it will be one of:

task

family

cycle (can be considered a family although you may need to add /root on the end)

oliver-sanders · 2022-11-24T16:25:33Z

src/components/graphqlFormGenerator/EditRuntimeForm.vue

+    },
+
+    async submit () {
+      const tokens = new Tokens(this.cylcObject.id)


Post Graph View this is available as node.tokens.

oliver-sanders · 2022-11-24T16:31:38Z

src/components/graphqlFormGenerator/FormInput.vue

@@ -141,6 +99,70 @@ export default {

      return ret
    }
+  },
+
+  render (createElement) {


Out of interest what was the motivation for moving from <template> to render()? I can't see anything that looks like it couldn't have been done with <template>.

The template-based way became a bit awkward for passing in slot props to the append-outer slot, due to an issue in Vuetify v2 (sorry can't find the GH link). Basically, doing it with a render function avoids the need to duplicate the slot with an if-else.

MetRonnie · 2022-11-24T17:10:13Z

@oliver-sanders Happy for you to take over and push changes to this branch

wxtim · 2022-12-05T09:52:37Z

Note to self : Check this closes Close mutation editor on submission #835

oliver-sanders · 2022-12-09T11:35:49Z

I have raised the deconflict branch Ronnie prepared in anticipation of the graph-view/central-data-store PR being merged as a new PR here - #1160

oliver-sanders · 2022-12-12T13:39:15Z

Superseded by #1160

MetRonnie added 14 commits November 18, 2022 12:12

Make eslint less frustrating during development

dcc1508

Tidy & improve JSDoc annotations

f6999b2

Add "edit runtime" mutation support

2b09f17

- Allow a mutation argument type to be associated with a cylc object type (cycle, task etc.) without auto filling that object into the form input - Add icon for Edit Runtime

Implement ability to issue GraphQL query

44d8713

Uses introspection to expand fields of the query if none specified

Add taskProxy{ runtime } query to mock service

e2a1899

Update introspection query response in mock service

Move title & description from FormGenerator component up into Mutatio…

f5ec1af

…n component

Re-render mutation dialog each time it's opened

53140b7

Avoids need to manually reset state of form

Implement Edit-Runtime form

7c86494

Edit-Runtime form: prevent rename/deletion of pre-existing key-val pairs

e27caff

Edit-Runtime form: add new key-val pairs to top of list

64ae80b

Because that's the order they appear in the broadcast

Tidy

a0000ec

Move properties that do not need to be reactive out of `data`

Convert FormInput template to render-function

3355462

Simplify help icon logic - it now shows help on hover instead of click

Broadcast from Edit-Runtime form

6334bff

Switch to custom schema type for RuntimeSetting

267e892

Adapt AOTF's handling of 'INPUT_OBJECT' for 'OBJECT' seeing as the former is not used?

MetRonnie added the enhancement label Nov 18, 2022

MetRonnie added this to the 1.4.0 milestone Nov 18, 2022

MetRonnie self-assigned this Nov 18, 2022

MetRonnie changed the title ~~Edit runtime~~ Edit Runtime Nov 18, 2022

MetRonnie marked this pull request as draft November 18, 2022 16:58

MetRonnie force-pushed the edit-runtime branch from 8a298a2 to 66f174a Compare November 21, 2022 16:34

MetRonnie added 3 commits November 21, 2022 17:52

Switch to in-UI edit-runtime dummy mutation instead of getting it fro…

8c6d822

…m UIS schema

JSDoc fix

118c678

Refactor form submission to conform Edit-Runtime with other mutations

089fdc4

MetRonnie force-pushed the edit-runtime branch from 66f174a to 43c00d1 Compare November 21, 2022 17:54

MetRonnie marked this pull request as ready for review November 21, 2022 17:55

MetRonnie requested review from oliver-sanders and wxtim November 22, 2022 09:58

MetRonnie added 3 commits November 23, 2022 14:48

Add e2e tests for Edit-Runtime form

5ca2e0d

Update changelog

7506c79

MetRonnie force-pushed the edit-runtime branch from 43c00d1 to 12e02ad Compare November 23, 2022 14:48

Rename variable

5c0c730

wxtim approved these changes Nov 24, 2022

View reviewed changes

oliver-sanders reviewed Nov 24, 2022

View reviewed changes

oliver-sanders mentioned this pull request Dec 1, 2022

Close mutation editor on submission #835

Closed

4 tasks

oliver-sanders mentioned this pull request Dec 9, 2022

Edit runtime (deconflicted) #1160

Merged

6 tasks

This was referenced Dec 9, 2022

edit-runtime: hide unused fields #1161

Closed

edit-runtime: allow editing cycle points #1165

Closed

oliver-sanders added the superseded label Dec 12, 2022

oliver-sanders closed this Dec 12, 2022

oliver-sanders removed this from the 1.4.0 milestone Dec 12, 2022

MetRonnie deleted the edit-runtime branch December 15, 2022 11:01

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Edit Runtime #1144

Edit Runtime #1144

MetRonnie commented Nov 18, 2022 •

edited

Loading

MetRonnie commented Nov 23, 2022 •

edited

Loading

wxtim left a comment

MetRonnie commented Nov 24, 2022

wxtim commented Nov 24, 2022 •

edited

Loading

MetRonnie commented Nov 24, 2022

MetRonnie commented Nov 24, 2022

oliver-sanders left a comment •

edited

Loading

oliver-sanders Nov 24, 2022

oliver-sanders Nov 24, 2022

oliver-sanders Nov 24, 2022

oliver-sanders Nov 24, 2022

MetRonnie Nov 24, 2022

MetRonnie commented Nov 24, 2022

wxtim commented Dec 5, 2022

oliver-sanders commented Dec 9, 2022

oliver-sanders commented Dec 12, 2022

Edit Runtime #1144

Edit Runtime #1144

Conversation

MetRonnie commented Nov 18, 2022 • edited Loading

Needs

Requirements check-list

MetRonnie commented Nov 23, 2022 • edited Loading

wxtim left a comment

Choose a reason for hiding this comment

Functional Review

Questions

MetRonnie commented Nov 24, 2022

wxtim commented Nov 24, 2022 • edited Loading

MetRonnie commented Nov 24, 2022

MetRonnie commented Nov 24, 2022

oliver-sanders left a comment • edited Loading

Choose a reason for hiding this comment

oliver-sanders Nov 24, 2022

Choose a reason for hiding this comment

oliver-sanders Nov 24, 2022

Choose a reason for hiding this comment

oliver-sanders Nov 24, 2022

Choose a reason for hiding this comment

oliver-sanders Nov 24, 2022

Choose a reason for hiding this comment

MetRonnie Nov 24, 2022

Choose a reason for hiding this comment

MetRonnie commented Nov 24, 2022

wxtim commented Dec 5, 2022

oliver-sanders commented Dec 9, 2022

oliver-sanders commented Dec 12, 2022

MetRonnie commented Nov 18, 2022 •

edited

Loading

MetRonnie commented Nov 23, 2022 •

edited

Loading

wxtim commented Nov 24, 2022 •

edited

Loading

oliver-sanders left a comment •

edited

Loading