Subscription

[ZohebShaikh]

These are the limitation of the tiled server ws

• External registered tabular data is not yet supported.
• Other data structures (sparse, awkward) are not yet supported.
• Arrays can be patched with either extend=True or persist=False, but not both.
• Deletions of nodes are not yet visible to subscribers.

Currently I can get updates on the root node of creation of new node
and patch updates + creation updates for a particular node

To test the subscription to tiled websocket

1. docker run -d --rm --name tiled-test-redis -p 6379:6379 docker.io/redis:7-alpine
2. tiled serve catalog --temp --api-key secret --cache redis://localhost:6379

Todo:

1. I was not able to pass the API key in the header (Done)
2. Deserialization logic as in tiled code
3. tests Done with help from gemini

[codecov]

Codecov Report

❌ Patch coverage is 57.00000% with 43 lines in your changes missing coverage. Please review.
✅ Project coverage is 50.91%. Comparing base (a2eb617) to head (74b1af1).

Files with missing lines	Patch %	Lines
src/handlers.rs	0.00%	32 Missing ⚠️
src/main.rs	0.00%	7 Missing ⚠️
src/clients.rs	90.47%	2 Missing ⚠️
src/model/subscription.rs	94.59%	2 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #106      +/-   ##
==========================================
+ Coverage   49.27%   50.91%   +1.64%     
==========================================
  Files          13       14       +1     
  Lines         621      707      +86     
==========================================
+ Hits          306      360      +54     
- Misses        315      347      +32     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[tpoliaw]

I was not able to pass the API key in the header

Possibly related to this, I'm not able to run any subscriptions. Is there a way to get it working with the current state or does the auth stuff need fixing first?

[ZohebShaikh]

The way I'm testing it is by chaning these lines in the tiled server code to just return "secret"

https://github.com/bluesky/tiled/blob/481cd1844a05f34470c69dc5492809b00365513f/tiled/server/authentication.py#L487

async def get_current_principal_websocket(
    websocket: WebSocket,
    api_key: Optional[str] = Depends(get_api_key_websocket),
    settings: Settings = Depends(get_settings),
    db_factory: Callable[[], Optional[AsyncSession]] = Depends(
        get_database_session_factory
    ),
):
    return "secret"

I tried to get the headers today but could'nt find a way
I think I need to add something like this

[tpoliaw]

The public_address problem and the error reporting are the main changes needed - most of the other comments aren't critical

[ZohebShaikh]

@tpoliaw I have fixed the public address issue and the errors are also reported now.

Think to note : tiled has a new way of doing auth for websocket
The process is tiled lets a websocket connection to be opened if there is no headers and waits for a Auth token etc in the first message. If the first message has a vaild token it starts giving you data/ events.
So if you make a call from glazed without any headers it will look like nothing happening and you are also not getting any errors.

To test if errors are coming try adding the apikey header with a wrong value

For unit tests:-
I think we can create some integration tests rather than creating a mock websocket / mock tiled. It will be more useful and is worth putting effort into

[tpoliaw]

The graphiql editor is also failing to get the schema with a CORS error - no idea why

[tpoliaw]

nit: expect messages are usually the condition you expect to be met rather than the error state, so something like .expect("Headers should have be sent after stream is read above") or similar.

[tpoliaw]

This is returning () and the user won't see any errors. Could we make the method return either Stream<Item=Result<...>> or Result<Stream<...>> (or even Result<Stream<Item=Result<...>>>) so that the user gets feedback when the connection fails?

[tpoliaw]

What is value here? Can it be named something more descriptive?

[tpoliaw]

Why merge these into the same statement?