feat: add support for typescript compiler

Author: patriksimek

.github/workflows/test.yml

@@ -38,4 +38,9 @@ jobs:
 
             - name: Run unit tests (node < 16)
               if: ${{ matrix.node-version < 16 }}
-              run: node scripts/legacy-test-runner.js
+              run: node scripts/legacy-test-runner.js
+
+            - name: Run unit tests (compilers)
+              if: ${{ matrix.node-version >= 16 }}
+              run: npm install typescript coffee-script --no-save && npm run test:compilers
+

README.md

@@ -43,7 +43,7 @@ new VM().run('this.constructor.constructor("return process")().exit()');
 npm install vm2
 ```
 
-## Quick Example
+## Quick Examples
 
 ```js
 const { VM } = require('vm2');
@@ -98,7 +98,7 @@ VM is a simple sandbox to synchronously run untrusted code without the `require`
 
 -   `timeout` - Script timeout in milliseconds. **WARNING**: You might want to use this option together with `allowAsync=false`. Further, operating on returned objects from the sandbox can run arbitrary code and circumvent the timeout. One should test if the returned object is a primitive with `typeof` and fully discard it (doing logging or creating error messages with such an object might also run arbitrary code again) in the other case.
 -   `sandbox` - VM's global object.
--   `compiler` - `javascript` (default) or `coffeescript` or custom compiler function. The library expects you to have coffee-script pre-installed if the compiler is set to `coffeescript`.
+-   `compiler` - `javascript` (default), `typescript`, `coffeescript` or custom compiler function. The library expects you to have compiler pre-installed if the value is set to `typescript` or `coffeescript`.
 -   `eval` - If set to `false` any calls to `eval` or function constructors (`Function`, `GeneratorFunction`, etc.) will throw an `EvalError` (default: `true`).
 -   `wasm` - If set to `false` any attempt to compile a WebAssembly module will throw a `WebAssembly.CompileError` (default: `true`).
 -   `allowAsync` - If set to `false` any attempt to run code using `async` will throw a `VMError` (default: `true`).
@@ -133,7 +133,7 @@ Unlike `VM`, `NodeVM` allows you to require modules in the same way that you wou
 
 -   `console` - `inherit` to enable console, `redirect` to redirect to events, `off` to disable console (default: `inherit`).
 -   `sandbox` - VM's global object.
--   `compiler` - `javascript` (default) or `coffeescript` or custom compiler function (which receives the code, and it's file path). The library expects you to have coffee-script pre-installed if the compiler is set to `coffeescript`.
+-   `compiler` - `javascript` (default), `typescript`, `coffeescript` or custom compiler function (which receives the code, and it's file path). The library expects you to have compiler pre-installed if the value is set to `typescript` or `coffeescript`.
 -   `eval` - If set to `false` any calls to `eval` or function constructors (`Function`, `GeneratorFunction`, etc.) will throw an `EvalError` (default: `true`).
 -   `wasm` - If set to `false` any attempt to compile a WebAssembly module will throw a `WebAssembly.CompileError` (default: `true`).
 -   `sourceExtensions` - Array of file extensions to treat as source code (default: `['js']`).

index.d.ts

@@ -134,10 +134,14 @@ export function makeResolverFromLegacyOptions(options: VMRequire, override?: {[k
  */
 export interface VMOptions {
   /**
-   * `javascript` (default) or `coffeescript` or custom compiler function (which receives the code, and it's file path).
-   *  The library expects you to have coffee-script pre-installed if the compiler is set to `coffeescript`.
+   * `javascript` (default), `typescript`, `coffeescript` or custom compiler function (which receives the code, and it's file path).
+   *  The library expects you to have compiler pre-installed if the value is set to `typescript` or `coffeescript`.
    */
-  compiler?: "javascript" | "coffeescript" | CompilerFunction;
+  compiler?: "javascript" | "typescript" | "coffeescript" | CompilerFunction;
+  /**
+   * Compiler options.
+   */
+  compilerOptions?: Record<string, any>;
   /** VM's global object. */
   sandbox?: any;
   /**
@@ -285,19 +289,22 @@ export class VMScript {
   constructor(code: string, path: string, options?: {
     lineOffset?: number;
     columnOffset?: number;
-    compiler?: "javascript" | "coffeescript" | CompilerFunction;
+    compiler?: "javascript" | "typescript" | "coffeescript" | CompilerFunction;
+    compilerOptions?: Record<string, any>;
   });
   constructor(code: string, options?: {
     filename?: string,
     lineOffset?: number;
     columnOffset?: number;
-    compiler?: "javascript" | "coffeescript" | CompilerFunction;
+    compiler?: "javascript" | "typescript" | "coffeescript" | CompilerFunction;
+    compilerOptions?: Record<string, any>;
   });
   readonly code: string;
   readonly filename: string;
   readonly lineOffset: number;
   readonly columnOffset: number;
-  readonly compiler: "javascript" | "coffeescript" | CompilerFunction;
+  readonly compiler: "javascript" | "typescript" | "coffeescript" | CompilerFunction;
+  readonly compilerOptions: Record<string, any> | undefined;
   /**
    * Wraps the code
    * @deprecated

lib/compiler.js

@@ -4,31 +4,55 @@ const {
 	VMError
 } = require('./bridge');
 
-let cacheCoffeeScriptCompiler;
-
 /**
  * Returns the cached coffee script compiler or loads it
  * if it is not found in the cache.
  *
  * @private
+ * @param {Object} [options] - Optional compiler options.
  * @return {compileCallback} The coffee script compiler.
  * @throws {VMError} If the coffee-script module can't be found.
  */
-function getCoffeeScriptCompiler() {
-	if (!cacheCoffeeScriptCompiler) {
-		try {
-			// The warning generated by webpack can be disabled by setting:
-			// ignoreWarnings[].message = /Can't resolve 'coffee-script'/
-			/* eslint-disable-next-line global-require */
-			const coffeeScript = require('coffee-script');
-			cacheCoffeeScriptCompiler = (code, filename) => {
-				return coffeeScript.compile(code, {header: false, bare: true});
-			};
-		} catch (e) {
-			throw new VMError('Coffee-Script compiler is not installed.');
-		}
+function getCoffeeScriptCompiler(options) {
+	try {
+		// The warning generated by webpack can be disabled by setting:
+		// ignoreWarnings[].message = /Can't resolve 'coffee-script'/
+		/* eslint-disable-next-line global-require */
+		const coffeeScript = require('coffee-script');
+		return (code, filename) => {
+			return coffeeScript.compile(code, Object.assign({header: false, bare: true}, options));
+		};
+	} catch (e) {
+		throw new VMError('Coffee-Script compiler is not installed.');
+	}
+}
+
+/**
+ * Returns the cached TypeScript compiler or loads it
+ * if it is not found in the cache.
+ *
+ * @private
+ * @param {Object} [options] - Optional compiler options.
+ * @return {compileCallback} The TypeScript compiler.
+ * @throws {VMError} If the TypeScript module can't be found.
+ */
+function getTypeScriptCompiler(options) {
+	try {
+		// The warning generated by webpack can be disabled by setting:
+		// ignoreWarnings[].message = /Can't resolve 'typescript'/
+		/* eslint-disable-next-line global-require */
+		const typescript = require('typescript');
+		return (code, filename) => {
+			return typescript.transpileModule(code, {
+				fileName: filename,
+				compilerOptions: Object.assign({
+					module: typescript.ModuleKind.CommonJS,
+				}, options)
+			}).outputText;
+		};
+	} catch (e) {
+		throw new VMError('TypeScript compiler is not installed.');
 	}
-	return cacheCoffeeScriptCompiler;
 }
 
 /**
@@ -62,22 +86,28 @@ function jsCompiler(code, filename) {
  *
  * @private
  * @param {(string|compileCallback)} compiler - A compile callback or the name of the compiler.
+ * @param {Object} [options] - Optional compiler options.
  * @return {compileCallback} The resolved compiler.
  * @throws {VMError} If the compiler is unknown or the coffee script module was needed and couldn't be found.
  */
-function lookupCompiler(compiler) {
+function lookupCompiler(compiler, options) {
 	if ('function' === typeof compiler) return compiler;
 	switch (compiler) {
 		case 'coffeescript':
 		case 'coffee-script':
 		case 'cs':
 		case 'text/coffeescript':
-			return getCoffeeScriptCompiler();
+			return getCoffeeScriptCompiler(options);
 		case 'javascript':
 		case 'java-script':
 		case 'js':
 		case 'text/javascript':
 			return jsCompiler;
+		case 'typescript':
+		case 'type-script':
+		case 'ts':
+		case 'text/typescript':
+			return getTypeScriptCompiler(options);
 		default:
 			throw new VMError(`Unsupported compiler '${compiler}'.`);
 	}

lib/script.js

@@ -172,12 +172,13 @@ class VMScript {
 
 		const {
 			compiler = 'javascript',
+			compilerOptions,
 			lineOffset = 0,
 			columnOffset = 0
 		} = useOptions;
 
 		// Throw if the compiler is unknown.
-		const resolvedCompiler = lookupCompiler(compiler);
+		const resolvedCompiler = lookupCompiler(compiler, compilerOptions);
 
 		objectDefineProperties(this, {
 			__proto__: null,
@@ -219,6 +220,11 @@ class VMScript {
 				value: compiler,
 				enumerable: true
 			},
+			compilerOptions: {
+				__proto__: null,
+				value: compilerOptions,
+				enumerable: true
+			},
 			_code: {
 				__proto__: null,
 				value: sCode,

lib/vm.js

@@ -229,6 +229,7 @@ class VM extends EventEmitter {
 			timeout,
 			sandbox,
 			compiler = 'javascript',
+			compilerOptions,
 			allowAsync: optAllowAsync = true
 		} = options;
 		const allowEval = options.eval !== false;
@@ -241,7 +242,7 @@ class VM extends EventEmitter {
 		}
 
 		// Early error if compiler can't be found.
-		const resolvedCompiler = lookupCompiler(compiler);
+		const resolvedCompiler = lookupCompiler(compiler, compilerOptions);
 
 		// Create a new context for this vm.
 		const _context = createContext(undefined, {

package.json

@@ -30,7 +30,8 @@
 		"node": ">=6.0"
 	},
 	"scripts": {
-		"test": "mocha test",
+		"test": "mocha test --ignore test/compilers.js",
+		"test:compilers": "mocha test/compilers.js",
 		"lint": "eslint ."
 	},
 	"bin": {

test/compilers.js

@@ -0,0 +1,28 @@
+'use strict';
+
+const assert = require('assert');
+const {VM, NodeVM, VMScript} = require('..');
+
+global.isHost = true;
+
+describe('Compilers', () => {
+	it('run TypeScript', () => {
+		const vm = new VM();
+		const script = new VMScript('1 as number', {
+			compiler: 'typescript'
+		});
+		const val = vm.run(script);
+		assert.strictEqual(val, 1);
+	});
+
+	it('run CoffeeScript', () => {
+		const vm = new NodeVM({
+			require: {
+				external: true
+			},
+			compiler: 'coffeescript'
+		});
+
+		assert.equal(vm.run('module.exports = working: true').working, true);
+	});
+});

test/nodevm.js

@@ -102,17 +102,6 @@ describe('modules', () => {
 		assert.equal(vm.run(`module.exports = require('./data/json.json')`, `${__dirname}/vm.js`).working, true);
 	});
 
-	it.skip('run coffee-script', () => {
-		const vm = new NodeVM({
-			require: {
-				external: true
-			},
-			compiler: 'coffeescript'
-		});
-
-		assert.equal(vm.run('module.exports = working: true').working, true);
-	});
-
 	it('optionally can run a custom compiler function', () => {
 		let ranCustomCompiler = false;
 		const scriptCode = 'var a = 1;';