Add Insight test for frame variables in a JS block scope.

Author: woess

vm/tests/all/agentscript/agent-blockscope-js.test

@@ -0,0 +1,38 @@
+# Copyright (c) 2025, Oracle and/or its affiliates. All rights reserved.
+# DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+#
+# This code is free software; you can redistribute it and/or modify it
+# under the terms of the GNU General Public License version 2 only, as
+# published by the Free Software Foundation.  Oracle designates this
+# particular file as subject to the "Classpath" exception as provided
+# by Oracle in the LICENSE file that accompanied this code.
+#
+# This code is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+# FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+# version 2 for more details (a copy is included in the LICENSE file that
+# accompanied this code).
+#
+# You should have received a copy of the GNU General Public License version
+# 2 along with this work; if not, write to the Free Software Foundation,
+# Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+#
+# Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+# or visit www.oracle.com if you need additional information or have any
+# questions.
+#
+> js --insight=blockscopeinsight.js blockscope.js
+=== on enter at sumEvenNumbers (blockscope.js:32) : {i=0, limit=5, sum=0}
+       frame at sumEvenNumbers (blockscope.js:32) : {i=0, limit=5, sum=0}
+=== on leave at sumEvenNumbers (blockscope.js:32) : {i=0, limit=5, sum=0}
+       frame at sumEvenNumbers (blockscope.js:32) : {i=0, limit=5, sum=0}
+=== on enter at sumEvenNumbers (blockscope.js:32) : {i=2, limit=5, sum=0}
+       frame at sumEvenNumbers (blockscope.js:32) : {i=2, limit=5, sum=0}
+=== on leave at sumEvenNumbers (blockscope.js:32) : {i=2, limit=5, sum=2}
+       frame at sumEvenNumbers (blockscope.js:32) : {i=2, limit=5, sum=2}
+=== on enter at sumEvenNumbers (blockscope.js:32) : {i=4, limit=5, sum=2}
+       frame at sumEvenNumbers (blockscope.js:32) : {i=4, limit=5, sum=2}
+=== on leave at sumEvenNumbers (blockscope.js:32) : {i=4, limit=5, sum=6}
+       frame at sumEvenNumbers (blockscope.js:32) : {i=4, limit=5, sum=6}
+=== on leave at sumEvenNumbers (blockscope.js:26) : {sum=6}
+6

vm/tests/all/agentscript/blockscope.js

@@ -0,0 +1,39 @@
+/*
+ * Copyright (c) 2025, Oracle and/or its affiliates. All rights reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation.  Oracle designates this
+ * particular file as subject to the "Classpath" exception as provided
+ * by Oracle in the LICENSE file that accompanied this code.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
+ */
+
+function sumEvenNumbers() {
+    let sum = 0;
+    {
+        const limit = 5;
+        for (let i = 0; i < limit; i++) {
+            if (i % 2 === 0) {
+                sum += i;
+            }
+        }
+    }
+    return sum;
+}
+
+console.log(sumEvenNumbers());

vm/tests/all/agentscript/blockscopeinsight.js

@@ -0,0 +1,52 @@
+/*
+ * Copyright (c) 2025, Oracle and/or its affiliates. All rights reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation.  Oracle designates this
+ * particular file as subject to the "Classpath" exception as provided
+ * by Oracle in the LICENSE file that accompanied this code.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
+ */
+
+function dumpVars(vars) {
+  return Object.entries(vars).filter(([name]) => name != "this").map(([name, value]) => `${name}=${value}`).join(", ");
+}
+
+for (let [eventId, eventName = eventId] of [["enter"], ["return", "leave"]]) {
+  insight.on(eventId, function(ctx, frame) {
+    console.log(`=== on ${eventName} at ${ctx.name} (${ctx.source.name}:${ctx.line}) : {${dumpVars(frame)}}`);
+    ctx.iterateFrames((at, frameVars) => {
+      if (at.name.endsWith("sumEvenNumbers")) {
+        console.log(`       frame at ${at.name} (${at.source.name}:${at.line}) : {${dumpVars(frameVars)}}`);
+      }
+    });
+  }, {
+    statements: true,
+    at: {
+      sourcePath: ".*blockscope.*",
+      line: 32,
+    }
+  });
+}
+
+insight.on("return", function(ctx, frame) {
+  console.log(`=== on leave at ${ctx.name} (${ctx.source.name}:${ctx.line}) : {${dumpVars(frame)}}`);
+}, {
+  roots: true,
+  rootNameFilter: "sumEvenNumbers",
+});