feat: live log args (#18)

Author: BFergerson

src/control/ContextReceiver.ts

@@ -8,6 +8,7 @@ import {Debugger} from "inspector";
 import VariableUtil from "../util/VariableUtil";
 import ProbeMemory from "../ProbeMemory";
 import SourcePlusPlus from "../SourcePlusPlus";
+import LiveLog from "../model/instruments/LiveLog";
 
 const debugLog = (...args: any[]) => SourcePlusPlus.debugLog(args);
 
@@ -25,7 +26,7 @@ namespace ContextReceiver {
         for (let scope in variables) {
             for (let variable of variables[scope]) {
                 if (variable.name === varName) {
-                    return variable;
+                    return variable.value?.value;
                 }
             }
         }
@@ -113,18 +114,25 @@ namespace ContextReceiver {
         }
     }
 
-    export function applyLog(liveLogId: string, logFormat: string, logArguments: any) {
-        debugLog(`applyLog: ${liveLogId} ${logFormat} ${logArguments}`);
+    export function applyLog(liveLog: LiveLog, variables) {
+        debugLog(`applyLog: ${liveLog.id} ${liveLog.logFormat}`);
+
+        if (liveLog.throttle.isRateLimited()) {
+            return;
+        } else {
+            //todo: eval condition
+        }
+
         let logTags = new LogTags();
-        logTags.addData(new KeyStringValuePair().setKey('log_id').setValue(liveLogId));
+        logTags.addData(new KeyStringValuePair().setKey('log_id').setValue(liveLog.id));
         logTags.addData(new KeyStringValuePair().setKey('level').setValue('Live'));
         logTags.addData(new KeyStringValuePair().setKey('thread').setValue('n/a'));
 
-        if (logArguments) {
-            for (const varName in logArguments) {
+        if (liveLog.logArguments) {
+            for (const varIndex in liveLog.logArguments) {
                 logTags.addData(new KeyStringValuePair()
-                    .setKey(`argument.${varName}`)
-                    .setValue(logArguments[varName]));
+                    .setKey(`argument.${varIndex}`)
+                    .setValue(tryFindVariable(liveLog.logArguments[varIndex], variables).toString() || 'undefined'));
             }
         }
 
@@ -135,7 +143,7 @@ namespace ContextReceiver {
             .setServiceinstance("TODO") // TODO: Config
             .setBody(new LogDataBody()
                 .setType("text")
-                .setText(new TextLog().setText(logFormat))
+                .setText(new TextLog().setText(liveLog.logFormat))
             )
             .setTracecontext(new TraceContext()
                 .setTraceid(swContext.segment.relatedTraces[0].toString())

src/control/LiveInstrumentRemote.ts

@@ -161,9 +161,8 @@ export default class LiveInstrumentRemote {
                                 } else if (instrument.type == LiveInstrumentType.LOG) {
                                     let logInstrument = <LiveLog>instrument;
                                     ContextReceiver.applyLog(
-                                        instrument.id,
-                                        logInstrument.logFormat,
-                                        data[i].logArguments
+                                        logInstrument,
+                                        variables
                                     );
                                 } else if (instrument.type == LiveInstrumentType.METER) {
                                     let meterInstrument = <LiveMeter>instrument;

src/model/instruments/LiveLog.ts

@@ -21,7 +21,7 @@ export default class LiveLog extends LiveInstrument {
                 if (${this.condition}) { 
                     let data = {success: true}; 
                     (data => {${logArgumentsExpression}})(data); 
-                    returndata; 
+                    return data; 
                 } else { 
                     return {success: false}; 
                 }

test/LiveLogArgsTest.js

@@ -0,0 +1,48 @@
+const assert = require('assert');
+const TestUtils = require("./TestUtils.js");
+
+module.exports = function () {
+    function simplePrimitives() {
+        let i = 1
+        TestUtils.addLineLabel("done", () => TestUtils.getLineNumber())
+    }
+
+    it('add live log with args', async function () {
+        simplePrimitives() //setup labels
+
+        await TestUtils.addLiveLog({
+            "source": TestUtils.getFilename()(),
+            "line": TestUtils.getLineLabelNumber("done")
+        }, null, 1, "arg i = {}", ["i"]).then(function (res) {
+            assert.equal(res.status, 200);
+            simplePrimitives(); //trigger breakpoint
+        }).catch(function (err) {
+            assert.fail(err)
+        });
+    });
+
+    it('verify log data', async function () {
+        this.timeout(2000)
+
+        setTimeout(() => simplePrimitives(), 1000);
+
+        let event = await TestUtils.awaitMarkerEvent("LOG_HIT");
+        let logResult = event.logResult
+        assert.notEqual(logResult, undefined);
+
+        let logs = logResult.logs
+        assert.notEqual(logs, undefined);
+        assert.equal(logs.length, 1);
+
+        let log = logs[0]
+        assert.notEqual(log, undefined);
+        assert.equal(log.content, "arg i = {}");
+
+        let args = log.arguments
+        assert.notEqual(args, undefined);
+        assert.equal(args.length, 1);
+
+        let arg = args[0]
+        assert.equal(arg, "1");
+    });
+};

test/test.js

@@ -7,4 +7,5 @@ describe("test breakpoint after breakpoint", require("./BreakpointAfterBreakpoin
 describe("test simple primitives", require("./SimplePrimitivesLiveInstrumentTest"));
 describe("test simple collections", require("./SimpleCollectionsLiveInstrumentTest"));
 describe("test live log", require("./LiveLogTest"));
+describe("test live log with args", require("./LiveLogArgsTest"));
 describe("test hit limit", require("./HitLimitTest"));