Merge pull request #8 from SurjitSahoo/feat/download-enhancements

Download Enhancements, Integrate Clarity analytics, database migrations, and cache redesign

Author: SurjitSahoo

.agent/rules/project-context.md

@@ -18,6 +18,11 @@ This is an offline-first Android client app for the [audiobookshelf](https://git
 - If the offline track is deleted/cleared while the book is being played, the player should attempt to fallback to the online URL if the server is reachable, otherwise pause playback and persist the last playback state (track ID, playback position/timestamp, current chapter/index, and playback status) plus a flag indicating offline content was removed; ensure the rule notes that these persisted fields are used to resume or report playback state and are written atomically to the player state store.
 - The app must be fully functional for downloaded content when offline.
 
+## Future Plans (Not to be implemented now)
+- The app should support multi-server / multi-user connections. A user should be able to connect to a server, download a few books for offline listening, then disconnect and connect to a new server and download few more books, and listen to all the books offline, and then connecting back to the previous server should push (sync) progress updates from the books which were downloaded earlier for offline listening.
+- The app should also support uploading books that were downloaded from a server to another server (sharing)
+- The app should support importing audiobooks from the phone storage directly without any server connection. Optionally, the user should be able to upload these audiobooks to the server along with the progress.
+
 ## Ensure Stability
 
 - Ensure null-safety when converting data (e.g., check for division by zero in percentage calculations).
@@ -40,4 +45,4 @@ This is an offline-first Android client app for the [audiobookshelf](https://git
 - **ABSOLUTELY NO** hardcoded user-facing strings in UI code. All strings must be extracted to `strings.xml` and accessed via `stringResource`.
 - Use `associateBy` or proper indexing for collection lookups (O(1)) instead of nested loops (O(N^2)) when synchronizing data.
 - Avoid expensive operations on the main thread.
-- No code duplication, keep the code clean and easy to maintain.
+- No code duplication, keep the code clean and easy to maintain.

.coderabbit.yaml

@@ -0,0 +1,3 @@
+language: "en-US"
+reviews:
+  auto_title_placeholder: "@coderabbit title"

.github/workflows/release.yml

@@ -44,15 +44,38 @@ jobs:
           RELEASE_KEY_ALIAS: ${{ secrets.RELEASE_KEY_ALIAS }}
           RELEASE_KEY_PASSWORD: ${{ secrets.RELEASE_KEY_PASSWORD }}
 
+      - name: Build Changelog
+        id: build_changelog
+        uses: mikepenz/release-changelog-builder-action@v5
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          configuration: |
+            {
+              "categories": [
+                {
+                  "title": "## 🚀 Features",
+                  "labels": ["feature", "enhancement"]
+                },
+                {
+                  "title": "## 🐛 Bug Fixes",
+                  "labels": ["fix", "bug"]
+                },
+                {
+                  "title": "## 📦 Dependencies & Maintenance",
+                  "labels": ["chore", "deps", "dependency", "refactor"]
+                }
+              ],
+              "template": "{{CHANGELOG}}"
+            }
+
       - name: Create Release
-        uses: softprops/action-gh-release@v1
+        uses: softprops/action-gh-release@v2
         with:
           files: app/build/outputs/apk/release/app-release.apk
           tag_name: v${{ steps.get_version.outputs.version }}
           name: Kahani v${{ steps.get_version.outputs.version }}
-          body: |
-            Automated Release for Kahani.
-            Commit: ${{ github.sha }}
+          body: ${{ steps.build_changelog.outputs.changelog }}
           draft: false
           prerelease: false
         env:

.gitignore

@@ -27,9 +27,6 @@ render.experimental.xml
 *.jks
 *.keystore
 
-# Google Services (e.g. APIs or Firebase)
-google-services.json
-
 # Android Profiling
 *.hprof
 

app/build.gradle.kts

@@ -8,6 +8,8 @@ plugins {
   id("com.google.dagger.hilt.android")
   id("org.jmailen.kotlinter") version "5.2.0"
   id("com.google.devtools.ksp")
+  alias(libs.plugins.google.services)
+  alias(libs.plugins.firebase.crashlytics)
 }
 
 kotlinter {
@@ -60,11 +62,7 @@ android {
 
     testInstrumentationRunner = "androidx.test.runner.AndroidJUnitRunner"
 
-    val acraReportLogin = "8yJ59n0UToCja8LR"
-    val acraReportPassword = "kuW9TV7BbJByuIAc"
-    
-    buildConfigField("String", "ACRA_REPORT_LOGIN", "\"$acraReportLogin\"")
-    buildConfigField("String", "ACRA_REPORT_PASSWORD", "\"$acraReportPassword\"")
+    buildConfigField("String", "CLARITY_PROJECT_ID", "\"vc8bgk8nk9\"")
 
     signingConfigs {
       create("release") {
@@ -183,17 +181,19 @@ dependencies {
   implementation(libs.androidx.glance.appwidget)
   implementation(libs.androidx.glance.material3)
 
-  implementation(libs.acra.core)
-  implementation(libs.acra.http)
-  implementation(libs.acra.toast)
-  
   implementation(libs.androidx.room.runtime)
   implementation(libs.androidx.room.ktx)
 
   implementation(libs.converter.moshi)
   implementation(libs.moshi)
   implementation(libs.moshi.kotlin)
 
+  implementation(libs.microsoft.clarity)
+  
+  implementation(platform(libs.firebase.bom))
+  implementation(libs.firebase.crashlytics)
+  implementation(libs.firebase.analytics)
+  
   debugImplementation(libs.androidx.ui.tooling)
   debugImplementation(libs.androidx.ui.test.manifest)
 }

app/google-services.json

@@ -0,0 +1,48 @@
+{
+  "project_info": {
+    "project_number": "139954826172",
+    "project_id": "kahani-app-android",
+    "storage_bucket": "kahani-app-android.firebasestorage.app"
+  },
+  "client": [
+    {
+      "client_info": {
+        "mobilesdk_app_id": "1:139954826172:android:0f4f76f1de010ba41699b9",
+        "android_client_info": {
+          "package_name": "com.kahani.app"
+        }
+      },
+      "oauth_client": [],
+      "api_key": [
+        {
+          "current_key": "AIzaSyAB8o-65tB6TzUbdaqVAP9XnTl1wgC6dks"
+        }
+      ],
+      "services": {
+        "appinvite_service": {
+          "other_platform_oauth_client": []
+        }
+      }
+    },
+    {
+      "client_info": {
+        "mobilesdk_app_id": "1:139954826172:android:1d7d97392c6e248f1699b9",
+        "android_client_info": {
+          "package_name": "com.kahani.app.debug"
+        }
+      },
+      "oauth_client": [],
+      "api_key": [
+        {
+          "current_key": "AIzaSyAB8o-65tB6TzUbdaqVAP9XnTl1wgC6dks"
+        }
+      ],
+      "services": {
+        "appinvite_service": {
+          "other_platform_oauth_client": []
+        }
+      }
+    }
+  ],
+  "configuration_version": "1"
+}

app/proguard-rules.pro

@@ -17,4 +17,8 @@
 # Hilt and Dagger rules (usually bundled, but good to ensure)
 -keep class dagger.hilt.android.internal.** { *; }
 -keep class *__HiltBindingModule { *; }
--keep class org.grakovne.lissen.**_HiltComponents$* { *; }
+-keep class org.grakovne.lissen.**_HiltComponents$* { *; }
+
+# Microsoft Clarity
+-keep class com.microsoft.clarity.** { *; }
+-keep interface com.microsoft.clarity.** { *; }