Deterministic OpenAPI spec generation

Author: N2D4

apps/backend/scripts/generate-openapi-fumadocs.ts

@@ -29,7 +29,7 @@ async function main() {
   // Generate OpenAPI specs for each audience (let parseOpenAPI handle the filtering)
   const filePathPrefix = path.resolve(process.platform === "win32" ? "apps/src/app/api/latest" : "src/app/api/latest");
   const importPathPrefix = "@/app/api/latest";
-  const filePaths = [...await glob(filePathPrefix + "/**/route.{js,jsx,ts,tsx}")];
+  const filePaths = [...await glob(filePathPrefix + "/**/route.{js,jsx,ts,tsx}")].sort((a, b) => a.localeCompare(b));
 
   const endpoints = new Map(await Promise.all(filePaths.map(async (filePath) => {
     if (!filePath.startsWith(filePathPrefix)) {

apps/backend/src/lib/openapi.tsx

@@ -34,7 +34,13 @@ export function parseOpenAPI(options: {
           )]
         ))
         .filter(([_, handlersByMethod]) => Object.keys(handlersByMethod).length > 0)
-        .sort(([_a, handlersByMethodA], [_b, handlersByMethodB]) => stringCompare((Object.values(handlersByMethodA)[0] as any).tags[0] ?? "", (Object.values(handlersByMethodB)[0] as any).tags[0] ?? "")),
+        .sort(([pathA, handlersByMethodA], [pathB, handlersByMethodB]) => {
+          const tagComparison = stringCompare((Object.values(handlersByMethodA)[0] as any).tags[0] ?? "", (Object.values(handlersByMethodB)[0] as any).tags[0] ?? "");
+          if (tagComparison !== 0) {
+            return tagComparison;
+          }
+          return stringCompare(pathA, pathB);
+        }),
     ),
   };
 }