change: build pipeline to fastlane deploy

Add build and release pipeline for app

Fixes bug where location permission screen was not appearing on < Android 9

Bump versions

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,31 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: "[BUG] - Problem with app"
+labels: bug
+assignees: zaneschepke
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**Smartphone (please complete the following information):**
+ - Device: [e.g. iPhone6]
+ - Android Version: [e.g. iOS8.1]
+ - App Version [e.g. 22]
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots (Only if necessary)**
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: "[FEATURE] - New feature request"
+labels: enhancement
+assignees: zaneschepke
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/workflows/android.yml

@@ -0,0 +1,90 @@
+# name of the workflow
+name: Android CI Tag Deployment
+
+on:
+  push:
+    tags:
+      - '*.*.*'
+
+jobs:
+  build:
+    name: Build Signed APK
+    # change to macos because of hilt issues on ubuntu in gradle 8.3
+    runs-on: ubuntu-latest
+
+    env:
+      KEY_STORE_PATH: ${{ secrets.KEY_STORE_PATH }}
+      SIGNING_KEY_ALIAS: ${{ secrets.SIGNING_KEY_ALIAS }}
+      SIGNING_KEY_PASSWORD: ${{ secrets.SIGNING_KEY_PASSWORD }}
+      SIGNING_STORE_PASSWORD: ${{ secrets.SIGNING_STORE_PASSWORD }}
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up JDK 17
+        uses: actions/setup-java@v3
+        with:
+          distribution: 'temurin'
+          java-version: '17'
+          cache: gradle
+      - name: Grant execute permission for gradlew
+        run: chmod +x gradlew
+
+      # Here we need to decode keystore.jks from base64 string and place it
+      # in the folder specified in the release signing configuration
+      - name: Decode Keystore
+        id: decode_keystore
+        uses: timheuer/base64-to-file@v1.2
+        with:
+          fileName: 'android_keystore.jks'
+          fileDir: ${{ github.workspace }}/app/keystore/
+          encodedString: ${{ secrets.KEYSTORE }}
+
+      - name: Create service_account.json
+        id: createServiceAccount
+        run: echo '${{ secrets.SERVICE_ACCOUNT_JSON }}' > service_account.json
+
+      # Build and sign APK ("-x test" argument is used to skip tests)
+      # add fdroid flavor for apk upload
+      - name: Build Fdroid Release APK
+        run: ./gradlew :app:assembleFdroidRelease -x test
+
+      # get fdroid flavor release apk path
+      - name: Get apk path
+        id: apk-path
+        run: echo "path=$(find . -regex '^.*/build/outputs/apk/fdroid/release/.*\.apk$' -type f | head -1)" >> $GITHUB_OUTPUT
+
+      # Save the APK after the Build job is complete to publish it as a Github release in the next job
+      - name: Upload APK
+        uses: actions/upload-artifact@v3.1.2
+        with:
+          name: wgtunnel
+          path: ${{ steps.apk-path.outputs.path }}
+      - name: Download APK from build
+        uses: actions/download-artifact@v1
+        with:
+          name: wgtunnel
+      - name: Create Release with Fastlane changelog notes
+        id: create_release
+        uses: softprops/action-gh-release@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          # fix hardcode changelog file name
+          body_path: ${{ github.workspace }}/fastlane/metadata/android/en-US/changelogs/32100.txt
+          tag_name: ${{ github.ref_name }}
+          name: Release ${{ github.ref_name }}
+          draft: false
+          prerelease: false
+          files: ${{ github.workspace }}/${{ steps.apk-path.outputs.path }}
+  deploy:
+    name: Deploy with fastlane
+    needs: build
+    runs-on: ubuntu-latest
+    steps:
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.2' # Not needed with a .ruby-version file
+          bundler-cache: true
+
+      - name: Distribute app to Beta track 🚀
+        run: (cd ${{ github.workspace }} && bundle install && bundle exec fastlane beta)

.gitignore

@@ -69,3 +69,5 @@ lint/tmp/
 # App Specific cases
 app/release/output.json
 .idea/codeStyles/
+# where we keep our signing secrets locally
+app/signing.properties

Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gem "fastlane"

app/build.gradle.kts

@@ -1,3 +1,5 @@
+import java.util.Properties
+
 plugins {
     alias(libs.plugins.android.application)
     alias(libs.plugins.kotlin.android)
@@ -7,15 +9,15 @@ plugins {
 }
 
 android {
-    namespace = "com.zaneschepke.wireguardautotunnel"
-    compileSdk = 34
+    namespace = Constants.APP_ID
+    compileSdk = Constants.TARGET_SDK
 
     defaultConfig {
-        applicationId = "com.zaneschepke.wireguardautotunnel"
-        minSdk = 26
-        targetSdk = 34
-        versionCode = 31900
-        versionName = "3.1.9"
+        applicationId = Constants.APP_ID
+        minSdk = Constants.MIN_SDK
+        targetSdk = Constants.TARGET_SDK
+        versionCode = Constants.VERSION_CODE
+        versionName = Constants.VERSION_NAME
 
         ksp {
             arg("room.schemaLocation", "$projectDir/schemas")
@@ -29,7 +31,38 @@ android {
         }
     }
 
+    signingConfigs {
+        create("release") {
+            val properties = Properties().apply {
+                //created local file for signing details
+                try {
+                    load(file("signing.properties").reader())
+                } catch (_ : Exception) {
+                    load(file("signing_template.properties").reader())
+                }
+            }
+
+            //try to get secrets from env first for pipeline build, then properties file for local build
+            storeFile = file(System.getenv().getOrDefault(Constants.KEY_STORE_PATH_VAR, properties.getProperty(Constants.KEY_STORE_PATH_VAR)))
+            storePassword = System.getenv().getOrDefault(Constants.STORE_PASS_VAR, properties.getProperty(Constants.STORE_PASS_VAR))
+            keyAlias = System.getenv().getOrDefault(Constants.KEY_ALIAS_VAR, properties.getProperty(Constants.KEY_ALIAS_VAR))
+            keyPassword = System.getenv().getOrDefault(Constants.KEY_PASS_VAR, properties.getProperty(Constants.KEY_PASS_VAR))
+        }
+    }
+
     buildTypes {
+        //don't strip
+        packaging.jniLibs.keepDebugSymbols.addAll(listOf("libwg-go.so", "libwg-quick.so", "libwg.so"))
+
+        applicationVariants.all {
+            val variant = this
+            variant.outputs
+                .map { it as com.android.build.gradle.internal.api.BaseVariantOutputImpl }
+                .forEach { output ->
+                    val outputFileName = "wgtunnel-${variant.flavorName}-${variant.buildType.name}-${variant.versionName}.apk"
+                    output.outputFileName = outputFileName
+                }
+        }
         release {
             isDebuggable = false
             isMinifyEnabled = true
@@ -38,6 +71,7 @@ android {
                 getDefaultProguardFile("proguard-android-optimize.txt"),
                 "proguard-rules.pro"
             )
+            signingConfig = signingConfigs.getByName("release")
         }
         debug {
             isDebuggable = true
@@ -61,6 +95,7 @@ android {
     compileOptions {
         sourceCompatibility = JavaVersion.VERSION_17
         targetCompatibility = JavaVersion.VERSION_17
+        isCoreLibraryDesugaringEnabled = true
     }
     kotlinOptions {
         jvmTarget = "17"
@@ -80,6 +115,14 @@ android {
     }
 }
 
+tasks.register("printVersionCode") {
+    doLast {
+        //print version code for CI
+        println(Constants.VERSION_CODE)
+    }
+}
+
+
 val generalImplementation by configurations
 dependencies {
     implementation(libs.androidx.core.ktx)
@@ -105,6 +148,7 @@ dependencies {
 
     //wg
     implementation(libs.tunnel)
+    coreLibraryDesugaring(libs.desugar.jdk.libs)
 
     //logging
     implementation(libs.timber)
@@ -121,7 +165,6 @@ dependencies {
     implementation(libs.accompanist.systemuicontroller)
     implementation(libs.accompanist.permissions)
     implementation(libs.accompanist.flowlayout)
-    implementation(libs.accompanist.navigation.animation)
     implementation(libs.accompanist.drawablepainter)
 
     //room

app/signing_template.properties

@@ -0,0 +1,4 @@
+SIGNING_STORE_PASSWORD=
+SIGNING_KEY_ALIAS=
+SIGNING_KEY_PASSWORD=
+KEY_STORE_PATH=/

app/src/main/java/com/zaneschepke/wireguardautotunnel/repository/DatabaseListConverters.kt

@@ -12,6 +12,12 @@ class DatabaseListConverters {
     @TypeConverter
     fun stringToList(value: String): MutableList<String> {
         if(value.isEmpty()) return mutableListOf()
-        return Json.decodeFromString<MutableList<String>>(value)
+        return try {
+            Json.decodeFromString<MutableList<String>>(value)
+        } catch (e : Exception) {
+            val list = value.split(",").toMutableList()
+            val json = listToString(list)
+            Json.decodeFromString<MutableList<String>>(json)
+        }
     }
 }

app/src/main/java/com/zaneschepke/wireguardautotunnel/ui/MainActivity.kt

@@ -34,9 +34,9 @@ import androidx.compose.ui.focus.FocusRequester
 import androidx.compose.ui.input.key.onKeyEvent
 import androidx.compose.ui.unit.dp
 import androidx.lifecycle.lifecycleScope
-import com.google.accompanist.navigation.animation.AnimatedNavHost
-import com.google.accompanist.navigation.animation.composable
-import com.google.accompanist.navigation.animation.rememberAnimatedNavController
+import androidx.navigation.compose.NavHost
+import androidx.navigation.compose.composable
+import androidx.navigation.compose.rememberNavController
 import com.google.accompanist.permissions.ExperimentalPermissionsApi
 import com.google.accompanist.permissions.isGranted
 import com.google.accompanist.permissions.rememberPermissionState
@@ -67,7 +67,7 @@ class MainActivity : AppCompatActivity() {
     override fun onCreate(savedInstanceState: Bundle?) {
         super.onCreate(savedInstanceState)
         setContent {
-            val navController = rememberAnimatedNavController()
+            val navController = rememberNavController()
             val focusRequester = remember { FocusRequester() }
 
             WireguardAutoTunnelTheme {
@@ -172,7 +172,7 @@ class MainActivity : AppCompatActivity() {
                         return@Scaffold
                     }
 
-                    AnimatedNavHost(navController, startDestination = Routes.Main.name) {
+                    NavHost(navController, startDestination = Routes.Main.name) {
                         composable(Routes.Main.name, enterTransition = {
                             when (initialState.destination.route) {
                                 Routes.Settings.name, Routes.Support.name ->

app/src/main/java/com/zaneschepke/wireguardautotunnel/ui/screens/main/MainScreen.kt

@@ -159,8 +159,8 @@ fun MainScreen(
         scope.launch(Dispatchers.IO) {
             try {
                 viewModel.onTunnelFileSelected(data)
-            } catch (e : Exception) {
-                showSnackbarMessage(e.message ?: context.getString(R.string.unknown_error))
+            } catch (e : WgTunnelException) {
+                showSnackbarMessage(e.message)
             }
         }
     }
@@ -171,8 +171,8 @@ fun MainScreen(
             scope.launch {
                 try {
                     viewModel.onTunnelQrResult(it.contents)
-                } catch (e: Exception) {
-                    showSnackbarMessage(context.getString(R.string.qr_result_failed))
+                } catch (e: WgTunnelException) {
+                    showSnackbarMessage(e.message)
                 }
             }
         }

app/src/main/java/com/zaneschepke/wireguardautotunnel/ui/screens/settings/SettingsScreen.kt

@@ -99,7 +99,7 @@ fun SettingsScreen(
     val fineLocationState = rememberPermissionState(Manifest.permission.ACCESS_FINE_LOCATION)
     var currentText by remember { mutableStateOf("") }
     val scrollState = rememberScrollState()
-    var didShowLocationDisclaimer by remember { mutableStateOf(false) }
+    var isLocationDisclaimerNeeded by remember { mutableStateOf(true) }
     var isBackgroundLocationGranted by remember { mutableStateOf(true) }
     var showAuthPrompt by remember { mutableStateOf(false) }
     var didExportFiles by remember { mutableStateOf(false) }
@@ -141,6 +141,7 @@ fun SettingsScreen(
         return(isBackgroundLocationGranted && fineLocationState.status.isGranted && !viewModel.isLocationServicesNeeded())
     }
 
+
     fun openSettings() {
         scope.launch {
             val intentSettings =
@@ -156,62 +157,75 @@ fun SettingsScreen(
             rememberPermissionState(Manifest.permission.ACCESS_BACKGROUND_LOCATION)
         if(!backgroundLocationState.status.isGranted) {
             isBackgroundLocationGranted = false
-            if(!didShowLocationDisclaimer) {
-                Column(
-                    horizontalAlignment = Alignment.CenterHorizontally,
-                    verticalArrangement = Arrangement.Top,
-                    modifier = Modifier
-                        .fillMaxSize()
-                        .verticalScroll(scrollState)
-                        .padding(padding)
-                ) {
-                    Icon(
-                        Icons.Rounded.LocationOff,
-                        contentDescription = stringResource(id = R.string.map),
-                        modifier = Modifier
-                            .padding(30.dp)
-                            .size(128.dp)
-                    )
-                    Text(
-                        stringResource(R.string.prominent_background_location_title),
-                        textAlign = TextAlign.Center,
-                        modifier = Modifier.padding(30.dp),
-                        fontSize = 20.sp
-                    )
-                    Text(
-                        stringResource(R.string.prominent_background_location_message),
-                        textAlign = TextAlign.Center,
-                        modifier = Modifier.padding(30.dp),
-                        fontSize = 15.sp
-                    )
-                    Row(
-                        modifier = if (WireGuardAutoTunnel.isRunningOnAndroidTv(context)) Modifier
-                            .fillMaxWidth()
-                            .padding(10.dp) else Modifier
-                            .fillMaxWidth()
-                            .padding(30.dp),
-                        verticalAlignment = Alignment.CenterVertically,
-                        horizontalArrangement = Arrangement.SpaceEvenly
-                    ) {
-                        TextButton(onClick = {
-                            didShowLocationDisclaimer = true
-                        }) {
-                            Text(stringResource(id = R.string.no_thanks))
-                        }
-                        TextButton(modifier = Modifier.focusRequester(focusRequester), onClick = {
-                            openSettings()
-                        }) {
-                            Text(stringResource(id = R.string.turn_on))
-                        }
-                    }
-                }
-                return
-            }
         } else {
+            isLocationDisclaimerNeeded = false
             isBackgroundLocationGranted = true
         }
     }
 
+    if(Build.VERSION.SDK_INT <= Build.VERSION_CODES.P) {
+        if(!fineLocationState.status.isGranted) {
+            isBackgroundLocationGranted = false
+        } else {
+            isLocationDisclaimerNeeded = false
+            isBackgroundLocationGranted = true
+        }
+    }
+
+    if(isLocationDisclaimerNeeded) {
+        Column(
+            horizontalAlignment = Alignment.CenterHorizontally,
+            verticalArrangement = Arrangement.Top,
+            modifier = Modifier
+                .fillMaxSize()
+                .verticalScroll(scrollState)
+                .padding(padding)
+        ) {
+            Icon(
+                Icons.Rounded.LocationOff,
+                contentDescription = stringResource(id = R.string.map),
+                modifier = Modifier
+                    .padding(30.dp)
+                    .size(128.dp)
+            )
+            Text(
+                stringResource(R.string.prominent_background_location_title),
+                textAlign = TextAlign.Center,
+                modifier = Modifier.padding(30.dp),
+                fontSize = 20.sp
+            )
+            Text(
+                stringResource(R.string.prominent_background_location_message),
+                textAlign = TextAlign.Center,
+                modifier = Modifier.padding(30.dp),
+                fontSize = 15.sp
+            )
+            Row(
+                modifier = if (WireGuardAutoTunnel.isRunningOnAndroidTv(context)) Modifier
+                    .fillMaxWidth()
+                    .padding(10.dp) else Modifier
+                    .fillMaxWidth()
+                    .padding(30.dp),
+                verticalAlignment = Alignment.CenterVertically,
+                horizontalArrangement = Arrangement.SpaceEvenly
+            ) {
+                TextButton(onClick = {
+                    isLocationDisclaimerNeeded = false
+                }) {
+                    Text(stringResource(id = R.string.no_thanks))
+                }
+                TextButton(modifier = Modifier.focusRequester(focusRequester), onClick = {
+                    openSettings()
+                }) {
+                    Text(stringResource(id = R.string.turn_on))
+                }
+            }
+        }
+        return
+    }
+
+
+
     if(showAuthPrompt) {
         AuthorizationPrompt(onSuccess = {
             showAuthPrompt = false

build.gradle.kts

@@ -7,8 +7,6 @@ buildscript {
     }
 }
 
-
-
 plugins {
     alias(libs.plugins.android.application) apply false
     alias(libs.plugins.kotlin.android) apply false

buildSrc/src/main/kotlin/Constants.kt

@@ -0,0 +1,12 @@
+object Constants {
+    const val VERSION_NAME = "3.2.1"
+    const val VERSION_CODE = 32100
+    const val TARGET_SDK = 34
+    const val MIN_SDK = 26
+    const val APP_ID = "com.zaneschepke.wireguardautotunnel"
+
+    const val STORE_PASS_VAR = "SIGNING_STORE_PASSWORD"
+    const val KEY_ALIAS_VAR = "SIGNING_KEY_ALIAS"
+    const val KEY_PASS_VAR = "SIGNING_KEY_PASSWORD"
+    const val KEY_STORE_PATH_VAR = "KEY_STORE_PATH"
+}

fastlane/Appfile

@@ -0,0 +1,2 @@
+json_key_file "service_account.json"
+package_name "com.zaneschepke.wireguardautotunnel"

fastlane/Fastfile

@@ -0,0 +1,17 @@
+default_platform(:android)
+
+platform :android do
+
+  desc "Deploy a beta version to the Google Play"
+  lane :beta do
+    gradle(task: "clean bundleGeneralRelease")
+    upload_to_play_store(track: 'beta')
+  end
+
+  desc "Deploy a new version to the Google Play"
+    lane :production do
+      gradle(task: "clean bundleGeneralRelease")
+      upload_to_play_store
+    end
+
+end

fastlane/metadata/android/en-US/changelogs/32100.txt

@@ -0,0 +1,3 @@
+Enhancements:
+- Fix < Android 9 permission bug
+- Other optimizations

gradle/libs.versions.toml

@@ -1,43 +1,43 @@
 [versions]
-accompanist = "0.31.2-alpha"
+accompanist = "0.32.0"
 activityCompose = "1.8.0"
 androidx-junit = "1.1.5"
 appcompat = "1.6.1"
 biometricKtx = "1.2.0-alpha05"
 coreGoogleShortcuts = "1.1.0"
 coreKtx = "1.12.0"
+desugar_jdk_libs = "2.0.4"
 espressoCore = "3.5.1"
 firebase-crashlytics-gradle = "2.9.9"
 google-services = "4.4.0"
-hiltAndroid = "2.48"
-hiltNavigationCompose = "1.0.0"
+hiltAndroid = "2.48.1"
+hiltNavigationCompose = "1.1.0"
 junit = "4.13.2"
-kotlinx-serialization-json = "1.5.1"
+kotlinx-serialization-json = "1.6.0"
 lifecycle-runtime-compose = "2.6.2"
 material-icons-extended = "1.5.4"
 material3 = "1.1.2"
-navigationCompose = "2.7.4"
+navigationCompose = "2.7.5"
 roomVersion = "2.6.0"
 timber = "5.0.1"
 tunnel = "1.0.20230706"
-androidGradlePlugin = "8.3.0-alpha06"
+androidGradlePlugin = "8.2.0-rc03"
 kotlin="1.9.10"
 ksp="1.9.10-1.0.13"
 composeBom="2023.10.01"
-firebaseBom="32.4.0"
+firebaseBom= "32.5.0"
 compose="1.5.4"
-crashlytics="18.5.0"
-analytics="21.4.0"
+crashlytics= "18.5.1"
+analytics="21.5.0"
 composeCompiler="1.5.3"
 zxingAndroidEmbedded = "4.3.0"
-zxingCore = "3.4.1"
+zxingCore = "3.5.2"
 
 
 [libraries]
 # accompanist
 accompanist-drawablepainter = { module = "com.google.accompanist:accompanist-drawablepainter", version.ref = "accompanist" }
 accompanist-flowlayout = { module = "com.google.accompanist:accompanist-flowlayout", version.ref = "accompanist" }
-accompanist-navigation-animation = { module = "com.google.accompanist:accompanist-navigation-animation", version.ref = "accompanist" }
 accompanist-permissions = { module = "com.google.accompanist:accompanist-permissions", version.ref = "accompanist" }
 accompanist-systemuicontroller = { module = "com.google.accompanist:accompanist-systemuicontroller", version.ref = "accompanist" }
 
@@ -61,6 +61,7 @@ androidx-compose-ui-tooling-preview = { module="androidx.compose.ui:ui-tooling-p
 androidx-compose-ui = { module="androidx.compose.ui:ui", version.ref="compose" }
 
 #hilt
+desugar_jdk_libs = { module = "com.android.tools:desugar_jdk_libs", version.ref = "desugar_jdk_libs" }
 hilt-android = { module = "com.google.dagger:hilt-android", version.ref = "hiltAndroid" }
 hilt-android-compiler = { module = "com.google.dagger:hilt-android-compiler", version.ref = "hiltAndroid" }
 

gradle/wrapper/gradle-wrapper.properties

@@ -1,6 +1,6 @@
 #Wed Oct 11 22:39:21 EDT 2023
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-8.3-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.4-bin.zip
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists