StreamingHTTPChannel2023 #1878

elf-pavlik · 2024-04-03T19:51:32Z

📁 Related issues

✍️ Description

Initial commit only supports pre-established notification channels advertised in the HTTP Link header.
We will start writing tests after the initial feedback.

✅ PR check list

Before this pull request can be merged, a core maintainer will check whether

this PR is labeled with the correct semver label
- semver.patch: Backwards compatible bug fixes.
- semver.minor: Backwards compatible feature additions.
- semver.major: Breaking changes. This includes changing interfaces or configuration behaviour.
the correct branch is targeted. Patch updates can target main, other changes should target the latest versions/* branch.
the RELEASE_NOTES.md document in case of relevant feature or config changes.
any relevant documentation was updated to reflect the changes in this PR.

Co-authored-by: Maciej Samoraj <maciej.samoraj@gmail.com>

joachimvh

Had a quick look. The idea seems fine, just requires some cleanup.

config/http/notifications/streaming-http/http.json

src/server/notifications/StreamingHTTPChannel2023/StreamingHTTPListeningActivityHandler.ts

src/server/notifications/StreamingHTTPChannel2023/StreamingHTTP2023Emitter.ts

Co-authored-by: Maciej Samoraj <maciej.samoraj@gmail.com>

config/http/notifications/streaming-http/http.json

Co-authored-by: Maciej Samoraj <maciej.samoraj@gmail.com>

test/integration/StreamingHttpChannel2023.test.ts

src/server/notifications/StreamingHttpChannel2023/StreamingHttp2023Emitter.ts

TallTed

Typo, grammar, punctuation...

documentation/markdown/usage/notifications.md

Co-authored-by: Ted Thibodeau Jr <tthibodeau@openlinksw.com>

elf-pavlik · 2024-04-29T13:33:29Z

When the client disconnects from the streaming response, the following gets logged.

[BasicResponseWriter] {Primary} error: Aborting streaming response because of server error; headers already sent.
[BasicResponseWriter] {Primary} error: Response error: premature close
[HandlerServerConfigurator] {Primary} error: Request error: aborted

I see it as normal behavior for the client to disconnect once they want to stop receiving notifications. It can also happen on a spotty connection. Should it be logged out as an error?

joachimvh · 2024-04-30T06:10:49Z

I see it as normal behavior for the client to disconnect once they want to stop receiving notifications. It can also happen on a spotty connection. Should it be logged out as an error?

You could attach an error listener to catch that one and emit a more detailed/correct error instead, but if this is only on disconnect this is not a big issue.

Co-authored-by: Maciej Samoraj <maciej.samoraj@gmail.com>

joachimvh

Mostly minor issues

config/http/notifications/all.json

config/http/notifications/streaming-http.json

config/http/notifications/streaming-http/http.json

test/integration/StreamingHttpChannel2023.test.ts

test/unit/server/notifications/StreamingHttpChannel2023/StreamingHttp2023Util.test.ts

test/util/Util.ts

elf-pavlik · 2024-05-14T23:32:07Z

test/integration/StreamingHttpChannel2023.test.ts

+    const del = await fetch(receiveFrom, {
+      method: 'DELETE',
+    });
+    expect(del.status).toBe(404);


I don't know why DELETE responds with 404 instead of 405, OperationRouteHandler has "allowedMethods": [ "GET" ]

The problem is that the RouterHandler does all its checks in the canHandle call instead of the handle call. Which means that if it throws an error the server will just try the next handlers until it finds one that can handle it. The last one, the LDP handler, can always handle a request and will then throw a 404 because it can't find that resource.

There is indeed something to be said for the fact that method checks should be done in the handle call instead so a 405 is returned, but that is out of scope for this PR.

And why does only the DELETE method respond with 404, while HEAD, PUT, and POST all respond with 405?

And why does only the DELETE method respond with 404, while HEAD, PUT, and POST all respond with 405?

I have no idea tbh, would be something to investigate 😅

If you like, I could create an issue to track it after this PR gets merged.

elf-pavlik · 2024-05-14T23:38:57Z

If all your feedback is addressed, I could

wait for update CI node versions #1906 and rebase this branch
remove undici and workaround that times out the response body in the integration test
squash everything into a single commit?

joachimvh · 2024-05-15T06:30:24Z

If all your feedback is addressed, I could

wait for update CI node versions #1906 and rebase this branch

remove undici and workaround that times out the response body in the integration test

squash everything into a single commit?

You can already update this PR as if the other one is merged so undici can be removed. Squashing is not necessary as I can do that when merging the PR myself.

joachimvh · 2024-05-15T06:32:07Z

One other thing I just thought of, could you also update the documentation at https://communitysolidserver.github.io/CommunitySolidServer/latest/architecture/features/notifications/ with some explanation about how the architecture of this one differs from the others?

elf-pavlik · 2024-05-15T16:49:15Z

All your suggestions should be addressed now. Thank you for all the help!

joachimvh

Minor documentation comments, after this it can be merged.

documentation/markdown/architecture/features/notifications.md

Co-authored-by: Joachim Van Herwegen <joachimvh@gmail.com>

joachimvh

Looks good ^^

feat: initial StremingHTTPChannel2023 notifications

1df0c1d

Co-authored-by: Maciej Samoraj <maciej.samoraj@gmail.com>

elf-pavlik changed the title ~~StremingHTTPChannel2023~~ StreamingHTTPChannel2023 Apr 3, 2024

joachimvh reviewed Apr 4, 2024

View reviewed changes

elf-pavlik mentioned this pull request Apr 5, 2024

Too Slow: Please provide Updates-Via shortcut to secure web socket address solid/notifications#110

Open

test: unit for StremingHTTPChannel2023 notifications

a2a235d

Co-authored-by: Maciej Samoraj <maciej.samoraj@gmail.com>

elf-pavlik commented Apr 10, 2024

View reviewed changes

config/http/notifications/streaming-http/http.json Show resolved Hide resolved

test: integration for StremingHTTPChannel2023 notifications

de0ea45

Co-authored-by: Maciej Samoraj <maciej.samoraj@gmail.com>

elf-pavlik force-pushed the streaming-http branch from c6ee114 to de0ea45 Compare April 12, 2024 13:20

elf-pavlik added 3 commits April 12, 2024 20:31

emit initial notification on streaming http channel

7df8200

fix linting erros

5dc8afa

ensure canceling fetch body in integration tests

e8c00f4

elf-pavlik force-pushed the streaming-http branch from bdea4bd to e8c00f4 Compare April 13, 2024 18:33

elf-pavlik commented Apr 13, 2024

View reviewed changes

test/integration/StreamingHttpChannel2023.test.ts Show resolved Hide resolved

extract defaultChannel for topic into util

2dd3166

elf-pavlik commented Apr 26, 2024

View reviewed changes

src/server/notifications/StreamingHttpChannel2023/StreamingHttp2023Emitter.ts Show resolved Hide resolved

add documentation

467a66b

elf-pavlik marked this pull request as ready for review April 26, 2024 02:04

TallTed suggested changes Apr 26, 2024

View reviewed changes

Apply suggestions from code review

5dee600

Co-authored-by: Ted Thibodeau Jr <tthibodeau@openlinksw.com>

only generate notifications when needed

2623ced

Co-authored-by: Maciej Samoraj <maciej.samoraj@gmail.com>

elf-pavlik force-pushed the streaming-http branch from b97ce39 to 2623ced Compare May 6, 2024 19:02

test: set body timeout to pass on node >21

340c6d3

Co-authored-by: Maciej Samoraj <maciej.samoraj@gmail.com>

elf-pavlik mentioned this pull request May 9, 2024

update CI node versions #1906

Merged

joachimvh requested changes May 14, 2024

View reviewed changes

address review feedback

9197581

elf-pavlik commented May 14, 2024

View reviewed changes

elf-pavlik requested a review from joachimvh May 14, 2024 23:36

remove node 21 workaround

2b137fe

elf-pavlik force-pushed the streaming-http branch from 3d050cc to eb3cdf5 Compare May 15, 2024 14:01

add architecture documentation

eb3cdf5

joachimvh requested changes May 21, 2024

View reviewed changes

documentation/markdown/architecture/features/notifications.md Outdated Show resolved Hide resolved

documentation/markdown/architecture/features/notifications.md Outdated Show resolved Hide resolved

joachimvh reviewed May 21, 2024

View reviewed changes

documentation/markdown/architecture/features/notifications.md Outdated Show resolved Hide resolved

Apply suggestions from code review

6faf86a

Co-authored-by: Joachim Van Herwegen <joachimvh@gmail.com>

elf-pavlik requested a review from joachimvh May 21, 2024 12:10

joachimvh approved these changes May 22, 2024

View reviewed changes

joachimvh merged commit cb38613 into CommunitySolidServer:main May 22, 2024
37 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

StreamingHTTPChannel2023 #1878

StreamingHTTPChannel2023 #1878

elf-pavlik commented Apr 3, 2024

joachimvh left a comment

TallTed left a comment

elf-pavlik commented Apr 29, 2024

joachimvh commented Apr 30, 2024

joachimvh left a comment

elf-pavlik May 14, 2024

joachimvh May 15, 2024 •

edited

elf-pavlik May 15, 2024

joachimvh May 21, 2024

elf-pavlik May 21, 2024

joachimvh May 22, 2024

elf-pavlik commented May 14, 2024

joachimvh commented May 15, 2024 •

edited

joachimvh commented May 15, 2024

elf-pavlik commented May 15, 2024

joachimvh left a comment

joachimvh left a comment

StreamingHTTPChannel2023 #1878

StreamingHTTPChannel2023 #1878

Conversation

elf-pavlik commented Apr 3, 2024

📁 Related issues

✍️ Description

✅ PR check list

joachimvh left a comment

Choose a reason for hiding this comment

TallTed left a comment

Choose a reason for hiding this comment

elf-pavlik commented Apr 29, 2024

joachimvh commented Apr 30, 2024

joachimvh left a comment

Choose a reason for hiding this comment

elf-pavlik May 14, 2024

Choose a reason for hiding this comment

joachimvh May 15, 2024 • edited

Choose a reason for hiding this comment

elf-pavlik May 15, 2024

Choose a reason for hiding this comment

joachimvh May 21, 2024

Choose a reason for hiding this comment

elf-pavlik May 21, 2024

Choose a reason for hiding this comment

joachimvh May 22, 2024

Choose a reason for hiding this comment

elf-pavlik commented May 14, 2024

joachimvh commented May 15, 2024 • edited

joachimvh commented May 15, 2024

elf-pavlik commented May 15, 2024

joachimvh left a comment

Choose a reason for hiding this comment

joachimvh left a comment

Choose a reason for hiding this comment

joachimvh May 15, 2024 •

edited

joachimvh commented May 15, 2024 •

edited