Fix for #213: throw an error when user tries to iterate over a non-ar…

…ray. Also added test that, without the fix, hangs indefinitely until Jest timeout kicks in.
guigrpa · May 31, 2021 · 165377b · 165377b
1 parent 68b255a
commit 165377b
Show file tree

Hide file tree

Showing 5 changed files with 31 additions and 2 deletions.
diff --git a/src/__tests__/__snapshots__/templating.test.ts.snap b/src/__tests__/__snapshots__/templating.test.ts.snap
@@ -28018,6 +28018,8 @@ Object {
 }
 `;
 
+exports[`noSandbox Template processing throw when user tries to iterate over non-array 1`] = `"Invalid FOR command: can only iterate over Array: FOR name IN companies"`;
+
 exports[`noSandbox Template processing works with macro-enabled (docm) templates 1`] = `
 Object {
   "_attrs": Object {
@@ -56216,6 +56218,8 @@ Object {
 }
 `;
 
+exports[`sandbox Template processing throw when user tries to iterate over non-array 1`] = `"Invalid FOR command: can only iterate over Array: FOR name IN companies"`;
+
 exports[`sandbox Template processing works with macro-enabled (docm) templates 1`] = `
 Object {
   "_attrs": Object {

diff --git a/src/__tests__/fixtures/forOverObject.docx b/src/__tests__/fixtures/forOverObject.docx
diff --git a/src/__tests__/fixtures/forOverObjectKeys.docx b/src/__tests__/fixtures/forOverObjectKeys.docx
diff --git a/src/__tests__/templating.test.ts b/src/__tests__/templating.test.ts
@@ -1046,11 +1046,31 @@ Morbi dignissim consequat ex, non finibus est faucibus sodales. Integer sed just
         expect(result).toMatchSnapshot();
       });
 
-      it('iterate over object properties and keys in FOR loop', async () => {
+      it('throw when user tries to iterate over non-array', async () => {
         // Example to answer question posed in issue #149
         const template = await fs.promises.readFile(
           path.join(__dirname, 'fixtures', 'forOverObject.docx')
         );
+        await expect(
+          createReport({
+            noSandbox,
+            template,
+            data: {
+              companies: {
+                one: 'FIRST',
+                two: 'SECOND',
+                three: 'THIRD',
+              },
+            },
+          })
+        ).rejects.toThrowErrorMatchingSnapshot();
+      });
+
+      it('iterate over object properties and keys in FOR loop', async () => {
+        // Example to answer question posed in issue #149
+        const template = await fs.promises.readFile(
+          path.join(__dirname, 'fixtures', 'forOverObjectKeys.docx')
+        );
         const result = await createReport(
           {
             noSandbox,

diff --git a/src/processTemplate.ts b/src/processTemplate.ts
@@ -651,7 +651,7 @@ const processForIf = async (
     const parentLoopLevel = ctx.loops.length - 1;
     const fParentIsExploring =
       parentLoopLevel >= 0 && ctx.loops[parentLoopLevel].idx === -1;
-    let loopOver;
+    let loopOver: unknown[];
     if (fParentIsExploring) {
       loopOver = [];
     } else if (isIf) {
@@ -660,6 +660,11 @@ const processForIf = async (
     } else {
       if (!forMatch) throw new InvalidCommandError('Invalid FOR command', cmd);
       loopOver = await runUserJsAndGetRaw(data, forMatch[2], ctx);
+      if (!Array.isArray(loopOver))
+        throw new InvalidCommandError(
+          'Invalid FOR command: can only iterate over Array',
+          cmd
+        );
     }
     ctx.loops.push({
       refNode: node,