chore: add debugging configuration for VsCode

Author: aminya

.vscode/extensions.json

@@ -5,6 +5,7 @@
     "llvm-vs-code-extensions.vscode-clangd",
     "xadillax.gyp",
     "dbaeumer.vscode-eslint",
-    "esbenp.prettier-vscode"
+    "esbenp.prettier-vscode",
+    "vadimcn.vscode-lldb"
   ]
 }

.vscode/launch.json

@@ -0,0 +1,46 @@
+{
+    "configurations": [
+        {
+            "name": "JS-Attach",
+            "type": "node",
+            "request": "attach",
+            "port": 9229,
+            "continueOnAttach": true,
+            "autoAttachChildProcesses": true,
+            "resolveSourceMapLocations": [
+                "!**/node_modules/**",
+                "!**/.vscode/extensions/hbenl.vscode-mocha-test-adapter-*/**"
+            ],
+            "skipFiles": [
+                "<node_internals>/**"
+            ],
+        },
+        {
+            "type": "lldb",
+            "request": "launch",
+            "name": "Native-Launch",
+            "preLaunchTask": "clean_build_debug",
+            "program": "node",
+            "suppressMultipleSessionWarning": true,
+            "sourceLanguages": [
+                "cpp"
+            ],
+            "args": [
+                "--inspect-brk=9229",
+                "--expose-gc",
+                "-r",
+                "ts-node/register",
+                "${workspaceFolder}/test/debug.ts"
+            ],
+        }
+    ],
+    "compounds": [
+        {
+            "name": "Node-Launch",
+            "configurations": [
+                "Native-Launch",
+                "JS-Attach",
+            ]
+        }
+    ]
+}

.vscode/settings.json

@@ -3,5 +3,6 @@
   "mochaExplorer.globImplementation": "vscode",
   "mochaExplorer.nodeArgv": [
     "--expose-gc"
-  ]
+  ],
+  "mochaExplorer.debuggerConfig": "JS-Attach"
 }

.vscode/tasks.json

@@ -0,0 +1,10 @@
+{
+    "version": "2.0.0",
+    "tasks": [
+        {
+            "label": "clean_build_debug",
+            "type": "shell",
+            "command": "pnpm clean.release && pnpm build.debug",
+        }
+    ]
+}

package.json

@@ -84,6 +84,7 @@
   "scripts": {
     "install": "(shx test -f ./script/build.js || run-s build.js) && cross-env npm_config_build_from_source=true aminya-node-gyp-build",
     "clean": "shx rm -rf ./build ./lib/ ./prebuilds ./script/*.js ./script/*.js.map ./script/*.d.ts ./script/*.tsbuildinfo",
+    "clean.release": "shx rm -rf ./build/Release",
     "clean.temp": "shx rm -rf ./tmp && shx mkdir -p ./tmp",
     "build.library": "tsc -p ./src/tsconfig.json",
     "build.script": "tsc -p ./script/tsconfig.json && tsc -p ./script/tsconfig.esm.json",

test/debug.ts

@@ -0,0 +1,26 @@
+import * as zmq from "../src"
+
+import {getGcOrSkipTest} from "./unit/helpers"
+
+async function main() {
+  const gc = getGcOrSkipTest()
+
+  let weakRef: undefined | WeakRef<zmq.Context>
+  const task = async () => {
+    const context: zmq.Context | undefined = new zmq.Context()
+    const dealer = new zmq.Dealer({context, linger: 0})
+    weakRef = new WeakRef(context)
+
+    // dealer.close()
+  }
+
+  await task()
+  await gc()
+
+  console.log(weakRef?.deref())
+}
+
+main().catch(err => {
+  console.error(err)
+  process.exit(1)
+})

test/unit/helpers.ts

@@ -259,9 +259,9 @@ interface GCFunction {
   }): void | Promise<void>
 }
 
-export function getGcOrSkipTest(test: Mocha.Context) {
+export function getGcOrSkipTest(test?: Mocha.Context) {
   if (process.env.SKIP_GC_TESTS === "true") {
-    test.skip()
+    test?.skip()
   }
 
   const gc = global.gc as undefined | GCFunction