Store resolved variables by key instead of id

Author: Waboodoo

HTTPShortcuts/app/src/main/kotlin/ch/rmy/android/http_shortcuts/scripting/actions/types/SetVariableAction.kt

@@ -37,7 +37,6 @@ constructor(
     )
 
     companion object {
-
         private const val MAX_VARIABLE_LENGTH = 40_000
     }
 }

HTTPShortcuts/app/src/main/kotlin/ch/rmy/android/http_shortcuts/variables/VariableManager.kt

@@ -16,52 +16,52 @@ class VariableManager(
     var globalVariables = globalVariables
         private set
 
-    private val variablesById: MutableMap<GlobalVariableId, GlobalVariable> = globalVariables.associateBy { it.id }.toMutableMap()
-    private val variablesByKey: MutableMap<VariableKey, GlobalVariable> = globalVariables.associateBy { it.key }.toMutableMap()
-    private val variableValuesById = mutableMapOf<String, String>()
+    private val globalVariablesById: MutableMap<GlobalVariableId, GlobalVariable> = globalVariables.associateBy { it.id }.toMutableMap()
+    private val globalVariablesByKey: MutableMap<VariableKey, GlobalVariable> = globalVariables.associateBy { it.key }.toMutableMap()
+    private val variableValuesByKey = mutableMapOf<VariableKey, String>()
 
     init {
         preResolvedValues.forEach { (variableKeyOrId, value) ->
             val variable = getGlobalVariableByKeyOrId(variableKeyOrId) ?: return@forEach
-            variableValuesById[variable.id] = encodeValue(variable, value)
+            variableValuesByKey[variable.key] = encodeValue(variable, value)
         }
     }
 
     fun getGlobalVariableById(id: GlobalVariableId): GlobalVariable? =
-        variablesById[id]
+        globalVariablesById[id]
 
     fun getGlobalVariableByKey(key: VariableKey): GlobalVariable? =
-        variablesByKey[key]
+        globalVariablesByKey[key]
 
     fun getGlobalVariableByKeyOrId(keyOrId: VariableKeyOrId): GlobalVariable? =
-        if (variablesById.containsKey(keyOrId)) {
+        if (globalVariablesById.containsKey(keyOrId)) {
             getGlobalVariableById(keyOrId)
         } else {
             getGlobalVariableByKey(keyOrId)
         }
 
     fun getGlobalVariableValueById(globalVariableId: GlobalVariableId): String? =
-        variableValuesById[globalVariableId]
+        getGlobalVariableById(globalVariableId)?.key
+            ?.let { variableKey ->
+                getVariableValueByKey(variableKey)
+            }
 
     fun getVariableValueByKey(variableKey: VariableKey): String? =
-        getGlobalVariableByKey(variableKey)?.id
-            ?.let { variableId ->
-                getGlobalVariableValueById(variableId)
-            }
+        variableValuesByKey[variableKey]
 
     fun getVariableValueByKeyOrId(variableKeyOrId: VariableKeyOrId): String? =
-        getGlobalVariableByKeyOrId(variableKeyOrId)?.id
-            ?.let { variableId ->
-                getGlobalVariableValueById(variableId)
+        getGlobalVariableByKeyOrId(variableKeyOrId)?.key
+            ?.let { variableKey ->
+                getVariableValueByKey(variableKey)
             }
 
     fun setGlobalVariableValue(variable: GlobalVariable, value: String, storeOnly: Boolean = false) {
         val newVariable = variable.copy(value = value)
         this@VariableManager.globalVariables = this@VariableManager.globalVariables.map { if (it.id == variable.id) newVariable else it }
-        variablesById[variable.id] = newVariable
-        variablesByKey[variable.key] = newVariable
+        globalVariablesById[variable.id] = newVariable
+        globalVariablesByKey[variable.key] = newVariable
         if (!storeOnly) {
-            variableValuesById[variable.id] = encodeValue(variable, value)
+            variableValuesByKey[variable.key] = encodeValue(variable, value)
         }
     }
 
@@ -73,29 +73,27 @@ class VariableManager(
     }
 
     fun getVariableValuesByIds(): Map<GlobalVariableId, String> =
-        variableValuesById
-
-    fun getVariableValuesByKeys(): Map<VariableKey, String> =
-        variableValuesById
+        variableValuesByKey
             .mapKeys { entry ->
-                getGlobalVariableById(entry.key)!!.key
+                getGlobalVariableByKey(entry.key)!!.id
             }
 
-    fun isResolved(globalVariableId: GlobalVariableId): Boolean =
-        variableValuesById.containsKey(globalVariableId)
+    fun getVariableValuesByKeys(): Map<VariableKey, String> =
+        variableValuesByKey
+
+    fun isResolved(variableKey: VariableKey): Boolean =
+        variableValuesByKey.containsKey(variableKey)
 
-    companion object {
-        internal fun encodeValue(variable: GlobalVariable, value: String) =
-            value
-                .runIf(variable.jsonEncode) {
-                    JSONObject.quote(this).drop(1).dropLast(1)
-                }
-                .runIf(variable.urlEncode) {
-                    try {
-                        URLEncoder.encode(this, "utf-8")
-                    } catch (_: UnsupportedEncodingException) {
-                        this
-                    }
+    private fun encodeValue(variable: GlobalVariable, value: String) =
+        value
+            .runIf(variable.jsonEncode) {
+                JSONObject.quote(this).drop(1).dropLast(1)
+            }
+            .runIf(variable.urlEncode) {
+                try {
+                    URLEncoder.encode(this, "utf-8")
+                } catch (_: UnsupportedEncodingException) {
+                    this
                 }
-    }
+            }
 }

HTTPShortcuts/app/src/main/kotlin/ch/rmy/android/http_shortcuts/variables/VariableResolver.kt

@@ -24,7 +24,8 @@ constructor(
     ) {
         requiredGlobalVariableIds
             .filter { globalVariableId ->
-                !variableManager.isResolved(globalVariableId)
+                val globalVariable = variableManager.getGlobalVariableById(globalVariableId)
+                globalVariable != null && !variableManager.isResolved(globalVariable.key)
             }
             .toSet()
             .let { globalVariableIds ->
@@ -44,7 +45,7 @@ constructor(
         if (recursionDepth >= MAX_RECURSION_DEPTH) {
             return
         }
-        if (variableManager.isResolved(globalVariable.id)) {
+        if (variableManager.isResolved(globalVariable.key)) {
             return
         }
 

HTTPShortcuts/app/src/test/kotlin/ch/rmy/android/http_shortcuts/variables/VariableResolverTest.kt

@@ -176,7 +176,7 @@ class VariableResolverTest {
             listOf(
                 variable(id = "123", key = "myVariable1", value = "Hello {{789}}"),
                 variable(id = "456", key = "myVariable2", value = "!!!"),
-                variable(id = "789", key = "myVariable2", value = "World"),
+                variable(id = "789", key = "myVariable3", value = "World"),
             ),
         )
         VariableResolver(variableTypeFactory)
@@ -206,7 +206,7 @@ class VariableResolverTest {
             listOf(
                 variable(id = "123", key = "myVariable1", value = "Hello {{456}}"),
                 variable(id = "456", key = "myVariable2", value = "World{{789}}"),
-                variable(id = "789", key = "myVariable2", value = "!!!"),
+                variable(id = "789", key = "myVariable3", value = "!!!"),
             ),
         )
         VariableResolver(variableTypeFactory)