Add multiple file compilation for SVML (#1375)

* Add multiple file program support to SVML compiler

* Add multiple file program tests for SVML compiler

Author: ianyong

src/index.ts

@@ -30,6 +30,7 @@ import * as es from 'estree'
 import { ECEResultPromise, resumeEvaluate } from './ec-evaluator/interpreter'
 import { CannotFindModuleError } from './errors/localImportErrors'
 import { validateFilePath } from './localImports/filePaths'
+import preprocessFileImports from './localImports/preprocessor'
 import { getKeywords, getProgramNames, NameDeclaration } from './name-extractor'
 import { parse } from './parser/parser'
 import { parseWithComments } from './parser/utils'
@@ -371,13 +372,39 @@ export function compile(
   context: Context,
   vmInternalFunctions?: string[]
 ): SVMProgram | undefined {
-  const astProgram = parse(code, context)
-  if (!astProgram) {
+  const defaultFilePath = '/default.js'
+  const files: Partial<Record<string, string>> = {}
+  files[defaultFilePath] = code
+  return compileFiles(files, defaultFilePath, context, vmInternalFunctions)
+}
+
+export function compileFiles(
+  files: Partial<Record<string, string>>,
+  entrypointFilePath: string,
+  context: Context,
+  vmInternalFunctions?: string[]
+): SVMProgram | undefined {
+  for (const filePath in files) {
+    const filePathError = validateFilePath(filePath)
+    if (filePathError !== null) {
+      context.errors.push(filePathError)
+      return undefined
+    }
+  }
+
+  const entrypointCode = files[entrypointFilePath]
+  if (entrypointCode === undefined) {
+    context.errors.push(new CannotFindModuleError(entrypointFilePath))
+    return undefined
+  }
+
+  const preprocessedProgram = preprocessFileImports(files, entrypointFilePath, context)
+  if (!preprocessedProgram) {
     return undefined
   }
 
   try {
-    return compileToIns(astProgram, undefined, vmInternalFunctions)
+    return compileToIns(preprocessedProgram, undefined, vmInternalFunctions)
   } catch (error) {
     context.errors.push(error)
     return undefined

src/runner/__tests__/files.ts

@@ -1,4 +1,4 @@
-import { parseError, runFilesInContext } from '../../index'
+import { compileFiles, parseError, runFilesInContext } from '../../index'
 import { mockContext } from '../../mocks/context'
 import { Chapter } from '../../types'
 
@@ -73,3 +73,75 @@ describe('runFilesInContext', () => {
     `)
   })
 })
+
+describe('compileFiles', () => {
+  let context = mockContext(Chapter.SOURCE_4)
+
+  beforeEach(() => {
+    context = mockContext(Chapter.SOURCE_4)
+  })
+
+  it('returns IllegalCharInFilePathError if any file path contains invalid characters', () => {
+    const files: Record<string, string> = {
+      '/a.js': '1 + 2;',
+      '/+-.js': '"hello world";'
+    }
+    compileFiles(files, '/a.js', context)
+    expect(parseError(context.errors)).toMatchInlineSnapshot(
+      `"File path '/+-.js' must only contain alphanumeric chars and/or '_', '/', '.', '-'."`
+    )
+  })
+
+  it('returns IllegalCharInFilePathError if any file path contains invalid characters - verbose', () => {
+    const files: Record<string, string> = {
+      '/a.js': '1 + 2;',
+      '/+-.js': '"hello world";'
+    }
+    compileFiles(files, '/a.js', context)
+    expect(parseError(context.errors, true)).toMatchInlineSnapshot(`
+      "File path '/+-.js' must only contain alphanumeric chars and/or '_', '/', '.', '-'.
+      Rename the offending file path to only use valid chars.
+      "
+    `)
+  })
+
+  it('returns ConsecutiveSlashesInFilePathError if any file path contains consecutive slash characters', () => {
+    const files: Record<string, string> = {
+      '/a.js': '1 + 2;',
+      '/dir//dir2/b.js': '"hello world";'
+    }
+    compileFiles(files, '/a.js', context)
+    expect(parseError(context.errors)).toMatchInlineSnapshot(
+      `"File path '/dir//dir2/b.js' cannot contain consecutive slashes '//'."`
+    )
+  })
+
+  it('returns ConsecutiveSlashesInFilePathError if any file path contains consecutive slash characters - verbose', () => {
+    const files: Record<string, string> = {
+      '/a.js': '1 + 2;',
+      '/dir//dir2/b.js': '"hello world";'
+    }
+    compileFiles(files, '/a.js', context)
+    expect(parseError(context.errors, true)).toMatchInlineSnapshot(`
+      "File path '/dir//dir2/b.js' cannot contain consecutive slashes '//'.
+      Remove consecutive slashes from the offending file path.
+      "
+    `)
+  })
+
+  it('returns CannotFindModuleError if entrypoint file does not exist', () => {
+    const files: Record<string, string> = {}
+    compileFiles(files, '/a.js', context)
+    expect(parseError(context.errors)).toMatchInlineSnapshot(`"Cannot find module '/a.js'."`)
+  })
+
+  it('returns CannotFindModuleError if entrypoint file does not exist - verbose', () => {
+    const files: Record<string, string> = {}
+    compileFiles(files, '/a.js', context)
+    expect(parseError(context.errors, true)).toMatchInlineSnapshot(`
+      "Cannot find module '/a.js'.
+      Check that the module file path resolves to an existing file.
+      "
+    `)
+  })
+})