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

fix: set default protocol version to 3 to allow backward compatibilit… #616

Conversation

simonemazzoni
Copy link
Contributor

…y of socket.io-client-swift

socket.io-client-swift libs version <=15.2.0, which uses protocol version 3, do not explicitly add the EIO query parameter at transport initialization. This omission leads the server to treat the client as a client that supports the protocol version 4, previously set as default, which is not correct for those versions of the client lib.

From socket.io-client-swift version v16.0.0 the EIO query parameter is explicitly passed to specify the protocol version supported, but since the allowEIO3 parameter aims to make the server compatible with previous versions which in most of the cases are already used in production and not easily upgradable, it makes more sense to default the EIO version to 3 if not explicitly set by the client since the newer client versions pass the EIO protocol version in query parameters.

The kind of change this PR does introduce

  • a bug fix
  • a new feature
  • an update to the documentation
  • a code change that improves performance
  • other

Current behaviour

socket.io-client-swift libs version <=15.2.0 cannot connect due to parsing errors since they are treated as client that support EIO protocol 4 but they supporto EIO protocol 3.

New behaviour

socket.io-client-swift libs version <=15.2.0 are correctly identified as EIO protocol 3 client and can connect correctly

Other information (e.g. related issues)

MOTIVATION: this new version of engine.io is used by the new version of socket.io and have a flag that allow backward compatibility with older client versions that implement EIO protocol version 3, but this is not true in practice since the EIO protocol used is defaulted to 4 if not explicitly indicated in the connection request, as in the case of socket.io-client-swift libs version <=15.2.0. Since is very likely that an update to socket.io from v2 to v3 involves the connection from clients that implements both EIO protocol 3 and 4, it makes sense to maintain the backward compatibility for all the client libs.

…y of socket.io-client-swift

socket.io-client-swift libs version <=15.2.0, which uses protocol version 3, do not explicitly add the EIO query parameter at transport initialization. This omission leads the server to treat the client as a client that supports the protocol version 4, previously set as default, which is not correct for those versions of the client lib.

From socket.io-client-swift version v16.0.0 the EIO query parameter is explicitly passed to specify the protocol version supported, but since the allowEIO3 parameter aims to make the server compatible with previous versions which in most of the cases are already used in production and not easily upgradable, it makes more sense to default the EIO version to 3 if not explicitly set by the client since the newer client versions pass the EIO protocol version in query parameters.
darrachequesne pushed a commit that referenced this pull request Mar 9, 2021
socket.io-client-swift libs version <=15.2.0, which uses protocol
version 3, do not explicitly add the EIO query parameter at transport
initialization. This omission leads the server to treat the client as
a client that supports the protocol version 4, previously set as
default, which is not correct for those versions of the client lib.

From socket.io-client-swift version v16.0.0 the EIO query parameter is
explicitly passed to specify the protocol version supported, but since
the allowEIO3 parameter aims to make the server compatible with
previous versions which in most of the cases are already used in
production and not easily upgradable, it makes more sense to default
the EIO version to 3 if not explicitly set by the client since the
newer client versions pass the EIO protocol version in query
parameters.

Related: socketio/socket.io#3794
@darrachequesne
Copy link
Member

That totally makes sense 👍 , merged as 868d891. Thanks a lot!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants