Merge pull request #60 from postmanlabs/release/v0.1.1

Release version v0.1.1

Author: VShingala

.github/workflows/draft-new-release.yml

@@ -0,0 +1,78 @@
+name: Draft new release
+
+on:
+  workflow_dispatch:
+    inputs:
+      version:
+        description: The version you want to release. Must be a valid semver version.
+        required: true
+        type: string
+
+jobs:
+  draft-new-release:
+    if: startsWith(github.event.inputs.version, 'v')
+    name: Draft a new release
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      pull-requests: write
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Create release branch
+        run: git checkout -b release/${{ github.event.inputs.version }}
+
+      - name: Update changelog
+        uses: thomaseizinger/[email protected]
+        with:
+          version: ${{ github.event.inputs.version }}
+
+      - name: Initialize mandatory git config
+        run: |
+          git config user.name "GitHub Actions"
+          git config user.email [email protected]
+
+      - name: Bump version
+        run: npm version ${{ github.event.inputs.version }} --git-tag-version false
+
+      - name: Commit changelog and manifest files
+        id: make-commit
+        run: |
+          git add CHANGELOG.md package.json package-lock.json
+          git commit --message "Prepare release ${{ github.event.inputs.version }}"
+          echo "::set-output name=commit::$(git rev-parse HEAD)"
+      
+      - name: Push new branch
+        run: git push origin release/${{ github.event.inputs.version }}
+
+      - name: Create pull request for master
+        uses: thomaseizinger/[email protected]
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          head: release/${{ github.event.inputs.version }}
+          base: master
+          title: "Release version ${{ github.event.inputs.version }}"
+          reviewers: ${{ github.actor }}
+          body: |
+            Hi @${{ github.actor }}!
+
+            This PR was created in response to a manual trigger of the release workflow here: https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}.
+            I've updated the changelog and bumped the versions in the manifest files in this commit: ${{ steps.make-commit.outputs.commit }}.
+
+      - name: Create pull request for develop
+        uses: thomaseizinger/[email protected]
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          head: release/${{ github.event.inputs.version }}
+          base: develop
+          title: "Release version ${{ github.event.inputs.version }}"
+          reviewers: ${{ github.actor }}
+          body: |
+            Hi @${{ github.actor }}!
+
+            This PR was created in response to a manual trigger of the release workflow here: https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}.
+            I've updated the changelog and bumped the versions in the manifest files in this commit: ${{ steps.make-commit.outputs.commit }}.

.github/workflows/publish-new-release.yml

@@ -0,0 +1,46 @@
+name: "Publish new release"
+
+on:
+  pull_request:
+    branches:
+      - master
+    types:
+      - closed
+
+jobs:
+  release:
+    name: Publish new release
+    runs-on: ubuntu-latest
+    # only merged pull requests that begin with 'release/' or 'hotfix/' must trigger this job
+    if: github.event.pull_request.merged == true &&
+      (contains(github.event.pull_request.head.ref, 'release/') || contains(github.event.pull_request.head.ref, 'hotfix/'))
+    permissions:
+      contents: write
+
+    steps:
+      - name: Extract version from branch name (for release branches)
+        if: contains(github.event.pull_request.head.ref, 'release/')
+        run: |
+          BRANCH_NAME="${{ github.event.pull_request.head.ref }}"
+          VERSION=${BRANCH_NAME#release/}
+
+          echo "RELEASE_VERSION=$VERSION" >> $GITHUB_ENV
+
+      - name: Extract version from branch name (for hotfix branches)
+        if: contains(github.event.pull_request.head.ref, 'hotfix/')
+        run: |
+          BRANCH_NAME="${{ github.event.pull_request.head.ref }}"
+          VERSION=${BRANCH_NAME#hotfix/}
+
+          echo "RELEASE_VERSION=$VERSION" >> $GITHUB_ENV
+
+      - name: Create Release
+        uses: thomaseizinger/[email protected]
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          target_commitish: ${{ github.event.pull_request.merge_commit_sha }}
+          tag_name: ${{ env.RELEASE_VERSION }}
+          name: ${{ env.RELEASE_VERSION }}
+          draft: false
+          prerelease: false

.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

CHANGELOG.md

@@ -1,47 +1,73 @@
 # Changelog for graphql-to-postman
 
+## [Unreleased]
+
+## [v0.1.1] - 2024-04-05
+
+### Fixed
+
+-   Fixed an issue where GQL definition of having Union self refs past depth limit was failing with RangeError.
+
 #### v0.1.0 (June 06, 2023)
-* Added support for CLI usage to convert GraphQL definition to collection with custom depth.
-* Added maximum limit to depth allowed via usage of module APIs.
+
+-   Added support for CLI usage to convert GraphQL definition to collection with custom depth.
+-   Added maximum limit to depth allowed via usage of module APIs.
 
 ### v0.0.12 (March 30, 2023)
-* Fixed issue where conversion failed with type error while resolving non-defined variables.
-* Added support for release script.
+
+-   Fixed issue where conversion failed with type error while resolving non-defined variables.
+-   Added support for release script.
 
 ### v0.0.12 (January 9, 2023)
-* Fix for - [#10070](hhttps://github.com/postmanlabs/postman-app-support/issues/10070) Added support for nested lists.
+
+-   Fix for - [#10070](hhttps://github.com/postmanlabs/postman-app-support/issues/10070) Added support for nested lists.
 
 ### v0.0.11 (Sept 27, 2021)
-* Fix for - [#24](https://github.com/postmanlabs/graphql-to-postman/issues/24) Fixed an issue where nesting was faulty.
+
+-   Fix for - [#24](https://github.com/postmanlabs/graphql-to-postman/issues/24) Fixed an issue where nesting was faulty.
 
 ### v0.0.10 (Sept 27, 2021)
-* Fix for - [#9884](https://github.com/postmanlabs/postman-app-support/issues/9884) Fixed an issue with union types self referencing
+
+-   Fix for - [#9884](https://github.com/postmanlabs/postman-app-support/issues/9884) Fixed an issue with union types self referencing
 
 ### v0.0.9 (April 9, 2021)
-* Added the support for changing stack depth if required.
+
+-   Added the support for changing stack depth if required.
 
 ### v0.0.8 (March 15, 2021)
-* Fixed issue where error shown was meaningless for incorrect GraphQL SDL.
+
+-   Fixed issue where error shown was meaningless for incorrect GraphQL SDL.
 
 ### v0.0.7 (Oct 23, 2020)
-* fix for - [#8863](https://github.com/postmanlabs/postman-app-support/issues/8863) Fixed an issue where custom name for type threw an error.
+
+-   fix for - [#8863](https://github.com/postmanlabs/postman-app-support/issues/8863) Fixed an issue where custom name for type threw an error.
 
 ### v0.0.6 (Jul 23, 2020)
-* Fix for circular reference input object types.
-* Fix for introspection query response type support.
+
+-   Fix for circular reference input object types.
+-   Fix for introspection query response type support.
 
 ### v0.0.5 (May 15, 2020)
-* Fix for - [#8429](https://github.com/postmanlabs/postman-app-support/issues/8429) [#10](https://github.com/postmanlabs/graphql-to-postman/issues/10) - Schemas with Input type will now be converted successfully.
+
+-   Fix for - [#8429](https://github.com/postmanlabs/postman-app-support/issues/8429) [#10](https://github.com/postmanlabs/graphql-to-postman/issues/10) - Schemas with Input type will now be converted successfully.
 
 #### v0.0.4 (April 29, 2020)
-* Sanitization of options.
-* Added a function for getting meta data.
+
+-   Sanitization of options.
+-   Added a function for getting meta data.
 
 #### v0.0.3 (March 26, 2020)
-* Fix for empty collection generation for certain queries.
+
+-   Fix for empty collection generation for certain queries.
 
 #### v0.0.2 (December 20, 2019)
-* Support for GraphQL variables.
+
+-   Support for GraphQL variables.
 
 #### v0.0.1 (December 10, 2019)
-* Base release
+
+-   Base release
+
+[Unreleased]: https://github.com/postmanlabs/graphql-to-postman/compare/v0.1.1...HEAD
+
+[v0.1.1]: https://github.com/postmanlabs/graphql-to-postman/compare/011f91a2fff94f02aeefcfc004a96777a62829bb...v0.1.1

lib/assets/gql-generator.js

@@ -18,6 +18,10 @@ var graphql = require('graphql'),
    * @param dict dictionary of arguments
    */
   getArgsToVarsStr = (dict) => {
+    if (typeof dict !== 'object') {
+      return '';
+    }
+
     return Object.entries(dict)
       .map(([varName, arg]) => { return `${arg.name}: $${varName}`; })
       .join(', ');
@@ -102,6 +106,10 @@ var graphql = require('graphql'),
    * @param dict dictionary of arguments
    */
   getVarsToTypesStr = (dict) => {
+    if (typeof dict !== 'object') {
+      return '';
+    }
+
     return Object.entries(dict)
       .map(([varName, arg]) => {
         return `$${varName}: ${arg.type}`;
@@ -151,7 +159,7 @@ function resolveVariableType (type, gqlSchema, stack = 0, stackLimit = 4) {
 
   if (graphql.isInputObjectType(argType)) {
     fields = argType.getFields();
-    Object.keys(fields).forEach((field) => {
+    typeof fields === 'object' && Object.keys(fields).forEach((field) => {
       if (fields[field].type === type) {
         fieldObj[field] = '<Same as ' + type + '>';
       }
@@ -241,7 +249,7 @@ module.exports = {
         }
         crossReferenceKeyList[crossReferenceKey] = true;
 
-        let childKeys = Object.keys(curType.getFields());
+        let childKeys = Object.keys(curType.getFields() || {});
         childQuery = childKeys
           .filter((fieldName) => {
             /* Exclude deprecated fields */
@@ -273,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)}`,
@@ -282,7 +300,7 @@ module.exports = {
           for (let i = 0, len = types.length; i < len; i++) {
             const valueTypeName = types[i],
               valueType = gqlSchema.getType(valueTypeName),
-              unionChildQuery = Object.keys(valueType.getFields())
+              unionChildQuery = Object.keys(valueType.getFields() || {})
                 .map((cur) => {
                   // Don't genrate query fields that have self referencing
                   if (cur === curName) {
@@ -330,7 +348,7 @@ module.exports = {
           console.log('[gqlg warning]:', 'description is required');
       }
 
-      Object.keys(obj).forEach((type) => {
+      typeof obj === 'object' && Object.keys(obj).forEach((type) => {
 
         let field,
           newDescription;
@@ -358,9 +376,12 @@ module.exports = {
 
           /* Generate variables Object from argumentDict */
           var variables = {};
-          Object.entries(queryResult.argumentsDict).map(([varName, arg]) => {
-            variables[varName] = resolveVariableType(arg.type, gqlSchema, 0, stackLimit);
-          });
+
+          if (typeof queryResult.argumentsDict === 'object') {
+            Object.entries(queryResult.argumentsDict).map(([varName, arg]) => {
+              variables[varName] = resolveVariableType(arg.type, gqlSchema, 0, stackLimit);
+            });
+          }
 
           let query = queryResult.queryStr;
           // here the `description` is used to construct the actual queries

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "graphql-to-postman",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Generates a Postman Collection from a GraphQL schema.",
   "main": "index.js",
   "bin": {