Merge pull request #84 from synonymdev/ovi/fix-android-native-symbols

fix: publish android debug symbols

Author: ovitrif

.github/workflows/publish-android.yml

@@ -6,18 +6,32 @@ on:
   workflow_dispatch:
     inputs:
       version:
-        description: "Version to publish (e.g., v0.1.0)"
+        description: "Version/tag to publish (e.g., v0.7.0-rc.50 or 0.7.0-rc.50)"
         required: true
 
 jobs:
   publish:
     runs-on: ubuntu-latest
     permissions:
-      contents: read
+      contents: write
       packages: write
 
     steps:
+    - name: Normalize release version
+      id: version
+      shell: bash
+      run: |
+        VERSION="${{ github.event.inputs.version || github.event.release.tag_name || github.ref_name }}"
+        TAG="$VERSION"
+        if [[ "$TAG" != v* ]]; then
+          TAG="v$TAG"
+        fi
+        echo "tag=$TAG" >> "$GITHUB_OUTPUT"
+        echo "version=${TAG#v}" >> "$GITHUB_OUTPUT"
+
     - uses: actions/checkout@v4
+      with:
+        ref: ${{ steps.version.outputs.tag }}
     - name: Set up JDK 17
       uses: actions/setup-java@v4
       with:
@@ -29,24 +43,44 @@ jobs:
     - name: Setup Gradle
       uses: gradle/actions/setup-gradle@v4
 
-    - name: Extract version from input or tag
-      id: version
-      shell: bash
-      run: |
-        VERSION="${{ inputs.version }}"
-        if [[ -z "$VERSION" ]]; then
-          VERSION="$GITHUB_REF_NAME"
-        fi
-        echo "version=${VERSION#v}" >> $GITHUB_OUTPUT
+    - name: Install native build dependencies
+      run: sudo apt-get update && sudo apt-get install -y pkg-config protobuf-compiler
+
+    - name: Set up Android SDK
+      uses: android-actions/setup-android@v3
+
+    - name: Set up Android NDK
+      id: setup-ndk
+      uses: nttld/setup-ndk@v1
+      with:
+        ndk-version: r28c
+        add-to-path: true
+
+    - name: Export Android NDK root
+      run: echo "ANDROID_NDK_ROOT=${{ steps.setup-ndk.outputs.ndk-path }}" >> "$GITHUB_ENV"
+
+    - name: Generate Android bindings
+      run: scripts/uniffi_bindgen_generate_kotlin_android.sh
 
     - name: Build with Gradle
       working-directory: bindings/kotlin/ldk-node-android
       run: ./gradlew build -Pversion=${{ steps.version.outputs.version }}
 
+    - name: Upload native debug symbols artifact
+      uses: actions/upload-artifact@v4
+      with:
+        name: ldk-node-native-debug-symbols-${{ steps.version.outputs.version }}
+        path: bindings/kotlin/ldk-node-android/native-debug-symbols.zip
+
+    - name: Upload native debug symbols to release
+      env:
+        GH_TOKEN: ${{ github.token }}
+      run: gh release upload "${{ steps.version.outputs.tag }}" bindings/kotlin/ldk-node-android/native-debug-symbols.zip --clobber
+
     - name: Publish to GitHub Packages
       working-directory: bindings/kotlin/ldk-node-android
       env:
         GITHUB_ACTOR: ${{ github.actor }}
-        GITHUB_TOKEN: ${{ secrets.ORG_PACKAGES_TOKEN }}
+        GITHUB_TOKEN: ${{ github.token }}
         GITHUB_REPO: ${{ github.repository }}
       run: ./gradlew publish -Pversion=${{ steps.version.outputs.version }}

.gitignore

@@ -2,6 +2,7 @@
 # will have compiled files and executables
 /target/
 /bindings/uniffi-bindgen/target/
+/bindings/kotlin/ldk-node-android/native-debug-symbols.zip
 
 # Remove Cargo.lock from gitignore if creating an executable, leave it for libraries
 # More information here https://doc.rust-lang.org/cargo/guide/cargo-toml-vs-cargo-lock.html

CHANGELOG.md

@@ -1,7 +1,9 @@
-# 0.7.0-rc.46 (Synonym Fork)
+# 0.7.0-rc.51 (Synonym Fork)
 
 ## Bug Fixes
 
+- Published stripped `ldk-node-android` artifacts with separate native debug symbols
+  and failed Android binding generation when generated JNI libraries lack usable symbols.
 - Persist missing announced channel peers from the network graph during
   build-time restore and after Rapid Gossip Sync graph updates. Automatic
   recovery respects explicit disconnects and last-channel closes during the

Cargo.toml

@@ -4,7 +4,7 @@ exclude = ["bindings/uniffi-bindgen"]
 
 [package]
 name = "ldk-node"
-version = "0.7.0-rc.46"
+version = "0.7.0-rc.51"
 authors = ["Elias Rohrer <dev@tnull.de>"]
 homepage = "https://lightningdevkit.org/"
 license = "MIT OR Apache-2.0"

Package.swift

@@ -3,8 +3,8 @@
 
 import PackageDescription
 
-let tag = "v0.7.0-rc.46"
-let checksum = "06558c2834c186d3da188389ef197942e948ac4f6f3261746e3594420ab0ee23"
+let tag = "v0.7.0-rc.51"
+let checksum = "efeec8d0480f1400c6a4203232359f5b3c4c338a4ba13826538cac12b8fe1bac"
 let url = "https://github.com/synonymdev/ldk-node/releases/download/\(tag)/LDKNodeFFI.xcframework.zip"
 
 let package = Package(

bindings/kotlin/ldk-node-android/gradle.properties

@@ -3,4 +3,4 @@ android.useAndroidX=true
 android.enableJetifier=true
 kotlin.code.style=official
 group=com.synonym
-version=0.7.0-rc.46
+version=0.7.0-rc.51

bindings/kotlin/ldk-node-android/lib/build.gradle.kts

@@ -1,3 +1,6 @@
+import java.io.ByteArrayOutputStream
+import java.io.File
+
 plugins {
     id("com.android.library")
     kotlin("android")
@@ -58,6 +61,107 @@ dependencies {
     api("org.slf4j:slf4j-api:1.7.30")
 }
 
+val androidNativeAbis = listOf("armeabi-v7a", "arm64-v8a", "x86_64")
+
+fun executableFromPath(name: String): String? {
+    return System.getenv("PATH")
+        ?.split(File.pathSeparator)
+        ?.asSequence()
+        ?.map { File(it, name) }
+        ?.firstOrNull { it.canExecute() }
+        ?.absolutePath
+}
+
+fun findReadelf(): String {
+    executableFromPath("llvm-readelf")?.let { return it }
+    executableFromPath("readelf")?.let { return it }
+
+    return listOf("ANDROID_NDK_ROOT", "ANDROID_NDK_HOME", "NDK_HOME")
+        .mapNotNull { System.getenv(it) }
+        .map { File(it, "toolchains/llvm/prebuilt") }
+        .firstNotNullOfOrNull { prebuiltDir ->
+            if (!prebuiltDir.isDirectory) return@firstNotNullOfOrNull null
+
+            prebuiltDir
+                .walkTopDown()
+                .firstOrNull { it.name == "llvm-readelf" && it.canExecute() }
+                ?.absolutePath
+        }
+        ?: throw GradleException(
+            "llvm-readelf or readelf is required to validate Android native debug symbols"
+        )
+}
+
+fun Project.runReadelf(readelf: String, vararg args: String): Pair<Int, String> {
+    val stdout = ByteArrayOutputStream()
+    val stderr = ByteArrayOutputStream()
+    val result = exec {
+        commandLine(readelf, *args)
+        standardOutput = stdout
+        errorOutput = stderr
+        isIgnoreExitValue = true
+    }
+
+    return result.exitValue to stdout.toString().ifBlank { stderr.toString() }
+}
+
+fun String.parseElfAlignment(): Long {
+    return if (startsWith("0x")) {
+        removePrefix("0x").toLong(16)
+    } else {
+        toLong()
+    }
+}
+
+val validateReleaseNativeLibraries by tasks.registering {
+    group = "verification"
+    description = "Validates release JNI libraries are stripped and keep 16 KB LOAD alignment."
+
+    doLast {
+        val readelf = findReadelf()
+        val loadAlignmentRegex = Regex("""^\s*LOAD\s+.*\s+(0x[0-9a-fA-F]+|\d+)\s*$""")
+
+        androidNativeAbis.forEach { abi ->
+            val lib = layout.projectDirectory.file("src/main/jniLibs/$abi/libldk_node.so").asFile
+            if (!lib.isFile) {
+                throw GradleException("Android native library missing at '${lib.path}'")
+            }
+
+            val (sectionsExit, sections) = runReadelf(readelf, "-S", lib.absolutePath)
+            if (sectionsExit != 0) {
+                throw GradleException("Unable to inspect Android native library sections: '${lib.path}'")
+            }
+            if (Regex("""\.debug_""").containsMatchIn(sections)) {
+                throw GradleException("Android release native library still contains .debug_* sections: '${lib.path}'")
+            }
+
+            val wideHeaders = runReadelf(readelf, "-W", "-l", lib.absolutePath)
+            val headers = if (wideHeaders.first == 0) {
+                wideHeaders.second
+            } else {
+                val fallbackHeaders = runReadelf(readelf, "-l", lib.absolutePath)
+                if (fallbackHeaders.first != 0) {
+                    throw GradleException("Unable to inspect Android native library headers: '${lib.path}'")
+                }
+                fallbackHeaders.second
+            }
+
+            val alignments = headers
+                .lineSequence()
+                .mapNotNull { loadAlignmentRegex.matchEntire(it)?.groupValues?.get(1)?.parseElfAlignment() }
+                .toList()
+
+            if (alignments.isEmpty() || alignments.any { it < 16_384 }) {
+                throw GradleException("Android native library is not 16 KB page-size aligned: '${lib.path}'")
+            }
+        }
+    }
+}
+
+tasks.matching { it.name == "bundleReleaseAar" || it.name.startsWith("publish") }.configureEach {
+    dependsOn(validateReleaseNativeLibraries)
+}
+
 afterEvaluate {
     publishing {
         publications {
@@ -68,6 +172,10 @@ afterEvaluate {
                 version = providers.gradleProperty("version").orNull ?: "0.0.0"
 
                 from(components["release"])
+                artifact(rootProject.layout.projectDirectory.file("native-debug-symbols.zip")) {
+                    classifier = "native-debug-symbols"
+                    extension = "zip"
+                }
                 pom {
                     name.set(mavenArtifactId)
                     description.set("LDK Node Android bindings (Synonym fork).")