feat: Better ergonomy for ack responses with custom `AckStream` struct #201

Totodore · 2023-12-16T02:56:39Z

Replacement of the BoxStream<'static, Result<AckResponse<V>, AckError> to a custom AckStream that implement both Future (it will yield the first element). And Stream to poll every element.
Thanks to that combo the interface will be unified between :

Socket::emit_with_ack which sends to one socket and expect one ack.
Io::emit_with_ack which sends to all the sockets of the namespaces and expect n acks.
Operator::emit_with_ack which is doing both depending of the configuration.

Add tests and checks
Verify that every related API is coherent
Imrove documentation on related API functions
Add e2e-tests to the suite

socketioxide/src/socket.rs

…to feat-ack-stream

Totodore · 2023-12-24T00:39:23Z

Blocked by 1c3t3a/rust-socketio#385 for ack testing.

…kError`

socketioxide/src/packet.rs

socketioxide/src/socket.rs

fixes #222

…onse` fixes #222

e2e/socketioxide/socketioxide.rs

Totodore added 3 commits December 16, 2023 03:40

feat: Replace BoxStream for stream of acks to custom AckStream

78dd12f

Merge branch 'deps-switch-o-pin-project-lite' into feat-ack-stream

0d94d96

feat(socketio/socket): switch to pin-project-lite

025cb8f

Totodore changed the title ~~Feat: Better ergonomy for ack responses with custom AckStream struct~~ Better ergonomy for ack responses with custom AckStream struct Dec 16, 2023

Totodore added 2 commits December 16, 2023 03:56

Merge branch 'main' into feat-ack-stream

825d44a

feat(socketio/socket): add AckStream to Socket::emit_with_ack

40081f1

Totodore added enhancement A-socketioxide Area related to socketioxide labels Dec 16, 2023

github-advanced-security bot found potential problems Dec 16, 2023

View reviewed changes

socketioxide/src/socket.rs Fixed Show fixed Hide fixed

fix(socketio/socket): clippy

c9dc1f8

github-advanced-security bot found potential problems Dec 16, 2023

View reviewed changes

socketioxide/src/socket.rs Fixed Show fixed Hide fixed

socketioxide/src/socket.rs Fixed Show fixed Hide fixed

Totodore added 4 commits December 16, 2023 16:14

fix(socketio/socket): clippy

f16778e

feat: add an internal SendError

42b99da

test(socketio/ack): add acknowledgement tests

fb1210a

feat(socketio/ack): wip for better AckStream

3181ab6

Totodore mentioned this pull request Dec 21, 2023

Rework of errors when emitting data #172

Closed

Totodore added 9 commits December 21, 2023 19:21

feat: ack module with AckStream implementation

b18f21a

Merge remote-tracking branch 'origin/main' into feat-ack-stream

461b4e4

test(socketio/ack): fix ack tests

b4754f6

Merge remote-tracking branch 'origin/main' into feat-ack-stream

39e0fcd

Merge branch 'main' into feat-ack-stream

1e9a15a

chore: remove unused deps

79455cf

Merge branch 'main' into feat-ack-stream

d069632

Merge remote-tracking branch 'refs/remotes/origin/feat-ack-stream' in…

bf73951

…to feat-ack-stream

test(socketio/ack): add rust_socketio for ack testing

e9b37de

Totodore added 3 commits December 24, 2023 14:05

test(socketio/ack): switch to raw websocket for ack integration tests

da6ffc3

test(socketio/ack): use stream foreach loop

e1fc8b2

test(socketio/ack): fix PORT for broadcast_with_ack

b914f51

test(socketio/ack): fix imports

63ea303

Totodore marked this pull request as ready for review December 25, 2023 14:41

Totodore changed the title ~~Better ergonomy for ack responses with custom AckStream struct~~ feat: Better ergonomy for ack responses with custom AckStream struct Dec 25, 2023

Totodore changed the base branch from prepare-v0.10 to main December 25, 2023 14:42

tausifcreates approved these changes Dec 25, 2023

View reviewed changes

Totodore added 9 commits December 27, 2023 16:27

feat(socketio/socket): custom DisconnectError

48c08b1

feat(socketio/errors): better granularity with SocketError

3175d88

test(socketio/extract): add timeout to test

517efa9

doc(socketio/ack): fix doc tests

b22ed2d

feat(socketio/errors): improve error naming and add Adapter for `Ac…

332185f

…kError`

doc(socketio/ack): improve doc

67a1749

Merge branch 'feat-ack-stream' into feat-disconnect-error

840d382

doc(socketio/ack): improve doc

25f31a5

test(e2e): add emit-with-ack e2e test

25d1f9b

github-advanced-security bot found potential problems Dec 28, 2023

View reviewed changes

socketioxide/src/packet.rs Fixed Show fixed Hide fixed

socketioxide/src/socket.rs Fixed Show fixed Hide fixed

Totodore added 2 commits December 28, 2023 22:30

fix(socketio/ack): clippy lints

c3e08b0

Merge branch 'main' into feat-ack-stream

1de820c

Totodore mentioned this pull request Dec 29, 2023

SocketRef inside AckResponses #222

Closed

feat(socket/ack): add related socket to the AckResponse

e260ad1

fixes #222

Totodore linked an issue Dec 29, 2023 that may be closed by this pull request

SocketRef inside AckResponses #222

Closed

feat(socket/ack): add related sid and not SocketRef to the `AckResp…

ec8ad8c

…onse` fixes #222

github-advanced-security bot found potential problems Jan 1, 2024

View reviewed changes

e2e/socketioxide/socketioxide.rs Fixed Show fixed Hide fixed

e2e/socketioxide/socketioxide.rs Fixed Show fixed Hide fixed

e2e/socketioxide/socketioxide.rs Fixed Show fixed Hide fixed

e2e/socketioxide/socketioxide.rs Fixed Show fixed Hide fixed

Totodore added 2 commits January 1, 2024 22:51

fix(e2e): use emit_with_ack

98e5429

fix(socket/ack): make AckResultWithId private

0649293

tausifcreates approved these changes Jan 2, 2024

View reviewed changes

Totodore added 3 commits January 2, 2024 10:43

doc(socketio/ack): add doc for emit_with_ack

5803cc7

fix(socket/ack): make AckResultWithId public

5174e35

chore(deps): bump to v0.10.0

6032ffb

Totodore merged commit 87b8195 into main Jan 2, 2024
12 checks passed

Totodore deleted the feat-ack-stream branch January 10, 2024 14:32

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Better ergonomy for ack responses with custom `AckStream` struct #201

feat: Better ergonomy for ack responses with custom `AckStream` struct #201

Totodore commented Dec 16, 2023 •

edited

Loading

Totodore commented Dec 24, 2023

feat: Better ergonomy for ack responses with custom AckStream struct #201

feat: Better ergonomy for ack responses with custom AckStream struct #201

Conversation

Totodore commented Dec 16, 2023 • edited Loading

Totodore commented Dec 24, 2023

feat: Better ergonomy for ack responses with custom `AckStream` struct #201

feat: Better ergonomy for ack responses with custom `AckStream` struct #201

Totodore commented Dec 16, 2023 •

edited

Loading