From 4bd7b0a819d9f85f8d06374b63e30ca4679ff262 Mon Sep 17 00:00:00 2001
From: ogaclejapan <ogaclejapan@gmail.com>
Date: Sun, 24 Nov 2024 08:56:57 +0900
Subject: [PATCH] Add Namespace Extension Property `autoCompositionKeyHash`

In #115 and #116, we introduced the `auto` extension function to assist with the automatic generation of unique namespaces for Mutations and Subscriptions.
This PR adds an alternative that allows the use of a value calculated from `currentCompositionKeyHash` instead of the
`auto` function, but only within a Composable function limited to a single key.
---
 .../compose/RememberExampleSubscription.kt    |  4 +--
 .../query/compose/util/NamespaceGeneration.kt | 36 ++++++++++++++++---
 2 files changed, 34 insertions(+), 6 deletions(-)

diff --git a/internal/playground/src/commonMain/kotlin/soil/playground/query/compose/RememberExampleSubscription.kt b/internal/playground/src/commonMain/kotlin/soil/playground/query/compose/RememberExampleSubscription.kt
index 3c50b28..6fe1d9e 100644
--- a/internal/playground/src/commonMain/kotlin/soil/playground/query/compose/RememberExampleSubscription.kt
+++ b/internal/playground/src/commonMain/kotlin/soil/playground/query/compose/RememberExampleSubscription.kt
@@ -5,13 +5,13 @@ import soil.playground.query.key.ExampleSubscriptionKey
 import soil.query.annotation.ExperimentalSoilQueryApi
 import soil.query.compose.SubscriptionObject
 import soil.query.compose.rememberSubscription
-import soil.query.compose.util.auto
+import soil.query.compose.util.autoCompositionKeyHash
 import soil.query.core.Namespace
 
 @OptIn(ExperimentalSoilQueryApi::class)
 @Composable
 fun rememberExampleSubscription(): SubscriptionObject<String> {
     return rememberSubscription(
-        key = ExampleSubscriptionKey(Namespace.auto())
+        key = ExampleSubscriptionKey(Namespace.autoCompositionKeyHash)
     )
 }
diff --git a/soil-query-compose/src/commonMain/kotlin/soil/query/compose/util/NamespaceGeneration.kt b/soil-query-compose/src/commonMain/kotlin/soil/query/compose/util/NamespaceGeneration.kt
index 702c638..37128a4 100644
--- a/soil-query-compose/src/commonMain/kotlin/soil/query/compose/util/NamespaceGeneration.kt
+++ b/soil-query-compose/src/commonMain/kotlin/soil/query/compose/util/NamespaceGeneration.kt
@@ -4,6 +4,7 @@
 package soil.query.compose.util
 
 import androidx.compose.runtime.Composable
+import androidx.compose.runtime.currentCompositeKeyHash
 import androidx.compose.runtime.saveable.Saver
 import androidx.compose.runtime.saveable.rememberSaveable
 import soil.query.core.Namespace
@@ -22,7 +23,34 @@ fun Namespace.Companion.auto(): Namespace {
 }
 
 internal val Namespace.Companion.Saver
-    get() = Saver<Namespace, String>(
-        save = { it.value },
-        restore = { Namespace(it) }
-    )
+    get() = Saver<Namespace, String>(save = { it.value }, restore = { Namespace(it) })
+
+
+/**
+ * Automatically generated value for `mutationId` and `subscriptionId`.
+ *
+ * This property is useful for generating a unique namespace when a key,
+ * such as `MutationKey` or `SubscriptionKey`, is used within a single Composable function.
+ *
+ * **NOTE:**
+ * This property must only be used within a Composable function restricted to a single key
+ * (either Mutation or Subscription). It is intended to be used in a custom Composable function
+ * dedicated to handling a single key. For other use cases, it is recommended to use the [auto] function.
+ *
+ * Example:
+ * ```kotlin
+ * @Composable
+ * fun rememberCreatePost(): MutationObject<Post> {
+ *     return rememberMutation(CreatePostKey(Namespace.autoCompositionKeyHash))
+ * }
+ * ```
+ */
+val Namespace.Companion.autoCompositionKeyHash: Namespace
+    @Composable
+    get() {
+        val keyHash = currentCompositeKeyHash.toString(MaxSupportedRadix)
+        return Namespace("auto/$keyHash")
+    }
+
+// https://cs.android.com/androidx/platform/frameworks/support/+/androidx-main:compose/runtime/runtime-saveable/src/commonMain/kotlin/androidx/compose/runtime/saveable/RememberSaveable.kt?q=MaxSupportedRadix
+private const val MaxSupportedRadix: Int = 36