Merge pull request #57 from postmanlabs/feature/fix-union-self-ref-past-depth

Fixed an issue where GQL definition of having Union self refs past depth limit was failing with RangeError.

Author: VShingala

.github/workflows/test.yml

@@ -1,15 +1,22 @@
-name: Tests
+name: Test
 
 on:
-  [pull_request]
+  push:
+    branches: [develop, master]
+  pull_request:
 
 jobs:
   Unit-Tests:
     runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [16.x, 18.x]
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-node@v1
+      - uses: actions/checkout@v3
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v3
         with:
-          node-version: '14.x'
+          node-version: ${{ matrix.node-version }}
       - run: npm ci
-      - run: npm run test
+      - run: npm run test-lint
+      - run: npm run test-unit

lib/assets/gql-generator.js

@@ -281,6 +281,16 @@ module.exports = {
 
       /* Union types */
       if (curType.astNode && curType.astNode.kind === 'UnionTypeDefinition') {
+
+        /* Make sure UnionTypeDefinition are also not circularly referenced */
+        if ((crossReferenceKeyList.hasOwnProperty(crossReferenceKey) && crossReferenceKeyList[crossReferenceKey]) ||
+          curDepth > depthLimit
+        ) {
+          crossReferenceKeyList[crossReferenceKey] = false;
+          return '';
+        }
+        crossReferenceKeyList[crossReferenceKey] = true;
+
         const types = curType.getTypes();
         if (types && types.length) {
           const indent = `${'    '.repeat(curDepth)}`,

test/unit/converter.test.js

@@ -17,6 +17,9 @@ var converter = require('../../index'),
   invalidSchemaJson = require('./fixtures/invalidSchema.json'),
   validSchemaSDL = fs.readFileSync(path.join(__dirname, './fixtures/validSchemaSDL.graphql')).toString(),
   selfRefSchema = fs.readFileSync(path.join(__dirname, './fixtures/selfRefUnionTypeExample.graphql')).toString(),
+  seflRefDepthUnionSchema = fs.readFileSync(
+    path.join(__dirname, './fixtures/seflRefDepthUnionSchema.graphql')
+  ).toString(),
   customTypeNames = fs.readFileSync(path.join(__dirname, './fixtures/custom-queryname.gql')).toString(),
   issue10 = fs.readFileSync(path.join(__dirname, './fixtures/issue#10.graphql')).toString(),
   circularInput = fs.readFileSync(path.join(__dirname, './fixtures/circularInput.graphql')).toString(),
@@ -120,7 +123,7 @@ describe('Converter tests', function () {
     it('should generate a collection for a valid SDL schema with a union type self referencing', function (done) {
       convert({ type: 'string',
         data: selfRefSchema
-      }, {}, function (error, result) {
+      }, { depth: 3 }, function (error, result) {
         if (error) {
           expect.fail(null, null, error);
           return done();
@@ -268,6 +271,28 @@ describe('Converter tests', function () {
         return done();
       });
     });
+
+    it('should generate a collection for a valid SDL schema with a union type self referencing' +
+      ' and past allowed depth limit', function (done) {
+      convert({ type: 'string',
+        data: seflRefDepthUnionSchema
+      }, { depth: 3 }, function (error, result) {
+        if (error) {
+          expect.fail(null, null, error);
+          return done();
+        }
+        const collection = result.output[0].data;
+        expect(collection.item[0].item[0].request.body.mode).to.be.equal('graphql');
+        expect(collection.item[0].item[0].request.body.graphql).to.be.an('object');
+        expect(collection.item[0].item[0].request.body.graphql.query).to.be.a('string');
+        expect(collection.item[0].item[0].request.body.graphql.variables).to.be.a('string');
+        expect(collection.item[0].item[0].request.body.graphql.query).to.contain('# self reference detected');
+        expect(collection.item[0].item[0].request.body.graphql.query).to.contain('# skipping "createdBy"');
+        expect(collection.item[0].item[0].request.body.graphql.query).to.contain('# skipping "updatedBy"');
+
+        return done();
+      });
+    });
   });
 
   describe('Validate function', function () {

test/unit/fixtures/seflRefDepthUnionSchema.graphql

@@ -0,0 +1,30 @@
+# A date-time string at UTC, such as 2019-12-03T09:54:33Z, compliant with the date-time format.
+scalar DateTime
+
+type Organization {
+  id: ID!
+  createdBy: User!
+  updatedBy: User!
+  name: String!
+  avatarUrl: String
+  owner: String!
+}
+
+# User
+type User {
+  id: ID!
+  organization: OrganizationOrStringUnion
+  idpId: String!
+  firstName: String!
+  lastName: String!
+  createdBy: UserOrStringUnion
+  updatedBy: UserOrStringUnion
+}
+
+union OrganizationOrStringUnion = Organization
+
+union UserOrStringUnion = User
+
+type Query {
+  User(id: String!): User!
+}