fix: subpackages should recursively expand its children (#3875)

fix: subpackages should recursively expand its children in step 2
fern-api · Jun 18, 2024 · f459d03 · f459d03
1 parent 026e796
commit f459d03
Show file tree

Hide file tree

Showing 13 changed files with 183 additions and 42 deletions.
diff --git a/.pnp.cjs b/.pnp.cjs
diff --git a/...-npm-0.98.0-rc1-621f8f4dde-5178c9e245.zip → ....98.2-d590e2c8a-7fd0ca2aac-40586b9a27.zip b/...-npm-0.98.0-rc1-621f8f4dde-5178c9e245.zip → ....98.2-d590e2c8a-7fd0ca2aac-40586b9a27.zip
diff --git a/packages/cli/configuration/package.json b/packages/cli/configuration/package.json
@@ -29,7 +29,7 @@
   },
   "dependencies": {
     "@fern-api/core-utils": "workspace:*",
-    "@fern-api/fdr-sdk": "0.98.0-rc1",
+    "@fern-api/fdr-sdk": "0.98.2-d590e2c8a",
     "@fern-api/fs-utils": "workspace:*",
     "@fern-api/task-context": "workspace:*",
     "@fern-fern/fiddle-sdk": "^0.0.552",

diff --git a/packages/cli/docs-preview/package.json b/packages/cli/docs-preview/package.json
@@ -28,7 +28,7 @@
   },
   "dependencies": {
     "@fern-api/docs-resolver": "workspace:*",
-    "@fern-api/fdr-sdk": "0.98.0-rc1",
+    "@fern-api/fdr-sdk": "0.98.2-d590e2c8a",
     "@fern-api/fs-utils": "workspace:*",
     "@fern-api/ir-sdk": "workspace:*",
     "@fern-api/logger": "workspace:*",

diff --git a/packages/cli/docs-resolver/package.json b/packages/cli/docs-resolver/package.json
@@ -29,7 +29,7 @@
   "dependencies": {
     "@fern-api/configuration": "workspace:*",
     "@fern-api/core-utils": "workspace:*",
-    "@fern-api/fdr-sdk": "0.98.0-rc1",
+    "@fern-api/fdr-sdk": "0.98.2-d590e2c8a",
     "@fern-api/fs-utils": "workspace:*",
     "@fern-api/ir-generator": "workspace:*",
     "@fern-api/ir-sdk": "workspace:*",

diff --git a/packages/cli/docs-resolver/src/ApiReferenceNodeConverter.ts b/packages/cli/docs-resolver/src/ApiReferenceNodeConverter.ts
@@ -67,7 +67,7 @@ export class ApiReferenceNodeConverter {
 
         // Step 2. Fill in the any missing navigation items from the API definition
         this.#children = this.#mergeAndFilterChildren(
-            this.#children.map((child) => this.#convertApiPackageChild(child, this.#slug)),
+            this.#children.map((child) => this.#enrichApiPackageChild(child)),
             this.#convertApiDefinitionPackage(this.#holder.api.rootPackage, this.#slug)
         );
     }
@@ -363,6 +363,8 @@ export class ApiReferenceNodeConverter {
                 this.taskContext.logger.error(`Duplicate endpoint found in the API Reference layout: ${endpointId}`);
             }
             this.#visitedEndpoints.add(endpointId);
+            const endpointSlug =
+                endpointItem.slug != null ? parentSlug.append(endpointItem.slug) : parentSlug.apply(endpoint);
             return {
                 id: idgen.append(endpoint.id).get(),
                 type: "endpoint",
@@ -372,10 +374,7 @@ export class ApiReferenceNodeConverter {
                 availability: FernNavigation.utils.convertAvailability(endpoint.availability),
                 isResponseStream: endpoint.response?.type.type === "stream",
                 title: endpointItem.title ?? endpoint.name ?? stringifyEndpointPathParts(endpoint.path.parts),
-                slug: (endpointItem.slug != null
-                    ? parentSlug.append(endpointItem.slug)
-                    : parentSlug.apply(endpoint)
-                ).get(),
+                slug: endpointSlug.get(),
                 icon: endpointItem.icon,
                 hidden: endpointItem.hidden
             };
@@ -458,18 +457,20 @@ export class ApiReferenceNodeConverter {
         );
     }
 
-    #convertApiPackageChild(
-        child: FernNavigation.ApiPackageChild,
-        parentSlug: FernNavigation.SlugGenerator
-    ): FernNavigation.ApiPackageChild {
+    #enrichApiPackageChild(child: FernNavigation.ApiPackageChild): FernNavigation.ApiPackageChild {
         if (child.type === "apiPackage") {
-            const slug = parentSlug.set(child.slug);
+            // expand the subpackage to include children that haven't been visited yet
+            const slug = FernNavigation.SlugGenerator.init(child.slug);
             const subpackageIds = this.#nodeIdToSubpackageId.get(child.id) ?? [];
             const subpackageChildren = subpackageIds.flatMap((subpackageId) =>
                 this.#convertApiDefinitionPackageId(subpackageId, slug)
             );
 
-            const children = this.#mergeAndFilterChildren(child.children, subpackageChildren);
+            // recursively apply enrichment to children
+            const enrichedChildren = child.children.map((innerChild) => this.#enrichApiPackageChild(innerChild));
+
+            // combine children with subpackage (tacked on at the end to preserve order)
+            const children = this.#mergeAndFilterChildren(enrichedChildren, subpackageChildren);
 
             return {
                 ...child,
@@ -495,6 +496,8 @@ export class ApiReferenceNodeConverter {
             if (this.#visitedEndpoints.has(endpointId)) {
                 return;
             }
+
+            const endpointSlug = parentSlug.apply(endpoint);
             additionalChildren.push({
                 id: FernNavigation.NodeId(`${this.apiDefinitionId}:${endpointId}`),
                 type: "endpoint",
@@ -504,7 +507,7 @@ export class ApiReferenceNodeConverter {
                 availability: FernNavigation.utils.convertAvailability(endpoint.availability),
                 isResponseStream: endpoint.response?.type.type === "stream",
                 title: endpoint.name ?? stringifyEndpointPathParts(endpoint.path.parts),
-                slug: parentSlug.apply(endpoint).get(),
+                slug: endpointSlug.get(),
                 icon: undefined,
                 hidden: undefined
             });

diff --git a/packages/cli/docs-resolver/src/__test__/__snapshots__/api-resolver.test.ts.snap b/packages/cli/docs-resolver/src/__test__/__snapshots__/api-resolver.test.ts.snap
@@ -50,6 +50,72 @@ exports[`converts to api reference node 1`] = `
       "apiDefinitionId": "550e8400-e29b-41d4-a716-446655440000",
       "availability": undefined,
       "children": [
+        {
+          "apiDefinitionId": "550e8400-e29b-41d4-a716-446655440000",
+          "availability": undefined,
+          "children": [
+            {
+              "apiDefinitionId": "550e8400-e29b-41d4-a716-446655440000",
+              "availability": undefined,
+              "endpointId": "endpoint_trailers.createTrailer",
+              "hidden": undefined,
+              "icon": undefined,
+              "id": "550e8400-e29b-41d4-a716-446655440000:endpoint_trailers.createTrailer",
+              "isResponseStream": false,
+              "method": "POST",
+              "slug": "base/path/api-reference/imdb/trailers/create-trailer",
+              "title": "Create Trailer",
+              "type": "endpoint",
+            },
+            {
+              "apiDefinitionId": "550e8400-e29b-41d4-a716-446655440000",
+              "availability": undefined,
+              "endpointId": "endpoint_trailers.getTrailer",
+              "hidden": undefined,
+              "icon": undefined,
+              "id": "550e8400-e29b-41d4-a716-446655440000:endpoint_trailers.getTrailer",
+              "isResponseStream": false,
+              "method": "GET",
+              "slug": "base/path/api-reference/imdb/trailers/get-trailer",
+              "title": "Get Trailer",
+              "type": "endpoint",
+            },
+            {
+              "apiDefinitionId": "550e8400-e29b-41d4-a716-446655440000",
+              "availability": undefined,
+              "endpointId": "endpoint_trailers.getTrailerForMovie",
+              "hidden": undefined,
+              "icon": undefined,
+              "id": "550e8400-e29b-41d4-a716-446655440000:endpoint_trailers.getTrailerForMovie",
+              "isResponseStream": false,
+              "method": "GET",
+              "slug": "base/path/api-reference/imdb/trailers/get-trailer-for-movie",
+              "title": "Get Trailer For Movie",
+              "type": "endpoint",
+            },
+            {
+              "apiDefinitionId": "550e8400-e29b-41d4-a716-446655440000",
+              "availability": undefined,
+              "endpointId": "endpoint_trailers.deleteTrailer",
+              "hidden": undefined,
+              "icon": undefined,
+              "id": "550e8400-e29b-41d4-a716-446655440000:endpoint_trailers.deleteTrailer",
+              "isResponseStream": false,
+              "method": "DELETE",
+              "slug": "base/path/api-reference/imdb/trailers/delete-trailer",
+              "title": "Delete Trailer",
+              "type": "endpoint",
+            },
+          ],
+          "hidden": undefined,
+          "icon": undefined,
+          "id": "550e8400-e29b-41d4-a716-446655440000.subpackage_imdb.subpackage_trailers",
+          "overviewPageId": undefined,
+          "pointsTo": "base/path/api-reference/imdb/trailers/create-trailer",
+          "slug": "base/path/api-reference/imdb/trailers",
+          "title": "Trailers",
+          "type": "apiPackage",
+        },
         {
           "apiDefinitionId": "550e8400-e29b-41d4-a716-446655440000",
           "availability": undefined,
@@ -66,9 +132,9 @@ exports[`converts to api reference node 1`] = `
       ],
       "hidden": undefined,
       "icon": undefined,
-      "id": "550e8400-e29b-41d4-a716-446655440000:subpackage_imdb",
+      "id": "550e8400-e29b-41d4-a716-446655440000.subpackage_imdb",
       "overviewPageId": undefined,
-      "pointsTo": "base/path/api-reference/imdb/create-movie",
+      "pointsTo": "base/path/api-reference/imdb/trailers/create-trailer",
       "slug": "base/path/api-reference/imdb",
       "title": "Imdb",
       "type": "apiPackage",
@@ -173,12 +239,27 @@ exports[`converts to api reference node: endpointsByLocator keys 1`] = `
   "GET /movies/:id",
   "DELETE /movies/{id}",
   "DELETE /movies/:id",
+  "POST /trailers/create",
+  "GET /trailers/{id}",
+  "GET /trailers/:id",
+  "GET /trailers/movie/{id}",
+  "GET /trailers/movie/:id",
+  "DELETE /trailers/{id}",
+  "DELETE /trailers/:id",
   "imdb.createMovie",
   "imdb/createMovie",
   "imdb.getMovie",
   "imdb/getMovie",
   "imdb.deleteMovie",
   "imdb/deleteMovie",
+  "trailers.createTrailer",
+  "trailers/createTrailer",
+  "trailers.getTrailer",
+  "trailers/getTrailer",
+  "trailers.getTrailerForMovie",
+  "trailers/getTrailerForMovie",
+  "trailers.deleteTrailer",
+  "trailers/deleteTrailer",
 ]
 `;
 
@@ -326,5 +407,7 @@ exports[`converts to api reference node: subpackagesByLocator keys 1`] = `
   "__package__.yml",
   "imdb",
   "imdb.yml",
+  "trailers",
+  "trailers.yml",
 ]
 `;
diff --git a/packages/cli/docs-resolver/src/__test__/fixtures/api-resolver/fern/definition/trailers.yml b/packages/cli/docs-resolver/src/__test__/fixtures/api-resolver/fern/definition/trailers.yml
@@ -0,0 +1,52 @@
+# yaml-language-server: $schema=https://raw.githubusercontent.com/fern-api/fern/main/fern.schema.json
+
+imports:
+  imdb: ./imdb.yml
+
+service:
+  auth: false
+  base-path: /trailers
+  endpoints:
+    createTrailer:
+      method: POST
+      path: /create
+      request: CreateTrailerRequest
+      response: TrailerId
+
+    getTrailer:
+      method: GET
+      path: /{id}
+      path-parameters:
+        id: TrailerId
+      response: Trailer
+
+    getTrailerForMovie:
+      method: GET
+      path: /movie/{id}
+      path-parameters:
+        id: imdb.MovieId
+      response: list<Trailer>
+
+    deleteTrailer:
+      method: DELETE
+      path: /{id}
+      path-parameters:
+        id: TrailerId
+
+types:
+  TrailerId:
+    type: string
+    docs: The unique identifier for a trailer in the database
+
+  CreateTrailerRequest:
+    properties:
+      id: TrailerId
+      movieId: imdb.MovieId
+      title: string
+      url: string
+
+  Trailer:
+    properties:
+      movieId: imdb.MovieId
+      title: string
+      url: string
diff --git a/packages/cli/docs-resolver/src/__test__/fixtures/api-resolver/fern/docs.yml b/packages/cli/docs-resolver/src/__test__/fixtures/api-resolver/fern/docs.yml
@@ -7,3 +7,6 @@ navigation:
           contents:
             - DELETE /movies/{id}
             - GET /movies/{id}
+      - imdb:
+          contents:
+            - trailers
diff --git a/packages/cli/generation/remote-generation/remote-workspace-runner/package.json b/packages/cli/generation/remote-generation/remote-workspace-runner/package.json
@@ -32,7 +32,7 @@
     "@fern-api/core": "workspace:*",
     "@fern-api/core-utils": "workspace:*",
     "@fern-api/docs-resolver": "workspace:*",
-    "@fern-api/fdr-sdk": "0.98.0-rc1",
+    "@fern-api/fdr-sdk": "0.98.2-d590e2c8a",
     "@fern-api/fs-utils": "workspace:*",
     "@fern-api/ir-generator": "workspace:*",
     "@fern-api/ir-migrations": "workspace:*",

diff --git a/packages/cli/register/package.json b/packages/cli/register/package.json
@@ -31,7 +31,7 @@
     "@fern-api/configuration": "workspace:*",
     "@fern-api/core": "workspace:*",
     "@fern-api/core-utils": "workspace:*",
-    "@fern-api/fdr-sdk": "0.98.0-rc1",
+    "@fern-api/fdr-sdk": "0.98.2-d590e2c8a",
     "@fern-api/ir-generator": "workspace:*",
     "@fern-api/ir-sdk": "workspace:*",
     "@fern-api/task-context": "workspace:*",

diff --git a/packages/core/package.json b/packages/core/package.json
@@ -27,7 +27,7 @@
     "depcheck": "depcheck"
   },
   "dependencies": {
-    "@fern-api/fdr-sdk": "0.98.0-rc1",
+    "@fern-api/fdr-sdk": "0.98.2-d590e2c8a",
     "@fern-api/venus-api-sdk": "0.0.38",
     "@fern-fern/fdr-test-sdk": "^0.0.5297",
     "@fern-fern/fiddle-sdk": "^0.0.552"