xtrigger: ui support

[oliver-sanders]

This exposes xtriggers in Tui and lays the groundwork for exposing them in the GUI.

• Unblocks xtriggers: tree view and beyond cylc-ui#331
• Unblocks info view: add xtriggers cylc-ui#2103
• Partially addresses GraphQL: updating arrays with delta updates #6307

Visibility of xtriggers in the GUI (retry triggers in particular) has been flagged as a high priority development for production use cases and a desirable feature in general.

xtriggers: fix update and add is_retry, is_wallclock and is_xtriggered attrs

• Don't update xtriggers incrementally:
  • Xtriggers were being updated in the data store incrementally.
  • This doesn't work with GraphQL subscriptions (see GraphQL: updating arrays with delta updates #6307).
  • This turns off incremental updates ensuring that all xtriggers are included in all updates.
  • Unblocks info view: add xtriggers cylc-ui#2103
• Add is_retry, is_wallclock and is_xtriggered task attributes.
  • We would like to be able to incorporate xtriggers into the task icons used in the GUI and Tui.
  • These attributes allow clients to access the required information without having to subscribe to and monitor all xtriggers.
  • Unblocks xtriggers: tree view and beyond cylc-ui#331

tui: add retry, wallclock and xtrigger task modifiers

• Display information about a task's xtriggers as part of the task icon using a modifier.
• Incorporate a text-based summary of these modifiers into the task menu.
• Change the runahead task modifier icon to match the placement of theother modifiers.

TODO:

• Confirm viability of selected Tui icons in various terminals.
  • linux/xterm (good)
  • linux/terminator (good)
  • chromium/vscode (task alignment good, modifier alignment differs, ok IMO)
  • browser/jupyterlab (task alignment good, modifier alignment differs, ok IMO)
  • macos/terminal.app (good)
• Settle the names and descriptions of the is_retry, is_wallclock and is_xtriggered attributes (if folk would like to debate them).
• Update Tui integration tests.
• Back-compat support for Tui (detect workflow version and modify the query).
• Back-compat support for GUI (requires a cylc-uiserver shim). would appear not to be necessary xtrigger: ui support #6671 (comment)

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]

TODO: Back-compat support for GUI (requires a cylc-uiserver shim).

This PR has added three new fields, I had expected this to cause an inter-version compatibility issue, because if we request isRetry on a 8.4.0 workflow, that field doesn't exist.

But, when I tried out querying an older version via the UIS, I found that it didn't return an error and a False value was returned (which is what we want).

So it looks like there is an implicit default_value = False (for boolean fields) coming from somewhere. Fortunately, that happens to be the right default so I don't think that any UIS shim is required. Although we'll need to confirm that this is still the case after the GraphQL upgrade.

For info, here is the UIS shim that I had started to write

I put this in place and it all worked fine. I then commented out the overrides and found that it worked exactly the same 🤷 😕 ???

diff --git a/cylc/uiserver/schema.py b/cylc/uiserver/schema.py
index 38de421..3fee4df 100644
--- a/cylc/uiserver/schema.py
+++ b/cylc/uiserver/schema.py
@@ -31,11 +31,14 @@ from cylc.flow.rundb import CylcWorkflowDAO
 from cylc.flow.pathutil import get_workflow_run_dir
 from cylc.flow.workflow_files import WorkflowFiles
 from cylc.flow.network.schema import (
+    ALL_PROXY_ARGS,
+    DELTA_ADDED,
     NODE_MAP,
     CyclePoint,
     GenericResponse,
     SortArgs,
     Task,
+    TaskProxy,
     Job,
     Mutations,
     Queries,
@@ -45,7 +48,8 @@ from cylc.flow.network.schema import (
     WorkflowID,
     WorkflowRunMode as RunMode,
     _mut_field,
-    get_nodes_all
+    get_nodes_all,
+    delta_subs,
 )
 from cylc.flow.util import sstrip
 from cylc.uiserver.resolvers import (
@@ -585,6 +589,42 @@ class UISQueries(Queries):
     )
 
 
+class UISTaskProxy(TaskProxy):
+
+    # Replace workflow and task name in workflow and task URLs.
+    # BACK COMPAT: isRetry, isWallclock, isXtriggered
+    # url:
+    #     https://github.com/cylc/cylc-flow/pull/6671
+    # from:
+    #     Cylc < 8.5.0
+    # to:
+    #     Cylc 8.5.0
+    # remove at:
+    #     Cylc 8.x (when inter-operability is no longer required)
+
+    isRetry = graphene.Boolean(default_value=False)
+    isWallclock = graphene.Boolean(default_value=False)
+    isXtriggered = graphene.Boolean(default_value=False)
+
+
+class UISFamilyProxy(TaskProxy):
+
+    # Replace workflow and task name in workflow and task URLs.
+    # BACK COMPAT: isRetry, isWallclock, isXtriggered
+    # url:
+    #     https://github.com/cylc/cylc-flow/pull/6671
+    # from:
+    #     Cylc < 8.5.0
+    # to:
+    #     Cylc 8.5.0
+    # remove at:
+    #     Cylc 8.x (when inter-operability is no longer required)
+
+    isRetry = graphene.Boolean(default_value=False)
+    isWallclock = graphene.Boolean(default_value=False)
+    isXtriggered = graphene.Boolean(default_value=False)
+
+
 class UISSubscriptions(Subscriptions):
     # Example graphiql workflow log subscription:
     # subscription {
@@ -615,6 +655,30 @@ class UISSubscriptions(Subscriptions):
         resolver=stream_log
     )
 
+    # task_proxies = graphene.List(
+    #     UISTaskProxy,
+    #     description=UISTaskProxy._meta.description,
+    #     args=ALL_PROXY_ARGS,
+    #     strip_null=graphene.Boolean(default_value=True),
+    #     delta_store=graphene.Boolean(default_value=True),
+    #     delta_type=graphene.String(default_value=DELTA_ADDED),
+    #     initial_burst=graphene.Boolean(default_value=True),
+    #     ignore_interval=graphene.Float(default_value=0.0),
+    #     resolver=delta_subs
+    # )
+
+    # family_proxies = graphene.List(
+    #     UISFamilyProxy,
+    #     description=UISFamilyProxy._meta.description,
+    #     args=ALL_PROXY_ARGS,
+    #     strip_null=graphene.Booolean(default_value=True),
+    #     delta_store=graphene.Booolean(default_value=True),
+    #     delta_type=graphene.String(default_value=DELTA_ADDED),
+    #     initial_burst=graphene.Booolean(default_value=True),
+    #     ignore_interval=graphene.Float(default_value=0.0),
+    #     resolver=delta_subs
+    # )
+
 
 class UISMutations(Mutations):
     play = _mut_field(Play)

[wxtim]

Not working with my PR:

[scheduler]
    allow implicit tasks = True

[scheduling]
    cycling mode = integer
    [[xtriggers]]
        foo_made = file_exists('/var/tmp/foo')
        bar_made = file_exists('/var/tmp/bar')

    [[graph]]
        R1 = @foo_made & @bar_made => task

[wxtim]

Suggested change

	Tuple (host name, port number, publish port number, scheduler veresion)
	Tuple (host name, port number, publish port number, scheduler version)

[oliver-sanders]

@wxtim Try again now 🤞

(added test)

[wxtim]

cylc/cylc-ui#2102 Works with 21637a5