Added maximumWalkingDepth option for supporting large documents

README.md

@@ -132,6 +132,15 @@ const report = await createReport({
    * Defaults to false.
    */
   fixSmartQuotes: false;
+
+  /**
+   * Maximum loop iterations allowed when walking through the template.
+   * You can increase this to generate reports with large amount of FOR loop elements.
+   * Tip: You can disable infinite loop protection by using the `Infinity` constant.
+   * This may be useful if you implement a process timeout instead.
+   * (Default: 1,000,000)
+   */
+  maximumWalkingDepth: 1_000_000;
 });
 ```
 

src/main.ts

@@ -165,6 +165,7 @@ async function createReport(
       options.processLineBreaksAsNewText == null
         ? false
         : options.processLineBreaksAsNewText,
+    maximumWalkingDepth: options.maximumWalkingDepth,
   };
   const xmlOptions = { literalXmlDelimiter };
 

src/processTemplate.ts

@@ -210,6 +210,7 @@ export async function walkTemplate(
   const errors: Error[] = [];
 
   let loopCount = 0;
+  const maximumWalkingDepth = ctx.options?.maximumWalkingDepth || 1_000_000;
   while (true) {
     const curLoop = getCurLoop(ctx);
     let nextSibling: Node | null = null;
@@ -249,14 +250,14 @@ export async function walkTemplate(
           `=== parent is null, breaking after ${loopCount} loops...`
         );
         break;
-      } else if (loopCount > 1000000) {
+      } else if (loopCount > maximumWalkingDepth) {
         // adding a emergency exit to avoid infit loops
         logger.debug(
           `=== parent is still not null after ${loopCount} loops, something must be wrong ...`,
           debugPrintNode(parent)
         );
         throw new InternalError(
-          'something went wrong with the document. Please review and try again'
+          'infinite loop or massive dataset detected. Please review and try again'
         );
       }
       nodeIn = parent;

src/types.ts

@@ -118,6 +118,15 @@ export type UserOptions = {
    * (Default: false)
    */
   processLineBreaksAsNewText?: boolean;
+
+  /**
+   * Maximum loop iterations allowed when walking through the template.
+   * You can increase this to generate reports with large amount of FOR loop elements.
+   * Tip: You can disable infinite loop protection by using the `Infinity` constant.
+   * This may be useful if you implement a process timeout instead.
+   * (Default: 1,000,000)
+   */
+  maximumWalkingDepth?: number;
 };
 
 export type CreateReportOptions = {
@@ -132,6 +141,7 @@ export type CreateReportOptions = {
   errorHandler: ErrorHandler | null;
   fixSmartQuotes: boolean;
   processLineBreaksAsNewText: boolean;
+  maximumWalkingDepth?: number;
 };
 
 export type SandBox = {