Kotlin multiplatform integration for android, ios, web (WASM) and desktop (macos, windows, linux) targets

.gitignore

@@ -2,12 +2,15 @@
 .idea
 .gradle/
 app/build/
+.gradle
+**/build/
 
 # Local configuration file (sdk path, etc)
 local.properties
 
 # Log/OS Files
 *.log
+.DS_Store
 
 # Android Studio generated files and folders
 captures/
@@ -33,14 +36,55 @@ google-services.json
 # Android Profiling
 *.hprof
 
+# Diagram backups
 *.drawio.bkp
-.DS_Store
-
-server/
-ktor-server/build/
+/docs/*.drawio.bkp
 
+build/
 
-app/src/main/res/values/developer-config.xml
+# Android
+**/developer-config.xml
 
+# Internal
 /TODO.md
-/docs/.$design.drawio.bkp
+
+
+# Xcode
+## Obj-C/Swift specific
+*.hmap
+## App packaging
+*.ipa
+*.dSYM.zip
+*.dSYM
+# Swift Package Manager
+# Add this line if you want to avoid checking in source code from Swift Package Manager dependencies.
+Packages/
+Package.pins
+Package.resolved
+
+# Xcode automatically generates this directory with a .xcworkspacedata file and xcuserdata
+# hence it is not needed unless you have added a package configuration file to your project
+.swiftpm
+# CocoaPods - Only use to conserve bandwidth / Save time on Pushing
+#           - Also handy if you have a large number of dependant pods
+#           - AS PER https://guides.cocoapods.org/using/using-cocoapods.html NEVER IGNORE THE LOCK FILE
+Pods/
+.build/
+/compose-ios-app/Podfile.lock
+
+## Xcode 8 and earlier
+
+### Xcode Patch ###
+*.xcodeproj/*
+!*.xcodeproj/project.pbxproj
+!*.xcodeproj/xcshareddata/
+!*.xcodeproj/project.xcworkspace/
+!*.xcworkspace/contents.xcworkspacedata
+/*.gcno
+**/xcshareddata/WorkspaceSettings.xcsettings
+
+xcuserdata
+!src/**/build/
+captures
+.externalNativeBuild
+.cxx

.run/Desktop app.run.xml

@@ -0,0 +1,24 @@
+<component name="ProjectRunConfigurationManager">
+  <configuration default="false" name="Desktop app" type="GradleRunConfiguration" factoryName="Gradle">
+    <ExternalSystemSettings>
+      <option name="executionName" />
+      <option name="externalProjectPath" value="$PROJECT_DIR$" />
+      <option name="externalSystemIdString" value="GRADLE" />
+      <option name="scriptParameters" value="" />
+      <option name="taskDescriptions">
+        <list />
+      </option>
+      <option name="taskNames">
+        <list>
+          <option value=":compose-desktop-app:run" />
+        </list>
+      </option>
+      <option name="vmOptions" />
+    </ExternalSystemSettings>
+    <ExternalSystemDebugServerProcess>true</ExternalSystemDebugServerProcess>
+    <ExternalSystemReattachDebugProcess>true</ExternalSystemReattachDebugProcess>
+    <DebugAllEnabled>false</DebugAllEnabled>
+    <ForceTestExec>false</ForceTestExec>
+    <method v="2" />
+  </configuration>
+</component>

.run/IOS app.run.xml

@@ -0,0 +1,7 @@
+<component name="ProjectRunConfigurationManager">
+  <configuration default="false" name="IOS app" type="KmmRunConfiguration" factoryName="iOS Application" CONFIG_VERSION="1" EXEC_TARGET_ID="90E2B698-5866-4ADA-8DB5-4B07AB652589" XCODE_PROJECT="$PROJECT_DIR$/compose-ios-app/compose-ios-app.xcworkspace" XCODE_CONFIGURATION="Debug" XCODE_SCHEME="compose-ios-app">
+    <method v="2">
+      <option name="com.jetbrains.kmm.ios.BuildIOSAppTask" enabled="true" />
+    </method>
+  </configuration>
+</component>

.run/Web app (Wasm + JS).run.xml

@@ -0,0 +1,24 @@
+<component name="ProjectRunConfigurationManager">
+  <configuration default="false" name="Web app (Wasm + JS)" type="GradleRunConfiguration" factoryName="Gradle">
+    <ExternalSystemSettings>
+      <option name="executionName" />
+      <option name="externalProjectPath" value="$PROJECT_DIR$" />
+      <option name="externalSystemIdString" value="GRADLE" />
+      <option name="scriptParameters" value="" />
+      <option name="taskDescriptions">
+        <list />
+      </option>
+      <option name="taskNames">
+        <list>
+          <option value="compose-web-js-wasm-app:jsBrowserDevelopmentRun" />
+        </list>
+      </option>
+      <option name="vmOptions" />
+    </ExternalSystemSettings>
+    <ExternalSystemDebugServerProcess>true</ExternalSystemDebugServerProcess>
+    <ExternalSystemReattachDebugProcess>true</ExternalSystemReattachDebugProcess>
+    <DebugAllEnabled>false</DebugAllEnabled>
+    <ForceTestExec>false</ForceTestExec>
+    <method v="2" />
+  </configuration>
+</component>

.run/Web app (Wasm).run.xml

@@ -0,0 +1,24 @@
+<component name="ProjectRunConfigurationManager">
+  <configuration default="false" name="Web app (Wasm)" type="GradleRunConfiguration" factoryName="Gradle">
+    <ExternalSystemSettings>
+      <option name="executionName" />
+      <option name="externalProjectPath" value="$PROJECT_DIR$/compose-web-wasm-app" />
+      <option name="externalSystemIdString" value="GRADLE" />
+      <option name="scriptParameters" value="" />
+      <option name="taskDescriptions">
+        <list />
+      </option>
+      <option name="taskNames">
+        <list>
+          <option value="wasmJsBrowserDevelopmentRun" />
+        </list>
+      </option>
+      <option name="vmOptions" />
+    </ExternalSystemSettings>
+    <ExternalSystemDebugServerProcess>true</ExternalSystemDebugServerProcess>
+    <ExternalSystemReattachDebugProcess>true</ExternalSystemReattachDebugProcess>
+    <DebugAllEnabled>false</DebugAllEnabled>
+    <RunAsTest>false</RunAsTest>
+    <method v="2" />
+  </configuration>
+</component>

LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Vitalii Stoianov
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,38 +1,62 @@
-# PoC of design implementation for processing large GPS node trace data effectively
+# Kotlin/Multiplatform + Compose/Multiplatform PoC of design implementation for processing large GPS node trace data effectively
+
 
 [![.github/workflows/main.yml](https://github.com/vitaliystoyanov/trace-node-tracking-playground/actions/workflows/main.yml/badge.svg?branch=gitworkflow)](https://github.com/vitaliystoyanov/trace-node-tracking-playground/actions/workflows/main.yml)
- ![API](https://img.shields.io/badge/API-23%2B-brightgreen.svg?style=flat)
+![API](https://img.shields.io/badge/API-23%2B-brightgreen.svg?style=flat)
+
+![badge][badge-android]
+![badge][badge-ios]
+![badge][badge-mac]
+![badge][badge-jvm]
+![badge][badge-js]
+![badge][badge-wasm]
+![badge][badge-windows]
+![badge][badge-linux]
+
+> [!WARNING]
+> This branch in development. The project setup guide will be later. This has XCode projects, CocoaPods tool, different AndroidStudio plugins and run configurations that should be guided with instructions.
+
+## Supported targets
+
+- `android`.
+- `jvm`.
+- `js` (`IR`).
+- `wasmJs`.
+- `iosArm64`, `iosX64`, `iosSimulatorArm64`.
+- `macosX64`, `macosArm64`.
+- `mingwX64`
+- `linuxX64`, `linuxArm64`.
 
-The application processes GPS node trace data using the Scarlet websocket client, deserializes it using Gson and writes the data to a local Room database for further data rendering based on Jetpack Compose and MapBox SDK built-in capabilities.
-On the other side, the Node.js backend generates sample data using the turf.js library. For each node, the route, direction and speed are generated at runtime.
+# Demo
 
-Some considerations:
-* The application processes 10 thousand websocket messages and then renders efficiently. The websocket message format is a string, but it is better to implement a binary message format. These nodes are dynamic moving, which is CPU and GPU-intensive to render and process highly frequently updated node movements. (However, there is a slight stuttering in UI rendering frames due to MapBox rendering on the native C++ side). All buffers have been disabled in the MapBox configuration.
-* At each layer of the architecture: db entity, external and network models have mappers for each other. Used object pool design pattern to avoid intensive allocation/deallocation of objects.
+[android_demo.webm](https://github.com/vitaliystoyanov/trace-node-tracking-playground/assets/9073014/07302946-b544-4078-b541-a0fe382d6969)
 
+[desktop_jvm_demo.webm](https://github.com/vitaliystoyanov/trace-node-tracking-playground/assets/9073014/f8e1b550-b688-4a76-94f6-f7aaed80972a)
 
-<p align="center">
-  <img alt="Light" src="/docs/demo3.gif" width="45%">
-&nbsp; &nbsp; &nbsp; &nbsp;
-  <img alt="Dark" src="/docs/demo1.gif" width="45%">
-</p>
+[ios_demo.webm](https://github.com/vitaliystoyanov/trace-node-tracking-playground/assets/9073014/76453330-0538-463e-9396-8a94163519b6)
+
+[web_wasm_demo.webm](https://github.com/vitaliystoyanov/trace-node-tracking-playground/assets/9073014/756f118f-5923-40dd-92fe-37ca7b03c941)
 
 ## Tech stack
 
 Nothing special :)
 
+* [Kotlin/Multiplatform](https://www.jetbrains.com/kotlin-multiplatform/)
+* [Compose Multiplatform](https://www.jetbrains.com/lp/compose-multiplatform/)
+* [Kotlin/Multiplatform Skiko for Skia: The 2D Graphics Library](https://github.com/JetBrains/skiko?tab=readme-ov-file)
+* [KotlinX/Coroutine](https://github.com/Kotlin/kotlinx.coroutines)
+* [KotlinX/Multiplatform date/time library](https://github.com/Kotlin/kotlinx-datetime)
+* [Koin: Kotlin & Kotlin Multiplatform DI framework](https://insert-koin.io/)
 * Kotlin Channels & Flows APIs
 * (experimental) Kotlin multiplatform / multi-format reflectionless serialization 
   * [Kotlin Serialization ProtoBuf](https://github.com/Kotlin/kotlinx.serialization/blob/master/docs/formats.md#protobuf-experimental)
-* Jetpack Compose with Material3 design
 * [Ktor.io Websocket Client](https://ktor.io/docs/websocket.html)
 * [MapBox SDK for Android](https://docs.mapbox.com/android/maps/guides/)
 * [Mapbox Maps Compose Extension](https://github.com/mapbox/mapbox-maps-android/tree/extension-compose-v0.1.0/extension-compose)
 * [Scarlet: A Retrofit inspired WebSocket client](https://github.com/Tinder/Scarlet)
   * [Scarlet coroutines stream adapter](https://github.com/Tinder/Scarlet/tree/main/scarlet-stream-adapter-coroutines)
 * [Room database](https://developer.android.com/training/data-storage/room)
 * [OkHttp](http://square.github.io/okhttp/)
-* [Koin: Kotlin & Kotlin Multiplatform DI framework](https://insert-koin.io/)
 
 ## Functionality
 * Supports websocket connections in background
@@ -170,3 +194,12 @@ If your dev environment is emulator:
 
 To be a part of ... you know :)
 
+[badge-android]: http://img.shields.io/badge/android-6EDB8D.svg?style=flat
+[badge-ios]: http://img.shields.io/badge/ios-CDCDCD.svg?style=flat
+[badge-js]: http://img.shields.io/badge/js-F8DB5D.svg?style=flat
+[badge-jvm]: http://img.shields.io/badge/jvm-DB413D.svg?style=flat
+[badge-linux]: http://img.shields.io/badge/linux-2D3F6C.svg?style=flat
+[badge-windows]: http://img.shields.io/badge/windows-4D76CD.svg?style=flat
+[badge-mac]: http://img.shields.io/badge/macos-111111.svg?style=flat
+[badge-wasm]: https://img.shields.io/badge/wasm-624FE8.svg?style=flat
+

build-logic/convention/build.gradle.kts

@@ -0,0 +1,47 @@
+import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
+
+plugins {
+    `kotlin-dsl`
+}
+
+group = "io.architecture.plugin.convention"
+
+// Configure the build-logic plugins to target JDK 17
+// This matches the JDK used to build the project, and is not related to what is running on device.
+java {
+    sourceCompatibility = JavaVersion.VERSION_17
+    targetCompatibility = JavaVersion.VERSION_17
+}
+tasks.withType<KotlinCompile>().configureEach {
+    kotlinOptions {
+        jvmTarget = JavaVersion.VERSION_17.toString()
+    }
+}
+
+dependencies {
+    compileOnly(libs.android.gradlePlugin)
+    compileOnly(libs.android.tools.common)
+    compileOnly(libs.kotlin.gradlePlugin)
+}
+
+tasks {
+    validatePlugins {
+        enableStricterValidation = true
+        failOnWarning = true
+    }
+}
+
+gradlePlugin {
+    plugins {
+        register("androidLibrary") {
+            id = "io.architecture.android.library"
+            implementationClass = "AndroidLibraryConventionPlugin"
+        }
+    }
+    plugins {
+        register("multiplatformDefaultTargetPreset") {
+            id = "io.architecture.multiplatform.target.preset.default"
+            implementationClass = "MultiplatformTargetPresetConventionPlugin"
+        }
+    }
+}

build-logic/convention/src/main/kotlin/AndroidLibraryConventionPlugin.kt

@@ -0,0 +1,26 @@
+import com.android.build.api.variant.LibraryAndroidComponentsExtension
+import com.android.build.gradle.LibraryExtension
+import io.architecture.build.logic.configureKotlinAndroid
+import org.gradle.api.Plugin
+import org.gradle.api.Project
+import org.gradle.kotlin.dsl.configure
+import org.gradle.kotlin.dsl.dependencies
+import org.gradle.kotlin.dsl.kotlin
+
+class AndroidLibraryConventionPlugin : Plugin<Project> {
+    override fun apply(target: Project) {
+        with(target) {
+            with(pluginManager) {
+                apply("com.android.library")
+            }
+            extensions.configure<LibraryExtension> {
+                configureKotlinAndroid(this)
+            }
+            extensions.configure<LibraryAndroidComponentsExtension> {
+            }
+            dependencies {
+                add("testImplementation", kotlin("test"))
+            }
+        }
+    }
+}

build-logic/convention/src/main/kotlin/MultiplatformTargetPresetConventionPlugin.kt

@@ -0,0 +1,26 @@
+import org.gradle.api.Plugin
+import org.gradle.api.Project
+import org.gradle.kotlin.dsl.configure
+import org.jetbrains.kotlin.gradle.dsl.KotlinMultiplatformExtension
+import org.jetbrains.kotlin.gradle.targets.js.dsl.ExperimentalWasmDsl
+
+class MultiplatformTargetPresetConventionPlugin : Plugin<Project> {
+    override fun apply(target: Project) {
+        with(target) {
+            with(pluginManager) {
+                apply("org.jetbrains.kotlin.multiplatform")
+            }
+            extensions.configure<KotlinMultiplatformExtension> {
+                applyDefaultHierarchyTemplate()
+                @OptIn(ExperimentalWasmDsl::class)
+                wasmJs { browser() }
+                js(IR) { browser() }
+                androidTarget()
+                iosX64()
+//                iosArm64()
+//                iosSimulatorArm64()
+                jvm()
+            }
+        }
+    }
+}