RobinTail / express-zod-api / 12245767980

100%

push

github

SSE (#2238)

This should be an alternative to `zod-sockets` and enable subscriptions
without websockets, without socket.io and so on. Also related to #991

### Resources

- Standard:
https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#event_stream_format
- Article: https://web.dev/articles/eventsource-basics
- stack:
https://stackoverflow.com/questions/34657222/how-to-use-server-sent-events-in-express-js
- random tutorial:
https://masteringjs.io/tutorials/express/server-sent-events


### Findings

- it turned out it's required to do `flush()` after each message:
https://stackoverflow.com/questions/40304985/server-side-events-sse-not-reaching-client-side
- it's recommended to use `webhooks` entry for describing SSE in OpenAPI
3.1 :
https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.1.md#oas-webhooks
- example: https://learn.openapis.org/examples/v3.1/webhook-example.html
- to make middlewares, I'd probably have to deal with mixins to avoid
repeating EndpointsFactory implementation
  - https://www.typescriptlang.org/docs/handbook/mixins.html

1200 of 1222 branches covered (98.2%)

84 of 84 new or added lines in 3 files covered. (100.0%)

4276 of 4276 relevant lines covered (100.0%)

350.28 hits per line