feat: pass maxRefDepth to tree to limit recursion (#243)

stoplightio · Nov 15, 2023 · c467ab1 · c467ab1
1 parent 38f4f92
commit c467ab1
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 6 deletions.
diff --git a/package.json b/package.json
@@ -46,7 +46,7 @@
   },
   "dependencies": {
     "@stoplight/json": "^3.20.1",
-    "@stoplight/json-schema-tree": "^2.2.5",
+    "@stoplight/json-schema-tree": "^2.3.0",
     "@stoplight/react-error-boundary": "^2.0.0",
     "@types/json-schema": "^7.0.7",
     "classnames": "^2.2.6",

diff --git a/src/components/JsonSchemaViewer.tsx b/src/components/JsonSchemaViewer.tsx
@@ -23,6 +23,8 @@ export type JsonSchemaProps = Partial<JSVOptions> & {
   emptyText?: string;
   className?: string;
   resolveRef?: SchemaTreeRefDereferenceFn;
+  /** Controls the level of recursion of refs. Prevents overly complex trees and running out of stack depth. */
+  maxRefDepth?: number;
   onTreePopulated?: (props: { rootNode: RootNode; nodeCount: number }) => void;
   maxHeight?: number;
   parentCrumbs?: string[];
@@ -80,6 +82,7 @@ const JsonSchemaViewerInner = ({
   viewMode,
   className,
   resolveRef,
+  maxRefDepth,
   emptyText = 'No schema defined',
   onTreePopulated,
   maxHeight,
@@ -91,6 +94,7 @@ const JsonSchemaViewerInner = ({
   | 'viewMode'
   | 'className'
   | 'resolveRef'
+  | 'maxRefDepth'
   | 'emptyText'
   | 'onTreePopulated'
   | 'maxHeight'
@@ -106,6 +110,7 @@ const JsonSchemaViewerInner = ({
     const jsonSchemaTree = new JsonSchemaTree(schema, {
       mergeAllOf: true,
       refResolver: resolveRef,
+      maxRefDepth,
     });
 
     let nodeCount = 0;
@@ -134,7 +139,7 @@ const JsonSchemaViewerInner = ({
       jsonSchemaTreeRoot: jsonSchemaTree.root,
       nodeCount,
     };
-  }, [schema, resolveRef, viewMode]);
+  }, [schema, resolveRef, maxRefDepth, viewMode]);
 
   React.useEffect(() => {
     onTreePopulated?.({

diff --git a/yarn.lock b/yarn.lock
@@ -2392,10 +2392,10 @@
     json-schema-compare "^0.2.2"
     lodash "^4.17.4"
 
-"@stoplight/json-schema-tree@^2.2.5":
-  version "2.2.5"
-  resolved "https://registry.yarnpkg.com/@stoplight/json-schema-tree/-/json-schema-tree-2.2.5.tgz#a3f78f3d475b74338f6d2da7ec6733a96cb9819f"
-  integrity sha512-H2d5EHbWJwbu4h7Eh3R4He4SGlfA5ScucpMqylVTgPwQImvikIyrI+v6oqzpl9fFZ6SkidfTcUs3z1+IKwxWdA==
+"@stoplight/json-schema-tree@^2.3.0":
+  version "2.3.0"
+  resolved "https://registry.yarnpkg.com/@stoplight/json-schema-tree/-/json-schema-tree-2.3.0.tgz#cdad7f7571700016d8e0e5bad59d287e9bb782d0"
+  integrity sha512-IH4SYuvV0C4maYQEPftduDBG1qVV4hy5ZXzS9rgq3V7zCT34I7xVwX9Vmpl0mOQTh2IZaTcyPWXkngt21ShJaQ==
   dependencies:
     "@stoplight/json" "^3.12.0"
     "@stoplight/json-schema-merge-allof" "^0.7.8"