Merge pull request #1320 from Agoric/mfig/bundle-source-errors

fix(bundle-source): fix comment misparse, make require optional
Agoric · Jul 22, 2020 · 62797d5 · 62797d5
2 parents 1c4adc5 + 661aae8
commit 62797d5
Show file tree

Hide file tree

Showing 9 changed files with 109 additions and 21 deletions.
diff --git a/packages/bundle-source/demo/comments/block-closer.js b/packages/bundle-source/demo/comments/block-closer.js
@@ -0,0 +1,3 @@
+/* global success */
+// */ [not executed]
+success();
diff --git a/packages/bundle-source/demo/comments/block-opener.js b/packages/bundle-source/demo/comments/block-opener.js
@@ -0,0 +1,4 @@
+/* global success */
+// /*
+success();
+// */
diff --git a/...es/bundle-source/demo/trailing-comment.js → ...-source/demo/comments/trailing-comment.js b/...es/bundle-source/demo/trailing-comment.js → ...-source/demo/comments/trailing-comment.js
diff --git a/packages/bundle-source/demo/external-fs.js b/packages/bundle-source/demo/external-fs.js
@@ -0,0 +1 @@
+import 'fs';
diff --git a/packages/bundle-source/src/index.js b/packages/bundle-source/src/index.js
@@ -122,7 +122,9 @@ export default async function bundleSource(
         .replace(HTML_COMMENT_START_RE, '<!X-')
         .replace(HTML_COMMENT_END_RE, '-X>')
         // ...replace import expressions with a defanged version to pass SES restrictions.
-        .replace(IMPORT_RE, 'X$1$2');
+        .replace(IMPORT_RE, 'X$1$2')
+        // ...replace end-of-comment markers
+        .replace(/\*\//g, '*X/');
       if (unmapLoc) {
         unmapLoc(node.loc);
       }
@@ -309,7 +311,8 @@ function getExportWithNestedEvaluate(filePrefix) {
   ${computeExports}
 
   // Evaluate the entrypoint recursively, seeding the exports.
-  return computeExports(entrypoint, { require }, {});
+  const systemRequire = typeof require === 'undefined' ? undefined : require;
+  return computeExports(entrypoint, { require: systemRequire }, {});
 }
 ${sourceMap}`;
   }

diff --git a/packages/bundle-source/test/circular.js b/packages/bundle-source/test/circular.js
@@ -16,10 +16,9 @@ test('circular export', async t => {
       'nestedEvaluate',
     );
 
-    const require = _ => o => o;
     const nestedEvaluate = src => {
       // console.log('========== evaluating', src);
-      return evaluate(src, { require, nestedEvaluate });
+      return evaluate(src, { nestedEvaluate });
     };
     // console.log(src1);
     const srcMap1 = `(${src1})\n${map1}`;

diff --git a/packages/bundle-source/test/sanity.js b/packages/bundle-source/test/sanity.js
@@ -23,10 +23,9 @@ test('nestedEvaluate', async t => {
 
     t.equal(mf1, 'nestedEvaluate', 'module format is nestedEvaluate');
 
-    const require = _ => o => o;
     const nestedEvaluate = src => {
       // console.log('========== evaluating', src);
-      return evaluate(src, { require, nestedEvaluate });
+      return evaluate(src, { nestedEvaluate });
     };
     const ex1 = nestedEvaluate(srcMap1)();
 
@@ -85,7 +84,7 @@ test('getExport', async t => {
     t.equal(mf1, 'getExport', 'module format is getExport');
 
     // eslint-disable-next-line no-eval
-    const ex1 = eval(`const require = _ => o => o;${srcMap1}`)();
+    const ex1 = eval(`${srcMap1}`)();
 
     const bundle = ex1.default();
     const err = bundle.makeError('foo');
@@ -105,7 +104,7 @@ test('getExport', async t => {
 
     const nestedEvaluate = src => {
       // console.log('========== evaluating', src, '\n=========');
-      return evaluate(src, { require, nestedEvaluate });
+      return evaluate(src, { nestedEvaluate });
     };
     // eslint-disable-next-line no-eval
     const ex2 = nestedEvaluate(srcMap2)();

diff --git a/packages/bundle-source/test/test-comment.js b/packages/bundle-source/test/test-comment.js
@@ -0,0 +1,85 @@
+/* global Compartment */
+import '@agoric/install-ses';
+import { test } from 'tape-promise/tape';
+import bundleSource from '..';
+
+function evaluate(src, endowments) {
+  const c = new Compartment(endowments, {}, {});
+  return c.evaluate(src);
+}
+
+test('trailing comment', async t => {
+  try {
+    const { source: src1 } = await bundleSource(
+      `${__dirname}/../demo/comments/trailing-comment.js`,
+      'nestedEvaluate',
+    );
+
+    const nestedEvaluate = src => {
+      // console.log('========== evaluating', src);
+      return evaluate(src, { nestedEvaluate });
+    };
+    // console.log(src1);
+    const srcMap1 = `(${src1})`;
+    const ex1 = nestedEvaluate(srcMap1)();
+
+    // console.log(err.stack);
+    t.equals(
+      typeof ex1.buildRootObject,
+      'function',
+      `buildRootObject is exported`,
+    );
+  } catch (e) {
+    t.isNot(e, e, 'unexpected exception');
+  } finally {
+    t.end();
+  }
+});
+
+test('comment block opener', async t => {
+  try {
+    t.plan(1);
+    const { source: src1 } = await bundleSource(
+      `${__dirname}/../demo/comments/block-opener.js`,
+      'nestedEvaluate',
+    );
+
+    const success = () => t.pass('body runs correctly');
+
+    const nestedEvaluate = src => {
+      // console.log('========== evaluating', src);
+      return evaluate(src, { nestedEvaluate, success });
+    };
+    // console.log(src1);
+    const srcMap1 = `(${src1})`;
+    nestedEvaluate(srcMap1)();
+  } catch (e) {
+    t.isNot(e, e, 'unexpected exception');
+  } finally {
+    t.end();
+  }
+});
+
+test('comment block closer', async t => {
+  try {
+    t.plan(1);
+    const { source: src1 } = await bundleSource(
+      `${__dirname}/../demo/comments/block-closer.js`,
+      'nestedEvaluate',
+    );
+
+    const success = () => t.pass('body runs correctly');
+
+    const nestedEvaluate = src => {
+      // console.log('========== evaluating', src);
+      return evaluate(src, { nestedEvaluate, success });
+    };
+    // console.log(src1);
+    const srcMap1 = `(${src1})`;
+    nestedEvaluate(srcMap1)();
+  } catch (e) {
+    t.isNot(e, e, 'unexpected exception');
+  } finally {
+    t.end();
+  }
+});
diff --git a/...ndle-source/test/test-trailing-comment.js → ...es/bundle-source/test/test-external-fs.js b/...ndle-source/test/test-trailing-comment.js → ...es/bundle-source/test/test-external-fs.js
@@ -8,29 +8,23 @@ function evaluate(src, endowments) {
   return c.evaluate(src);
 }
 
-test('trailing comment', async t => {
+test(`external require('fs')`, async t => {
   try {
+    t.plan(1);
     const { source: src1 } = await bundleSource(
-      `${__dirname}/../demo/trailing-comment.js`,
+      `${__dirname}/../demo/external-fs.js`,
       'nestedEvaluate',
     );
 
-    // Fake out `require('@agoric/harden')`.
-    const require = _ => o => o;
+    const myRequire = mod => t.equals(mod, 'fs', 'required fs module');
+
     const nestedEvaluate = src => {
       // console.log('========== evaluating', src);
-      return evaluate(src, { require, nestedEvaluate });
+      return evaluate(src, { nestedEvaluate, require: myRequire });
     };
     // console.log(src1);
     const srcMap1 = `(${src1})`;
-    const ex1 = nestedEvaluate(srcMap1)();
-
-    // console.log(err.stack);
-    t.equals(
-      typeof ex1.buildRootObject,
-      'function',
-      `buildRootObject is exported`,
-    );
+    nestedEvaluate(srcMap1)();
   } catch (e) {
     t.isNot(e, e, 'unexpected exception');
   } finally {