Add global context.cacheDir provider. (#1606)

## Type of change

- [ ] Feature
- [ ] Bugfix
- [x] Technical
- [ ] Other :

## Content

Dagger now provides the app's `cacheDir` when requesting a `@CacheDirectory File`  type.

## Motivation and context

To support some upcoming code that needs the `cacheDir` to be changed during tests.

app/src/main/kotlin/io/element/android/x/di/AppModule.kt

@@ -31,6 +31,7 @@ import io.element.android.libraries.core.meta.BuildType
 import io.element.android.libraries.designsystem.utils.snackbar.SnackbarDispatcher
 import io.element.android.libraries.di.AppScope
 import io.element.android.libraries.di.ApplicationContext
+import io.element.android.libraries.di.CacheDirectory
 import io.element.android.libraries.di.DefaultPreferences
 import io.element.android.libraries.di.SingleIn
 import io.element.android.x.BuildConfig
@@ -51,6 +52,12 @@ object AppModule {
         return File(context.filesDir, "sessions")
     }
 
+    @Provides
+    @CacheDirectory
+    fun providesCacheDirectory(@ApplicationContext context: Context): File {
+        return context.cacheDir
+    }
+
     @Provides
     fun providesResources(@ApplicationContext context: Context): Resources {
         return context.resources

libraries/di/src/main/kotlin/io/element/android/libraries/di/ApplicationContext.kt

@@ -18,4 +18,10 @@ package io.element.android.libraries.di
 
 import javax.inject.Qualifier
 
-@Qualifier annotation class ApplicationContext
+/**
+ * Qualifies a [Context] object that represents the application context.
+ */
+@Retention(AnnotationRetention.RUNTIME)
+@MustBeDocumented
+@Qualifier
+annotation class ApplicationContext

libraries/di/src/main/kotlin/io/element/android/libraries/di/CacheDirectory.kt

@@ -0,0 +1,27 @@
+/*
+ * Copyright (c) 2022 New Vector Ltd
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package io.element.android.libraries.di
+
+import javax.inject.Qualifier
+
+/**
+ * Qualifies a [File] object which represents the application cache directory.
+ */
+@Retention(AnnotationRetention.RUNTIME)
+@MustBeDocumented
+@Qualifier
+annotation class CacheDirectory

libraries/matrix/impl/src/main/kotlin/io/element/android/libraries/matrix/impl/RustMatrixClientFactory.kt

@@ -16,9 +16,8 @@
 
 package io.element.android.libraries.matrix.impl
 
-import android.content.Context
 import io.element.android.libraries.core.coroutine.CoroutineDispatchers
-import io.element.android.libraries.di.ApplicationContext
+import io.element.android.libraries.di.CacheDirectory
 import io.element.android.libraries.network.useragent.UserAgentProvider
 import io.element.android.libraries.sessionstorage.api.SessionData
 import io.element.android.libraries.sessionstorage.api.SessionStore
@@ -32,8 +31,8 @@ import java.io.File
 import javax.inject.Inject
 
 class RustMatrixClientFactory @Inject constructor(
-    @ApplicationContext private val context: Context,
     private val baseDirectory: File,
+    @CacheDirectory private val cacheDirectory: File,
     private val appCoroutineScope: CoroutineScope,
     private val coroutineDispatchers: CoroutineDispatchers,
     private val sessionStore: SessionStore,
@@ -63,7 +62,7 @@ class RustMatrixClientFactory @Inject constructor(
             appCoroutineScope = appCoroutineScope,
             dispatchers = coroutineDispatchers,
             baseDirectory = baseDirectory,
-            baseCacheDirectory = context.cacheDir,
+            baseCacheDirectory = cacheDirectory,
             clock = clock,
         )
     }

samples/minimal/src/main/kotlin/io/element/android/samples/minimal/MainActivity.kt

@@ -49,8 +49,8 @@ class MainActivity : ComponentActivity() {
             sessionStore = sessionStore,
             userAgentProvider = userAgentProvider,
             rustMatrixClientFactory = RustMatrixClientFactory(
-                context = applicationContext,
                 baseDirectory = baseDirectory,
+                cacheDirectory = applicationContext.cacheDir,
                 appCoroutineScope = Singleton.appScope,
                 coroutineDispatchers = Singleton.coroutineDispatchers,
                 sessionStore = sessionStore,