feat(terminateCircularRelationships): Add 'immediate' as a value for the terminateCircularRelationships option

README.md

@@ -26,11 +26,13 @@ Adds `__typename` property to mock data
 
 Changes enums to TypeScript string union types
 
-### terminateCircularRelationships (`boolean`, defaultValue: `false`)
+### terminateCircularRelationships (`boolean | 'immediate'`, defaultValue: `false`)
 
 When enabled, prevents circular relationships from triggering infinite recursion. After the first resolution of a
 specific type in a particular call stack, subsequent resolutions will return an empty object cast to the correct type.
 
+When enabled with `immediate`, it will only resolve the relationship once, independently of the call stack. Use this option if you're experiencing `out of memory` errors while generating mocks.
+
 ### prefix (`string`, defaultValue: `a` for consonants & `an` for vowels)
 
 The prefix to add to the mock function name. Cannot be empty since it will clash with the associated

src/index.ts

@@ -22,7 +22,7 @@ type Options<T = TypeNode> = {
     types: TypeItem[];
     typeNamesConvention: NamingConvention;
     enumValuesConvention: NamingConvention;
-    terminateCircularRelationships: boolean;
+    terminateCircularRelationships: boolean | 'immediate';
     prefix: string | undefined;
     typesPrefix: string;
     enumsPrefix: string;
@@ -40,6 +40,9 @@ type Options<T = TypeNode> = {
     nonNull: boolean;
 };
 
+const getTerminateCircularRelationshipsConfig = ({ terminateCircularRelationships }: TypescriptMocksPluginConfig) =>
+    terminateCircularRelationships ? terminateCircularRelationships : false;
+
 const convertName = (value: string, fn: (v: string) => string, transformUnderscore: boolean): string => {
     if (transformUnderscore) {
         return fn(value);
@@ -430,7 +433,7 @@ const getMockString = (
     typeName: string,
     fields: string,
     typeNamesConvention: NamingConvention,
-    terminateCircularRelationships: boolean,
+    terminateCircularRelationships: boolean | 'immediate',
     addTypename = false,
     prefix,
     typesPrefix = '',
@@ -443,13 +446,15 @@ const getMockString = (
     const typenameReturnType = addTypename ? `{ __typename: '${typeName}' } & ` : '';
 
     if (terminateCircularRelationships) {
+        const relationshipsToOmitInit =
+            terminateCircularRelationships === 'immediate' ? '_relationshipsToOmit' : 'new Set(_relationshipsToOmit)';
         return `
 export const ${toMockName(
             typeName,
             casedName,
             prefix,
         )} = (overrides?: Partial<${casedNameWithPrefix}>, _relationshipsToOmit: Set<string> = new Set()): ${typenameReturnType}${casedNameWithPrefix} => {
-    const relationshipsToOmit: Set<string> = new Set(_relationshipsToOmit);
+    const relationshipsToOmit: Set<string> = ${relationshipsToOmitInit};
     relationshipsToOmit.add('${casedName}');
     return {${typename}
 ${fields}
@@ -541,7 +546,7 @@ export interface TypescriptMocksPluginConfig {
     addTypename?: boolean;
     prefix?: string;
     scalars?: ScalarMap;
-    terminateCircularRelationships?: boolean;
+    terminateCircularRelationships?: boolean | 'immediate';
     typesPrefix?: string;
     enumsPrefix?: string;
     transformUnderscore?: boolean;
@@ -669,7 +674,7 @@ export const plugin: PluginFunction<TypescriptMocksPluginConfig> = (schema, docu
                         types,
                         typeNamesConvention,
                         enumValuesConvention,
-                        terminateCircularRelationships: !!config.terminateCircularRelationships,
+                        terminateCircularRelationships: getTerminateCircularRelationshipsConfig(config),
                         prefix: config.prefix,
                         typesPrefix: config.typesPrefix,
                         enumsPrefix: config.enumsPrefix,
@@ -706,7 +711,7 @@ export const plugin: PluginFunction<TypescriptMocksPluginConfig> = (schema, docu
                                       types,
                                       typeNamesConvention,
                                       enumValuesConvention,
-                                      terminateCircularRelationships: !!config.terminateCircularRelationships,
+                                      terminateCircularRelationships: getTerminateCircularRelationshipsConfig(config),
                                       prefix: config.prefix,
                                       typesPrefix: config.typesPrefix,
                                       enumsPrefix: config.enumsPrefix,
@@ -733,7 +738,7 @@ export const plugin: PluginFunction<TypescriptMocksPluginConfig> = (schema, docu
                         fieldName,
                         mockFields,
                         typeNamesConvention,
-                        !!config.terminateCircularRelationships,
+                        getTerminateCircularRelationshipsConfig(config),
                         false,
                         config.prefix,
                         config.typesPrefix,
@@ -756,7 +761,7 @@ export const plugin: PluginFunction<TypescriptMocksPluginConfig> = (schema, docu
                         typeName,
                         mockFields,
                         typeNamesConvention,
-                        !!config.terminateCircularRelationships,
+                        getTerminateCircularRelationshipsConfig(config),
                         !!config.addTypename,
                         config.prefix,
                         config.typesPrefix,
@@ -777,7 +782,7 @@ export const plugin: PluginFunction<TypescriptMocksPluginConfig> = (schema, docu
                         typeName,
                         mockFields,
                         typeNamesConvention,
-                        !!config.terminateCircularRelationships,
+                        getTerminateCircularRelationshipsConfig(config),
                         !!config.addTypename,
                         config.prefix,
                         config.typesPrefix,

tests/terminateCircularRelationshipsImmediately/__snapshots__/spec.ts.snap

@@ -0,0 +1,39 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`should support setting terminateCircularRelationships as imediate and not create a new set of relationships 1`] = `
+"
+export const anA = (overrides?: Partial<A>, _relationshipsToOmit: Set<string> = new Set()): A => {
+    const relationshipsToOmit: Set<string> = _relationshipsToOmit;
+    relationshipsToOmit.add('A');
+    return {
+        B: overrides && overrides.hasOwnProperty('B') ? overrides.B! : relationshipsToOmit.has('B') ? {} as B : aB({}, relationshipsToOmit),
+        C: overrides && overrides.hasOwnProperty('C') ? overrides.C! : relationshipsToOmit.has('C') ? {} as C : aC({}, relationshipsToOmit),
+    };
+};
+
+export const aB = (overrides?: Partial<B>, _relationshipsToOmit: Set<string> = new Set()): B => {
+    const relationshipsToOmit: Set<string> = _relationshipsToOmit;
+    relationshipsToOmit.add('B');
+    return {
+        A: overrides && overrides.hasOwnProperty('A') ? overrides.A! : relationshipsToOmit.has('A') ? {} as A : anA({}, relationshipsToOmit),
+    };
+};
+
+export const aC = (overrides?: Partial<C>, _relationshipsToOmit: Set<string> = new Set()): C => {
+    const relationshipsToOmit: Set<string> = _relationshipsToOmit;
+    relationshipsToOmit.add('C');
+    return {
+        aCollection: overrides && overrides.hasOwnProperty('aCollection') ? overrides.aCollection! : [relationshipsToOmit.has('A') ? {} as A : anA({}, relationshipsToOmit)],
+    };
+};
+
+export const aD = (overrides?: Partial<D>, _relationshipsToOmit: Set<string> = new Set()): D => {
+    const relationshipsToOmit: Set<string> = _relationshipsToOmit;
+    relationshipsToOmit.add('D');
+    return {
+        A: overrides && overrides.hasOwnProperty('A') ? overrides.A! : relationshipsToOmit.has('A') ? {} as A : anA({}, relationshipsToOmit),
+        B: overrides && overrides.hasOwnProperty('B') ? overrides.B! : relationshipsToOmit.has('B') ? {} as B : aB({}, relationshipsToOmit),
+    };
+};
+"
+`;

tests/terminateCircularRelationshipsImmediately/schema.ts

@@ -0,0 +1,18 @@
+import { buildSchema } from 'graphql';
+
+export default buildSchema(/* GraphQL */ `
+    type A {
+        B: B!
+        C: C!
+    }
+    type B {
+        A: A!
+    }
+    type C {
+        aCollection: [A!]!
+    }
+    type D {
+        A: A!
+        B: B!
+    }
+`);

tests/terminateCircularRelationshipsImmediately/spec.ts

@@ -0,0 +1,12 @@
+import { plugin } from '../../src';
+import testSchema from './schema';
+
+it('should support setting terminateCircularRelationships as imediate and not create a new set of relationships', async () => {
+    const result = await plugin(testSchema, [], {
+        terminateCircularRelationships: 'immediate',
+    });
+
+    expect(result).toBeDefined();
+    expect(result).not.toContain('new Set(_relationshipsToOmit)');
+    expect(result).toMatchSnapshot();
+});

tests/terminateCircularRelationshipsImmediately/types.ts

@@ -0,0 +1,17 @@
+export type A = {
+    B: B;
+    C: C;
+};
+
+export type B = {
+    A: A;
+};
+
+export type C = {
+    aCollection: A[];
+};
+
+export type D = {
+    A: A;
+    B: B;
+};