Merge pull request #158 from iot-dsa-v2/develop

a-hansen · web-flow · commit ba80610c3fc7 · 2019-10-09T09:26:13.000-07:00
0.70.4
diff --git a/build.gradle b/build.gradle
@@ -5,7 +5,7 @@ subprojects {
     apply plugin: 'maven'
 
     group 'org.iot-dsa'
-    version '0.70.2'
+    version '0.70.4'
     
     targetCompatibility = JavaVersion.VERSION_1_8
     sourceCompatibility = JavaVersion.VERSION_1_8
diff --git a/dslink-v2-api/src/main/java/org/iot/dsa/dslink/Value.java b/dslink-v2-api/src/main/java/org/iot/dsa/dslink/Value.java
@@ -17,7 +17,6 @@ public interface Value extends Node {
     /**
      * Does not have to be the current value, used to determine the type
      * of the value.
-     * @return
      */
     public DSIValue toValue();
 
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
@@ -6,6 +6,7 @@
 import org.iot.dsa.node.DSIMetadata;
 import org.iot.dsa.node.DSIObject;
 import org.iot.dsa.node.DSIValue;
+import org.iot.dsa.node.DSInfo;
 import org.iot.dsa.node.DSMap;
 import org.iot.dsa.node.DSMetadata;
 
@@ -208,9 +209,15 @@ public int getParameterCount() {
         return -1;
     }
 
+    /**
+     * Puts the metadata from an already added parameter into the bucket, and calls prepareParameter
+     * so that is can be updated for any current state.
+     * @see #prepareParameter(DSInfo, DSMap)
+     */
     @Override
-    public void getParameterMetadata(int idx, DSMap bucket) {
+    public void getParameterMetadata(DSInfo target, int idx, DSMap bucket) {
         bucket.putAll(parameters.get(idx));
+        prepareParameter(target, bucket);
     }
 
     @Override
@@ -228,6 +235,17 @@ public ActionResults invoke(DSIActionRequest request) {
         return null;
     }
 
+    /**
+     * Called for each parameter as it is being sent to the requester in response to a list
+     * request. The intent is to update the default value to represent the current state of the
+     * target.  Does nothing by default.
+     *
+     * @param target    The target of the action.
+     * @param parameter Map representing a single parameter.
+     */
+    public void prepareParameter(DSInfo target, DSMap parameter) {
+    }
+
     /**
      * Sets the action group, which is null by default.
      */
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
@@ -100,17 +100,6 @@ public default ActionResults makeResults(DSIActionRequest req, DSIResults res) {
         return toResults(req, res);
     }
 
-    /**
-     * Called for each parameter as it is being sent to the requester in response to a list
-     * request. The intent is to update the default value to represent the current state of the
-     * target.  Does nothing by default.
-     *
-     * @param target    The info about the target of the action (its parent).
-     * @param parameter Map representing a single parameter.
-     */
-    public default void prepareParameter(DSInfo target, DSMap parameter) {
-    }
-
     /**
      * Makes an aync action result for the given parameters.  If the DIResult defines columns those
      * will be used, otherwise the columns defined by the action will be used.
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
@@ -29,6 +29,7 @@
 import org.iot.dsa.node.DSNode;
 import org.iot.dsa.node.DSPath;
 import org.iot.dsa.node.DSString;
+import org.iot.dsa.node.action.DSIAction;
 import org.iot.dsa.node.event.DSEvent;
 import org.iot.dsa.node.event.DSISubscriber;
 import org.iot.dsa.node.event.DSISubscription;
@@ -451,14 +452,22 @@ private void encodeAction(Action action, DSMap cacheMap) {
                 enqueue("$invokable", "read");
             }
         }
+        DSIAction dsiAction = null;
+        if (action instanceof DSIAction) {
+            dsiAction = (DSIAction) action;
+        }
         e = cacheMap.remove("$params");
         if (e != null) {
             enqueue("$params", e);
         } else {
             DSList list = new DSList();
             for (int i = 0, len = action.getParameterCount(); i < len; i++) {
                 DSMap param = new DSMap();
-                action.getParameterMetadata(i, param);
+                if (dsiAction != null) {
+                    dsiAction.getParameterMetadata(target.getParentInfo(), i, param);
+                } else {
+                    action.getParameterMetadata(i, param);
+                }
                 fixRangeTypes(param);
                 list.add(param);
             }
@@ -471,7 +480,11 @@ private void encodeAction(Action action, DSMap cacheMap) {
             DSList list = new DSList();
             for (int i = 0, len = action.getColumnCount(); i < len; i++) {
                 DSMap col = new DSMap();
-                action.getColumnMetadata(i, col);
+                if (dsiAction != null) {
+                    dsiAction.getColumnMetadata(target.getParentInfo(), i, col);
+                } else {
+                    action.getColumnMetadata(i, col);
+                }
                 fixRangeTypes(col);
                 list.add(col);
             }
diff --git a/dslink-v2/src/main/java/com/acuity/iot/dsa/dslink/sys/logging/LoggerNode.java b/dslink-v2/src/main/java/com/acuity/iot/dsa/dslink/sys/logging/LoggerNode.java
@@ -8,13 +8,13 @@
  */
 public class LoggerNode extends StreamableLogNode {
 
-    private DSInfo levelInfo = getInfo("Log Level");
+    private DSInfo<?> levelInfo = getInfo("Log Level");
     private Logger logger;
 
     public LoggerNode() {
     }
 
-    public DSInfo getLevelInfo() {
+    public DSInfo<?> getLevelInfo() {
         return levelInfo;
     }
 
@@ -29,7 +29,7 @@ public Logger getLoggerObj() {
     protected void declareDefaults() {
         super.declareDefaults();
         declareDefault("Log Level", LoggerNodeLevel.DEFAULT);
-        declareDefault("Stream Log", getStreamLogAction());
+        declareDefault("Stream Log", getStreamLogAction(false));
     }
 
     @Override
@@ -45,7 +45,7 @@ protected void onChildChanged(DSInfo info) {
     @Override
     protected void onStable() {
         super.onStable();
-        DSInfo info = getLevelInfo();
+        DSInfo<?> info = getLevelInfo();
         LoggerNodeLevel level = (LoggerNodeLevel) info.get();
         getLoggerObj().setLevel(level.toLevel());
     }
diff --git a/dslink-v2/src/main/java/com/acuity/iot/dsa/dslink/sys/logging/StreamableLogNode.java b/dslink-v2/src/main/java/com/acuity/iot/dsa/dslink/sys/logging/StreamableLogNode.java
@@ -1,8 +1,11 @@
 package com.acuity.iot.dsa.dslink.sys.logging;
 
+import java.io.PrintWriter;
+import java.io.StringWriter;
 import java.util.LinkedList;
 import java.util.List;
 import java.util.logging.Handler;
+import java.util.logging.Level;
 import java.util.logging.LogRecord;
 import java.util.logging.Logger;
 import org.iot.dsa.dslink.Action.ResultsType;
@@ -17,6 +20,7 @@
 import org.iot.dsa.node.DSString;
 import org.iot.dsa.node.action.DSAction;
 import org.iot.dsa.node.action.DSIActionRequest;
+import org.iot.dsa.time.DSDateTime;
 
 /**
  * @author Daniel Shapiro
@@ -25,36 +29,51 @@ public abstract class StreamableLogNode extends DSNode {
 
     private static DSList levelRange;
 
-    public abstract DSInfo getLevelInfo();
+    public abstract DSInfo<?> getLevelInfo();
 
     public abstract Logger getLoggerObj();
 
-    protected DSAction getStreamLogAction() {
+    protected DSAction getStreamLogAction(boolean isRoot) {
         DSAction act = new DSAction() {
             @Override
             public ActionResults invoke(DSIActionRequest req) {
                 return ((StreamableLogNode) req.getTarget()).startLogStream(req);
             }
         };
+        if (isRoot) {
+            act.addParameter("Log Name", DSString.NULL, "Optional log name to filter by");
+        }
+        act.addDefaultParameter("Log Level", DSLevel.ALL, "Log level filter");
         act.addParameter("Filter", DSString.NULL, "Optional regex filter");
         act.setResultsType(ResultsType.STREAM);
-        act.addColumnMetadata("Log", DSString.NULL).setEditor("textarea");
+        act.addColumnMetadata("Timestamp", DSDateTime.NULL);
+        act.addColumnMetadata("Log Name", DSString.NULL);
+        act.addColumnMetadata("Level", DSLevel.ALL);
+        act.addColumnMetadata("Message", DSString.NULL).setEditor("textarea");
         return act;
     }
 
     private ActionResults startLogStream(final DSIActionRequest req) {
         final Logger loggerObj = getLoggerObj();
+        final String name = req.getParameters().getString("Log Name");
+        final DSLevel level = DSLevel.make(req.getParameters().getString("Log Level"));
         final String filter = req.getParameters().getString("Filter");
-        final List<String> lines = new LinkedList<>();
+        final List<DSList> lines = new LinkedList<>();
         final Handler handler = new DSLogHandler() {
             @Override
             protected void write(LogRecord record) {
-                String line = toString(this, record);
-                if (filter == null || line.matches(filter)) {
+            	String recordName = record.getLoggerName();
+            	Level recordLevel = record.getLevel();
+            	String recordMsg = encodeLogRecord(record);
+                DSDateTime ts = DSDateTime.valueOf(record.getMillis());
+                if (levelMatches(recordLevel, level.toLevel()) && 
+                        (name == null || name.isEmpty() || name.equals(recordName)) &&
+                        (filter == null || filter.isEmpty() || recordMsg.matches(filter))) {
+                    
                     while (lines.size() > 1000) {
                         lines.remove(0);
                     }
-                    lines.add(line);
+                    lines.add(DSList.valueOf(ts.toString(), recordName, DSLevel.valueOf(recordLevel).toString(), recordMsg));
                     req.sendResults();
                 }
             }
@@ -63,17 +82,25 @@ protected void write(LogRecord record) {
         return new ActionResults() {
             @Override
             public int getColumnCount() {
-                return 1;
+                return 4;
             }
 
             @Override
             public void getColumnMetadata(int idx, DSMap bucket) {
-                new DSMetadata(bucket).setName("Record").setType(DSString.NULL);
+                if (idx == 0) {
+                    new DSMetadata(bucket).setName("Timestamp").setType(DSDateTime.NULL);
+                } else if (idx == 1) {
+                    new DSMetadata(bucket).setName("Log Name").setType(DSString.NULL);
+                } else if (idx == 2) {
+                    new DSMetadata(bucket).setName("Level").setType(DSLevel.ALL);
+                } else if (idx == 3) {
+                    new DSMetadata(bucket).setName("Message").setType(DSString.NULL);
+                }
             }
 
             @Override
             public void getResults(DSList bucket) {
-                bucket.add(DSString.valueOf(lines.remove(0)));
+                bucket.addAll(lines.remove(0));
             }
 
             @Override
@@ -93,6 +120,44 @@ public void onClose() {
             }
         };
     }
+    
+    private static String encodeLogRecord(LogRecord record) {
+        StringBuilder builder = new StringBuilder();
+       // class
+        if (record.getSourceClassName() != null) {
+            builder.append(record.getSourceClassName());
+            builder.append(" - ");
+        }
+        // method
+        if (record.getSourceMethodName() != null) {
+            builder.append(record.getSourceMethodName());
+            builder.append(" - ");
+        }
+        // message
+        String msg = record.getMessage();
+        if ((msg != null) && (msg.length() > 0)) {
+            Object[] params = record.getParameters();
+            if (params != null) {
+                msg = String.format(msg, params);
+            }
+            builder.append(msg);
+        }
+        // exception
+        Throwable thrown = record.getThrown();
+        if (thrown != null) {
+            builder.append("\n");
+            StringWriter sw = new StringWriter();
+            PrintWriter pw = new PrintWriter(sw);
+            thrown.printStackTrace(pw);
+            pw.close();
+            builder.append(sw.toString());
+        }
+        return builder.toString();
+    }
+    
+    public static boolean levelMatches(Level msgLevel, Level desiredLevel) {
+        return msgLevel.intValue() >= desiredLevel.intValue();
+    }
 
     static {
         levelRange = new DSList();
diff --git a/dslink-v2/src/main/java/com/acuity/iot/dsa/dslink/sys/logging/SysLogService.java b/dslink-v2/src/main/java/com/acuity/iot/dsa/dslink/sys/logging/SysLogService.java
@@ -22,7 +22,7 @@
  */
 public class SysLogService extends StreamableLogNode {
 
-    private DSInfo levelInfo = getInfo("Default Log Level");
+    private DSInfo<?> levelInfo = getInfo("Default Log Level");
 
     public SysLogService() {
     }
@@ -40,7 +40,7 @@ public Logger getLoggerObj() {
     protected void declareDefaults() {
         super.declareDefaults();
         declareDefault("Add Log", getAddLogAction());
-        declareDefault("Stream All", getStreamLogAction());
+        declareDefault("Stream All", getStreamLogAction(true));
         declareDefault("Default Log Level", DSLevel.valueOf(getRootLevel()))
                 .setTransient(true);
     }
