Pipeline vm2 fix (#405)

georg-schwarz · web-flow · commit 151fdf7ac793 · 2022-04-01T17:18:01.000+02:00
* Pipeline: Fix error position parsing in VM2

* Pipeline: upgrade vm2 version
diff --git a/pipeline/package-lock.json b/pipeline/package-lock.json
diff --git a/pipeline/package.json b/pipeline/package.json
@@ -23,7 +23,7 @@
     "body-parser": "^1.19.0",
     "cors": "^2.8.5",
     "express": "^4.17.1",
-    "vm2": "^3.9.5"
+    "vm2": "^3.9.9"
   },
   "devDependencies": {
     "@jvalue/eslint-config-jvalue": "^1.1.0",
diff --git a/pipeline/src/pipeline-execution/sandbox/vm2SandboxExecutor.ts b/pipeline/src/pipeline-execution/sandbox/vm2SandboxExecutor.ts
@@ -26,22 +26,27 @@ export default class VM2SandboxExecutor implements SandboxExecutor {
 
     const json = JSON.stringify(data);
 
-    const script = new VMScript(code, 'main');
-    script.wrap('function main(data) {\n', `\n}\nmain(${json});`);
+    const wrappedCode =
+      'function main(data) {\n' + `${code}\n` + '}\n' + `main(${json})`;
+    const script = new VMScript(wrappedCode, 'main');
 
     try {
       script.compile();
     } catch (err) {
       const error = err as Error;
-      return { error: convertSyntaxError(error, FUNCTION_WRAP_PREFIX_LENGTH) };
+      return {
+        error: convertSyntaxError(error, FUNCTION_WRAP_PREFIX_LENGTH, code),
+      };
     }
 
     try {
       const result = this.vm.run(script) as Record<string, unknown>;
       return { data: result };
     } catch (err) {
       const error = err as Error;
-      return { error: convertRuntimeError(error, FUNCTION_WRAP_PREFIX_LENGTH) };
+      return {
+        error: convertRuntimeError(error, FUNCTION_WRAP_PREFIX_LENGTH),
+      };
     }
   }
 }
diff --git a/pipeline/src/pipeline-execution/sandbox/vm2StacktraceParser.ts b/pipeline/src/pipeline-execution/sandbox/vm2StacktraceParser.ts
@@ -69,10 +69,12 @@ function rewriteStacktrace(oldLines: string[], prefixLength: number): string[] {
  *       at VMScript.compile (/home/ods-main/pipeline/node_modules/vm2/lib/main.js:80:20)
  *       ...
  * @param error The original javascript syntax error
+ * @param codeSnippet The original executed code snippet
  */
 export function convertSyntaxError(
   error: Error,
   prefixLength: number,
+  originalCode: string,
 ): JobError {
   if (error.name !== 'SyntaxError') {
     throw new Error('Not a syntax error');
@@ -86,13 +88,28 @@ export function convertSyntaxError(
   const header = lines[0];
   const [, lineNumber] = parseSyntaxErrorHeader(header);
   const lineNumberAdjusted = lineNumber - prefixLength;
+  const message = lines[4];
+
+  const codeSnippetLines = originalCode.split('\n').length;
+  const errorProjectedToWrappingMain =
+    lineNumberAdjusted === codeSnippetLines + 1;
+  if (errorProjectedToWrappingMain) {
+    // Special case: the error concerns the wrapping main function
+    const lastCodeLine = originalCode.split('\n')[codeSnippetLines - 1];
+    const lastPositionInLastCodeLine = lastCodeLine.length - 1;
+    return {
+      name: error.name,
+      message,
+      position: +lastPositionInLastCodeLine,
+      lineNumber: codeSnippetLines,
+      stacktrace: [],
+    };
+  }
 
   const markers = lines[2];
   const markerIndex = markers.indexOf('^');
   const position = markerIndex > 0 ? markerIndex : 0;
 
-  const message = lines[4];
-
   return {
     name: error.name,
     message,
