fix(cli): recursive type checking exceeding max call stack. (#5184)

* fix(cli): recursive type checking exceeding max call stack. * Enforce depth assignment instead of fallback to default value. * Minor cleanup. * Update Postman snapshots. * Update PHP SDK snapshots. * Update Ruby snapshots. * Update ts-express snapshots. * Update ts-sdk snapshots. * Update c sharp snapshots. * Update ts-sdk snapshots. * fix --------- Co-authored-by: dsinghvi <deep@usebirch.com>
fern-api · Nov 17, 2024 · b02a296 · b02a296
1 parent 1908ee6
commit b02a296
Show file tree

Hide file tree

Showing 620 changed files with 26,925 additions and 1,548 deletions.
diff --git a/...valid-example-endpoint-call/__test__/fixtures/endpoint-recursive-types/definition/api.yml b/...valid-example-endpoint-call/__test__/fixtures/endpoint-recursive-types/definition/api.yml
@@ -0,0 +1,3 @@
+name: endpoint-recursive
+auth: bearer
+default-environment: Production
diff --git a/...example-endpoint-call/__test__/fixtures/endpoint-recursive-types/definition/recursive.yml b/...example-endpoint-call/__test__/fixtures/endpoint-recursive-types/definition/recursive.yml
@@ -0,0 +1,39 @@
+types:
+  RecursiveResponse:
+    type: list<Node>
+  Node:
+    discriminated: false
+    union:
+      - type: Node
+      - type: Node
+      - type: Node
+      - type: Node
+      - type: Node
+      - type: Terminate
+  Terminate:
+    properties:
+      end: string
+
+
+service:
+  auth: false
+  base-path: ""
+  endpoints:
+    recursiveGet:
+      method: GET
+      path: /recursive
+      request:
+        name: RecursiveRequest
+        body:
+          properties:
+            query: string
+      response:
+        type: RecursiveResponse
+      examples:
+        - name: "Example Recursion"
+          request:
+            query: "foo"
+          response:
+            body:
+              - end: "bar"
+
diff --git a/...les/valid-example-endpoint-call/__test__/fixtures/endpoint-recursive-types/generators.yml b/...les/valid-example-endpoint-call/__test__/fixtures/endpoint-recursive-types/generators.yml
@@ -0,0 +1 @@
+{}
diff --git a/...idator/src/rules/valid-example-endpoint-call/__test__/valid-example-endpoint-call.test.ts b/...idator/src/rules/valid-example-endpoint-call/__test__/valid-example-endpoint-call.test.ts
@@ -510,4 +510,19 @@ describe("valid-example-endpoint-call", () => {
 
         expect(violations).toEqual(expectedViolations);
     });
+
+    it("endpoint-recursive-types", async () => {
+        const violations = await getViolationsForRule({
+            rule: ValidExampleEndpointCallRule,
+            absolutePathToWorkspace: join(
+                AbsoluteFilePath.of(__dirname),
+                RelativeFilePath.of("fixtures"),
+                RelativeFilePath.of("endpoint-recursive-types")
+            )
+        });
+
+        const expectedViolations: ValidationViolation[] = [];
+
+        expect(violations).toEqual(expectedViolations);
+    });
 });
diff --git a/.../validator/src/rules/valid-example-endpoint-call/validateExampleEndpointCallParameters.ts b/.../validator/src/rules/valid-example-endpoint-call/validateExampleEndpointCallParameters.ts
@@ -80,7 +80,8 @@ export function validateExampleEndpointCallParameters<T>({
                             workspace,
                             typeResolver,
                             exampleResolver,
-                            breadcrumbs
+                            breadcrumbs,
+                            depth: 0
                         }).map((val): RuleViolation => {
                             return { severity: "error", message: val.message };
                         })

diff --git a/...es/cli/fern-definition/validator/src/rules/valid-example-endpoint-call/validateRequest.ts b/...es/cli/fern-definition/validator/src/rules/valid-example-endpoint-call/validateRequest.ts
@@ -43,7 +43,8 @@ export function validateRequest({
                 exampleResolver,
                 workspace,
                 example,
-                breadcrumbs: ["request"]
+                breadcrumbs: ["request"],
+                depth: 0
             }).map((val): RuleViolation => {
                 return { severity: "error", message: val.message };
             })
@@ -57,7 +58,8 @@ export function validateRequest({
                 workspace,
                 typeResolver,
                 exampleResolver,
-                breadcrumbs: ["response", "body"]
+                breadcrumbs: ["response", "body"],
+                depth: 0
             }).map((val): RuleViolation => {
                 return { severity: "error", message: val.message };
             })

diff --git a/...s/cli/fern-definition/validator/src/rules/valid-example-endpoint-call/validateResponse.ts b/...s/cli/fern-definition/validator/src/rules/valid-example-endpoint-call/validateResponse.ts
@@ -76,7 +76,8 @@ function validateBodyResponse({
                     exampleResolver,
                     file,
                     workspace,
-                    breadcrumbs: ["response", "body"]
+                    breadcrumbs: ["response", "body"],
+                    depth: 0
                 }).map((val): RuleViolation => {
                     return {
                         severity: "error",
@@ -122,7 +123,8 @@ function validateBodyResponse({
                         exampleResolver,
                         file: errorDeclaration.file,
                         workspace,
-                        breadcrumbs: ["response", "body"]
+                        breadcrumbs: ["response", "body"],
+                        depth: 0
                     }).map((val): RuleViolation => {
                         return { severity: "error", message: val.message };
                     })
@@ -177,7 +179,8 @@ function validateStreamResponse({
                     exampleResolver,
                     file,
                     workspace,
-                    breadcrumbs: ["response", "body"]
+                    breadcrumbs: ["response", "body"],
+                    depth: 0
                 }).map((val): RuleViolation => {
                     return { severity: "error", message: val.message };
                 })
@@ -228,7 +231,8 @@ function validateSseResponse({
                     exampleResolver,
                     file,
                     workspace,
-                    breadcrumbs: ["response", "body"]
+                    breadcrumbs: ["response", "body"],
+                    depth: 0
                 }).map((val): RuleViolation => {
                     return { severity: "error", message: val.message };
                 })

diff --git a/packages/cli/fern-definition/validator/src/rules/valid-example-error/valid-example-error.ts b/packages/cli/fern-definition/validator/src/rules/valid-example-error/valid-example-error.ts
@@ -31,7 +31,8 @@ export const ValidExampleErrorRule: Rule = {
                         workspace,
                         typeResolver,
                         exampleResolver,
-                        breadcrumbs: ["response", "body"]
+                        breadcrumbs: ["response", "body"],
+                        depth: 0
                     });
                     return violations.map((violation) => {
                         return {

diff --git a/packages/cli/fern-definition/validator/src/rules/valid-example-type/valid-example-type.ts b/packages/cli/fern-definition/validator/src/rules/valid-example-type/valid-example-type.ts
@@ -32,7 +32,8 @@ export const ValidExampleTypeRule: Rule = {
                         typeResolver,
                         exampleResolver,
                         workspace,
-                        breadcrumbs: []
+                        breadcrumbs: [],
+                        depth: 0
                     });
                     return violations.map((violation) => {
                         return {

diff --git a/packages/cli/generation/ir-generator/src/converters/type-declarations/convertExampleType.ts b/packages/cli/generation/ir-generator/src/converters/type-declarations/convertExampleType.ts
@@ -141,7 +141,8 @@ export function convertTypeExample({
                     exampleResolver,
                     file: fileContainingType,
                     workspace,
-                    breadcrumbs: []
+                    breadcrumbs: [],
+                    depth: 0
                 });
                 if (violationsForMember.length === 0) {
                     return ExampleTypeShape.undiscriminatedUnion({

diff --git a/packages/cli/generation/ir-generator/src/examples/validateAliasExample.ts b/packages/cli/generation/ir-generator/src/examples/validateAliasExample.ts
@@ -13,7 +13,8 @@ export function validateAliasExample({
     typeResolver,
     exampleResolver,
     workspace,
-    breadcrumbs
+    breadcrumbs,
+    depth
 }: {
     rawAlias: string | RawSchemas.AliasSchema;
     example: RawSchemas.ExampleTypeValueSchema;
@@ -22,6 +23,7 @@ export function validateAliasExample({
     exampleResolver: ExampleResolver;
     workspace: FernWorkspace;
     breadcrumbs: string[];
+    depth: number;
 }): ExampleViolation[] {
     return validateTypeReferenceExample({
         rawTypeReference: typeof rawAlias === "string" ? rawAlias : rawAlias.type,
@@ -30,6 +32,7 @@ export function validateAliasExample({
         typeResolver,
         exampleResolver,
         workspace,
-        breadcrumbs
+        breadcrumbs,
+        depth: depth + 1
     });
 }
diff --git a/packages/cli/generation/ir-generator/src/examples/validateObjectExample.ts b/packages/cli/generation/ir-generator/src/examples/validateObjectExample.ts
@@ -19,7 +19,8 @@ export function validateObjectExample({
     exampleResolver,
     workspace,
     example,
-    breadcrumbs
+    breadcrumbs,
+    depth
 }: {
     // undefined for inline requests
     typeName: string | undefined;
@@ -31,6 +32,7 @@ export function validateObjectExample({
     exampleResolver: ExampleResolver;
     workspace: FernWorkspace;
     breadcrumbs: string[];
+    depth: number;
 }): ExampleViolation[] {
     if (!isPlainObject(example)) {
         return getViolationsForMisshapenExample(example, "an object");
@@ -100,7 +102,8 @@ export function validateObjectExample({
                     workspace,
                     typeResolver,
                     exampleResolver,
-                    breadcrumbs: [...breadcrumbs, `${exampleKey}`]
+                    breadcrumbs: [...breadcrumbs, `${exampleKey}`],
+                    depth: depth + 1
                 })
             );
         }

diff --git a/packages/cli/generation/ir-generator/src/examples/validateTypeExample.ts b/packages/cli/generation/ir-generator/src/examples/validateTypeExample.ts
@@ -18,7 +18,8 @@ export function validateTypeExample({
     exampleResolver,
     example,
     workspace,
-    breadcrumbs
+    breadcrumbs,
+    depth
 }: {
     typeName: string;
     typeDeclaration: RawSchemas.TypeDeclarationSchema;
@@ -28,6 +29,7 @@ export function validateTypeExample({
     example: RawSchemas.ExampleTypeValueSchema;
     workspace: FernWorkspace;
     breadcrumbs: string[];
+    depth: number;
 }): ExampleViolation[] {
     return visitRawTypeDeclaration(typeDeclaration, {
         alias: (rawAlias) => {
@@ -38,7 +40,8 @@ export function validateTypeExample({
                 exampleResolver,
                 example,
                 workspace,
-                breadcrumbs
+                breadcrumbs,
+                depth
             });
         },
         enum: (rawEnum) => {
@@ -58,7 +61,8 @@ export function validateTypeExample({
                 typeResolver,
                 exampleResolver,
                 workspace,
-                breadcrumbs
+                breadcrumbs,
+                depth
             });
         },
         discriminatedUnion: (rawUnion) => {
@@ -70,7 +74,8 @@ export function validateTypeExample({
                 typeResolver,
                 exampleResolver,
                 workspace,
-                breadcrumbs
+                breadcrumbs,
+                depth
             });
         },
         undiscriminatedUnion: (rawUnion) => {
@@ -81,7 +86,8 @@ export function validateTypeExample({
                 typeResolver,
                 exampleResolver,
                 workspace,
-                breadcrumbs
+                breadcrumbs,
+                depth
             });
         }
     });

diff --git a/packages/cli/generation/ir-generator/src/examples/validateTypeReferenceExample.ts b/packages/cli/generation/ir-generator/src/examples/validateTypeReferenceExample.ts
@@ -27,14 +27,17 @@ const UUID_REGEX = /^[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA
 
 const RFC_3339_DATE_REGEX = /^\d{4}-\d{2}-\d{2}$/;
 
+const MAX_RECURSION_DEPTH = 16;
+
 export function validateTypeReferenceExample({
     rawTypeReference,
     example,
     typeResolver,
     exampleResolver,
     file,
     workspace,
-    breadcrumbs
+    breadcrumbs,
+    depth
 }: {
     rawTypeReference: string;
     example: RawSchemas.ExampleTypeReferenceSchema;
@@ -43,7 +46,17 @@ export function validateTypeReferenceExample({
     file: FernFileContext;
     workspace: FernWorkspace;
     breadcrumbs: string[];
+    depth: number;
 }): ExampleViolation[] {
+    if (depth > MAX_RECURSION_DEPTH) {
+        // This comment never reaches the user and serves as a termination condition for the recursion.
+        return [
+            {
+                message: "Example is too deeply nested. This may indicate a circular reference."
+            }
+        ];
+    }
+
     if (typeof example === "string" && example.startsWith(EXAMPLE_REFERENCE_PREFIX)) {
         // if it's a reference to another example, we just need to compare the
         // expected type with the referenced type
@@ -107,7 +120,8 @@ export function validateTypeReferenceExample({
                     typeResolver,
                     exampleResolver,
                     workspace,
-                    breadcrumbs
+                    breadcrumbs,
+                    depth: depth + 1
                 });
             },
             map: ({ keyType, valueType }) => {
@@ -122,7 +136,8 @@ export function validateTypeReferenceExample({
                         exampleResolver,
                         file,
                         workspace,
-                        breadcrumbs: [...breadcrumbs, exampleKey]
+                        breadcrumbs: [...breadcrumbs, exampleKey],
+                        depth: depth + 1
                     }),
                     ...validateTypeReferenceExample({
                         rawTypeReference: valueType,
@@ -131,7 +146,8 @@ export function validateTypeReferenceExample({
                         exampleResolver,
                         file,
                         workspace,
-                        breadcrumbs: [...breadcrumbs, exampleKey]
+                        breadcrumbs: [...breadcrumbs, exampleKey],
+                        depth: depth + 1
                     })
                 ]);
             },
@@ -147,7 +163,8 @@ export function validateTypeReferenceExample({
                         exampleResolver,
                         file,
                         workspace,
-                        breadcrumbs: [...breadcrumbs, `${idx}`]
+                        breadcrumbs: [...breadcrumbs, `${idx}`],
+                        depth: depth + 1
                     })
                 );
             },
@@ -176,7 +193,8 @@ export function validateTypeReferenceExample({
                         exampleResolver,
                         file,
                         workspace,
-                        breadcrumbs: [...breadcrumbs, `${idx}`]
+                        breadcrumbs: [...breadcrumbs, `${idx}`],
+                        depth: depth + 1
                     })
                 );
             },
@@ -191,7 +209,8 @@ export function validateTypeReferenceExample({
                     exampleResolver,
                     file,
                     workspace,
-                    breadcrumbs
+                    breadcrumbs,
+                    depth: depth + 1
                 });
             },
             unknown: () => {