NC Android - setup APK publish (#2967)

* ci(nc-android): init workflow apk build & release

* ci(nc-android): setup nc android project for APK publish

* docs(nc-android): update readme

* ci(nc-android): add note in the workflow

.github/workflows/nc-android-apk.yml

@@ -0,0 +1,127 @@
+name: NC Android APK Release
+
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - "release/nc-android-v[0-9].[0-9].[0-9]*"
+
+jobs:
+  build:
+    name: Build APK
+    runs-on: ubuntu-latest
+    env:
+      ANDROID_HOME: ${{ github.workspace }}/android-sdk
+      NDK_VERSION: 25.1.8937393
+      NDK_HOME: ${{ env.ANDROID_HOME }}/ndk/${{ env.NDK_VERSION }}
+      SDK_PLATFORM_VERSION: android-33
+      SDK_BUILDTOOLS_VERSION: 33.0.1
+
+    steps:
+      - name: Install Dependencies (Linux)
+        # https://next--tauri.netlify.app/next/guides/getting-started/prerequisites/linux/#1-system-dependencies
+        run: |
+          sudo apt-get update
+          sudo apt-get -y install \
+          libwebkit2gtk-4.0-dev \
+          build-essential \
+          curl \
+          wget \
+          libssl-dev \
+          libgtk-3-dev \
+          squashfs-tools \
+          libayatana-appindicator3-dev \
+          librsvg2-dev
+
+      - name: Install Java
+        uses: actions/setup-java@v3
+        with:
+          distribution: "temurin"
+          java-version: "17"
+
+      - name: Install Android SDK manager
+        # https://developer.android.com/studio/command-line/sdkmanager
+        run: |
+          curl -sS https://dl.google.com/android/repository/commandlinetools-linux-9477386_latest.zip -o cmdline-tools.zip
+          unzip cmdline-tools.zip
+          mkdir -p $ANDROID_HOME/cmdline-tools/latest
+          mv cmdline-tools/* $ANDROID_HOME/cmdline-tools/latest
+          rm -rf cmdline-tools
+
+      - name: Install Android S/NDK
+        run: |
+          echo y | $ANDROID_HOME/cmdline-tools/latest/bin/sdkmanager --licenses
+          echo y | $ANDROID_HOME/cmdline-tools/latest/bin/sdkmanager \
+            "platforms;$SDK_PLATFORM_VERSION" \
+            "platform-tools" \
+            "ndk;$NDK_VERSION" \
+            "build-tools;$SDK_BUILDTOOLS_VERSION"
+
+      - name: Install Rust toolchain
+        uses: dtolnay/rust-toolchain@stable
+
+      - name: Install tauri cli
+        run: cargo install tauri-cli --version "^2.0.0-alpha.2"
+
+      - name: Install rust android targets
+        run: |
+          rustup target add aarch64-linux-android \
+            armv7-linux-androideabi \
+            i686-linux-android \
+            x86_64-linux-android
+
+      - name: Setup Nodejs
+        uses: actions/setup-node@v3
+        with:
+          node-version: 18
+
+      - name: Install yarn
+        run: |
+          npm i -g yarn
+          yarn --version
+
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Build frontend code
+        run: |
+          yarn install --frozen-lockfile
+          yarn build
+          yarn workspace @nym/nym-connect-android webpack:prod
+
+      - name: Build APK
+        working-directory: nym-connect-android
+        env:
+          WRY_ANDROID_PACKAGE: net.nymtech.nym_connect_android
+          WRY_ANDROID_LIBRARY: nym_connect_android
+        # TODO build with release profile (--release), it will requires
+        # to sign the APK. For now build with debug profile to avoid that
+        run: cargo tauri android build --debug --apk
+
+      # TODO add the version number to APK name
+      - name: Rename APK artifact
+        run: |
+          mv nym-connect-android/src-tauri/gen/android/nym_connect_android/app/build/outputs/apk/universal/debug/app-universal-debug.apk \
+            nym-connect-debug.apk
+
+      - name: Upload APK artifact
+        uses: actions/upload-artifact@v3
+        with:
+          name: nc-apk-debug
+          path: nym-connect-debug.apk
+
+  publish:
+    name: Publish APK
+    needs: build
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Download binary artifact
+        uses: actions/download-artifact@v3
+        with:
+          name: nc-apk-debug
+          path: apk
+      # TODO add a step to upload the APK somewhere
+      # - name: Publish
+      #   uses: ???

nym-connect-android/README.md

@@ -21,10 +21,11 @@ https://next--tauri.netlify.app/next/guides/getting-started/prerequisites/linux#
 
 ## Installation
 
-Inside the `nym-connect-android` directory, run the following command:
+Inside the `nym-connect-android` directory, run the following commands:
 
 ```
 yarn install
+yarn prewebpack:dev
 ```
 
 ## Development
@@ -34,7 +35,7 @@ or a real [device](https://developer.android.com/studio/run/device) connected.
 Inside the `nym-connect-android/src-tauri` directory, run the following command:
 
 ```
-WRY_ANDROID_PACKAGE=net.nymtech.nym_connect_android WRY_ANDROID_LIBRARY=nym_connect_android cargo tauri android dev
+yarn dev
 ```
 
 #### Debugging
@@ -43,10 +44,11 @@ https://next--tauri.netlify.app/next/guides/debugging/application#mobile
 
 ## Production
 
-To build the application bundles (APK and AAB files), run the build command.
+To build the APK, run the build commands.
 
 ```
-WRY_ANDROID_PACKAGE=net.nymtech.nym_connect_android WRY_ANDROID_LIBRARY=nym_connect_android cargo tauri android build
+yarn webpack:prod
+WRY_ANDROID_PACKAGE=net.nymtech.nym_connect_android WRY_ANDROID_LIBRARY=nym_connect_android cargo tauri android build --debug --apk
 ```
 
 # Storybook

nym-connect-android/package.json

@@ -8,9 +8,9 @@
     "webpack:dev": "yarn webpack serve --config webpack.dev.js",
     "webpack:dev:onlyThis": "yarn webpack serve --config webpack.dev.js",
     "webpack:prod": "yarn webpack --progress --config webpack.prod.js",
-    "tauri:dev": "RUST_DEBUG=1 yarn tauri dev",
-    "tauri:build": "yarn tauri build",
-    "dev": "run-p webpack:dev tauri:dev",
+    "tauri:dev": "WRY_ANDROID_PACKAGE=net.nymtech.nym_connect_android WRY_ANDROID_LIBRARY=nym_connect_android cargo tauri android dev",
+    "tauri:build": "WRY_ANDROID_PACKAGE=net.nymtech.nym_connect_android WRY_ANDROID_LIBRARY=nym_connect_android cargo tauri android build",
+    "dev": "run-p webpack:dev:onlyThis tauri:dev",
     "prebuild": "yarn --cwd .. build",
     "build": "run-s webpack:prod tauri:build",
     "storybook": "start-storybook -p 6006",

nym-connect-android/src-tauri/Cargo.toml

@@ -19,9 +19,6 @@ crate-type = ["staticlib", "cdylib", "rlib"]
 # tauri-build = { version = "2.0.0-alpha.0", features = [] }
 tauri-build = {  git = "https://github.com/tauri-apps/tauri", branch = "next", features = [] }
 
-# tauri-codegen = "2.0.0-alpha.0"
-# tauri-macros = "2.0.0-alpha.0"
-
 [dependencies]
 anyhow = "1.0"
 bip39 = "1.0"
@@ -41,8 +38,7 @@ serde = { version = "1.0", features = ["derive"] }
 serde_json = "1.0"
 serde_repr = "0.1"
 tap = "1.0.1"
-# TODO swithing to `rfd101` temporarily, untill https://github.com/tauri-apps/tauri/pull/6174 is merged
-tauri = { git = "https://github.com/tauri-apps/tauri", branch = "rfd101", features = ["clipboard-write-text", "native-tls-vendored", "notification-all", "shell-open", "system-tray", "window-close", "window-minimize", "window-start-dragging"] }
+tauri = { git = "https://github.com/tauri-apps/tauri", branch = "next", features = ["clipboard-write-text", "native-tls-vendored", "notification-all", "shell-open", "system-tray", "window-close", "window-minimize", "window-start-dragging"] }
 tendermint-rpc = "0.23.0"
 thiserror = "1.0"
 tokio = { version = "1.24.1", features = ["sync", "time"] }
@@ -70,3 +66,7 @@ custom-protocol = ["tauri/custom-protocol"]
 # opt-level = "s"
 # lto = true
 
+[profile.release]
+strip = true
+opt-level = "s"
+lto = true

nym-connect-android/src-tauri/gen/android/nym-connect-android/app/.gitignore

@@ -1 +0,0 @@
-/src/main/java/net/nymtech/nym-connect-android/generated

nym-connect-android/src-tauri/gen/android/nym-connect-android/app/build.gradle.kts

@@ -1,112 +0,0 @@
-plugins {
-  id("com.android.application")
-  id("org.jetbrains.kotlin.android")
-  id("rustPlugin")
-}
-
-android {
-  compileSdk = 33
-  defaultConfig {
-    manifestPlaceholders["usesCleartextTraffic"] = "false"
-    applicationId = "net.nymtech.nym_connect_android"
-    minSdk = 24
-    targetSdk = 33
-    versionCode = 1
-    versionName = "1.0"
-  }
-  sourceSets.getByName("main") {
-    // Vulkan validation layers
-    val ndkHome = System.getenv("NDK_HOME")
-    jniLibs.srcDir("${ndkHome}/sources/third_party/vulkan/src/build-android/jniLibs")
-  }
-  buildTypes {
-    getByName("debug") {
-      manifestPlaceholders["usesCleartextTraffic"] = "true"
-      isDebuggable = true
-      isJniDebuggable = true
-      isMinifyEnabled = false
-      packagingOptions {
-        jniLibs.keepDebugSymbols.add("*/arm64-v8a/*.so")
-
-        jniLibs.keepDebugSymbols.add("*/armeabi-v7a/*.so")
-
-        jniLibs.keepDebugSymbols.add("*/x86/*.so")
-
-        jniLibs.keepDebugSymbols.add("*/x86_64/*.so")
-      }
-    }
-    getByName("release") {
-      isMinifyEnabled = false
-    //  proguardFiles(getDefaultProguardFile("proguard-android.txt"), "proguard-rules.pro")
-    }
-  }
-  flavorDimensions.add("abi")
-  productFlavors {
-    create("universal") {
-      val abiList = findProperty("abiList") as? String
-
-      dimension = "abi"
-      ndk {
-        abiFilters += abiList?.split(",")?.map { it.trim() } ?: listOf(
-          "arm64-v8a", "armeabi-v7a", "x86", "x86_64",
-        )
-      }
-    }
-    create("arm64") {
-      dimension = "abi"
-      ndk {
-        abiFilters += listOf("arm64-v8a")
-      }
-    }
-
-    create("arm") {
-      dimension = "abi"
-      ndk {
-        abiFilters += listOf("armeabi-v7a")
-      }
-    }
-
-    create("x86") {
-      dimension = "abi"
-      ndk {
-        abiFilters += listOf("x86")
-      }
-    }
-
-    create("x86_64") {
-      dimension = "abi"
-      ndk {
-        abiFilters += listOf("x86_64")
-      }
-    }
-  }
-
-  assetPacks += mutableSetOf()
-  namespace = "net.nymtech.nym_connect_android"
-}
-
-rust {
-  rootDirRel = "../../../../"
-  targets = listOf("aarch64", "armv7", "i686", "x86_64")
-  arches = listOf("arm64", "arm", "x86", "x86_64")
-}
-
-dependencies {
-  implementation("androidx.webkit:webkit:1.5.0")
-  implementation("androidx.appcompat:appcompat:1.5.1")
-  implementation("com.google.android.material:material:1.7.0")
-  testImplementation("junit:junit:4.13.2")
-  androidTestImplementation("androidx.test.ext:junit:1.1.4")
-  androidTestImplementation("androidx.test.espresso:espresso-core:3.5.0")
-}
-
-afterEvaluate {
-  android.applicationVariants.all {
-    tasks["mergeUniversalReleaseJniLibFolders"].dependsOn(tasks["rustBuildRelease"])
-    tasks["mergeUniversalDebugJniLibFolders"].dependsOn(tasks["rustBuildDebug"])
-    productFlavors.filter { it.name != "universal" }.forEach { _ ->
-      val archAndBuildType = name.capitalize()
-      tasks["merge${archAndBuildType}JniLibFolders"].dependsOn(tasks["rustBuild${archAndBuildType}"])
-    }
-  }
-}

nym-connect-android/src-tauri/gen/android/nym_connect_android/.gitignore

@@ -9,8 +9,6 @@
 /.idea/assetWizardSettings.xml
 .DS_Store
 build
-/buildSrc/src/main/java/net/nymtech/nym-connect-android/kotlin/BuildTask.kt
-/buildSrc/src/main/java/net/nymtech/nym-connect-android/kotlin/RustPlugin.kt
 /captures
 .externalNativeBuild
 .cxx

nym-connect-android/src-tauri/gen/android/nym_connect_android/app/.gitignore

@@ -0,0 +1 @@
+/src/main/java/net/nymtech/nym_connect_android/generated

nym-connect-android/src-tauri/gen/android/nym_connect_android/app/build.gradle.kts

@@ -0,0 +1,111 @@
+plugins {
+    id("com.android.application")
+    id("org.jetbrains.kotlin.android")
+    id("rustPlugin")
+}
+
+android {
+    compileSdk = 33
+    defaultConfig {
+        manifestPlaceholders["usesCleartextTraffic"] = "false"
+        applicationId = "net.nymtech.nym_connect_android"
+        minSdk = 24
+        targetSdk = 33
+        versionCode = 1
+        versionName = "1.0"
+    }
+    sourceSets.getByName("main") {
+        // Vulkan validation layers
+        val ndkHome = System.getenv("NDK_HOME")
+        jniLibs.srcDir("${ndkHome}/sources/third_party/vulkan/src/build-android/jniLibs")
+    }
+    buildTypes {
+        getByName("debug") {
+            manifestPlaceholders["usesCleartextTraffic"] = "true"
+            isDebuggable = true
+            isJniDebuggable = true
+            isMinifyEnabled = false
+            packagingOptions {
+                jniLibs.keepDebugSymbols.add("*/arm64-v8a/*.so")
+
+                jniLibs.keepDebugSymbols.add("*/armeabi-v7a/*.so")
+
+                jniLibs.keepDebugSymbols.add("*/x86/*.so")
+
+                jniLibs.keepDebugSymbols.add("*/x86_64/*.so")
+            }
+        }
+        getByName("release") {
+            isMinifyEnabled = false
+            proguardFiles(getDefaultProguardFile("proguard-android.txt"), "proguard-rules.pro")
+        }
+    }
+    flavorDimensions.add("abi")
+    productFlavors {
+        create("universal") {
+            val abiList = findProperty("abiList") as? String
+
+            dimension = "abi"
+            ndk {
+                abiFilters += abiList?.split(",")?.map { it.trim() } ?: listOf(                    "arm64-v8a",                    "armeabi-v7a",                    "x86",                    "x86_64",
+                )
+            }
+        }
+        create("arm64") {
+            dimension = "abi"
+            ndk {
+                abiFilters += listOf("arm64-v8a")
+            }
+        }
+
+        create("arm") {
+            dimension = "abi"
+            ndk {
+                abiFilters += listOf("armeabi-v7a")
+            }
+        }
+
+        create("x86") {
+            dimension = "abi"
+            ndk {
+                abiFilters += listOf("x86")
+            }
+        }
+
+        create("x86_64") {
+            dimension = "abi"
+            ndk {
+                abiFilters += listOf("x86_64")
+            }
+        }
+    }
+
+    assetPacks += mutableSetOf()
+    namespace = "net.nymtech.nym_connect_android"
+}
+
+rust {
+    rootDirRel = "../../../../"
+    targets = listOf("aarch64", "armv7", "i686", "x86_64")
+    arches = listOf("arm64", "arm", "x86", "x86_64")
+}
+
+dependencies {
+    implementation("androidx.webkit:webkit:1.5.0")
+    implementation("androidx.appcompat:appcompat:1.5.1")
+    implementation("com.google.android.material:material:1.7.0")
+    testImplementation("junit:junit:4.13.2")
+    androidTestImplementation("androidx.test.ext:junit:1.1.4")
+    androidTestImplementation("androidx.test.espresso:espresso-core:3.5.0")
+}
+
+afterEvaluate {
+    android.applicationVariants.all {
+        tasks["mergeUniversalReleaseJniLibFolders"].dependsOn(tasks["rustBuildRelease"])
+        tasks["mergeUniversalDebugJniLibFolders"].dependsOn(tasks["rustBuildDebug"])
+        productFlavors.filter{ it.name != "universal" }.forEach { _ ->
+            val archAndBuildType = name.capitalize()
+            tasks["merge${archAndBuildType}JniLibFolders"].dependsOn(tasks["rustBuild${archAndBuildType}"])
+        }
+    }
+}

nym-connect-android/src-tauri/gen/android/nym_connect_android/app/src/main/res/values/themes.xml

@@ -13,4 +13,4 @@
         <item name="android:statusBarColor" tools:targetApi="l">?attr/colorPrimaryVariant</item>
         <!-- Customize your theme here. -->
     </style>
-</resources>
+</resources>

nym-connect-android/src-tauri/gen/android/nym_connect_android/buildSrc/src/main/java/net/nymtech/nym_connect_android/kotlin/BuildTask.kt

@@ -0,0 +1,45 @@
+package net.nymtech
+
+import java.io.File
+import org.gradle.api.DefaultTask
+import org.gradle.api.GradleException
+import org.gradle.api.logging.LogLevel
+import org.gradle.api.tasks.Input
+import org.gradle.api.tasks.InputDirectory
+import org.gradle.api.tasks.PathSensitive
+import org.gradle.api.tasks.PathSensitivity
+import org.gradle.api.tasks.TaskAction
+
+open class BuildTask : DefaultTask() {
+    @InputDirectory
+    @PathSensitive(PathSensitivity.RELATIVE)
+    var rootDirRel: File? = null
+    @Input
+    var target: String? = null
+    @Input
+    var release: Boolean? = null
+
+    @TaskAction
+    fun build() {
+        val rootDirRel = rootDirRel ?: throw GradleException("rootDirRel cannot be null")
+        val target = target ?: throw GradleException("target cannot be null")
+        val release = release ?: throw GradleException("release cannot be null")
+        val home = (System.getenv("HOME") ?: "")
+        val cargo_home = (System.getenv("CARGO_HOME") ?: "$home/.cargo")
+        println("gradle Rust plugin: CARGO_HOME $cargo_home")
+        project.exec {
+            workingDir(File(project.projectDir, rootDirRel.path))
+            executable("""$cargo_home/bin/cargo-tauri""")
+            args(listOf("tauri", "android", "android-studio-script"))
+            if (project.logger.isEnabled(LogLevel.DEBUG)) {
+                args("-vv")
+            } else if (project.logger.isEnabled(LogLevel.INFO)) {
+                args("-v")
+            }
+            if (release) {
+                args("--release")
+            }
+            args(listOf("--target", target))
+        }.assertNormalExitValue()
+    }
+}

nym-connect-android/src-tauri/gen/android/nym_connect_android/buildSrc/src/main/java/net/nymtech/nym_connect_android/kotlin/RustPlugin.kt

@@ -0,0 +1,59 @@
+package net.nymtech
+
+import org.gradle.api.DefaultTask
+import org.gradle.api.GradleException
+import org.gradle.api.Plugin
+import org.gradle.api.Project
+import java.io.File
+import java.util.*
+
+const val TASK_GROUP = "rust"
+
+open class Config {
+    var rootDirRel: String? = null
+    var targets: List<String>? = null
+    var arches: List<String>? = null
+}
+
+open class RustPlugin : Plugin<Project> {
+    private lateinit var config: Config
+
+    override fun apply(project: Project) {
+        config = project.extensions.create("rust", Config::class.java)
+        project.afterEvaluate {
+            if (config.targets == null) {
+                throw GradleException("targets cannot be null")
+            }
+            if (config.arches == null) {
+                throw GradleException("arches cannot be null")
+            }
+            for (profile in listOf("debug", "release")) {
+                val profileCapitalized = profile.capitalize(Locale.ROOT)
+                val buildTask = project.tasks.maybeCreate(
+                    "rustBuild$profileCapitalized",
+                    DefaultTask::class.java
+                ).apply {
+                    group = TASK_GROUP
+                    description = "Build dynamic library in $profile mode for all targets"
+                }
+                for (targetPair in config.targets!!.withIndex()) {
+                    val targetName = targetPair.value
+                    val targetArch = config.arches!![targetPair.index]
+                    val targetArchCapitalized = targetArch.capitalize(Locale.ROOT)
+                    val targetBuildTask = project.tasks.maybeCreate(
+                        "rustBuild$targetArchCapitalized$profileCapitalized",
+                        BuildTask::class.java
+                    ).apply {
+                        group = TASK_GROUP
+                        description = "Build dynamic library in $profile mode for $targetArch"
+                        rootDirRel = config.rootDirRel?.let { File(it) }
+                        target = targetName
+                        release = profile == "release"
+                    }
+                    buildTask.dependsOn(targetBuildTask)
+                    project.tasks.findByName("preBuild")?.mustRunAfter(targetBuildTask)
+                }
+            }
+        }
+    }
+}

nym-connect-android/src-tauri/tauri.conf.json

@@ -6,8 +6,8 @@
   "build": {
     "distDir": "../dist",
     "devPath": "http://localhost:9000",
-    "beforeDevCommand": "yarn webpack:dev:onlyThis",
-    "beforeBuildCommand": "yarn webpack:prod"
+    "beforeDevCommand": "",
+    "beforeBuildCommand": ""
   },
   "tauri": {
     "bundle": {