Merge pull request #493 from markgrahamdawson/feature-add-scan-mutation

Feature add scan mutation

Author: hjoliver

CONTRIBUTING.md

@@ -58,6 +58,7 @@ below.
  - David Matthews
  - Mel Hall
  - Christopher Bennett
+ - Mark Dawson
  <!-- end-shortlog -->
 
 (All contributors are identifiable with email addresses in the git version

cylc/uiserver/resolvers.py

@@ -279,6 +279,15 @@ async def clean(
         await workflows_mgr.scan()
         return cls._return("Workflow(s) cleaned")
 
+    @classmethod
+    async def scan(
+        cls,
+        args: dict,
+        workflows_mgr: 'WorkflowsManager',
+    ):
+        await workflows_mgr.scan()
+        return cls._return("Scan requested")
+
     @classmethod
     async def play(cls, workflows, args, workflows_mgr, log):
         """Calls `cylc play`."""
@@ -534,24 +543,29 @@ async def service(
         info: 'ResolveInfo',
         command: str,
         workflows: Iterable['Tokens'],
-        kwargs: Dict[str, Any]
+        kwargs: Dict[str, Any],
     ) -> List[Union[bool, str]]:
-        if command == 'clean':
+
+        if command == 'clean':  # noqa: SIM116
             return await Services.clean(
                 workflows,
                 kwargs,
                 self.workflows_mgr,
                 log=self.log,
                 executor=self.executor
             )
-
         elif command == 'play':
             return await Services.play(
                 workflows,
                 kwargs,
                 self.workflows_mgr,
                 log=self.log
             )
+        elif command == 'scan':
+            return await Services.scan(
+                kwargs,
+                self.workflows_mgr
+            )
 
         raise NotImplementedError()
 

cylc/uiserver/schema.py

@@ -270,6 +270,17 @@ class Arguments:
     result = GenericScalar()
 
 
+class Scan(graphene.Mutation):
+    class Meta:
+        description = sstrip('''
+            Scan the filesystem for file changes.
+
+            Valid for: stopped workflows.
+        ''')
+        resolver = partial(mutator, command='scan')
+    result = GenericScalar()
+
+
 async def get_jobs(root, info, **kwargs):
     if kwargs['live']:
         return await get_nodes_all(root, info, **kwargs)
@@ -545,6 +556,7 @@ class Logs(graphene.ObjectType):
 class UISMutations(Mutations):
     play = _mut_field(Play)
     clean = _mut_field(Clean)
+    scan = _mut_field(Scan)
 
 
 schema = graphene.Schema(

cylc/uiserver/tests/test_authorise.py

@@ -42,6 +42,7 @@
     "reload",
     "remove",
     "resume",
+    "scan",
     "set_graph_window_extent",
     "set_hold_point",
     "set_outputs",
@@ -66,6 +67,7 @@
     "reload",
     "remove",
     "resume",
+    "scan",
     "set_graph_window_extent",
     "set_hold_point",
     "set_outputs",
@@ -126,6 +128,7 @@
                 "play",
                 "trigger",
                 "resume",
+                "scan",
                 "set_verbosity",
                 "set_graph_window_extent",
                 "read",