services: validate-reinstall by oliver-sanders · Pull Request #746 · cylc/cylc-uiserver

oliver-sanders · 2025-10-29T11:47:36Z

Closes #526

I somehow forgot that we have cylc vr support in the Tui, but not the GUI!

Trivial to add support. Supporting the cylc install command is also possible, however, that will require #512.

UI sibling: cylc/cylc-ui#2347

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).
Applied any dependency changes to both setup.cfg (and conda-environment.yml if present).
Tests are included (or explain why tests are not needed).
Changelog entry included if this is a change that can affect users
Cylc-Doc pull request opened if required at cylc/cylc-doc/pull/XXXX.
If this is a bug fix, PR should be raised against the relevant ?.?.x branch.

oliver-sanders · 2025-10-30T15:32:17Z

cylc/uiserver/resolvers.py

        args: Dict[str, Any],
-        workflows_mgr: 'WorkflowsManager',
        log: 'Logger',
-    ) -> List[Union[bool, str]]:


Changed from list[bool | str] to tuple[bool, str] as this is safer for the way we are trying to use it (('msg', False) would have been acceptable before).

oliver-sanders · 2025-10-30T15:32:49Z

cylc/uiserver/resolvers.py

+                try:
+                    ret_code = proc.wait(timeout=timeout)
+                except TimeoutExpired as exc:
+                    proc.kill()
+                    ret_code = 124  # mimic `timeout` command error code
+                    # NOTE: preserve any stderr that the command produced this
+                    # far as this may help with debugging
+                    out, err = proc.communicate()
+                    err = str(exc) + (('\n' + err) if err else '')


So, it turns out this timeout logic was bunk. You have to actually .kill() to process if you want it to stop.

https://docs.python.org/3/library/subprocess.html#subprocess.Popen.communicate

Additionally, this will now log the command's stderr which might be useful in the event of a timeout.

oliver-sanders · 2025-10-30T15:34:22Z

cylc/uiserver/resolvers.py


        if command == 'clean':  # noqa: SIM116
            return await Services.clean(
+                self.workflows_mgr,


Switched arg order for consistency.

oliver-sanders · 2025-10-30T16:01:39Z

FYI: style tests will fail until #748

cylc/uiserver/schema.py

wxtim

Read Code
Tried in practice.

n.b. I think that VR should be on the shortened list of commands, but that's a Cylc UI change

oliver-sanders · 2025-11-03T16:09:35Z

n.b. I think that VR should be on the shortened list of commands, but that's a Cylc UI change

There'll be a cylc-ui and cylc-doc counterpart.

oliver-sanders · 2025-11-03T16:31:29Z

@wxtim, since last review:

Fixed tests (hopefully)
Added support for the "global" option (BoM might want to use this)

* The `reload` mutation isn't the most helpful command post `cylc install`. * Swap it out in the workflow command shortlist for the [newly added](cylc/cylc-uiserver#746) `validateReinstall` mutation which has wider scope.

cylc/uiserver/resolvers.py

cylc/uiserver/schema.py

cylc/uiserver/tests/test_resolvers.py

oliver-sanders · 2025-11-05T13:00:16Z

(drafting whilst I look at how hard it will be to combine ALL play and reload opts)

* Closes cylc#526 * Add basic support for the `cylc vr` command.

* We were applying a timeout to the `Popen.wait` method, however, this doesn't actually kill the process (as one might expect) when the timeout elapses, it just stops waiting for it?!

oliver-sanders

This is now the "full" solution which should support all relevant usages/args.

Reviewers, please give attention to the newly-added arguments to ensure they are working as intended:

https://github.com/cylc/cylc-uiserver/pull/746/changes#r2833158708

oliver-sanders · 2026-02-20T13:17:44Z

cylc/uiserver/schema.py

+                Set the Cylc version that the workflow starts with.
+            ''')
+        )
+        # cylc-rose


Cylc-rose arguments (all new):

opt_conf_key

clear_rose_install_options

define

rose_template_variable

oliver-sanders · 2026-02-20T13:18:49Z

cylc/uiserver/schema.py

+        ''')
+        resolver = partial(mutator, command='validate_reinstall')
+
+    class Arguments(Reinstall.Arguments, Reload.Arguments):


Reload arguments (all new):

reload_global

* The `reload` mutation isn't the most helpful command post `cylc install`. * Swap it out in the workflow command shortlist for the [newly added](cylc/cylc-uiserver#746) `validateReinstall` mutation which has wider scope.

wxtim · 2026-02-23T09:54:42Z

cylc/uiserver/resolvers.py

    return cmd


+def _substitute_keys(dictionary, substitutions):


IMO rename is more ronseal that substitute.

Suggested change

def _substitute_keys(dictionary, substitutions):

def _rename_keys(dictionary, substitutions):

cylc/uiserver/resolvers.py

cylc/uiserver/schema.py

wxtim · 2026-02-23T10:35:34Z

cylc/uiserver/schema.py

+            ''')
+        )
+        # cylc-rose
+        opt_conf_key = graphene.List(


Tangential thought - should we be storing old rose-suite-cylc-install.conf when we re-install?

Consequences probably already logged in log/install?

I'm not sure that the variables blown away are stored anywhere.

The consequences of the opt config are written to log/config/TIMESTAMP-rose-suite.conf.

e.g:

cylc install -O '(foo)' cylc reinstall <wflow> -O '(bar)'

The latest rose-suite.conf in that dir will read:

!opts=(foo) (bar) [env] # ROSE_ORIG_HOST set by cylc install. ROSE_ORIG_HOST=... [template variables] # ROSE_ORIG_HOST set by cylc install. ROSE_ORIG_HOST=...

The previous will read !opts=(foo).

MetRonnie

I tried adding opt conf keys in the command form but they were not passed to the cylc reinstall command

MetRonnie · 2026-02-24T12:09:52Z

cylc/uiserver/schema.py

+        cylc_version = CylcVersion(
+            description=sstrip('''
+                Set the Cylc version that the workflow starts with.
+            ''')
+        )


I don't think this applies to reinstall, surely?

Suggested change

cylc_version = CylcVersion(

description=sstrip('''

Set the Cylc version that the workflow starts with.

''')

)

It is implemented for all commands, see def run_command.

But why? I can't see the need to do this for reinstall?

It's not just for reinstall (which isn't actually implemented), the cylc vr command will also (re)start a stopped workflow, so the CYLC_VERSION argument is just as important here as for the Play mutation.

But vr/ReinstallReload inherits Play's options which includes cylc_version

cylc/uiserver/schema.py

* Provide full coverage for the `cylc vr` command. * Separate the command into two GraphQL mutations: * [validate-]reinstall-reload. * [validate-]reinstall-restart.

oliver-sanders · 2026-02-25T13:13:49Z

https://github.com/cylc/cylc-uiserver/compare/2dbceab899de0bdcef9b5a097c2d364dc4781ea0..57b44ec5ab8d24e46f2b811ceb11c81d81b5a474

Hardcoded mappings from the GraphQL (plural) to CLI (singular) fields.
Renamed field.
Applied requested docs changes.

c8523a1

Prefix Rose fields with rose_.

oliver-sanders marked this pull request as draft October 29, 2025 12:01

oliver-sanders force-pushed the 526 branch from 37adf28 to 6c34368 Compare October 30, 2025 11:29

oliver-sanders added this to the 1.9.0 milestone Oct 30, 2025

oliver-sanders self-assigned this Oct 30, 2025

oliver-sanders requested a review from MetRonnie October 30, 2025 14:35

oliver-sanders force-pushed the 526 branch from 6c34368 to b9d5f22 Compare October 30, 2025 15:30

oliver-sanders commented Oct 30, 2025

View reviewed changes

oliver-sanders force-pushed the 526 branch from b9d5f22 to 1ecb5e4 Compare October 30, 2025 15:54

oliver-sanders force-pushed the 526 branch from 1ecb5e4 to 1804eb6 Compare October 30, 2025 16:03

oliver-sanders marked this pull request as ready for review October 30, 2025 16:03

oliver-sanders requested a review from wxtim October 30, 2025 16:03

wxtim reviewed Nov 3, 2025

View reviewed changes

cylc/uiserver/schema.py Outdated Show resolved Hide resolved

wxtim approved these changes Nov 3, 2025

View reviewed changes

oliver-sanders force-pushed the 526 branch 2 times, most recently from f8f0f51 to f6a6e5e Compare November 3, 2025 16:31

oliver-sanders mentioned this pull request Nov 3, 2025

aotf: replace "reload" with validateReinstall cylc/cylc-ui#2347

Open

8 tasks

oliver-sanders force-pushed the 526 branch from f6a6e5e to c83eb10 Compare November 3, 2025 16:46

wxtim approved these changes Nov 4, 2025

View reviewed changes

MetRonnie reviewed Nov 4, 2025

View reviewed changes

cylc/uiserver/resolvers.py Show resolved Hide resolved

cylc/uiserver/schema.py Show resolved Hide resolved

cylc/uiserver/schema.py Outdated Show resolved Hide resolved

cylc/uiserver/tests/test_resolvers.py Outdated Show resolved Hide resolved

oliver-sanders marked this pull request as draft November 5, 2025 13:00

oliver-sanders added 2 commits February 20, 2026 11:09

services: validate-reinstall

a647851

* Closes cylc#526 * Add basic support for the `cylc vr` command.

services - play: fix timeout implementation

913496c

* We were applying a timeout to the `Popen.wait` method, however, this doesn't actually kill the process (as one might expect) when the timeout elapses, it just stops waiting for it?!

oliver-sanders force-pushed the 526 branch from c83eb10 to 4a52c18 Compare February 20, 2026 13:15

oliver-sanders commented Feb 20, 2026

View reviewed changes

oliver-sanders force-pushed the 526 branch 2 times, most recently from e1ea902 to 2dbceab Compare February 20, 2026 13:33

oliver-sanders requested review from MetRonnie and wxtim February 20, 2026 13:43

oliver-sanders marked this pull request as ready for review February 20, 2026 13:43

wxtim reviewed Feb 23, 2026

View reviewed changes

MetRonnie requested changes Feb 24, 2026

View reviewed changes

services: validate-reinstall - cover all arguments

57b44ec

* Provide full coverage for the `cylc vr` command. * Separate the command into two GraphQL mutations: * [validate-]reinstall-reload. * [validate-]reinstall-restart.

oliver-sanders force-pushed the 526 branch from 2dbceab to 57b44ec Compare February 25, 2026 13:13

#

c8523a1

	def _substitute_keys(dictionary, substitutions):
	def _rename_keys(dictionary, substitutions):

Conversation

oliver-sanders commented Oct 29, 2025 • edited by MetRonnie Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

oliver-sanders Oct 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

oliver-sanders commented Oct 30, 2025

Uh oh!

Uh oh!

wxtim left a comment

Choose a reason for hiding this comment

Uh oh!

oliver-sanders commented Nov 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

oliver-sanders commented Nov 3, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

oliver-sanders commented Nov 5, 2025

Uh oh!

oliver-sanders left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

oliver-sanders Feb 24, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

MetRonnie left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

oliver-sanders Feb 25, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

oliver-sanders commented Feb 25, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

oliver-sanders commented Oct 29, 2025 •

edited by MetRonnie

Loading

oliver-sanders Oct 30, 2025 •

edited

Loading

oliver-sanders commented Nov 3, 2025 •

edited

Loading

oliver-sanders Feb 24, 2026 •

edited

Loading

oliver-sanders Feb 25, 2026 •

edited

Loading

oliver-sanders commented Feb 25, 2026 •

edited

Loading