[nrf noup] [android] Fix crash on DoorLock.lockDoor command

Cluster Interaction Tool screen would crash when trying to send a command that takes an optional argument. The reason was that optional arguments were incorrectly converted in the application and the underlying JNI layer. Signed-off-by: Damian Krolik <[email protected]>
project-chip · Jun 6, 2022 · ab8581d · ab8581d
1 parent 29e7dbd
commit ab8581d
Show file tree

Hide file tree

Showing 9 changed files with 518 additions and 504 deletions.
diff --git a/scripts/idl/generators/java/ChipClustersCpp.jinja b/scripts/idl/generators/java/ChipClustersCpp.jinja
@@ -1,14 +1,16 @@
 {%- macro encode_optional(target, source, depth, encodable) -%}
-  if ({{source}} != nullptr) {
-    jobject optionalValue_{{depth}};
+  {
+    jobject optionalValue_{{depth}} = nullptr;
     chip::JniReferences::GetInstance().GetOptionalValue({{source}}, optionalValue_{{depth}});
-    auto & definedValue_{{depth}} = {{target}}.Emplace();
-    {{ encode_value(
-       "definedValue_{}".format(depth),
-       "optionalValue_{}".format(depth),
-       depth+1,
-       encodable.without_optional()
-    )}}
+    if (optionalValue_{{depth}}) {
+      auto & definedValue_{{depth}} = {{target}}.Emplace();
+      {{ encode_value(
+          "definedValue_{}".format(depth),
+          "optionalValue_{}".format(depth),
+          depth+1,
+          encodable.without_optional()
+      )}}
+    }
   }
 {%- endmacro %}
 

diff --git a/...n/java/com/google/chip/chiptool/clusterclient/clusterinteraction/ClusterDetailFragment.kt b/...n/java/com/google/chip/chiptool/clusterclient/clusterinteraction/ClusterDetailFragment.kt
@@ -45,6 +45,8 @@ import kotlinx.coroutines.Dispatchers
 import kotlinx.coroutines.Job
 import kotlinx.coroutines.cancel
 import kotlinx.coroutines.launch
+import java.util.*
+import kotlin.collections.HashMap
 
 /**
  * ClusterDetailFragment allows user to pick cluster, command, specify parameters and see
@@ -135,15 +137,15 @@ class ClusterDetailFragment : Fragment() {
       )
       parameterList.forEach {
         val parameterName = it.clusterParameterNameTv.text.toString()
-        val castType =
-          selectedInteractionInfo.commandParameters[parameterName]!!.type
-        val data = castStringToType(it.clusterParameterData.text.toString(), castType)!!
+        val parameterType = selectedInteractionInfo.commandParameters[parameterName]!!.type
+        val parameterUnderlyingType = selectedInteractionInfo.commandParameters[parameterName]!!.underlyingType
+        val data = castStringToType(it.clusterParameterData.text.toString(), parameterType, parameterUnderlyingType)!!
         commandArguments[it.clusterParameterNameTv.text.toString()] = data
         clusterInteractionHistoryList[0].parameterList.add(
           HistoryParameterInfo(
             parameterName,
             data.toString(),
-            castType
+            parameterUnderlyingType
           )
         )
       }
@@ -185,12 +187,13 @@ class ClusterDetailFragment : Fragment() {
     }
   }
 
-  private fun castStringToType(data: String, type: Class<*>): Any? {
+  private fun castStringToType(data: String, type: Class<*>, underlyingType: Class<*>): Any? {
     return when (type) {
       Int::class.java -> data.toInt()
       Boolean::class.java -> data.toBoolean()
       ByteArray::class.java -> data.encodeToByteArray()
       Long::class.java -> data.toLong()
+      Optional::class.java -> if (data.isEmpty()) Optional.empty() else Optional.of(castStringToType(data, underlyingType, underlyingType)!!)
       else -> data
     }
   }

diff --git a/src/controller/java/src/chip/clusterinfo/CommandParameterInfo.java b/src/controller/java/src/chip/clusterinfo/CommandParameterInfo.java
@@ -4,11 +4,17 @@
 public class CommandParameterInfo {
   public CommandParameterInfo() {}
 
-  public CommandParameterInfo(String name, Class<?> type) {
+  /*
+   * If 'type' is a complex type, such as ArrayList or Optional, 'underlyingType'
+   * stores information about the wrapped or element type.
+   */
+  public CommandParameterInfo(String name, Class<?> type, Class<?> underlyingType) {
     this.name = name;
     this.type = type;
+    this.underlyingType = underlyingType;
   }
 
   public String name;
   public Class<?> type;
+  public Class<?> underlyingType;
 }
diff --git a/src/controller/java/templates/ClusterInfo-java.zapt b/src/controller/java/templates/ClusterInfo-java.zapt
@@ -307,7 +307,7 @@ public class ClusterInfoMapping {
      {{#chip_cluster_command_arguments}}
      {{#if_is_struct type}}
      {{else}}
-       CommandParameterInfo {{asLowerCamelCase ../../name}}{{asLowerCamelCase ../name}}{{asLowerCamelCase label}}CommandParameterInfo = new CommandParameterInfo("{{asLowerCamelCase label}}", {{asJavaType type null parent.parent.name removeGenericType=true}}.class);
+       CommandParameterInfo {{asLowerCamelCase ../../name}}{{asLowerCamelCase ../name}}{{asLowerCamelCase label}}CommandParameterInfo = new CommandParameterInfo("{{asLowerCamelCase label}}", {{asJavaType type null parent.parent.name removeGenericType=true}}.class, {{asJavaType type null parent.parent.name underlyingType=true}}.class);
        {{asLowerCamelCase ../../name}}{{asLowerCamelCase ../name}}CommandParams.put("{{asLowerCamelCase label}}",{{asLowerCamelCase ../../name}}{{asLowerCamelCase ../name}}{{asLowerCamelCase label}}CommandParameterInfo);
      {{#not_last}} {{/not_last}}
      {{/if_is_struct}}

diff --git a/src/controller/java/templates/ClusterInfo-write-interaction.zapt b/src/controller/java/templates/ClusterInfo-write-interaction.zapt
@@ -21,7 +21,7 @@ public class ClusterWriteMapping {
         {{#if isWritableAttribute}}
         {{#unless isArray}}
         Map<String, CommandParameterInfo> write{{asUpperCamelCase ../name}}{{asUpperCamelCase name}}CommandParams = new LinkedHashMap<String, CommandParameterInfo>();
-        CommandParameterInfo {{asLowerCamelCase ../name}}{{asLowerCamelCase name}}CommandParameterInfo = new CommandParameterInfo("value", {{asJavaType type null parent.parent.name removeGenericType=true}}.class);
+        CommandParameterInfo {{asLowerCamelCase ../name}}{{asLowerCamelCase name}}CommandParameterInfo = new CommandParameterInfo("value", {{asJavaType type null parent.parent.name removeGenericType=true}}.class, {{asJavaType type null parent.parent.name underlyingType=true}}.class);
         write{{asUpperCamelCase ../name}}{{asUpperCamelCase name}}CommandParams.put("value",{{asLowerCamelCase ../name}}{{asLowerCamelCase name}}CommandParameterInfo);
         InteractionInfo write{{asUpperCamelCase ../name}}{{asUpperCamelCase name}}AttributeInteractionInfo = new InteractionInfo(
           (cluster, callback, commandArguments) -> {

diff --git a/src/controller/java/templates/helper.js b/src/controller/java/templates/helper.js
@@ -217,24 +217,26 @@ async function asJavaType(type, zclType, cluster, options)
     classType += asJavaBoxedType(type, zclType);
   }
 
-  if (!options.hash.forceNotList && (this.isArray || this.entryType)) {
-    if (!options.hash.removeGenericType) {
-      classType = 'ArrayList<' + classType + '>';
-    } else {
-      classType = 'ArrayList';
+  if (!options.hash.underlyingType) {
+    if (!options.hash.forceNotList && (this.isArray || this.entryType)) {
+      if (!options.hash.removeGenericType) {
+        classType = 'ArrayList<' + classType + '>';
+      } else {
+        classType = 'ArrayList';
+      }
     }
-  }
 
-  if (this.isOptional) {
-    if (!options.hash.removeGenericType) {
-      classType = 'Optional<' + classType + '>';
-    } else {
-      classType = 'Optional';
+    if (this.isOptional) {
+      if (!options.hash.removeGenericType) {
+        classType = 'Optional<' + classType + '>';
+      } else {
+        classType = 'Optional';
+      }
     }
-  }
 
-  if (this.isNullable && options.hash.includeAnnotations) {
-    classType = '@Nullable ' + classType;
+    if (this.isNullable && options.hash.includeAnnotations) {
+      classType = '@Nullable ' + classType;
+    }
   }
 
   return classType;