Linux support (#11)

* add linux support

* create linux curl engine simultaneous ws and http reproduce case

* work around linux issue, add basic echo test on linux/windows native

* update ci

* fix linux ci command

* fix linux test

* add macos and js basic echo test

* fix macos ci

* update log logic, add more test cases

Author: Piasy

.github/workflows/ci.yaml

@@ -15,7 +15,20 @@ permissions:
 
 jobs:
   build:
-    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - os: macos-latest
+            cov: on
+            cmd: "./gradlew :kmp-socketio:jvmTest --info"
+          - os: macos-latest
+            cmd: "./gradlew :kmp-socketio:macosX64Test --info && ./kmp-socketio/src/jsTest/start_server.sh && ./gradlew :kmp-socketio:jsBrowserTest --info && ./kmp-socketio/src/jsTest/stop_server.sh"
+          - os: ubuntu-latest
+            cmd: "./gradlew :kmp-socketio:linuxX64Test --info"
+          - os: windows-latest
+            cmd: "./gradlew :kmp-socketio:mingwX64Test --info"
+    runs-on: ${{ matrix.os }}
     permissions:
       pull-requests: write
       contents: write
@@ -33,17 +46,19 @@ jobs:
       - uses: actions/setup-node@v4
         with:
           node-version: 14
+          architecture: 'x64'
       - name: Setup Test Env
         run: |
           cd kmp-socketio/src/jvmTest/resources/
           npm install
-      - name: Run Jvm tests
-        run: |
-          ./gradlew :kmp-socketio:jvmTest --info
+      - name: Run tests
+        run: ${{ matrix.cmd }}
       - name: Gen coverage
+        if: ${{ matrix.cov == 'on' }}
         run: |
           ./gradlew koverXmlReport
       - name: Add coverage to PR
+        if: ${{ matrix.cov == 'on' }}
         id: jacoco
         uses: madrapps/[email protected]
         with:
@@ -54,26 +69,28 @@ jobs:
           pass-emoji: ":white_check_mark:"
           fail-emoji: ":negative_squared_cross_mark:"
       - name: Overall coverage check
-        if: ${{ steps.jacoco.outputs.coverage-overall < 80 || steps.jacoco.outputs.coverage-changed-files < 80 }}
+        if: ${{ matrix.cov == 'on' && (steps.jacoco.outputs.coverage-overall < 80 || steps.jacoco.outputs.coverage-changed-files < 80) }}
         uses: actions/github-script@v7
         with:
           script: |
             core.setFailed("Coverage check failed! overall ${{ steps.jacoco.outputs.coverage-overall }}, diff ${{ steps.jacoco.outputs.coverage-changed-files }}.")
       - name: Create coverage summary json
+        if: ${{ matrix.cov == 'on' }}
         uses: jsdaniell/[email protected]
         with:
           dir: kmp-socketio/build/reports/kover/
           name: "coverage.json"
           json: '{"total":{"instructions":{"pct":${{ steps.jacoco.outputs.coverage-overall }} }}}'
       - name: Create Coverage Badges
+        if: ${{ matrix.cov == 'on' }}
         uses: jaywcjlove/coverage-badges-cli@main
         with:
           source: ${{ github.workspace }}/kmp-socketio/build/reports/kover/coverage.json
           output: dist/badges.svg
           jsonPath: total.instructions.pct
       - name: Deploy
         uses: peaceiris/actions-gh-pages@v4
-        if: ${{ github.ref == 'refs/heads/main' }}
+        if: ${{ matrix.cov == 'on' && github.ref == 'refs/heads/main' }}
         with:
           commit_message: ${{ github.event.head_commit.message }}
           github_token: ${{ secrets.GITHUB_TOKEN }}

README.md

@@ -10,20 +10,11 @@ KMP (pure Kotlin) implementation of SocketIO client.
 | :----------------: | :------------------: |
 |      `JVM` 17      |          🚀          |
 | `JS`     (Chrome)  |          🚀          |
-| `WasmJS` (Chrome)  |          🚀          |
 |     `Android`      |          🚀          |
 |       `iOS`        |          🚀          |
 |      `macOS`       |          🚀          |
 |   `Windows X64`    |          🚀          |
-|    `Linux X64`     |          🔮          |
-
-About Linux support: Ktor's curl engine doesn't support websockets now,
-although CIO engine supports websockets, but it doesn't support TLS.
-
-Ref:
-
-- [Native Sockets TLS Client/Server support for linux](https://github.com/ktorio/ktor/pull/2939)
-- [Possible websockets support for curl engine](https://github.com/whyoleg/ktor/tree/libcurl-ws)
+|    `Linux X64`     |          🚀          |
 
 ## Dependency
 
@@ -66,6 +57,11 @@ Most of the APIs are the same as socket.io-client-java, here are some difference
 
 ### Logging with [kmp-xlog](https://github.com/HackWebRTC/kmp-xlog)
 
+## Development
+
+To check coverage details, run `./gradlew :kmp-socketio:jvmTest --info && ./gradlew koverHtmlReport`,
+then check `kmp-socketio/build/reports/kover/html/index.html`. 
+
 ## Example
 
 Before running examples, run `node kmp-socketio/src/jvmTest/resources/socket-server.js` to start the socket-io echo server,
@@ -96,20 +92,18 @@ Use Chrome CORS Unblock extension to workaround with CORS error.
 ./gradlew :example:shared:jsBrowserRun
 ```
 
-### WASM JS
-
-Use Chrome CORS Unblock extension to workaround with CORS error.
-
- ```bash
-./gradlew :example:shared:wasmJsBrowserRun
- ```
-
 ### Windows
 
 ```bash
 .\gradlew runKmp_socketioDebugExecutableMingwX64
 ```
 
+### Linux
+
+```bash
+./gradlew runKmp_socketioDebugExecutableLinuxX64
+```
+
 ### macOS
 
 ```bash
@@ -121,6 +115,8 @@ Use Chrome CORS Unblock extension to workaround with CORS error.
 Maven central portal credentials and signing configs are set in `~/.gradle/gradle.properties`.
 
 ```bash
+# on Linux: need manual release on website
+./gradlew clean publishLinuxX64PublicationToMavenCentralRepository --no-configuration-cache
 # on Windows: need manual release on website
 .\gradlew clean publishMingwX64PublicationToMavenCentralRepository --no-configuration-cache
 # on macOS: need manual release on website
@@ -132,7 +128,6 @@ Maven central portal credentials and signing configs are set in `~/.gradle/gradl
     publishIosX64PublicationToMavenCentralRepository \
     publishMacosArm64PublicationToMavenCentralRepository \
     publishMacosX64PublicationToMavenCentralRepository \
-    publishWasmJsPublicationToMavenCentralRepository \
     publishJsPublicationToMavenCentralRepository \
     --no-configuration-cache
 ```

buildSrc/src/main/kotlin/Constants.kt

@@ -1,7 +1,7 @@
 object Consts {
   const val releaseGroup = "com.piasy"
   const val releaseName = "kmp-socketio"
-  const val releaseVersion = "1.1.4"
+  const val releaseVersion = "1.2.0"
 
   val androidNS = "$releaseGroup.${releaseName.replace('-', '.')}"
 }

example/shared/build.gradle.kts

@@ -1,4 +1,3 @@
-import org.jetbrains.kotlin.gradle.ExperimentalWasmDsl
 import org.jetbrains.kotlin.gradle.targets.js.webpack.KotlinWebpackConfig
 
 plugins {
@@ -40,27 +39,8 @@ kotlin {
         }
         binaries.executable()
     }
-    @OptIn(ExperimentalWasmDsl::class)
-    wasmJs {
-        moduleName = "example"
-        browser {
-            val rootDirPath = project.rootDir.path
-            val projectDirPath = project.projectDir.path
-            commonWebpackConfig {
-                outputFileName = "composeApp.js"
-                devServer = (devServer ?: KotlinWebpackConfig.DevServer()).apply {
-                    static = (static ?: mutableListOf()).apply {
-                        // Serve sources to debug inside browser
-                        add(rootDirPath)
-                        add(projectDirPath)
-                    }
-                }
-            }
-        }
-        binaries.executable()
-    }
 
-    listOf(/*linuxX64(), */mingwX64()).forEach {
+    listOf(linuxX64(), mingwX64()).forEach {
         it.binaries {
             executable("kmp_socketio") {
                 entryPoint = "com.piasy.kmp.socketio.example.main"
@@ -76,11 +56,6 @@ kotlin {
                 implementation(project(":kmp-socketio"))
             }
         }
-        wasmJsMain {
-            dependencies {
-                implementation(libs.kotlinx.browser)
-            }
-        }
     }
 }
 

example/shared/src/wasmJsMain/kotlin/com/piasy/kmp/socketio/example/Platform.kt

@@ -5,11 +5,11 @@ compileSdk = "35"
 minSdk = "21"
 targetSdk = "35"
 agp = "8.7.3"
-kotlin = "2.1.0"
+kotlin = "2.1.10"
 mockk = "1.13.16"
-ktor = "3.0.3"
+ktor = "3.1.0"
 coroutine = "1.10.1"
-compose = "1.7.7"
+compose = "1.7.8"
 
 [libraries]
 junit = "junit:junit:4.13.2"
@@ -18,9 +18,10 @@ kotlin-test = { module = "org.jetbrains.kotlin:kotlin-test", version.ref = "kotl
 mockk = { module = "io.mockk:mockk", version.ref = "mockk" }
 kotlinx-coroutines-test = { module = "org.jetbrains.kotlinx:kotlinx-coroutines-test", version.ref = "coroutine" }
 json = "org.json:json:20250107"
+kommand = "com.kgit2:kommand:2.3.0"
+
 socketioParser = "org.hildan.socketio:socketio-kotlin:2.0.0"
 kotlinx-coroutines-core = { module = "org.jetbrains.kotlinx:kotlinx-coroutines-core", version.ref = "coroutine" }
-kotlinx-browser = "org.jetbrains.kotlinx:kotlinx-browser:0.3"
 ktor-client-core = { module = "io.ktor:ktor-client-core", version.ref = "ktor" }
 ktor-client-websockets = { module = "io.ktor:ktor-client-websockets", version.ref = "ktor" }
 ktor-client-logging = { module = "io.ktor:ktor-client-logging", version.ref = "ktor" }
@@ -32,14 +33,14 @@ ktor-client-curl = { module = "io.ktor:ktor-client-curl", version.ref = "ktor" }
 ktor-client-js = { module = "io.ktor:ktor-client-js", version.ref = "ktor" }
 ktor-client-java = { module = "io.ktor:ktor-client-java", version.ref = "ktor" }
 ktor-client-cio = { module = "io.ktor:ktor-client-cio", version.ref = "ktor" }
-kmpXlog = "com.piasy:kmp-xlog-api:1.3.5"
+kmpXlog = "com.piasy:kmp-xlog-api:1.4.1"
 
 androidx-compose-ui = { module = "androidx.compose.ui:ui", version.ref = "compose" }
 androidx-compose-ui-tooling = { module = "androidx.compose.ui:ui-tooling", version.ref = "compose" }
 androidx-compose-ui-tooling-preview = { module = "androidx.compose.ui:ui-tooling-preview", version.ref = "compose" }
 androidx-compose-foundation = { module = "androidx.compose.foundation:foundation", version.ref = "compose" }
 androidx-compose-material = { module = "androidx.compose.material:material", version.ref = "compose" }
-androidx-activity-compose = "androidx.activity:activity-compose:1.10.0"
+androidx-activity-compose = "androidx.activity:activity-compose:1.10.1"
 
 [plugins]
 android-library = { id = "com.android.library", version.ref = "agp" }

example/shared/src/wasmJsMain/resources/index.html

@@ -1,5 +1,4 @@
 import com.vanniktech.maven.publish.SonatypeHost
-import org.jetbrains.kotlin.gradle.ExperimentalWasmDsl
 
 plugins {
     alias(libs.plugins.kmp)
@@ -20,29 +19,21 @@ kotlin {
     iosX64()
     macosArm64()
     macosX64()
+
     js(IR) {
         browser {
         }
         binaries.executable()
     }
-    mingwX64 {}
-    @OptIn(ExperimentalWasmDsl::class)
-    wasmJs {
-        browser {
-        }
-        binaries.executable()
-    }
 
-    // Ktor's curl engine doesn't support websockets now,
-    // although CIO engine supports websockets, but it doesn't support TLS.
-    // - [Native Sockets TLS Client/Server support for linux](https://github.com/ktorio/ktor/pull/2939)
-    // - [Possible websockets support for curl engine](https://github.com/whyoleg/ktor/tree/libcurl-ws)
-    //linuxX64 {}
+    mingwX64 {}
+    linuxX64 {}
 
     applyDefaultHierarchyTemplate()
     sourceSets {
         all {
             languageSettings.optIn("kotlinx.coroutines.ExperimentalCoroutinesApi")
+            languageSettings.optIn("kotlinx.cinterop.ExperimentalForeignApi")
         }
 
         commonMain {
@@ -55,6 +46,13 @@ kotlin {
                 api(libs.kmpXlog)
             }
         }
+        commonTest {
+            dependencies {
+                implementation(libs.kotlin.test)
+                implementation(libs.kotlinx.coroutines.test)
+            }
+        }
+
         jvmMain {
             dependencies {
                 //api(libs.ktor.client.java) // java engine can't get ws response headers
@@ -77,11 +75,17 @@ kotlin {
                 implementation(libs.json)
             }
         }
+
         appleMain {
             dependencies {
                 api(libs.ktor.client.darwin)
             }
         }
+        macosTest {
+            dependencies {
+                implementation(libs.kommand)
+            }
+        }
         jsMain {
             dependencies {
                 api(libs.ktor.client.js)
@@ -92,9 +96,14 @@ kotlin {
                 api(libs.ktor.client.winhttp)
             }
         }
-        wasmJsMain {
+        linuxMain {
+            dependencies {
+                api(libs.ktor.client.curl)
+            }
+        }
+        linuxTest {
             dependencies {
-                api(libs.ktor.client.wasm)
+                implementation(libs.kommand)
             }
         }
     }