Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(websockets): event handler #247

Merged
merged 2 commits into from
Apr 10, 2020
Merged

Conversation

JozefFlakus
Copy link
Member

PR Type

What kind of change does this PR introduce?

[ ] Bugfix
[x] Feature
[ ] Code style update (formatting, local variables)
[ ] Refactoring (no functional changes, no api changes)
[ ] Build related changes
[ ] CI related changes
[ ] Documentation content changes
[ ] Other... Please describe:

What is the current behavior?

There is no easy way to subscribe to WebSocket server events, like: connection, error, etc.

Issue Number: #160

What is the new behavior?

Developer can subscribe to incoming server events, eg. incoming connections and also watch for broken connections:

const connection$: WsServerEffect = (event$, ctx) =>
  event$.pipe(
    matchEvent(ServerEvent.connection),
    tap(event => {
      const { client } = event.payload;

      client.once('close', () => {
        // do some cleanup...
      });
    }),
  );

export const webSocketServer = createWebSocketServer({
  event$: combineEffects(connection$),
  listener: webSocketListener({ ... }),
});

Does this PR introduce a breaking change?

[ ] Yes
[x] No

@JozefFlakus JozefFlakus added enhancement New feature or request scope: websockets Relates to @marblejs/websockets package labels Apr 8, 2020
@JozefFlakus JozefFlakus added this to the 3.1 milestone Apr 8, 2020
@JozefFlakus JozefFlakus force-pushed the feat/websockets-events-handler branch from 09ef115 to a1ceb17 Compare April 8, 2020 13:03
@codecov
Copy link

codecov bot commented Apr 8, 2020

Codecov Report

Merging #247 into master will increase coverage by 0.00%.
The diff coverage is 78.94%.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #247   +/-   ##
=======================================
  Coverage   95.07%   95.07%           
=======================================
  Files         143      147    +4     
  Lines        2456     2518   +62     
  Branches      323      329    +6     
=======================================
+ Hits         2335     2394   +59     
- Misses        117      120    +3     
  Partials        4        4           
Impacted Files Coverage Δ
...ages/core/src/http/server/http.server.interface.ts 100.00% <ø> (ø)
...es/websockets/src/server/websocket.server.event.ts 72.72% <72.72%> (ø)
...ts/src/server/websocket.server.event.subscriber.ts 76.47% <76.47%> (ø)
.../middlewares/websockets.statusLogger.middleware.ts 82.60% <82.60%> (ø)
packages/websockets/src/server/websocket.server.ts 95.45% <84.61%> (+20.94%) ⬆️
...ebsockets/src/server/websocket.server.interface.ts 100.00% <100.00%> (ø)
...re/src/http/server/http.server.event.subscriber.ts 96.29% <0.00%> (-0.26%) ⬇️
...es/core/src/http/router/http.router.resolver.v2.ts 88.63% <0.00%> (-0.13%) ⬇️
packages/websockets/src/index.ts 100.00% <0.00%> (ø)
packages/core/src/http/server/http.server.ts 100.00% <0.00%> (ø)
... and 5 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 84cbb90...fdaab14. Read the comment docs.

@JozefFlakus JozefFlakus force-pushed the feat/websockets-events-handler branch from a1ceb17 to fdaab14 Compare April 10, 2020 18:20
@JozefFlakus JozefFlakus merged commit 38c40a2 into master Apr 10, 2020
@JozefFlakus JozefFlakus deleted the feat/websockets-events-handler branch April 10, 2020 18:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request scope: websockets Relates to @marblejs/websockets package
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant