Enable ToC merging into nodes with children (#773)

* add temporary(?) slug matching

* deploy to pre-prd

* fixup

* Allow replacement of node with children

Author: casthewiz

.github/workflows/deploy-stg-ecs.yml

@@ -3,6 +3,7 @@ on:
     branches:
       - "master"
       - "integration"
+      - "embedded-atlas-cli-launch"
 concurrency:
   group: environment-stg-${{ github.ref }}
   cancel-in-progress: true

modules/persistence/src/services/metadata/ToC/index.ts

@@ -33,10 +33,10 @@ export interface TocOrderInsertions {
   };
 }
 
-const isInsertionCandidateNode = (node: ToC, associated_products: AssociatedProduct[] = []): boolean => {
-  const nodeInProducts = node.options?.project && associated_products.find((p) => p.name === node.options?.project);
-  const nodeHasNoChildren = !node.children || node.children.length === 0;
-  return !!(nodeHasNoChildren && nodeInProducts);
+const isInsertionCandidateNode = (node: ToC, toBeInserted: Set<string> = new Set([])): boolean => {
+  const projectName = node.options?.project;
+  const nodeInProducts = projectName && toBeInserted.has(projectName);
+  return !!nodeInProducts;
 };
 
 const mergeNode = (node: ToC, tocs: ToCInsertions, currentProject) => {
@@ -100,15 +100,16 @@ export const traverseAndMerge = (
   const { project } = metadata;
 
   const toctree = hasAssociations(metadata) ? umbrellaToCs.original : umbrellaToCs.urlified;
-
+  const toBeInserted = new Set(associated_products.map((p) => p.name));
   let queue = [toctree];
-  while (queue?.length) {
+  while (queue?.length && toBeInserted.size) {
     let next = queue.shift();
     // TODO: We can exit early here once we've found all the nodes.
     // We should track remaining insertions in a set and add some break logic.
-    if (next && isInsertionCandidateNode(next, associated_products)) {
+    if (next && isInsertionCandidateNode(next, toBeInserted)) {
       next = mergeNode(next, tocInsertions, project);
       metadata.toctreeorder = mergeTocTreeOrder(metadata, next, tocOrderInsertions);
+      toBeInserted.delete(next.options?.project);
     } else if (next?.children) {
       queue = [...queue, ...next.children];
     }

modules/persistence/tests/metadata/ToC.test.ts

@@ -75,7 +75,7 @@ describe('ToC module', () => {
         if (candidate) break;
         candidate = findTargetToc([metadata[metadataIdx].toctree as unknown as ToC]);
       }
-      expect(_isInsertionCandidateNode(candidate, associatedProducts)).toBeTruthy();
+      expect(_isInsertionCandidateNode(candidate, new Set(associatedProducts.map((p) => p.name)))).toBeTruthy();
     });
 
     test('it returns false if node is not an associated product, or node has children', () => {
@@ -84,7 +84,7 @@ describe('ToC module', () => {
         if (candidate) break;
         candidate = findTargetToc([metadata[metadataIdx].toctree as unknown as ToC], false);
       }
-      expect(_isInsertionCandidateNode(candidate, associatedProducts)).toBeFalsy();
+      expect(_isInsertionCandidateNode(candidate, new Set(associatedProducts.map((p) => p.name)))).toBeFalsy();
     });
   });