feat: emit multipe parameters #249

SSebo · 2022-10-24T10:13:28Z

js client can emit multiple parameters in one call. user socketio server socket.on("foo", async (userId, body, callback)=>{}) (#246) accept this kind of data which rust-socektio can not emit.

codecov · 2022-10-24T10:20:30Z

Codecov Report

Merging #249 (12b0d73) into main (4ac27c7) will increase coverage by 0.05%.
The diff coverage is 81.33%.

@@            Coverage Diff             @@
##             main     #249      +/-   ##
==========================================
+ Coverage   86.27%   86.33%   +0.05%     
==========================================
  Files          31       31              
  Lines        2478     2562      +84     
==========================================
+ Hits         2138     2212      +74     
- Misses        340      350      +10

Impacted Files	Coverage Δ
socketio/src/client/builder.rs	`92.95% <ø> (ø)`
socketio/src/client/client.rs	`94.91% <ø> (ø)`
socketio/src/lib.rs	`100.00% <ø> (ø)`
socketio/src/payload.rs	`68.29% <51.85%> (-31.71%)`	⬇️
socketio/src/client/raw_client.rs	`78.50% <62.50%> (+0.87%)`	⬆️
socketio/src/socket.rs	`87.50% <94.84%> (+9.00%)`	⬆️
socketio/src/packet.rs	`91.84% <100.00%> (+0.40%)`	⬆️

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

ctrlaltf24

Thanks for the PR! Don't quite understand what the problem was, nor the solution, a brief explanation (preferably in comments) as to what happened may be helpful

socketio/examples/callback.rs

socketio/src/client/raw_client.rs

socketio/src/socket.rs

socketio/src/packet.rs

socketio/examples/readme.rs

david-sailplan · 2022-10-24T19:26:52Z

I had left an earlier comment but deleted it. Turns out it was an issue on the server side

david-sailplan · 2022-10-24T20:16:17Z

This does seem to solve the problem I was experiencing here. Good job

1c3t3a · 2022-10-25T07:52:25Z

First of all thanks for the quick solution @SSebo! But I wanted to ask whether this can be solved by reverting the behaviour of #220. This was the initial reason why I only accepted valid json and nothing else. I would prefer this approach over a completely new API call!

SSebo · 2022-10-25T08:00:08Z

First of all thanks for the quick solution @SSebo! But I wanted to ask whether this can be solved by reverting the behaviour of #220. This was the initial reason why I only accepted valid json and nothing else. I would prefer this approach over a completely new API call!

The root reason is socketio encoding accept [event, payload1, payload2 ... payloadn] format, original rust_socketio implementation only support [event, only_1_json_payload].
what user want is multiple payloads, and type can be number, string, json, and binary.
only one json payload [event, only_1_json_payload] can not be accepted by server code like socket.on("foo", async (userId, body, callback)=>{})

revert #220 is ok, but we still need a way to emit simple payload like number and string if nodejs socketio server needs.

the new API is a POC, even the name of that API is not good.

1c3t3a · 2022-10-25T08:02:57Z

This is not entirely true, we don't need number since this is part of Json, eg: { "my_number": 1}. Can you confirm that a revert of #220 results in being able to emit to a socketio server with socket.on("foo", async (userId, body, callback)=>{})where body is not empty? :)

SSebo · 2022-10-25T08:05:18Z

I agree, not include number. #220 is a little wired that callback payload can not emit back, maybe Payload::Json and Payload::Binary are better.

SSebo · 2022-10-25T08:19:08Z

This is not entirely true, we don't need number since this is part of Json, eg: { "my_number": 1}. Can you confirm that a revert of #220 results in being able to emit to a socketio server with socket.on("foo", async (userId, body, callback)=>{})where body is not empty? :)

@david-sailplan can you confirm that use a single json payload is able to emit to a socketio server with socket.on("foo", async (userId, body, callback)=>{})where body is not empty? :)

david-sailplan · 2022-10-25T17:58:21Z

@SSebo I'm not entirely sure what you're asking here. If you're asking if something to the effect of

let payload = json!(("user_id_1", json!({'data": 1})))
socket.emit_with_ack("foo",payload, duration, callback)

works with server code

socket.on("foo", async (userId, body, callback)=>{
    console.log({userId, body, callback});
    callback(1);
})

I can confirm that it does not. Log would be

{
    userId: ['user_id)1', {'data': 1}]
    body: [Function (anonymous)],
    callback: undefined
}

david-sailplan · 2022-10-25T18:07:09Z

If what you're asking is if

let payload = vec![json!(1), json({"data": 2}))]
socket.emit_multi_with_ack("foo", payload, duration, callback)

works with the above server code the answer is yes. It behaves as we expected even after removing the Payload::Number

ctrlaltf24

Just dropping by, as always @1c3t3a 's in charge

socketio/src/socket.rs

socketio/src/client/client.rs

ctrlaltf24

Thank you for being receptive to comments so far, feel free to ignore the "nit"s you don't want to do, just saying things I noticed.

Changes to Packet's public interface require @1c3t3a 's approval. We MIGHT be able to still squeeze by with changes to Packet, as it's not likely many use it. Your call.

socketio/src/payload.rs

ctrlaltf24 · 2022-10-26T16:06:10Z

socketio/src/socket.rs

        payload: Payload,
-        event: Event,
-        nsp: &'a str,
+        event: Option<Event>,


nit: when is event none? Only usage I can see is in the tests

I found client.emit(Buffer.from([4, 5, 6])); in socket-io.js, I thought event is optional that time. But I lookup the socketio dos, event is not optional. Does this mean the event can be a valid payload?
I could not figure out how to emit like that in rust-socketio.

right now in rust-socketio if only receive 1 item in packet.data, it will be treat as payload, not event.

rust-socketio/socketio/src/client/raw_client.rs

Lines 325 to 354 in 4ac27c7

fn handle_event(&self, packet: &Packet) -> Result<()> {

// unwrap the potential data

if let Some(data) = &packet.data {

// the string must be a valid json array with the event at index 0 and the

// payload at index 1. if no event is specified, the message callback is used

if let Ok(serde_json::Value::Array(contents)) =

serde_json::from_str::<serde_json::Value>(data)

{

let event: Event = if contents.len() > 1 {

contents

.get(0)

.map(|value| match value {

serde_json::Value::String(ev) => ev,

_ => "message",

})

.unwrap_or("message")

.into()

} else {

Event::Message

};

self.callback(

&event,

contents

.get(1)

.unwrap_or_else(|| contents.get(0).unwrap())

.to_string(),

)?;

}

}

Ok(())

Where did you find that? Specification only mentions, that when no event is specified, "Message" should be used. So having an Option<Event> would not make sense in that case.

@1c3t3a I found it here

rust-socketio/ci/socket-io.js

Line 41 in 4ac27c7

client.emit(Buffer.from([4, 5, 6]));

I agree event should not be optional. I just don't know how to emit like js in rust-socketio.
Does that mean this Buffer is event?

socketio/src/socket.rs

socketio/src/packet.rs

ctrlaltf24 · 2022-10-26T16:10:59Z

socketio/src/packet.rs

+        packet.data = match json_data {
+            Value::Array(vec) if vec.is_empty() => None,
+            // Value::Array(vec) if vec.len() == 1 => vec.get(0).map(|v| v.to_owned()),
+            _ => Some(json_data),


nit: would this still have the _placeholder in it?

Yes, _placeholder will be replaced to real Payload::Binary in socket.rs

packet.rs should handle all de-serialization of the packet. This will become more important if/when we want to support multiple versions.

BinaryEvent can be mixed with normal data and binary data like client.emit('test', Buffer.from([1, 2, 3]), "4", Buffer.from([5, 6]));, so we can not just remove all _placeholder as we do not know where the binary data is in the sequence of received items. socket.rs will not parse the packet, just to replace _placehoulder to Payload::Binary

I checked socket.io protocol, for now BinaryEvent is not changed when added in version 2. If we do not want to touch _placehoulder in socket.rs, we should replaced to Payload::Binary in packet.rs to keep order of mixed multi payloads. packet.data can not be Vec<Value> or Vec<String> but Vec<Payload>.

socketio/src/client/raw_client.rs

ctrlaltf24 · 2022-10-26T16:29:52Z

socketio/src/client/raw_client.rs

+                    .map(|value| match value {
+                        serde_json::Value::String(ev) => ev,
+                        _ => "message",
+                    })


Suggested change

.map(|value| match value {

serde_json::Value::String(ev) => ev,

_ => "message",

})

.and_then(|value| match value {

serde_json::Value::String(ev) => Some(ev),

_ => None

})

ctrlaltf24 · 2022-10-27T18:20:21Z

socketio/src/socket.rs

@@ -158,6 +158,47 @@ impl Socket {
        attachments.push(bin_data);
    }

+    pub(crate) fn decode_binary_payload(


nit: why did this move? It's only used in raw_client

I found encode is in socket.rs, so I move decode in socket.rs too.

ctrlaltf24 · 2022-12-05T21:26:52Z

Why was this closed @SSebo ?

1c3t3a · 2023-01-15T21:09:57Z

Good question!

SSebo mentioned this pull request Oct 24, 2022

Emit with multiple parameters #246

Open

SSebo force-pushed the emit_multi branch 2 times, most recently from 0987cdf to fdd47fd Compare October 24, 2022 12:12

feat: emit multipe payload

f776d9f

SSebo force-pushed the emit_multi branch from fdd47fd to f776d9f Compare October 24, 2022 12:30

ctrlaltf24 reviewed Oct 24, 2022

View reviewed changes

SSebo added 3 commits October 25, 2022 12:48

chore: improve readability

b271262

chore: remove Payload::Number

9003cbf

chore: restore example

3f9351f

ctrlaltf24 reviewed Oct 25, 2022

View reviewed changes

socketio/src/socket.rs Outdated Show resolved Hide resolved

socketio/src/socket.rs Outdated Show resolved Hide resolved

socketio/src/client/client.rs Outdated Show resolved Hide resolved

SSebo changed the title ~~feat: emit multipe payload~~ feat: emit multipe parameters Oct 26, 2022

SSebo force-pushed the emit_multi branch 3 times, most recently from 263fd9b to 34275ff Compare October 26, 2022 11:23

refactor: use Payload::Multi instead of new api

a206d5d

SSebo force-pushed the emit_multi branch from 34275ff to a206d5d Compare October 26, 2022 11:33

ctrlaltf24 reviewed Oct 26, 2022

View reviewed changes

chore: move binary decode to socket.rs

12b0d73

ctrlaltf24 reviewed Oct 27, 2022

View reviewed changes

SSebo closed this Nov 27, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: emit multipe parameters #249

feat: emit multipe parameters #249

SSebo commented Oct 24, 2022 •

edited

Loading

codecov bot commented Oct 24, 2022 •

edited

Loading

ctrlaltf24 left a comment

david-sailplan commented Oct 24, 2022

david-sailplan commented Oct 24, 2022

1c3t3a commented Oct 25, 2022

SSebo commented Oct 25, 2022 •

edited

Loading

1c3t3a commented Oct 25, 2022

SSebo commented Oct 25, 2022 •

edited

Loading

SSebo commented Oct 25, 2022

david-sailplan commented Oct 25, 2022

david-sailplan commented Oct 25, 2022

ctrlaltf24 left a comment

ctrlaltf24 left a comment

ctrlaltf24 Oct 26, 2022

SSebo Oct 27, 2022 •

edited

Loading

SSebo Oct 27, 2022

1c3t3a Oct 27, 2022

SSebo Oct 28, 2022 •

edited

Loading

ctrlaltf24 Oct 26, 2022

SSebo Oct 27, 2022

ctrlaltf24 Oct 27, 2022

SSebo Oct 28, 2022 •

edited

Loading

ctrlaltf24 Oct 26, 2022

ctrlaltf24 Oct 27, 2022

SSebo Oct 28, 2022

ctrlaltf24 commented Dec 5, 2022

1c3t3a commented Jan 15, 2023

	fn handle_event(&self, packet: &Packet) -> Result<()> {
	// unwrap the potential data
	if let Some(data) = &packet.data {
	// the string must be a valid json array with the event at index 0 and the
	// payload at index 1. if no event is specified, the message callback is used
	if let Ok(serde_json::Value::Array(contents)) =
	serde_json::from_str::<serde_json::Value>(data)
	{
	let event: Event = if contents.len() > 1 {
	contents
	.get(0)
	.map(\|value\| match value {
	serde_json::Value::String(ev) => ev,
	_ => "message",
	})
	.unwrap_or("message")
	.into()
	} else {
	Event::Message
	};
	self.callback(
	&event,
	contents
	.get(1)
	.unwrap_or_else(\|\| contents.get(0).unwrap())
	.to_string(),
	)?;
	}
	}
	Ok(())

feat: emit multipe parameters #249

feat: emit multipe parameters #249

Conversation

SSebo commented Oct 24, 2022 • edited Loading

codecov bot commented Oct 24, 2022 • edited Loading

Codecov Report

ctrlaltf24 left a comment

Choose a reason for hiding this comment

david-sailplan commented Oct 24, 2022

david-sailplan commented Oct 24, 2022

1c3t3a commented Oct 25, 2022

SSebo commented Oct 25, 2022 • edited Loading

1c3t3a commented Oct 25, 2022

SSebo commented Oct 25, 2022 • edited Loading

SSebo commented Oct 25, 2022

david-sailplan commented Oct 25, 2022

david-sailplan commented Oct 25, 2022

ctrlaltf24 left a comment

Choose a reason for hiding this comment

ctrlaltf24 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

SSebo Oct 27, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

SSebo Oct 28, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

SSebo Oct 28, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ctrlaltf24 commented Dec 5, 2022

1c3t3a commented Jan 15, 2023

SSebo commented Oct 24, 2022 •

edited

Loading

codecov bot commented Oct 24, 2022 •

edited

Loading

SSebo commented Oct 25, 2022 •

edited

Loading

SSebo commented Oct 25, 2022 •

edited

Loading

SSebo Oct 27, 2022 •

edited

Loading

SSebo Oct 28, 2022 •

edited

Loading

SSebo Oct 28, 2022 •

edited

Loading