feat: ui enhancements

Improved UI look and feel with various enhancements.

Fixed bug where VPN was stopping after a while due to lib errors that can be ignored.

Added splash screen activity better initial application data and state while splash is showing.

Added analytics screen for alpha to present users with options to send anonymous analytics.

Added skeleton of android/lib ci workflow.

.github/workflows/cd-pre-release.yml

@@ -150,6 +150,7 @@ jobs:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         with:
           body: |
+            <br />
             SHA256 fingerprint:
             ```${{ steps.checksum.outputs.checksum }}```
           tag_name: ${{ github.ref_name }}

.github/workflows/cd-release.yml

@@ -149,6 +149,7 @@ jobs:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         with:
           body: |
+            <br />
             SHA256 fingerprint:
             ```${{ steps.checksum.outputs.checksum }}```
           tag_name: ${{ github.ref_name }}

app/build.gradle.kts

@@ -35,7 +35,6 @@ android {
 			"\"${(System.getenv(Constants.SENTRY_DSN) ?: getLocalProperty("sentry.dsn")) ?: ""}\"",
 		)
 		buildConfigField("Boolean", "IS_SANDBOX", "false")
-		buildConfigField("Boolean", Constants.OPT_IN_REPORTING, "false")
 		proguardFile("fdroid-rules.pro")
 	}
 
@@ -47,10 +46,11 @@ android {
 					try {
 						load(file("signing.properties").reader())
 					} catch (_: Exception) {
-						load(file("signing_template.properties").reader())
+						// can't find signing file, use debug
+						this@create.initWith(signingConfigs.getByName("debug"))
+						return@create
 					}
 				}
-
 			// try to get secrets from env first for pipeline build, then properties file for local
 			// build
 			storeFile =

app/src/main/AndroidManifest.xml

@@ -21,15 +21,23 @@
         android:theme="@style/Theme.AppSplashScreen"
         tools:node="merge"
         tools:targetApi="33">
+		<activity
+			android:name=".ui.SplashActivity"
+			android:exported="true"
+			android:theme="@style/Theme.AppSplashScreen">
+			<intent-filter>
+				<action android:name="android.intent.action.MAIN" />
+				<category android:name="android.intent.category.LAUNCHER" />
+			</intent-filter>
+		</activity>
         <activity
             android:name=".ui.MainActivity"
             android:configChanges="orientation|keyboardHidden"
             android:exported="true"
+			android:theme="@style/Theme.NymVPN"
             android:screenOrientation="portrait"
             android:windowSoftInputMode="adjustResize">
             <intent-filter>
-                <action android:name="android.intent.action.MAIN" />
-                <category android:name="android.intent.category.LAUNCHER" />
                 <action android:name="android.service.quicksettings.action.QS_TILE_PREFERENCES" />
             </intent-filter>
         </activity>
@@ -95,4 +103,4 @@
             android:value="@string/fullVersionName" />
     </application>
 
-</manifest>
+</manifest>

app/src/main/java/net/nymtech/nymvpn/data/SettingsRepository.kt

@@ -26,9 +26,16 @@ interface SettingsRepository {
 
 	suspend fun setErrorReporting(enabled: Boolean)
 
+	suspend fun setAnalytics(enabled: Boolean)
+
+	suspend fun isAnalyticsEnabled(): Boolean
 	suspend fun isFirstHopSelectionEnabled(): Boolean
 
 	suspend fun setFirstHopSelection(enabled: Boolean)
 
+	suspend fun isAnalyticsShown(): Boolean
+
+	suspend fun setAnalyticsShown(shown: Boolean)
+
 	val settingsFlow: Flow<Settings>
 }

app/src/main/java/net/nymtech/nymvpn/data/datastore/DataStoreManager.kt

@@ -21,8 +21,10 @@ class DataStoreManager(private val context: Context) {
 		val VPN_MODE = stringPreferencesKey("VPN_MODE")
 		val FIRST_HOP_SELECTION = booleanPreferencesKey("FIRST_HOP_SELECTION")
 		val ERROR_REPORTING = booleanPreferencesKey("ERROR_REPORTING")
+		val ANALYTICS = booleanPreferencesKey("ANALYTICS")
 		val AUTO_START = booleanPreferencesKey("AUTO_START")
 		val LOGGED_IN = booleanPreferencesKey("LOGGED_IN")
+		val ANALYTICS_SHOWN = booleanPreferencesKey("ANALYTICS_SHOWN")
 
 		// GatewayCountries
 		val FIRST_HOP_COUNTRY = stringPreferencesKey("FIRST_HOP_COUNTRY")

app/src/main/java/net/nymtech/nymvpn/data/datastore/DataStoreSettingsRepository.kt

@@ -2,7 +2,6 @@ package net.nymtech.nymvpn.data.datastore
 
 import kotlinx.coroutines.flow.Flow
 import kotlinx.coroutines.flow.map
-import net.nymtech.nymvpn.BuildConfig
 import net.nymtech.nymvpn.data.SettingsRepository
 import net.nymtech.nymvpn.data.model.Settings
 import net.nymtech.nymvpn.ui.theme.Theme
@@ -61,13 +60,21 @@ class DataStoreSettingsRepository(private val dataStoreManager: DataStoreManager
 
 	override suspend fun isErrorReportingEnabled(): Boolean {
 		return dataStoreManager.getFromStore(DataStoreManager.ERROR_REPORTING)
-			?: BuildConfig.OPT_IN_REPORTING
+			?: Settings.REPORTING_DEFAULT
 	}
 
 	override suspend fun setErrorReporting(enabled: Boolean) {
 		dataStoreManager.saveToDataStore(DataStoreManager.ERROR_REPORTING, enabled)
 	}
 
+	override suspend fun setAnalytics(enabled: Boolean) {
+		dataStoreManager.saveToDataStore(DataStoreManager.ANALYTICS, enabled)
+	}
+
+	override suspend fun isAnalyticsEnabled(): Boolean {
+		return dataStoreManager.getFromStore(DataStoreManager.ANALYTICS) ?: Settings.REPORTING_DEFAULT
+	}
+
 	override suspend fun isFirstHopSelectionEnabled(): Boolean {
 		return dataStoreManager.getFromStore(DataStoreManager.FIRST_HOP_SELECTION)
 			?: Settings.FIRST_HOP_SELECTION_DEFAULT
@@ -77,6 +84,14 @@ class DataStoreSettingsRepository(private val dataStoreManager: DataStoreManager
 		dataStoreManager.saveToDataStore(DataStoreManager.FIRST_HOP_SELECTION, enabled)
 	}
 
+	override suspend fun isAnalyticsShown(): Boolean {
+		return dataStoreManager.getFromStore(DataStoreManager.ANALYTICS_SHOWN) ?: Settings.ANALYTICS_SHOWN_DEFAULT
+	}
+
+	override suspend fun setAnalyticsShown(shown: Boolean) {
+		dataStoreManager.saveToDataStore(DataStoreManager.ANALYTICS_SHOWN, shown)
+	}
+
 	override val settingsFlow: Flow<Settings> =
 		dataStoreManager.preferencesFlow.map { prefs ->
 			prefs?.let { pref ->
@@ -93,11 +108,14 @@ class DataStoreSettingsRepository(private val dataStoreManager: DataStoreManager
 							?: Settings.AUTO_START_DEFAULT,
 						errorReportingEnabled =
 						pref[DataStoreManager.ERROR_REPORTING]
-							?: BuildConfig.OPT_IN_REPORTING,
+							?: Settings.REPORTING_DEFAULT,
+						analyticsEnabled = pref[DataStoreManager.ANALYTICS]
+							?: Settings.REPORTING_DEFAULT,
 						firstHopSelectionEnabled =
 						pref[DataStoreManager.FIRST_HOP_SELECTION]
 							?: Settings.FIRST_HOP_SELECTION_DEFAULT,
 						loggedIn = pref[DataStoreManager.LOGGED_IN] ?: Settings.LOGGED_IN_DEFAULT,
+						isAnalyticsShown = pref[DataStoreManager.ANALYTICS_SHOWN] ?: Settings.ANALYTICS_SHOWN_DEFAULT,
 					)
 				} catch (e: IllegalArgumentException) {
 					Timber.e(e)

app/src/main/java/net/nymtech/nymvpn/data/model/Settings.kt

@@ -1,20 +1,23 @@
 package net.nymtech.nymvpn.data.model
 
-import net.nymtech.nymvpn.BuildConfig
 import net.nymtech.nymvpn.ui.theme.Theme
 import net.nymtech.vpn.model.VpnMode
 
 data class Settings(
 	val theme: Theme = Theme.default(),
 	val vpnMode: VpnMode = VpnMode.default(),
 	val autoStartEnabled: Boolean = AUTO_START_DEFAULT,
-	val errorReportingEnabled: Boolean = BuildConfig.OPT_IN_REPORTING,
+	val errorReportingEnabled: Boolean = REPORTING_DEFAULT,
+	val analyticsEnabled: Boolean = REPORTING_DEFAULT,
 	val firstHopSelectionEnabled: Boolean = FIRST_HOP_SELECTION_DEFAULT,
 	val loggedIn: Boolean = LOGGED_IN_DEFAULT,
+	val isAnalyticsShown: Boolean = ANALYTICS_SHOWN_DEFAULT,
 ) {
 	companion object {
 		const val FIRST_HOP_SELECTION_DEFAULT = false
 		const val AUTO_START_DEFAULT = false
 		const val LOGGED_IN_DEFAULT = false
+		const val REPORTING_DEFAULT = false
+		const val ANALYTICS_SHOWN_DEFAULT = false
 	}
 }

app/src/main/java/net/nymtech/nymvpn/module/ViewModelModule.kt

@@ -5,8 +5,8 @@ import dagger.Provides
 import dagger.hilt.InstallIn
 import dagger.hilt.android.components.ViewModelComponent
 import dagger.hilt.android.scopes.ViewModelScoped
-import net.nymtech.vpn.NymApi
 import net.nymtech.nymvpn.NymVpn
+import net.nymtech.vpn.NymApi
 
 @Module
 @InstallIn(ViewModelComponent::class)

app/src/main/java/net/nymtech/nymvpn/ui/AppUiState.kt

@@ -1,13 +1,12 @@
 package net.nymtech.nymvpn.ui
 
-import net.nymtech.nymvpn.ui.theme.Theme
+import net.nymtech.nymvpn.data.model.Settings
 import net.nymtech.vpn.model.VpnState
 
 data class AppUiState(
 	val loading: Boolean = true,
-	val theme: Theme = Theme.AUTOMATIC,
-	val loggedIn: Boolean = false,
 	val snackbarMessage: String = "",
 	val snackbarMessageConsumed: Boolean = true,
 	val vpnState: VpnState = VpnState.Down,
+	val settings: Settings = Settings(),
 )

app/src/main/java/net/nymtech/nymvpn/ui/AppViewModel.kt

@@ -17,6 +17,7 @@ import kotlinx.coroutines.flow.SharingStarted
 import kotlinx.coroutines.flow.combine
 import kotlinx.coroutines.flow.stateIn
 import kotlinx.coroutines.launch
+import kotlinx.coroutines.withContext
 import net.nymtech.logcathelper.LogcatHelper
 import net.nymtech.logcathelper.model.LogLevel
 import net.nymtech.logcathelper.model.LogMessage
@@ -53,11 +54,10 @@ constructor(
 		combine(_uiState, settingsRepository.settingsFlow, vpnClient.stateFlow) { state, settings, vpnState ->
 			AppUiState(
 				false,
-				settings.theme,
-				settings.loggedIn,
 				state.snackbarMessage,
 				state.snackbarMessageConsumed,
 				vpnState.vpnState,
+				settings,
 			)
 		}.stateIn(
 			viewModelScope,
@@ -118,6 +118,14 @@ constructor(
 		}
 	}
 
+	suspend fun isAnalyticsShown() = withContext(viewModelScope.coroutineContext + Dispatchers.Main) {
+		settingsRepository.isAnalyticsEnabled()
+	}
+
+	fun setAnalyticsShown() = viewModelScope.launch {
+		settingsRepository.setAnalyticsShown(true)
+	}
+
 	fun onEntryLocationSelected(selected: Boolean) = viewModelScope.launch {
 		settingsRepository.setFirstHopSelection(selected)
 		gatewayRepository.setFirstHopCountry(Country(isDefault = true))
@@ -131,6 +139,14 @@ constructor(
 		}
 	}
 
+	fun onErrorReportingSelected() = viewModelScope.launch {
+		settingsRepository.setErrorReporting(!uiState.value.settings.errorReportingEnabled)
+	}
+
+	fun onAnalyticsReportingSelected() = viewModelScope.launch {
+		settingsRepository.setAnalytics(!uiState.value.settings.analyticsEnabled)
+	}
+
 	private suspend fun updateEntryCountriesCache() {
 		try {
 			val entryCountries = nymApi.gateways(false)