Feature: implement EngineIO V3 (closes #22)

.github/workflows/engineio-ci.yml

@@ -0,0 +1,40 @@
+
+name: EngineIO CI
+
+on:
+  push:
+    tags:
+      - v*
+  pull_request:
+    branches:
+      - main
+      - develop
+
+jobs:
+  e2e_v3:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions-rs/toolchain@v1
+        with:
+          toolchain: stable
+      - uses: actions/checkout@v3
+        with:
+          # TODO: replace with official repo once https://github.com/socketio/engine.io-protocol/pull/45 has been merged
+          repository: sleeyax/engine.io-protocol
+          path: engine.io-protocol
+          ref: v3-testsuite
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 16
+      - name: Install deps & run tests 
+        run: |
+          cd engine.io-protocol/test-suite && npm install && cd ../..
+          cargo run --bin engineioxide-e2e --release --features v3 --no-default-features > v3_server.txt & npm --prefix engine.io-protocol/test-suite test > v3_client.txt
+      - name: Server output
+        if: always()
+        run: cat v3_server.txt
+      - name: Client output
+        if: always()
+        run:  cat v3_client.txt

.github/workflows/socketio-ci.yml

@@ -18,7 +18,7 @@ jobs:
       - uses: actions-rs/toolchain@v1
         with:
           toolchain: stable
-      - run: cargo test
+      - run: cargo test --all-features
   e2e:
     runs-on: ubuntu-latest
 

engineioxide/Cargo.toml

@@ -30,10 +30,16 @@ tower = "0.4.13"
 tracing = "0.1.37"
 rand = "0.8.5"
 base64id = { version = "0.3.1", features = ["std", "rand", "serde"] }
+cfg-if = "1.0.0"
 
 [dev-dependencies]
 criterion = { version = "0.5.1", features = ["html_reports", "async_tokio"] }
 
 [[bench]]
 name = "benchmark_polling"
-harness = false
+harness = false
+
+[features]
+default = ["v4"]
+v4 = []
+v3 = []

engineioxide/Readme.md

@@ -47,3 +47,23 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> {
     Ok(())
 }
 ```
+
+### Supported Protocols
+You can enable support for other EngineIO protocol implementations through feature flags. 
+The latest supported protocol version is enabled by default. 
+
+To add support for another protocol version, adjust your dependency configuration accordingly:
+
+```toml
+[dependencies]
+# Enables the `v3` protocol (`v4` is also implicitly enabled, as it's the default).
+engineioxide = { version = "0.3.0", features = ["v3"] }
+```
+
+To enable *a single protocol version only*, disable default features:
+
+```toml
+[dependencies]
+# Enables the `v3` protocol only.
+engineioxide = { version = "0.3.0", features = ["v3"], default-features = false }
+```

engineioxide/src/config.rs

@@ -53,6 +53,7 @@ impl EngineIoConfigBuilder {
             config: EngineIoConfig::default(),
         }
     }
+
     /// The path to listen for engine.io requests on.
     /// Defaults to "/engine.io".
     pub fn req_path(mut self, req_path: String) -> Self {