Merge pull request #573 from dolthub/taylor/agent-doc

tbantle22 · web-flow · commit 64b9666dacc3 · 2025-08-11T17:54:50.000Z
web,graphql: Support AGENT.md
diff --git a/graphql-server/schema.gql b/graphql-server/schema.gql
@@ -395,6 +395,7 @@ enum DocType {
   Unspecified
   Readme
   License
+  Agent
 }
 
 enum DiffRowType {
diff --git a/graphql-server/src/docs/doc.enum.ts b/graphql-server/src/docs/doc.enum.ts
@@ -5,6 +5,7 @@ export enum DocType {
   Unspecified = "Unspecified",
   Readme = "README.md",
   License = "LICENSE.md",
+  Agent = "AGENT.md",
 }
 
 registerEnumType(DocType, { name: "DocType" });
@@ -15,6 +16,8 @@ export function toDocType(r: Row): DocType {
       return DocType.Readme;
     case "LICENSE.md":
       return DocType.License;
+    case "AGENT.md":
+      return DocType.Agent;
     default:
       return DocType.Unspecified;
   }
diff --git a/graphql-server/src/docs/doc.resolver.ts b/graphql-server/src/docs/doc.resolver.ts
@@ -22,11 +22,8 @@ export class DocsResolver {
     const conn = this.conn.connection();
     const docRows = await conn.getDocs(args);
     if (!docRows?.length) return { list: [] };
-    const sortedDocs = docRows.sort(d =>
-      d.doc_name === DocType.Readme ? -1 : 1,
-    );
     return {
-      list: sortedDocs.map(d => fromDoltDocsRow(args.refName, d)),
+      list: docRows.map(d => fromDoltDocsRow(args.refName, d)),
     };
   }
 
diff --git a/graphql-server/src/queryFactory/dolt/doltEntityManager.ts b/graphql-server/src/queryFactory/dolt/doltEntityManager.ts
@@ -141,7 +141,8 @@ export async function getDoltDocs(em: EntityManager): t.UPR {
   const sel = em
     .createQueryBuilder()
     .select("*")
-    .from(DoltSystemTable.DOCS, "");
+    .from(DoltSystemTable.DOCS, "")
+    .orderBy("doc_name", "DESC");
   return handleTableNotFound(async () => sel.getRawMany());
 }
 
diff --git a/web/jest.config.js b/web/jest.config.js
@@ -1,4 +1,4 @@
-import nextJest from "next/jest.js";
+const nextJest = require("next/jest");
 
 const TEST_REGEX = "(/__tests__/.*|(\\.|/)(test|spec))\\.(jsx?|js?|tsx?|ts?)$";
 
@@ -36,4 +36,4 @@ const customJestConfig = {
 };
 
 // createJestConfig is exported in this way to ensure that next/jest can load the Next.js config which is async
-export default createJestConfig(customJestConfig);
+module.exports = createJestConfig(customJestConfig);
diff --git a/web/package.json b/web/package.json
@@ -75,6 +75,7 @@
     "uuid": "^11.1.0"
   },
   "devDependencies": {
+    "@babel/core": "^7.28.0",
     "@electron/osx-sign": "^2.0.0",
     "@graphql-codegen/cli": "^5.0.5",
     "@graphql-codegen/fragment-matcher": "^5.1.0",
@@ -86,6 +87,7 @@
     "@testing-library/user-event": "^14.6.1",
     "@types/adm-zip": "^0",
     "@types/apollo-upload-client": "^17",
+    "@types/babel__core": "^7",
     "@types/chance": "^1.1.5",
     "@types/diff": "^5.2.1",
     "@types/jest": "^29.5.6",
diff --git a/web/renderer/components/DatabaseHeaderAndNav/AddItemDropdown/DocItem.tsx b/web/renderer/components/DatabaseHeaderAndNav/AddItemDropdown/DocItem.tsx
@@ -23,7 +23,7 @@ function Inner(props: InnerProps) {
 
   const canCreateNewDoc =
     props.userHasWritePerms &&
-    (!res.data?.docs || res.data.docs.list.length < 2);
+    (!res.data?.docs || res.data.docs.list.length < 3);
 
   return <NewDocLink params={props.params} hide={!canCreateNewDoc} />;
 }
@@ -55,7 +55,7 @@ function NewDocLink(props: {
       doltDisabled={props.doltDisabled}
       hide={props.hide}
     >
-      New README/LICENSE
+      New doc
     </DropdownItem>
   );
 }
diff --git a/web/renderer/components/pageComponents/DatabasePage/ForDocs/DocsPage/DocList/NewDocButton.tsx b/web/renderer/components/pageComponents/DatabasePage/ForDocs/DocsPage/DocList/NewDocButton.tsx
@@ -17,7 +17,7 @@ export default function NewDocButton(props: Props) {
         <Button data-cy="add-doc-button">
           <div>
             <FiPlus />
-            Add README/LICENSE
+            Add doc
           </div>
         </Button>
       </Link>
diff --git a/web/renderer/components/pageComponents/DatabasePage/ForDocs/DocsPage/DocList/index.tsx b/web/renderer/components/pageComponents/DatabasePage/ForDocs/DocsPage/DocList/index.tsx
@@ -17,7 +17,7 @@ type InnerProps = Props & {
 };
 
 function Inner({ docs, params }: InnerProps) {
-  const canCreateNewDoc = docs.list.length < 2;
+  const canCreateNewDoc = docs.list.length < 3;
   return (
     <div className={css.docsContainer}>
       {docs.list.length > 0 && (
diff --git a/web/renderer/components/pageComponents/DatabasePage/ForDocs/NewDocPage/Header.tsx b/web/renderer/components/pageComponents/DatabasePage/ForDocs/NewDocPage/Header.tsx
@@ -15,7 +15,7 @@ export default function Header(props: Props) {
         pageName="docs"
         className={css.goBack}
       />
-      <div className={css.title}>Add a README or LICENSE</div>
+      <div className={css.title}>Add a doc</div>
     </div>
   );
 }
diff --git a/web/renderer/components/pageComponents/DatabasePage/ForDocs/NewDocPage/NewDocForm.test.tsx b/web/renderer/components/pageComponents/DatabasePage/ForDocs/NewDocPage/NewDocForm.test.tsx
@@ -1,4 +1,5 @@
 import { MockedProvider } from "@apollo/client/testing";
+import { databaseDetailsMock } from "@components/util/NotDoltWrapper/mocks";
 import useMockRouter, { actions } from "@hooks/useMockRouter";
 import { RefParams } from "@lib/params";
 import { setup } from "@lib/testUtils.test";
@@ -20,19 +21,24 @@ jest.mock("next/router", () => {
   };
 });
 
-const docTitle = "Add a README or LICENSE";
+const docTitle = "Add a doc";
 
 describe("test NewDocForm", () => {
+  beforeEach(() => {
+    actions.push.mockClear();
+  });
+
   it("renders new doc form for no docs", async () => {
     useMockRouter(jestRouter, {});
     const { user } = setup(
-      <MockedProvider mocks={[docsMock(params, [])]}>
+      <MockedProvider
+        mocks={[docsMock(params, []), databaseDetailsMock(true, false)]}
+      >
         <NewDocForm params={params} />
       </MockedProvider>,
     );
 
     expect(await screen.findByText(docTitle)).toBeVisible();
-    expect(await screen.findByText("LICENSE")).toBeVisible();
 
     const button = screen.getByText("Create");
     expect(button).toBeDisabled();
@@ -48,7 +54,7 @@ describe("test NewDocForm", () => {
 
     const { href, as } = sqlQuery({
       ...params,
-      q: `REPLACE INTO dolt_docs VALUES ("LICENSE.md", "${markdown}")`,
+      q: `REPLACE INTO dolt_docs VALUES ("AGENT.md", "${markdown}")`,
     });
     await waitFor(() => expect(actions.push).toHaveBeenCalledWith(href, as));
   });
diff --git a/web/renderer/components/pageComponents/DatabasePage/ForDocs/NewDocPage/NewDocForm.tsx b/web/renderer/components/pageComponents/DatabasePage/ForDocs/NewDocPage/NewDocForm.tsx
@@ -40,7 +40,7 @@ function Inner(props: InnerProps) {
       <div className={css.body}>
         <HideForNoWritesWrapper
           params={props.params}
-          noWritesAction="add LICENSE or README"
+          noWritesAction="add a doc"
         >
           <form onSubmit={onSubmit}>
             <div className={css.selectContainer}>
@@ -63,8 +63,8 @@ function Inner(props: InnerProps) {
               </div>
             ) : (
               <p className={css.marTop}>
-                Both README and LICENSE exist. Click on an individual document
-                in the About section to edit.
+                All docs exist. Click on an individual document in the About
+                section to edit.
               </p>
             )}
             <Button
@@ -94,6 +94,7 @@ function getOptions(docRows?: DocForDocPageFragment[]): Option[] {
   const options: Option[] = [
     { label: "README", value: DocType.Readme },
     { label: "LICENSE", value: DocType.License },
+    { label: "AGENT", value: DocType.Agent },
   ];
   return (
     options
diff --git a/web/renderer/gen/graphql-types.tsx b/web/renderer/gen/graphql-types.tsx
@@ -161,6 +161,7 @@ export type DocList = {
 };
 
 export enum DocType {
+  Agent = 'Agent',
   License = 'License',
   Readme = 'Readme',
   Unspecified = 'Unspecified'
diff --git a/web/renderer/lib/toDocType.ts b/web/renderer/lib/toDocType.ts
@@ -6,6 +6,8 @@ export default function toDocType(t: string | undefined): DocType {
       return DocType.Readme;
     case "LICENSE.md":
       return DocType.License;
+    case "AGENT.md":
+      return DocType.Agent;
     default:
       return DocType.Unspecified;
   }
@@ -17,6 +19,8 @@ export function fromDocType(t: DocType): string | undefined {
       return "README.md";
     case DocType.License:
       return "LICENSE.md";
+    case DocType.Agent:
+      return "AGENT.md";
     default:
       return undefined;
   }
diff --git a/web/yarn.lock b/web/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -395,6 +395,7 @@ enum DocType {`
`395`	`395`	`Unspecified`
`396`	`396`	`Readme`
`397`	`397`	`License`
	`398`	`+ Agent`
`398`	`399`	`}`
`399`	`400`
`400`	`401`	`enum DiffRowType {`
Original file line number	Diff line number	Diff line change
`@@ -141,7 +141,8 @@ export async function getDoltDocs(em: EntityManager): t.UPR {`
`141`	`141`	`const sel = em`
`142`	`142`	`.createQueryBuilder()`
`143`	`143`	`.select("*")`
`144`		`- .from(DoltSystemTable.DOCS, "");`
	`144`	`+ .from(DoltSystemTable.DOCS, "")`
	`145`	`+ .orderBy("doc_name", "DESC");`
`145`	`146`	`return handleTableNotFound(async () => sel.getRawMany());`
`146`	`147`	`}`
`147`	`148`
Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,7 @@ function Inner(props: InnerProps) {`
`23`	`23`
`24`	`24`	`const canCreateNewDoc =`
`25`	`25`	`props.userHasWritePerms &&`
`26`		`- (!res.data?.docs \|\| res.data.docs.list.length < 2);`
	`26`	`+ (!res.data?.docs \|\| res.data.docs.list.length < 3);`
`27`	`27`
`28`	`28`	`return <NewDocLink params={props.params} hide={!canCreateNewDoc} />;`
`29`	`29`	`}`
`@@ -55,7 +55,7 @@ function NewDocLink(props: {`
`55`	`55`	`doltDisabled={props.doltDisabled}`
`56`	`56`	`hide={props.hide}`
`57`	`57`	`>`
`58`		`- New README/LICENSE`
	`58`	`+ New doc`
`59`	`59`	`</DropdownItem>`
`60`	`60`	`);`
`61`	`61`	`}`
Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,7 @@ export default function Header(props: Props) {`
`15`	`15`	`pageName="docs"`
`16`	`16`	`className={css.goBack}`
`17`	`17`	`/>`
`18`		`- <div className={css.title}>Add a README or LICENSE</div>`
	`18`	`+ <div className={css.title}>Add a doc</div>`
`19`	`19`	`</div>`
`20`	`20`	`);`
`21`	`21`	`}`