(EAI-375): Ingest snooty docs facets and meta

examples/quick-start/packages/ingest/src/ingest.config.ts

@@ -56,4 +56,10 @@ export default {
 
     return [mongodbChatbotFrameworkSource];
   },
+  concurrencyOptions: () => ({
+    embed: {
+      createChunks: 5,
+      processPages: 2,
+    },
+  }),
 } satisfies Config;

packages/ingest-mongodb-public/src/sources/snooty/SnootyDataSource.ts

@@ -2,7 +2,11 @@ import { createInterface } from "readline";
 import { Page, PageFormat, logger } from "mongodb-rag-core";
 import fetch from "node-fetch";
 import { DataSource, ProjectBase } from "mongodb-rag-core/dataSources";
-import { snootyAstToMd, getTitleFromSnootyAst } from "./snootyAstToMd";
+import {
+  snootyAstToMd,
+  getTitleFromSnootyAst,
+  getMetadataFromSnootyAst,
+} from "./snootyAstToMd";
 import {
   getTitleFromSnootyOpenApiSpecAst,
   snootyAstToOpenApiSpec,
@@ -49,6 +53,35 @@ export type SnootyTextNode = SnootyNode & {
   value: string;
 };
 
+export type SnootyFacetNode = SnootyNode & {
+  type: "directive";
+  name: "facet";
+  children: never;
+  options?: {
+    name: string;
+    values: string;
+  };
+};
+
+export type SnootyMetaNode = SnootyNode & {
+  type: "directive";
+  name: "meta";
+  children: never;
+  options?: {
+    /**
+      List of relevant keywords for the page, comma separated.
+      @example "code example, node.js, analyze, array"
+     */
+    keywords?: string;
+
+    /**
+      High-level description of the page.
+     */
+    description: string;
+    [key: string]: string | undefined;
+  };
+};
+
 /**
   A page in the Snooty manifest.
  */
@@ -328,6 +361,7 @@ export const handlePage = async (
     body = snootyAstToMd(page.ast);
     title = getTitleFromSnootyAst(page.ast);
   }
+  const metadata = getMetadataFromSnootyAst(page.ast);
 
   return {
     url: new URL(pagePath, baseUrl.replace(/\/?$/, "/")).href.replace(
@@ -339,6 +373,7 @@ export const handlePage = async (
     body,
     format,
     metadata: {
+      ...metadata,
       tags,
       productName,
       version,

packages/ingest-mongodb-public/src/sources/snooty/snootyAstToMd.test.ts

@@ -1,6 +1,10 @@
 import Path from "path";
 import fs from "fs";
-import { snootyAstToMd, getTitleFromSnootyAst } from "./snootyAstToMd";
+import {
+  snootyAstToMd,
+  getTitleFromSnootyAst,
+  getMetadataFromSnootyAst,
+} from "./snootyAstToMd";
 import { SnootyNode } from "./SnootyDataSource";
 import { rstToSnootyAst } from "./rstToSnootyAst";
 
@@ -300,3 +304,33 @@ describe("getTitleFromSnootyAst", () => {
     );
   });
 });
+
+describe("getMetadataFromSnootyAst", () => {
+  const sampleMetadataPage = JSON.parse(
+    fs.readFileSync(
+      Path.resolve(SRC_ROOT, "../testData/samplePageWithMetadata.json"),
+      {
+        encoding: "utf-8",
+      }
+    )
+  );
+  it("extracts meta directives", () => {
+    const metadata = getMetadataFromSnootyAst(sampleMetadataPage.data.ast);
+    expect(metadata).toMatchObject({
+      pageDescription: expect.any(String),
+    });
+  });
+  it("extracts meta.keyword directives as string[]", () => {
+    const metadata = getMetadataFromSnootyAst(sampleMetadataPage.data.ast);
+    expect(metadata).toMatchObject({
+      pageKeywords: expect.arrayContaining([expect.any(String)]),
+    });
+  });
+  it("extracts facet directives", () => {
+    const metadata = getMetadataFromSnootyAst(sampleMetadataPage.data.ast);
+    expect(metadata).toMatchObject({
+      pageGenre: "tutorial",
+      pageFoo: "bar",
+    });
+  });
+});

packages/ingest-mongodb-public/src/sources/snooty/snootyAstToMd.ts

@@ -1,4 +1,9 @@
-import { SnootyNode, SnootyTextNode } from "./SnootyDataSource";
+import {
+  SnootyFacetNode,
+  SnootyMetaNode,
+  SnootyNode,
+  SnootyTextNode,
+} from "./SnootyDataSource";
 import { strict as assert } from "assert";
 import { renderSnootyTable } from "./renderSnootyTable";
 
@@ -204,3 +209,59 @@ export const getTitleFromSnootyAst = (node: SnootyNode): string | undefined => {
   ) as SnootyTextNode[];
   return textNodes.map(({ value }) => value).join("");
 };
+
+export const getMetadataFromSnootyAst = (
+  node: SnootyNode
+): Record<string, unknown> => {
+  const facetAndMetaNodes = findAll(
+    node,
+    ({ name }) => name === "facet" || name === "meta"
+  ) as (SnootyFacetNode | SnootyMetaNode)[];
+
+  const facetNodes = facetAndMetaNodes.filter(
+    (n) => n.name === "facet"
+  ) as SnootyFacetNode[];
+  const metaNodes = facetAndMetaNodes.filter(
+    (n) => n.name === "meta"
+  ) as SnootyMetaNode[];
+
+  const keyPrefix = "page";
+
+  const facets = facetNodes.reduce((acc, facetNode) => {
+    if (!facetNode.options) {
+      return acc;
+    }
+    const { name, values } = facetNode.options;
+    if (!name || !values) {
+      return acc;
+    }
+    acc[createKeyName(name, keyPrefix)] = values;
+    return acc;
+  }, {} as Record<string, string>);
+
+  const meta = metaNodes.reduce((acc, metaNode) => {
+    if (!metaNode.options) {
+      return acc;
+    }
+    const metaEntries = Object.entries(metaNode.options);
+    for (const [key, value] of metaEntries) {
+      if (key === "keywords" && value) {
+        acc[createKeyName(key, keyPrefix)] = value
+          .split(",")
+          .map((s) => s.trim());
+      } else if (key === "description" && value) {
+        acc[createKeyName(key, keyPrefix)] = value;
+      }
+    }
+
+    return acc;
+  }, {} as Record<string, string | string[]>);
+  return {
+    ...facets,
+    ...meta,
+  };
+};
+
+function createKeyName(key: string, prefix = "") {
+  return prefix + key.charAt(0).toUpperCase() + key.slice(1);
+}