add graphql websocket subsciption tests by dwsutherland · Pull Request #768 · cylc/cylc-uiserver

dwsutherland · 2025-12-20T10:39:38Z

Adds an integration test for testing the graphql subscriptions via websocket connection.

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

LGTM, one question (see comment).

This pushes code coverage in the right direction 👍:

There are still a few gaps:

Would be good to cover error handling, e.g, GraphQL validation errors.
Would be good to cover more of the websocket subprocotocol (though note that we will change subprotocol soon)
Would be good to cover connection termination (as this is something we've had issues with).

oliver-sanders · 2026-01-05T10:32:04Z

cylc/uiserver/graphql/tornado.py

-    def request_wants_html(self):
-        accepted = get_accepted_content_types(self.request)
-        accepted_length = len(accepted)
-        # the list will be ordered in preferred first - so we have to make
-        # sure the most preferred gets the highest number
-        html_priority = (
-            accepted_length - accepted.index("text/html")
-            if "text/html" in accepted
-            else 0
-        )
-        json_priority = (
-            accepted_length - accepted.index("application/json")
-            if "application/json" in accepted
-            else 0
-        )
-
-        return html_priority > json_priority
-


[note to reviewers]

This is presumably something we inherited via graphene-tornado that's no longer required - https://github.com/graphql-python/graphene-tornado/blob/e4fa7d7b4c2256fa37f5ad89cbfd4d4bf6fdb606/graphene_tornado/tornado_graphql_handler.py#L379

Can't find any trace of it in Tornado.

Yes, I used Django as the starting point, and graphene-tornado as the reference (because graphene-django is more up to date)..
Some of the things removed were related to the inbuilt GraphiQL, where we use the UI/Vue version instead.

oliver-sanders · 2026-01-05T10:32:34Z

cylc/uiserver/graphql/tornado.py

-def get_accepted_content_types(request: 'HTTPServerRequest') -> list:
-    def qualify(x):
-        parts = x.split(";", 1)
-        if len(parts) == 2:
-            match = re.match(
-                r"(^|;)q=(0(\.\d{,3})?|1(\.0{,3})?)(;|$)", parts[1])
-            if match:
-                return parts[0].strip(), float(match.group(2))
-        return parts[0].strip(), 1
-
-    raw_content_types = request.headers.get("Accept", "*/*").split(",")
-    qualified_content_types = map(qualify, raw_content_types)
-    return [
-        x[0]
-        for x in sorted(
-            qualified_content_types, key=lambda x: x[1], reverse=True)
-    ]
-
-


[note to reviewers]

Unused function.

Same as above

oliver-sanders · 2026-01-05T10:38:01Z

cylc/uiserver/tests/test_graphql.py

+    )
+    assert response.code == 200
+
+    # we should find the two dummy workflows in the response


Can only see one workflow in the response below?

Yeah, this is a weird one.. Both graphene-django and graphene-tornado don't appear to be built to handle an actual batched response (or list of queries)...

I may have to change the code to "fix" this in accordance to the accepted behavior..

I more meant that the test code below doesn't seem to match the comment?

Ah, sorry, probably a copy paste thing..

I would put this PR in draft mode, but I wanted the tests to run.

oliver-sanders · 2026-01-05T10:55:14Z

cylc/uiserver/tests/test_graphql.py

+    response = json.loads(await ws.read_message())
+
+    assert response == {
+        'id': sub_id,
+        'type': 'data',
+        'payload': {
+            'data': {
+                'workflows': [
+                    {
+                        'id': '~me/foo',
+                        'status': 'stopped'
+                    }
+                ]
+            }
+        }
+    }


Would be good to test that the subscription can yield more than one result, i.e:

for _ in range(3): assert json.loads(await ws.read_message()) == { ... # poke UIS subscriptions as though something changed to make them yield again await do_something()

Not sure what do_something is though?

dwsutherland · 2026-01-13T03:21:06Z

There are still a few gaps:

Yes, this is a work in process, I'll keep expanding the tests here (hopefully until 85% project coverage at min)

dwsutherland · 2026-01-22T08:52:18Z

cylc/uiserver/graphql/tornado.py

-                response = strip_null(response)

-                result = self.json_encode(response)
+            result = self.json_encode(response)


No need to wrap json.dumps/encode in this try/except.. see:
https://github.com/graphql-python/graphene-django/blob/f02ea337a23df06d166d463d6f92cb7505fbb435/graphene_django/views.py#L215

response should always be JSON serializable..

oliver-sanders · 2026-01-30T10:39:34Z

83% project coverage 🥇

Ping me when you want a review.

dwsutherland · 2026-02-02T23:07:44Z

83% project coverage 🥇

Ping me when you want a review.

Just need to bump up the websocket/subscription side of things first.

dwsutherland · 2026-02-17T10:32:42Z

@oliver-sanders - I think this will do for now, there's some more that could be done with the subscription handler.. But we might as well get this in as a first step for people to build on.

dwsutherland added this to the 1.8.2 milestone Dec 20, 2025

dwsutherland self-assigned this Dec 20, 2025

dwsutherland added the small label Dec 20, 2025

dwsutherland force-pushed the graphql-ws-tests branch 2 times, most recently from a0653ed to 8738722 Compare December 20, 2025 10:55

dwsutherland changed the title ~~add graphql websocket subsciption test~~ add graphql websocket subsciption tests Dec 20, 2025

dwsutherland force-pushed the graphql-ws-tests branch from de961c1 to 3503725 Compare December 24, 2025 01:03

oliver-sanders reviewed Jan 5, 2026

View reviewed changes

oliver-sanders modified the milestones: 1.8.2, 1.8.3 Jan 7, 2026

dwsutherland force-pushed the graphql-ws-tests branch from 3503725 to e1c4e1f Compare January 20, 2026 08:51

dwsutherland commented Jan 22, 2026

View reviewed changes

dwsutherland force-pushed the graphql-ws-tests branch 4 times, most recently from 1627744 to 5710e81 Compare January 30, 2026 08:07

dwsutherland added 9 commits February 17, 2026 22:34

add graphql websocket subsciption test

15fe79f

remove unused graphql code

1970210

content type and batch testing

2d5ea15

error reason propagate

cea5e32

GET & POST query

fe433bb

Add simple mutation

612ce4b

Remove unused django cruft

9f963f8

tornado graphql handler testing

bfebe25

test gql deltas subscription

a212c89

dwsutherland force-pushed the graphql-ws-tests branch from aa4cf1c to a212c89 Compare February 17, 2026 09:48

dwsutherland removed the small label Feb 17, 2026

Conversation

dwsutherland commented Dec 20, 2025

Uh oh!

oliver-sanders left a comment • 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!

dwsutherland Jan 13, 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!

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!

Choose a reason for hiding this comment

Uh oh!

oliver-sanders Jan 5, 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!

dwsutherland commented Jan 13, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

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

Uh oh!

Uh oh!

dwsutherland commented Feb 2, 2026

Uh oh!

dwsutherland commented Feb 17, 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!

2 participants

oliver-sanders left a comment •

edited

Loading

dwsutherland Jan 13, 2026 •

edited

Loading

oliver-sanders Jan 5, 2026 •

edited

Loading

oliver-sanders commented Jan 30, 2026 •

edited

Loading

dwsutherland commented Feb 17, 2026 •

edited

Loading