feat: migrate to forked lib

Migrated app to a forked version of wireguard-android to enable development work on features that require changes to the core lib, like #107 #104 #87 #52 #6 Improved first launch flow by change vpn permission to only launch on first tunnel start Changed to proper database seeding strategy Updated README to account for GitHub packages auth requirement Migrated from deprecated UI components and libs Bump versions
zaneschepke · Feb 19, 2024 · 2690ce2 · 2690ce2
1 parent 500b85f
commit 2690ce2
Show file tree

Hide file tree

Showing 27 changed files with 286 additions and 197 deletions.
diff --git a/.github/workflows/pre-release.yml b/.github/workflows/pre-release.yml
@@ -19,6 +19,8 @@ jobs:
       SIGNING_STORE_PASSWORD: ${{ secrets.SIGNING_STORE_PASSWORD }}
       KEY_STORE_FILE: 'android_keystore.jks'
       KEY_STORE_LOCATION: ${{ github.workspace }}/app/keystore/
+      GH_USER: ${{ secrets.GH_USER }}
+      GH_TOKEN: ${{ secrets.GH_TOKEN }}
 
     steps:
       - uses: actions/checkout@v4

diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -20,6 +20,8 @@ jobs:
       SIGNING_STORE_PASSWORD: ${{ secrets.SIGNING_STORE_PASSWORD }}
       KEY_STORE_FILE: 'android_keystore.jks'
       KEY_STORE_LOCATION: ${{ github.workspace }}/app/keystore/
+      GH_USER: ${{ secrets.GH_USER }}
+      GH_TOKEN: ${{ secrets.GH_TOKEN }}
 
     steps:
       - uses: actions/checkout@v4

diff --git a/README.md b/README.md
@@ -71,6 +71,31 @@ The repository for these docs can be found [here](https://github.com/zaneschepke
 ```
 $ git clone https://github.com/zaneschepke/wgtunnel
 $ cd wgtunnel
+```
+
+Create a personal access token (classic) in GitHuv to be able to pull the wireguard-android github dependencies from GitHub packages
+as documented [here](https://docs.github.com/en/packages/learn-github-packages/introduction-to-github-packages#authenticating-to-github-packages).
+
+Alternatively, you can clone [wireguard-android](https://github.com/zaneschepke/wireguard-android) and run the following command to publish the dependency to your local maven repository (requires you have maven installed). This is the ideal approach
+if you intent to make changes to this lib.
+
+```
+$ git clone https://github.com/zaneschepke/wireguard-android
+$ cd wireguard-android
+$ brew install maven
+$ ./gradlew publishToMavenLocal
+```
+
+The [wireguard-android](https://github.com/zaneschepke/wireguard-android) dependency is a fork of the official [wireguard-android](https://github.com/WireGuard/wireguard-android) library. 
+
+Add the following lines to local.properties file:
+```
+GH_USER=<your github username>
+GH_TOKEN=<the personal access token with read package permission you just created>
+```
+
+And then build the app:
+```
 $ ./gradlew assembleDebug
 ```
 

diff --git a/app/build.gradle.kts b/app/build.gradle.kts
@@ -156,13 +156,14 @@ dependencies {
     debugImplementation(libs.androidx.compose.ui.tooling)
     debugImplementation(libs.androidx.compose.manifest)
 
-    // wg
+    // get tunnel lib from github packages or mavenLocal
     implementation(libs.tunnel)
     coreLibraryDesugaring(libs.desugar.jdk.libs)
 
     // logging
     implementation(libs.timber)
 
+
     // compose navigation
     implementation(libs.androidx.navigation.compose)
     implementation(libs.androidx.hilt.navigation.compose)
@@ -172,7 +173,6 @@ dependencies {
     ksp(libs.hilt.android.compiler)
 
     // accompanist
-    implementation(libs.accompanist.systemuicontroller)
     implementation(libs.accompanist.permissions)
     implementation(libs.accompanist.flowlayout)
     implementation(libs.accompanist.drawablepainter)

diff --git a/app/src/androidTest/java/com/zaneschepke/wireguardautotunnel/MigrationTest.kt b/app/src/androidTest/java/com/zaneschepke/wireguardautotunnel/MigrationTest.kt
@@ -4,6 +4,7 @@ import androidx.room.testing.MigrationTestHelper
 import androidx.test.ext.junit.runners.AndroidJUnit4
 import androidx.test.platform.app.InstrumentationRegistry
 import com.zaneschepke.wireguardautotunnel.data.AppDatabase
+import com.zaneschepke.wireguardautotunnel.data.Queries
 import org.junit.Rule
 import org.junit.Test
 import org.junit.runner.RunWith
@@ -26,33 +27,7 @@ class MigrationTest {
         helper.createDatabase(dbName, 4).apply {
             // Database has schema version 1. Insert some data using SQL queries.
             // You can't use DAO classes because they expect the latest schema.
-            execSQL(
-                "INSERT INTO Settings (is_tunnel_enabled," +
-                    "is_tunnel_on_mobile_data_enabled," +
-                    "trusted_network_ssids," +
-                    "default_tunnel," +
-                    "is_always_on_vpn_enabled," +
-                    "is_tunnel_on_ethernet_enabled," +
-                    "is_shortcuts_enabled," +
-                    "is_battery_saver_enabled," +
-                    "is_tunnel_on_wifi_enabled," +
-                    "is_kernel_enabled," +
-                    "is_restore_on_boot_enabled," +
-                    "is_multi_tunnel_enabled)" +
-                    " VALUES " +
-                    "('false'," +
-                    "'false'," +
-                    "'[trustedSSID1,trustedSSID2]'," +
-                    "'defaultTunnel'," +
-                    "'false'," +
-                    "'false'," +
-                    "'false'," +
-                    "'false'," +
-                    "'false'," +
-                    "'false'," +
-                    "'false'," +
-                    "'false')",
-            )
+            execSQL(Queries.createDefaultSettings())
             execSQL(
                 "INSERT INTO TunnelConfig (name, wg_quick)" + " VALUES ('hello', 'hello')",
             )

diff --git a/app/src/main/java/com/zaneschepke/wireguardautotunnel/data/DatabaseCallback.kt b/app/src/main/java/com/zaneschepke/wireguardautotunnel/data/DatabaseCallback.kt
@@ -0,0 +1,21 @@
+package com.zaneschepke.wireguardautotunnel.data
+
+import androidx.room.RoomDatabase
+import androidx.sqlite.db.SupportSQLiteDatabase
+import timber.log.Timber
+
+class DatabaseCallback : RoomDatabase.Callback() {
+    override fun onCreate(db: SupportSQLiteDatabase) = db.run {
+        // Notice non-ui thread is here
+        beginTransaction()
+        try {
+            execSQL(Queries.createDefaultSettings())
+            Timber.i("Bootstrapping settings data")
+            setTransactionSuccessful()
+        } catch (e : Exception) {
+            Timber.e(e)
+        } finally {
+            endTransaction()
+        }
+    }
+}
diff --git a/app/src/main/java/com/zaneschepke/wireguardautotunnel/data/Queries.kt b/app/src/main/java/com/zaneschepke/wireguardautotunnel/data/Queries.kt
@@ -0,0 +1,33 @@
+package com.zaneschepke.wireguardautotunnel.data
+
+object Queries {
+    fun createDefaultSettings() : String {
+        return """
+            INSERT INTO Settings (is_tunnel_enabled,
+                    is_tunnel_on_mobile_data_enabled,
+                    trusted_network_ssids,
+                    default_tunnel,
+                    is_always_on_vpn_enabled,
+                    is_tunnel_on_ethernet_enabled,
+                    is_shortcuts_enabled,
+                    is_battery_saver_enabled,
+                    is_tunnel_on_wifi_enabled,
+                    is_kernel_enabled,
+                    is_restore_on_boot_enabled,
+                    is_multi_tunnel_enabled)
+                    VALUES
+                    ('false',
+                    'false',
+                    '[trustedSSID1,trustedSSID2]',
+                     NULL,
+                    'false',
+                    'false',
+                    'false',
+                    'false',
+                    'false',
+                    'false',
+                    'false',
+                    'false')
+        """.trimIndent()
+    }
+}
diff --git a/app/src/main/java/com/zaneschepke/wireguardautotunnel/module/DatabaseModule.kt b/app/src/main/java/com/zaneschepke/wireguardautotunnel/module/DatabaseModule.kt
@@ -4,6 +4,7 @@ import android.content.Context
 import androidx.room.Room
 import com.zaneschepke.wireguardautotunnel.R
 import com.zaneschepke.wireguardautotunnel.data.AppDatabase
+import com.zaneschepke.wireguardautotunnel.data.DatabaseCallback
 import dagger.Module
 import dagger.Provides
 import dagger.hilt.InstallIn
@@ -23,6 +24,7 @@ class DatabaseModule {
                 context.getString(R.string.db_name),
             )
             .fallbackToDestructiveMigration()
+            .addCallback(DatabaseCallback())
             .build()
     }
 }
diff --git a/app/src/main/java/com/zaneschepke/wireguardautotunnel/receiver/BootReceiver.kt b/app/src/main/java/com/zaneschepke/wireguardautotunnel/receiver/BootReceiver.kt
@@ -8,6 +8,7 @@ import com.zaneschepke.wireguardautotunnel.data.repository.TunnelConfigRepositor
 import com.zaneschepke.wireguardautotunnel.service.foreground.ServiceManager
 import com.zaneschepke.wireguardautotunnel.util.goAsync
 import dagger.hilt.android.AndroidEntryPoint
+import timber.log.Timber
 import javax.inject.Inject
 
 @AndroidEntryPoint
@@ -21,8 +22,10 @@ class BootReceiver : BroadcastReceiver() {
         if (Intent.ACTION_BOOT_COMPLETED != intent?.action) return@goAsync
         val settings = settingsRepository.getSettings()
         if (settings.isAutoTunnelEnabled) {
+            Timber.i("Starting watcher service from boot")
             ServiceManager.startWatcherServiceForeground(context!!)
         } else if(settings.isAlwaysOnVpnEnabled) {
+            Timber.i("Starting tunnel from boot")
             ServiceManager.startVpnServicePrimaryTunnel(context!!, settings, tunnelConfigRepository.getAll().firstOrNull())
         }
     }

diff --git a/...zaneschepke/wireguardautotunnel/service/foreground/WireGuardConnectivityWatcherService.kt b/...zaneschepke/wireguardautotunnel/service/foreground/WireGuardConnectivityWatcherService.kt
@@ -152,12 +152,16 @@ class WireGuardConnectivityWatcherService : ForegroundService() {
         wakeLock =
             (getSystemService(Context.POWER_SERVICE) as PowerManager).run {
                 newWakeLock(PowerManager.PARTIAL_WAKE_LOCK, "$tag::lock").apply {
-                    if (isBatterySaverOn) {
-                        Timber.d("Initiating wakelock with timeout")
-                        acquire(Constants.BATTERY_SAVER_WATCHER_WAKE_LOCK_TIMEOUT)
-                    } else {
-                        Timber.d("Initiating wakelock with zero timeout")
-                        acquire(Constants.DEFAULT_WATCHER_WAKE_LOCK_TIMEOUT)
+                    try {
+                        if (isBatterySaverOn) {
+                            Timber.d("Initiating wakelock with timeout")
+                            acquire(Constants.BATTERY_SAVER_WATCHER_WAKE_LOCK_TIMEOUT)
+                        } else {
+                            Timber.d("Initiating wakelock with zero timeout")
+                            acquire(Constants.DEFAULT_WATCHER_WAKE_LOCK_TIMEOUT)
+                        }
+                    } finally {
+                        release()
                     }
                 }
             }

diff --git a/app/src/main/java/com/zaneschepke/wireguardautotunnel/service/tunnel/WireGuardTunnel.kt b/app/src/main/java/com/zaneschepke/wireguardautotunnel/service/tunnel/WireGuardTunnel.kt
@@ -25,7 +25,7 @@ import javax.inject.Inject
 class WireGuardTunnel
 @Inject
 constructor(
-    @Userspace private val userspaceBackend: Backend,
+    @Userspace private val userspaceBackend : Backend,
     @Kernel private val kernelBackend: Backend,
     private val settingsRepository: SettingsRepository
 ) : VpnService {

diff --git a/app/src/main/java/com/zaneschepke/wireguardautotunnel/ui/ActivityViewModel.kt b/app/src/main/java/com/zaneschepke/wireguardautotunnel/ui/ActivityViewModel.kt
@@ -1,13 +1,12 @@
 package com.zaneschepke.wireguardautotunnel.ui
 
 import androidx.lifecycle.ViewModel
-import com.zaneschepke.wireguardautotunnel.data.SettingsDao
 import dagger.hilt.android.lifecycle.HiltViewModel
 import javax.inject.Inject
 
 @HiltViewModel
 class ActivityViewModel
 @Inject
-constructor(
-    private val settingsRepo: SettingsDao,
-) : ViewModel() {}
+constructor() : ViewModel() {
+
+}