refactor(scripting-revamp): migrate js-sandbox to web worker/Node vm based implementation (#3619)

packages/hoppscotch-js-sandbox/src/test-runner/node-vm/index.ts

@@ -0,0 +1,55 @@
+import * as E from "fp-ts/Either"
+import * as TE from "fp-ts/TaskEither"
+import { pipe } from "fp-ts/function"
+import { createContext, runInContext } from "vm"
+
+import { TestResponse, TestResult } from "~/types"
+import { getTestRunnerScriptMethods, preventCyclicObjects } from "~/utils"
+
+export const runTestScript = (
+  testScript: string,
+  envs: TestResult["envs"],
+  response: TestResponse
+): TE.TaskEither<string, TestResult> =>
+  pipe(
+    TE.tryCatch(
+      async () => {
+        return createContext()
+      },
+      (reason) => `Context initialization failed: ${reason}`
+    ),
+    TE.chain((context) =>
+      TE.tryCatch(
+        () => executeScriptInContext(testScript, envs, response, context),
+        (reason) => `Script execution failed: ${reason}`
+      )
+    )
+  )
+
+const executeScriptInContext = (
+  testScript: string,
+  envs: TestResult["envs"],
+  response: TestResponse,
+  context: any
+): Promise<TestResult> => {
+  return new Promise((resolve, reject) => {
+    // Parse response object
+    const responseObjHandle = preventCyclicObjects(response)
+    if (E.isLeft(responseObjHandle)) {
+      return reject(`Response parsing failed: ${responseObjHandle.left}`)
+    }
+
+    const { pw, testRunStack, updatedEnvs } = getTestRunnerScriptMethods(envs)
+
+    // Expose pw to the context
+    context.pw = { ...pw, response: responseObjHandle.right }
+
+    // Run the test script in the provided context
+    runInContext(testScript, context)
+
+    resolve({
+      tests: testRunStack,
+      envs: updatedEnvs,
+    })
+  })
+}

packages/hoppscotch-js-sandbox/src/test-runner/web-worker/index.ts

@@ -0,0 +1,27 @@
+import * as E from "fp-ts/Either"
+
+import { SandboxTestResult, TestResponse, TestResult } from "~/types"
+
+import Worker from "./worker?worker&inline"
+
+export const runTestScript = (
+  testScript: string,
+  envs: TestResult["envs"],
+  response: TestResponse
+): Promise<E.Either<string, SandboxTestResult>> => {
+  return new Promise((resolve) => {
+    const worker = new Worker()
+
+    // Listen for the results from the web worker
+    worker.addEventListener("message", (event: MessageEvent) =>
+      resolve(event.data.results)
+    )
+
+    // Send the script to the web worker
+    worker.postMessage({
+      testScript,
+      envs,
+      response,
+    })
+  })
+}

packages/hoppscotch-js-sandbox/src/test-runner/web-worker/worker.ts

@@ -0,0 +1,43 @@
+import * as E from "fp-ts/Either"
+import * as TE from "fp-ts/TaskEither"
+
+import { SandboxTestResult, TestResponse, TestResult } from "~/types"
+import { getTestRunnerScriptMethods, preventCyclicObjects } from "~/utils"
+
+const executeScriptInContext = (
+  testScript: string,
+  envs: TestResult["envs"],
+  response: TestResponse
+): TE.TaskEither<string, SandboxTestResult> => {
+  try {
+    const responseObjHandle = preventCyclicObjects(response)
+    if (E.isLeft(responseObjHandle)) {
+      return TE.left(`Response marshalling failed: ${responseObjHandle.left}`)
+    }
+
+    const { pw, testRunStack, updatedEnvs } = getTestRunnerScriptMethods(envs)
+
+    // Create a function from the test script using the `Function` constructor
+    const executeScript = new Function("pw", testScript)
+
+    // Execute the script
+    executeScript({ ...pw, response: responseObjHandle.right })
+
+    return TE.right(<SandboxTestResult>{
+      tests: testRunStack[0],
+      envs: updatedEnvs,
+    })
+  } catch (error) {
+    return TE.left(`Script execution failed: ${(error as Error).message}`)
+  }
+}
+
+// Listen for messages from the main thread
+self.addEventListener("message", async (event) => {
+  const { testScript, envs, response } = event.data
+
+  const results = await executeScriptInContext(testScript, envs, response)()
+
+  // Post the result back to the main thread
+  self.postMessage({ results })
+})