fix(checks): prevent OOM, disable concurrent with more than 100 checks

Author: tomastrajan

lib/tasks/run-checks.task.ts

@@ -32,85 +32,84 @@ export const runChecksTask: ListrTask = {
     }
   },
   task: async (ctx: Context, task) => {
-    const checksDefinitionsFromApi = ctx.definitions?.checks ?? [];
-    const checksDefinitionsFromCli = ctx.options?.checkDefinition
-      ? [JSON.parse(ctx.options.checkDefinition)]
-      : [];
-    const checkTasks: any = (
-      checksDefinitionsFromCli.length
-        ? checksDefinitionsFromCli
-        : checksDefinitionsFromApi
-    )
-      .filter((definition) => {
-        if (
-          ctx.options.checkPattern &&
-          !new RegExp(ctx.options.checkPattern, 'i').test(definition.name)
-        ) {
-          return false;
-        }
-        return definition.type !== CheckType.META;
-      })
-      .map((definition) => ({
-        title: `[${definition.type.padEnd(7, ' ')}] "${definition.name}"`,
-        skip: async (ctx: Context): Promise<any> => {
-          if (definition.disabled) {
+    const checkTasks = buildTasks(ctx);
+    task.title += `, ${checkTasks.length} applicable checks`;
+    return task.newListr(checkTasks, {
+      concurrent: checkTasks?.length < 100,
+    });
+  },
+};
+
+function buildTasks(ctx: Context) {
+  const checksDefinitionsFromApi = ctx.definitions?.checks ?? [];
+  const checksDefinitionsFromCli = ctx.options?.checkDefinition
+    ? [JSON.parse(ctx.options.checkDefinition)]
+    : [];
+  return (
+    checksDefinitionsFromCli.length
+      ? checksDefinitionsFromCli
+      : checksDefinitionsFromApi
+  )
+    .filter((definition) => {
+      if (
+        ctx.options.checkPattern &&
+        !new RegExp(ctx.options.checkPattern, 'i').test(definition.name)
+      ) {
+        return false;
+      }
+      return definition.type !== CheckType.META;
+    })
+    .map((definition) => ({
+      title: `[${definition.type.padEnd(7, ' ')}] "${definition.name}"`,
+      skip: async (ctx: Context): Promise<any> => {
+        if (definition.disabled) {
+          return `${CheckResultSymbol.SKIPPED} [${definition.type.padEnd(
+            7,
+            ' '
+          )}] "${definition.name}": DISABLED`;
+        } else if (definition.projectNamePattern) {
+          const projectNameRegexp = new RegExp(
+            definition.projectNamePattern,
+            resolveActiveFlags(
+              definition.projectNamePatternFlags,
+              DEFAULT_PROJECT_NAME_PATTERN_FLAGS
+            )
+          );
+          if (!projectNameRegexp.test(ctx.results.name || '')) {
             return `${CheckResultSymbol.SKIPPED} [${definition.type.padEnd(
               7,
               ' '
-            )}] "${definition.name}": DISABLED`;
-          } else if (definition.projectNamePattern) {
-            const projectNameRegexp = new RegExp(
-              definition.projectNamePattern,
-              resolveActiveFlags(
-                definition.projectNamePatternFlags,
-                DEFAULT_PROJECT_NAME_PATTERN_FLAGS
-              )
-            );
-            if (!projectNameRegexp.test(ctx.results.name || '')) {
-              return `${CheckResultSymbol.SKIPPED} [${definition.type.padEnd(
-                7,
-                ' '
-              )}] "${definition.name}": project ${
-                ctx.results.name
-              } doesn't match ${definition.projectNamePattern}`;
-            } else {
-              return false;
-            }
+            )}] "${definition.name}": project ${
+              ctx.results.name
+            } doesn't match ${definition.projectNamePattern}`;
           } else {
             return false;
           }
-        },
-        task: (() => {
-          if (definition.type === CheckType.CONTENT) {
-            return contentCheckTaskFactory(
-              definition as ContentCheckDefinition
-            );
-          } else if (definition.type === CheckType.XPATH) {
-            return xpathCheckTaskFactory(
-              definition as XPathCheckDefinition,
-              ctx
+        } else {
+          return false;
+        }
+      },
+      task: (() => {
+        if (definition.type === CheckType.CONTENT) {
+          return contentCheckTaskFactory(definition as ContentCheckDefinition);
+        } else if (definition.type === CheckType.XPATH) {
+          return xpathCheckTaskFactory(definition as XPathCheckDefinition, ctx);
+        } else if (definition.type === CheckType.SIZE) {
+          return sizeCheckTaskFactory(definition);
+        } else if (definition.type === CheckType.FILE) {
+          return fileCheckTaskFactory(definition);
+        } else if (definition.type === CheckType.JSON) {
+          return jsonCheckTaskFactory(definition);
+        } else {
+          return function unknownCheckTask(
+            ctx: Context,
+            task: ListrTaskWrapper<Context, ListrDefaultRenderer>
+          ) {
+            task.skip(
+              `Implementation for a check with type "${definition.type}" not found`
             );
-          } else if (definition.type === CheckType.SIZE) {
-            return sizeCheckTaskFactory(definition);
-          } else if (definition.type === CheckType.FILE) {
-            return fileCheckTaskFactory(definition);
-          } else if (definition.type === CheckType.JSON) {
-            return jsonCheckTaskFactory(definition);
-          } else {
-            return function unknownCheckTask(
-              ctx: Context,
-              task: ListrTaskWrapper<Context, ListrDefaultRenderer>
-            ) {
-              task.skip(
-                `Implementation for a check with type "${definition.type}" not found`
-              );
-            };
-          }
-        })(),
-      }));
-
-    return task.newListr(checkTasks, {
-      concurrent: true,
-    });
-  },
-};
+          };
+        }
+      })(),
+    }));
+}