Merge pull request #23 from algorandfoundation/main

feat: puya debugging support (#2)

.mocharc.js

@@ -0,0 +1,4 @@
+// .mocharc.js
+module.exports = {
+  timeout: 30000, // 30 seconds
+};

.vscode/launch.json

@@ -6,11 +6,12 @@
       "type": "extensionHost",
       "request": "launch",
       "args": [
+        "--disable-extensions",
         "--extensionDevelopmentPath=${workspaceFolder}/extension",
         "${workspaceFolder}/sampleWorkspace"
       ],
       "outFiles": ["${workspaceFolder}/extension/dist/**/*.js"],
-      "preLaunchTask": "npm: extension watch"
+      "preLaunchTask": "npm: extension:build"
     },
     {
       "name": "Server",

extension/package.json

@@ -56,6 +56,12 @@
     "breakpoints": [
       {
         "language": "teal"
+      },
+      {
+        "language": "python"
+      },
+      {
+        "language": "typescript"
       }
     ],
     "debuggers": [

extension/src/configuration.ts

@@ -26,9 +26,22 @@ export class AvmDebugConfigProvider
       return null;
     }
 
-    if (!config.programSourcesDescriptionFile) {
+    if (
+      config.programSourcesDescription &&
+      !config.programSourcesDescriptionFolder
+    ) {
       vscode.window.showErrorMessage(
-        'Missing property "programSourcesDescriptionFile" in debug config',
+        'Missing property "programSourcesDescriptionFolder" in debug config',
+      );
+      return null;
+    }
+
+    if (
+      !config.programSourcesDescriptionFile &&
+      !config.programSourcesDescription
+    ) {
+      vscode.window.showErrorMessage(
+        'Either "programSourcesDescriptionFile" or "programSourcesDescription" + "programSourcesDescriptionFolder" must be provided in debug config',
       );
       return null;
     }

package.json

@@ -49,6 +49,7 @@
     "src"
   ],
   "scripts": {
+    "prepare": "npm run compile",
     "compile": "shx rm -rf out && tsc -p ./",
     "lint": "eslint src --ext ts",
     "typecheck": "tsc -p tsconfig.json --noEmit",
@@ -63,11 +64,12 @@
     "extension:publish": "vsce publish",
     "extension:publish-pre-release": "vsce publish --pre-release",
     "test": "ts-mocha -p tsconfig.json 'tests/**/*test.ts' --timeout 30s --diff false",
-    "test:coverage": "nyc npm run test"
+    "test:coverage": "nyc npm run test",
+    "pre-commit": "npm run lint && npm run typecheck && npm run format"
   },
   "dependencies": {
     "@vscode/debugadapter": "^1.64.0",
-    "algosdk": "^3.0.0-beta.1",
+    "algosdk": "^3.0.0",
     "await-notify": "^1.0.1"
   },
   "devDependencies": {

sampleWorkspace/.vscode/launch.json

@@ -8,160 +8,136 @@
       "type": "avm",
       "request": "launch",
       "name": "Debug App Box State Changes",
-
       "simulateTraceFile": "${workspaceFolder}/app-state-changes/box-simulate-response.json",
       "programSourcesDescriptionFile": "${workspaceFolder}/app-state-changes/sources.json",
-
       "stopOnEntry": true
     },
     {
       "type": "avm",
       "request": "launch",
       "name": "Debug App Global State Changes",
-
       "simulateTraceFile": "${workspaceFolder}/app-state-changes/global-simulate-response.json",
       "programSourcesDescriptionFile": "${workspaceFolder}/app-state-changes/sources.json",
-
       "stopOnEntry": true
     },
     {
       "type": "avm",
       "request": "launch",
       "name": "Debug App Local State Changes",
-
       "simulateTraceFile": "${workspaceFolder}/app-state-changes/local-simulate-response.json",
       "programSourcesDescriptionFile": "${workspaceFolder}/app-state-changes/sources.json",
-
       "stopOnEntry": true
     },
     {
       "type": "avm",
       "request": "launch",
       "name": "Debug Recursive App",
-
       "simulateTraceFile": "${workspaceFolder}/recursive-app/simulate-response.json",
       "programSourcesDescriptionFile": "${workspaceFolder}/recursive-app/sources.json",
-
       "stopOnEntry": true
     },
     {
       "type": "avm",
       "request": "launch",
       "name": "Debug Slot Machine",
-
       "simulateTraceFile": "${workspaceFolder}/slot-machine/simulate-response.json",
       "programSourcesDescriptionFile": "${workspaceFolder}/slot-machine/sources.json",
-
       "stopOnEntry": true
     },
     {
       "type": "avm",
       "request": "launch",
       "name": "Debug Sourcemap Test",
-
       "simulateTraceFile": "${workspaceFolder}/sourcemap-test/simulate-response.json",
       "programSourcesDescriptionFile": "${workspaceFolder}/sourcemap-test/sources.json",
-
       "stopOnEntry": true
     },
     {
       "type": "avm",
       "request": "launch",
       "name": "Debug Stack Scratch",
-
       "simulateTraceFile": "${workspaceFolder}/stack-scratch/simulate-response.json",
       "programSourcesDescriptionFile": "${workspaceFolder}/stack-scratch/sources.json",
-
       "stopOnEntry": true
     },
     {
       "type": "avm",
       "request": "launch",
       "name": "Debug Stepping Test",
-
       "simulateTraceFile": "${workspaceFolder}/stepping-test/simulate-response.json",
       "programSourcesDescriptionFile": "${workspaceFolder}/stepping-test/sources.json",
-
       "stopOnEntry": true
     },
     {
       "type": "avm",
       "request": "launch",
       "name": "Debug App Error",
-
       "simulateTraceFile": "${workspaceFolder}/errors/app/simulate-response.json",
       "programSourcesDescriptionFile": "${workspaceFolder}/errors/app/sources.json",
-
       "stopOnEntry": true
     },
     {
       "type": "avm",
       "request": "launch",
       "name": "Debug App from LogicSig Error",
-
       "simulateTraceFile": "${workspaceFolder}/errors/app-from-logicsig/simulate-response.json",
       "programSourcesDescriptionFile": "${workspaceFolder}/errors/app-from-logicsig/sources.json",
-
       "stopOnEntry": true
     },
     {
       "type": "avm",
       "request": "launch",
       "name": "Debug Inner App Error (App Reject)",
-
       "simulateTraceFile": "${workspaceFolder}/errors/inner-app/app-reject-simulate-response.json",
       "programSourcesDescriptionFile": "${workspaceFolder}/errors/inner-app/sources.json",
-
       "stopOnEntry": true
     },
     {
       "type": "avm",
       "request": "launch",
       "name": "Debug Inner App Error (Overspend)",
-
       "simulateTraceFile": "${workspaceFolder}/errors/inner-app/overspend-simulate-response.json",
       "programSourcesDescriptionFile": "${workspaceFolder}/errors/inner-app/sources.json",
-
       "stopOnEntry": true
     },
     {
       "type": "avm",
       "request": "launch",
       "name": "Debug LogicSig Error",
-
       "simulateTraceFile": "${workspaceFolder}/errors/logicsig/simulate-response.json",
       "programSourcesDescriptionFile": "${workspaceFolder}/errors/logicsig/sources.json",
-
       "stopOnEntry": true
     },
     {
       "type": "avm",
       "request": "launch",
       "name": "Debug Error Before LogicSig",
-
       "simulateTraceFile": "${workspaceFolder}/errors/logicsig-after-error/simulate-response.json",
       "programSourcesDescriptionFile": "${workspaceFolder}/errors/logicsig-after-error/sources.json",
-
       "stopOnEntry": true
     },
     {
       "type": "avm",
       "request": "launch",
       "name": "Clear State Rejection",
-
       "simulateTraceFile": "${workspaceFolder}/errors/clear-state/rejection-response.json",
       "programSourcesDescriptionFile": "${workspaceFolder}/errors/clear-state/sources.json",
-
       "stopOnEntry": true
     },
     {
       "type": "avm",
       "request": "launch",
       "name": "Clear State Error",
-
       "simulateTraceFile": "${workspaceFolder}/errors/clear-state/error-response.json",
       "programSourcesDescriptionFile": "${workspaceFolder}/errors/clear-state/sources.json",
-
+      "stopOnEntry": true
+    },
+    {
+      "type": "avm",
+      "request": "launch",
+      "name": "Debug Puya",
+      "simulateTraceFile": "${workspaceFolder}/puya/simulate-response.json",
+      "programSourcesDescriptionFile": "${workspaceFolder}/puya/sources.json",
       "stopOnEntry": true
     }
   ]

sampleWorkspace/README.md

@@ -0,0 +1,12 @@
+## How to navigate examples?
+
+This folder contains sample workspaces representing various debugger use cases:
+
+- Simulate traces, TEAL sources and sourcemaps (e.g. `stack-scratch`, `stepping-test`, `app-state-changes`, `errors`). Various examples of using the debugger with TEAL sourcemaps and sources.
+- Simulate traces, [Puya](https://github.com/algorandfoundation/puya) sources and sourcemaps (e.g. `puya`). Showcasing various ways to simulate traces with puya sourcemaps and sources.
+
+> **Note:** The frontend language for Puya compiler scenarios is [Algorand Python](https://pypi.org/project/algorand-python/).
+
+### Launching sample workspaces
+
+Refer to the [launch.json](.vscode/launch.json) file to launch sample workspaces from VSCode. Keep the marketplace-based AlgoKit AVM Debugger extension disabled (if installed).

sampleWorkspace/puya/.algokit/sources/opup/approval.teal.map

@@ -0,0 +1,8 @@
+{
+    "version": 3,
+    "sources": [
+      "opup.teal"
+    ],
+    "names": [],
+    "mappings": ";AACA"
+  }

sampleWorkspace/puya/.algokit/sources/opup/opup.teal

@@ -0,0 +1,2 @@
+#pragma version 6
+int 1