0.70.7

a-hansen · web-flow · commit 874b27bdded2 · 2019-10-15T07:41:48.000-07:00
* Fix potential NPE with action parameters.
* Fix potential NPE with list.
* Make DSElementType a DSIEnum, rework how typing is handled with list.
* More generic notation in the public api.
diff --git a/dslink-v2-api/src/main/java/org/iot/dsa/dslink/ActionRequest.java b/dslink-v2-api/src/main/java/org/iot/dsa/dslink/ActionRequest.java
@@ -27,7 +27,11 @@ public interface ActionRequest {
      * A convenience for getting a single parameter out of the parameters map.
      */
     public default DSElement getParameter(String key) {
-        return getParameters().get(key);
+        DSMap map = getParameters();
+        if (map == null) {
+            return null;
+        }
+        return map.get(key);
     }
 
     /**
diff --git a/dslink-v2-api/src/main/java/org/iot/dsa/node/DSElementType.java b/dslink-v2-api/src/main/java/org/iot/dsa/node/DSElementType.java
@@ -1,11 +1,14 @@
 package org.iot.dsa.node;
 
+import java.util.HashMap;
+import java.util.Map;
+
 /**
  * The primitive types of the SDK.
  *
  * @author Aaron Hansen
  */
-public enum DSElementType {
+public enum DSElementType implements DSIEnum, DSIValue {
 
     BOOLEAN,
     BYTES,
@@ -16,13 +19,76 @@ public enum DSElementType {
     NULL,
     STRING;
 
-    private String display;
+    private static Map<String, DSElementType> nameMap;
+    private DSString display;
 
-    public String toString() {
+    @Override
+    public DSIObject copy() {
+        return this;
+    }
+
+    @Override
+    public DSList getEnums(DSList bucket) {
+        if (bucket == null) {
+            bucket = new DSList();
+        }
+        for (DSElementType e : values()) {
+            bucket.add(e.toElement());
+        }
+        return bucket;
+    }
+
+    @Override
+    public DSValueType getValueType() {
+        return DSValueType.ENUM;
+    }
+
+    @Override
+    public boolean isNull() {
+        return false;
+    }
+
+    /**
+     * Returns a DSString representation of the name() in lowercase.
+     */
+    @Override
+    public DSElement toElement() {
         if (display == null) {
-            display = name().toLowerCase();
+            display = DSString.valueOf(name().toLowerCase());
         }
         return display;
     }
 
+    public String toString() {
+        return toElement().toString();
+    }
+
+    /**
+     * Unlike Enum.valueOf, this will handle the lowercase display.
+     */
+    public static DSElementType valueFor(String type) {
+        DSElementType ret = nameMap.get(type);
+        return ret == null ? NULL : ret;
+    }
+
+    @Override
+    public DSElementType valueOf(DSElement element) {
+        DSElementType ret = nameMap.get(element.toString());
+        return ret == null ? NULL : ret;
+    }
+
+    static {
+        DSRegistry.registerDecoder(DSElementType.class, BOOLEAN);
+        nameMap = new HashMap<>();
+        for (DSElementType e : values()) {
+            nameMap.put(e.name(), e);
+            nameMap.put(e.toString(), e);
+        }
+        //DSA types
+        nameMap.put("bool", BOOLEAN);
+        nameMap.put("number", DOUBLE);
+        nameMap.put("array", LIST);
+        nameMap.put("binary", BYTES);
+        nameMap.put("dynamic", NULL);
+    }
 }
diff --git a/dslink-v2-api/src/main/java/org/iot/dsa/node/DSMetadata.java b/dslink-v2-api/src/main/java/org/iot/dsa/node/DSMetadata.java
@@ -370,11 +370,9 @@ public DSMetadata setPrecision(DSLong arg) {
      * Sets the type and if the given implements DSIMetadata, adds it's metadata as well.
      */
     public DSMetadata setType(DSIValue arg) {
-        if (arg != null) {
-            map.put(TYPE, arg.getValueType().toString());
-        }
+        map.put(DSMetadata.TYPE, arg.toElement().getElementType().toString());
         if (arg instanceof DSIMetadata) {
-            ((DSIMetadata)arg).getMetadata(map);
+            ((DSIMetadata) arg).getMetadata(map);
         }
         return this;
     }
@@ -383,9 +381,7 @@ public DSMetadata setType(DSIValue arg) {
      * The type for action parameters, can be used to override types in the responder api.
      */
     public DSMetadata setType(DSValueType arg) {
-        if (arg != null) {
-            map.put(TYPE, arg.toString());
-        }
+        map.put(TYPE, arg.toString());
         return this;
     }
 
diff --git a/dslink-v2-api/src/main/java/org/iot/dsa/node/action/DSAction.java b/dslink-v2-api/src/main/java/org/iot/dsa/node/action/DSAction.java
@@ -215,7 +215,7 @@ public int getParameterCount() {
      * @see #prepareParameter(DSInfo, DSMap)
      */
     @Override
-    public void getParameterMetadata(DSInfo target, int idx, DSMap bucket) {
+    public void getParameterMetadata(DSInfo<?> target, int idx, DSMap bucket) {
         bucket.putAll(parameters.get(idx));
         prepareParameter(target, bucket);
     }
@@ -243,7 +243,7 @@ public ActionResults invoke(DSIActionRequest request) {
      * @param target    The target of the action.
      * @param parameter Map representing a single parameter.
      */
-    public void prepareParameter(DSInfo target, DSMap parameter) {
+    public void prepareParameter(DSInfo<?> target, DSMap parameter) {
     }
 
     /**
diff --git a/dslink-v2-api/src/main/java/org/iot/dsa/node/action/DSIAction.java b/dslink-v2-api/src/main/java/org/iot/dsa/node/action/DSIAction.java
@@ -26,7 +26,7 @@ public interface DSIAction extends Action, DSIObject {
      *
      * @see Action#getColumnCount()
      */
-    public default int getColumnCount(DSInfo target) {
+    public default int getColumnCount(DSInfo<?> target) {
         return getColumnCount();
     }
 
@@ -36,7 +36,7 @@ public default int getColumnCount(DSInfo target) {
      *
      * @see Action#getColumnMetadata(int, DSMap)
      */
-    public default void getColumnMetadata(DSInfo target, int idx, DSMap bucket) {
+    public default void getColumnMetadata(DSInfo<?> target, int idx, DSMap bucket) {
         getColumnMetadata(idx, bucket);
     }
 
@@ -46,7 +46,7 @@ public default void getColumnMetadata(DSInfo target, int idx, DSMap bucket) {
      *
      * @see Action#getParameterCount()
      */
-    public default int getParameterCount(DSInfo target) {
+    public default int getParameterCount(DSInfo<?> target) {
         return getParameterCount();
     }
 
@@ -56,7 +56,7 @@ public default int getParameterCount(DSInfo target) {
      *
      * @see Action#getParameterMetadata(int, DSMap)
      */
-    public default void getParameterMetadata(DSInfo target, int idx, DSMap bucket) {
+    public default void getParameterMetadata(DSInfo<?> target, int idx, DSMap bucket) {
         getParameterMetadata(idx, bucket);
     }
 
diff --git a/dslink-v2-api/src/main/java/org/iot/dsa/node/action/DSIActionRequest.java b/dslink-v2-api/src/main/java/org/iot/dsa/node/action/DSIActionRequest.java
@@ -19,7 +19,7 @@ public default DSIAction getAction() {
     /**
      * The info for the action being invoked.
      */
-    public DSInfo getActionInfo();
+    public DSInfo<DSIAction> getActionInfo();
 
     /**
      * The target of the action, such as a node or value.
@@ -31,6 +31,6 @@ public default DSIObject getTarget() {
     /**
      * The target info of the action, such as a node or value.
      */
-    public DSInfo getTargetInfo();
+    public DSInfo<?> getTargetInfo();
 
 }
diff --git a/dslink-v2-api/src/main/java/org/iot/dsa/node/action/DuplicateAction.java b/dslink-v2-api/src/main/java/org/iot/dsa/node/action/DuplicateAction.java
@@ -46,7 +46,7 @@ public ActionResults invoke(DSIActionRequest request) {
     }
 
     @Override
-    public void prepareParameter(DSInfo target, DSMap parameter) {
+    public void prepareParameter(DSInfo<?> target, DSMap parameter) {
         parameter.put(DSMetadata.DEFAULT, target.getName());
     }
 
diff --git a/dslink-v2-api/src/main/java/org/iot/dsa/node/action/RenameAction.java b/dslink-v2-api/src/main/java/org/iot/dsa/node/action/RenameAction.java
@@ -46,7 +46,7 @@ public ActionResults invoke(DSIActionRequest request) {
     }
 
     @Override
-    public void prepareParameter(DSInfo target, DSMap parameter) {
+    public void prepareParameter(DSInfo<?> target, DSMap parameter) {
         parameter.put(DSMetadata.DEFAULT, target.getName());
     }
 
diff --git a/dslink-v2-api/src/main/java/org/iot/dsa/table/DSIResultsCursor.java b/dslink-v2-api/src/main/java/org/iot/dsa/table/DSIResultsCursor.java
@@ -8,7 +8,8 @@
 public interface DSIResultsCursor extends DSIResults {
 
     /**
-     * Returns true when the cursor
+     * The cursor must start before the first row of results.  If there is another row, this
+     * should advance the cursor and return true.  Otherwise return false.
      */
     public boolean next();
 
diff --git a/dslink-v2/src/main/java/com/acuity/iot/dsa/dslink/protocol/responder/DSInboundList.java b/dslink-v2/src/main/java/com/acuity/iot/dsa/dslink/protocol/responder/DSInboundList.java
@@ -18,6 +18,7 @@
 import org.iot.dsa.dslink.responder.InboundListRequest;
 import org.iot.dsa.dslink.responder.ListCloseHandler;
 import org.iot.dsa.node.DSElement;
+import org.iot.dsa.node.DSElementType;
 import org.iot.dsa.node.DSIEnum;
 import org.iot.dsa.node.DSIMetadata;
 import org.iot.dsa.node.DSIValue;
@@ -35,6 +36,7 @@
 import org.iot.dsa.node.event.DSISubscription;
 import org.iot.dsa.time.DSDateTime;
 import org.iot.dsa.util.DSException;
+import org.iot.dsa.util.DSUtil;
 
 /**
  * List implementation for a responder.
@@ -609,19 +611,38 @@ private void encodeTargetMetadata(DSMap metadata) {
     }
 
     private DSElement encodeType(DSIValue value, DSMetadata meta) {
-        String type = meta.getType();
-        if (getResponder().isV1()) {
-            if ((type == null) && (value != null)) {
-                meta.setType(value);
-            }
-        } else {
-            if ((type == null) && (value != null)) {
-                if (value instanceof DSIEnum) {
-                    meta.setType(DSString.NULL);
-                } else {
-                    meta.setType(value);
-                }
-            }
+        String orig = meta.getType();
+        String type = orig;
+        if ((type == null) && (value != null)) {
+            meta.setType(value);
+            type = meta.getType();
+        }
+        DSElementType et = DSElementType.valueFor(type);
+        switch (et) {
+            case BOOLEAN:
+                type = "bool";
+                break;
+            case DOUBLE:
+            case LONG:
+                type = "number";
+                break;
+            case LIST:
+                type = "array";
+                break;
+            case MAP:
+                type = "map";
+                break;
+            case BYTES:
+                type = "binary";
+                break;
+            case STRING:
+                type = "string";
+                break;
+            default:
+                type = "dynamic";
+        }
+        if (!DSUtil.equal(orig, type)) {
+            cacheMap.put(DSMetadata.TYPE, DSString.valueOf(type));
         }
         fixRangeTypes(meta.getMap());
         DSElement e = cacheMap.remove(DSMetadata.TYPE);
@@ -678,7 +699,7 @@ private void encodeValue(Value object) {
         cacheMap.clear();
         DSIValue val = object.toValue();
         if (val instanceof DSIMetadata) {
-            ((DSIMetadata)val).getMetadata(cacheMap);
+            ((DSIMetadata) val).getMetadata(cacheMap);
         }
         object.getMetadata(cacheMap);
         DSElement e = cacheMap.remove("$is");
diff --git a/dslink-v2/src/main/java/com/acuity/iot/dsa/dslink/protocol/v1/requester/DS1Requester.java b/dslink-v2/src/main/java/com/acuity/iot/dsa/dslink/protocol/v1/requester/DS1Requester.java
@@ -73,15 +73,13 @@ private void handleError(DSOutboundStub stub, DSElement details) {
                 String detail = null;
                 DSMap map = details.toMap();
                 String tmp = map.getString("type");
-                if (tmp == null) {
-                    type = ErrorType.internalError;
-                } else if (tmp.equals("permissionDenied")) {
+                if ("permissionDenied".equals(tmp)) {
                     type = ErrorType.permissionDenied;
-                } else if (tmp.equals("invalidRequest")) {
+                } else if ("invalidRequest".equals(tmp)) {
                     type = ErrorType.badRequest;
-                } else if (tmp.equals("invalidPath")) {
+                } else if ("invalidPath".equals(tmp)) {
                     type = ErrorType.badRequest;
-                } else if (tmp.equals("notSupported")) {
+                } else if ("notSupported".equals(tmp)) {
                     type = ErrorType.notSupported;
                 } else {
                     type = ErrorType.internalError;

Original file line number	Diff line number	Diff line change
`@@ -26,7 +26,7 @@ public interface DSIAction extends Action, DSIObject {`
`26`	`26`	`*`
`27`	`27`	`* @see Action#getColumnCount()`
`28`	`28`	`*/`
`29`		`- public default int getColumnCount(DSInfo target) {`
	`29`	`+ public default int getColumnCount(DSInfo<?> target) {`
`30`	`30`	`return getColumnCount();`
`31`	`31`	`}`
`32`	`32`
`@@ -36,7 +36,7 @@ public default int getColumnCount(DSInfo target) {`
`36`	`36`	`*`
`37`	`37`	`* @see Action#getColumnMetadata(int, DSMap)`
`38`	`38`	`*/`
`39`		`- public default void getColumnMetadata(DSInfo target, int idx, DSMap bucket) {`
	`39`	`+ public default void getColumnMetadata(DSInfo<?> target, int idx, DSMap bucket) {`
`40`	`40`	`getColumnMetadata(idx, bucket);`
`41`	`41`	`}`
`42`	`42`
`@@ -46,7 +46,7 @@ public default void getColumnMetadata(DSInfo target, int idx, DSMap bucket) {`
`46`	`46`	`*`
`47`	`47`	`* @see Action#getParameterCount()`
`48`	`48`	`*/`
`49`		`- public default int getParameterCount(DSInfo target) {`
	`49`	`+ public default int getParameterCount(DSInfo<?> target) {`
`50`	`50`	`return getParameterCount();`
`51`	`51`	`}`
`52`	`52`
`@@ -56,7 +56,7 @@ public default int getParameterCount(DSInfo target) {`
`56`	`56`	`*`
`57`	`57`	`* @see Action#getParameterMetadata(int, DSMap)`
`58`	`58`	`*/`
`59`		`- public default void getParameterMetadata(DSInfo target, int idx, DSMap bucket) {`
	`59`	`+ public default void getParameterMetadata(DSInfo<?> target, int idx, DSMap bucket) {`
`60`	`60`	`getParameterMetadata(idx, bucket);`
`61`	`61`	`}`
`62`	`62`
Original file line number	Diff line number	Diff line change
`@@ -46,7 +46,7 @@ public ActionResults invoke(DSIActionRequest request) {`
`46`	`46`	`}`
`47`	`47`
`48`	`48`	`@Override`
`49`		`- public void prepareParameter(DSInfo target, DSMap parameter) {`
	`49`	`+ public void prepareParameter(DSInfo<?> target, DSMap parameter) {`
`50`	`50`	`parameter.put(DSMetadata.DEFAULT, target.getName());`
`51`	`51`	`}`
`52`	`52`