remove parallelism to debug performance

Author: avivkeller

src/generators/jsx-ast/index.mjs

@@ -1,21 +1,44 @@
 import { OVERRIDDEN_POSITIONS } from './constants.mjs';
+import { buildSideBarProps } from './utils/buildBarProps.mjs';
 import buildContent from './utils/buildContent.mjs';
-import {
-  getCompatibleVersions,
-  getVersionFromSemVer,
-  getVersionURL,
-  groupNodesByModule,
-} from '../../utils/generators.mjs';
+import { groupNodesByModule } from '../../utils/generators.mjs';
 import { getRemarkRecma } from '../../utils/remark.mjs';
 
 /**
- * This generator generates a JSX AST from an input MDAST
+ * Generator for converting MDAST to JSX AST.
  *
  * @typedef {Array<ApiDocMetadataEntry>} Input
- *
  * @type {GeneratorMetadata<Input, string>}
  */
-export default {
+
+/**
+ * Sorts entries by OVERRIDDEN_POSITIONS and then heading name.
+ * @param {Array<ApiDocMetadataEntry>} entries
+ */
+const getSortedHeadNodes = entries => {
+  return entries
+    .filter(node => node.heading.depth === 1)
+    .sort((a, b) => {
+      const ai = OVERRIDDEN_POSITIONS.indexOf(a.api);
+      const bi = OVERRIDDEN_POSITIONS.indexOf(b.api);
+
+      if (ai !== -1 && bi !== -1) {
+        return ai - bi;
+      }
+
+      if (ai !== -1) {
+        return -1;
+      }
+
+      if (bi !== -1) {
+        return 1;
+      }
+
+      return a.heading.data.name.localeCompare(b.heading.data.name);
+    });
+};
+
+const jsxAstGenerator = {
   name: 'jsx-ast',
   version: '1.0.0',
   description: 'Generates JSX AST from the input MDAST',
@@ -31,70 +54,35 @@ export default {
   async generate(entries, { index, releases, version }) {
     const remarkRecma = getRemarkRecma();
     const groupedModules = groupNodesByModule(entries);
-
-    // Get sorted primary heading nodes
-    const headNodes = entries
-      .filter(node => node.heading.depth === 1)
-      .sort((a, b) => {
-        const ai = OVERRIDDEN_POSITIONS.indexOf(a.api),
-          bi = OVERRIDDEN_POSITIONS.indexOf(b.api);
-        // If this is in OVERRIDDEN_POSITIONS, it must come first
-        return ai !== -1 && bi !== -1
-          ? ai - bi
-          : ai !== -1
-            ? -1
-            : bi !== -1
-              ? 1
-              : // Just compare headings
-                a.heading.data.name.localeCompare(b.heading.data.name);
-      });
+    const headNodes = getSortedHeadNodes(entries);
 
     // Generate table of contents
     const docPages = index
       ? index.map(({ section, api }) => [section, `${api}.html`])
       : headNodes.map(node => [node.heading.data.name, `${node.api}.html`]);
 
     // Process each head node and build content
-    const results = await Promise.all(
-      headNodes.map(entry => {
-        const versions = getCompatibleVersions(
-          entry.introduced_in,
-          releases,
-          true
-        );
-
-        const sideBarProps = {
-          versions: versions.map(({ version, isLts, isCurrent }) => {
-            const parsed = getVersionFromSemVer(version);
-            let label = `v${parsed}`;
+    const results = [];
+    for (const entry of headNodes) {
+      const sideBarProps = buildSideBarProps(
+        entry,
+        releases,
+        version,
+        docPages
+      );
 
-            if (isLts) {
-              label += ' (LTS)';
-            }
-
-            if (isCurrent) {
-              label += ' (Current)';
-            }
-
-            return {
-              value: getVersionURL(parsed, entry.api),
-              label,
-            };
-          }),
-          currentVersion: `v${version.version}`,
-          pathname: `${entry.api}.html`,
-          docPages,
-        };
-
-        return buildContent(
+      results.push(
+        await buildContent(
           groupedModules.get(entry.api),
           entry,
           sideBarProps,
           remarkRecma
-        );
-      })
-    );
+        )
+      );
+    }
 
     return results;
   },
 };
+
+export default jsxAstGenerator;

src/generators/jsx-ast/utils/buildBarProps.mjs

@@ -2,6 +2,11 @@ import readingTime from 'reading-time';
 import { visit } from 'unist-util-visit';
 
 import { DOC_API_BLOB_EDIT_BASE_URL } from '../../../constants.mjs';
+import {
+  getCompatibleVersions,
+  getVersionFromSemVer,
+  getVersionURL,
+} from '../../../utils/generators.mjs';
 
 /**
  * Builds metadata for the sidebar and meta bar
@@ -42,3 +47,36 @@ export const buildMetaBarProps = (head, entries) => {
     editThisPage: `${DOC_API_BLOB_EDIT_BASE_URL}${head.api}.md`,
   };
 };
+
+/**
+ * Builds the sidebar properties for a given entry.
+ * @param {ApiDocMetadataEntry} entry
+ * @param {Array<ApiDocReleaseEntry>} releases
+ * @param {import('semver').SemVer} version
+ * @param {Array<[string, string]>} docPages
+ */
+export const buildSideBarProps = (entry, releases, version, docPages) => {
+  const versions = getCompatibleVersions(entry.introduced_in, releases, true);
+
+  return {
+    versions: versions.map(({ version, isLts, isCurrent }) => {
+      const parsed = getVersionFromSemVer(version);
+
+      let label = `v${parsed}`;
+      if (isLts) {
+        label += ' (LTS)';
+      }
+      if (isCurrent) {
+        label += ' (Current)';
+      }
+
+      return {
+        value: getVersionURL(parsed, entry.api),
+        label,
+      };
+    }),
+    currentVersion: `v${version.version}`,
+    pathname: `${entry.api}.html`,
+    docPages,
+  };
+};

src/generators/jsx-ast/utils/buildContent.mjs

@@ -224,15 +224,16 @@ const createDocumentLayout = (entries, sideBarProps, metaBarProps) => {
  * @param {import('unified').Processor} remark - Remark processor instance for markdown processing
  * @returns {JSXContent} The processed MDX content
  */
-const buildContent = (metadataEntries, head, sideBarProps, remark) => {
+const buildContent = async (metadataEntries, head, sideBarProps, remark) => {
   const metaBarProps = buildMetaBarProps(head, metadataEntries);
 
   const root = createDocumentLayout(
     metadataEntries,
     sideBarProps,
     metaBarProps
   );
-  const ast = remark.runSync(root);
+
+  const ast = await remark.run(root);
 
   // ast => { Program: { Expression: { JSX } } }
   return {

src/generators/web/index.mjs

@@ -107,12 +107,12 @@ export default {
     const require = createRequire(RESOLVE_DIR);
 
     // Process all entries
-    // TODO(@avivkeller): Remove parallelism, as it can cause memory crashes
-    const results = await Promise.all(
-      entries.map(entry =>
-        processEntry(entry, template, astBuilders, require, output)
-      )
-    );
+    const results = [];
+    for (const entry of entries) {
+      results.push(
+        await processEntry(entry, template, astBuilders, require, output)
+      );
+    }
 
     if (output) {
       await writeFile(