feat(astVisitor): add operation: 'query' | 'mutation' | 'subscription' property to visitFn in second argument info.

Author: nodkz

package.json

@@ -20,6 +20,7 @@
     "@types/dedent": "0.7.0",
     "@types/glob": "7.1.1",
     "@types/jest": "25.2.1",
+    "@types/lodash.sortby": "^4.7.6",
     "@types/node": "13.11.0",
     "@typescript-eslint/eslint-plugin": "2.26.0",
     "@typescript-eslint/parser": "2.26.0",
@@ -30,6 +31,7 @@
     "graphql": "15.0.0",
     "graphql-compose": "7.14.1",
     "jest": "25.2.7",
+    "lodash.sortby": "^4.7.0",
     "prettier": "2.0.2",
     "rimraf": "3.0.2",
     "semantic-release": "17.0.4",

src/__tests__/astVisitor-test.ts

@@ -2,6 +2,7 @@ import { astVisitor, VISITOR_REMOVE_NODE, VISITOR_SKIP_CHILDREN } from '../astVi
 import { directoryToAst, AstRootNode } from '../directoryToAst';
 import { astToSchema } from '../astToSchema';
 import { graphql } from 'graphql';
+import sortBy from 'lodash.sortby';
 
 describe('astVisitor', () => {
   let ast: AstRootNode;
@@ -114,6 +115,59 @@ describe('astVisitor', () => {
     });
   });
 
+  describe('visitFn should have path & operation & name properties', () => {
+    it('check ROOT_TYPE', () => {
+      const nodes = [] as Array<any>;
+      astVisitor(ast, {
+        ROOT_TYPE: (node, info) => {
+          nodes.push({ operation: info.operation, name: info.name, path: info.path });
+        },
+      });
+      expect(sortBy(nodes, ['operation', 'name'])).toEqual([
+        { name: 'mutation', operation: 'mutation', path: [] },
+        { name: 'query', operation: 'query', path: [] },
+      ]);
+    });
+
+    it('check DIR & FILE elements', () => {
+      const nodes = [] as Array<any>;
+      astVisitor(ast, {
+        DIR: (node, info) => {
+          nodes.push({ operation: info.operation, name: info.name, path: info.path });
+        },
+        FILE: (node, info) => {
+          nodes.push({ operation: info.operation, name: info.name, path: info.path });
+        },
+      });
+      expect(sortBy(nodes, ['operation', 'name'])).toEqual([
+        { operation: 'mutation', name: 'auth', path: ['mutation'] },
+        { operation: 'mutation', name: 'create', path: ['mutation', 'user'] },
+        { operation: 'mutation', name: 'list', path: ['mutation', 'logs.nested'] },
+        { operation: 'mutation', name: 'login', path: ['mutation', 'auth'] },
+        { operation: 'mutation', name: 'logout', path: ['mutation', 'auth'] },
+        { operation: 'mutation', name: 'logs.nested', path: ['mutation'] },
+        { operation: 'mutation', name: 'method', path: ['mutation', 'auth', 'nested'] },
+        { operation: 'mutation', name: 'nested', path: ['mutation', 'auth'] },
+        { operation: 'mutation', name: 'update', path: ['mutation', 'user'] },
+        { operation: 'mutation', name: 'user', path: ['mutation'] },
+        { operation: 'query', name: 'address.city', path: ['query', 'me'] },
+        { operation: 'query', name: 'address.street', path: ['query', 'me'] },
+        { operation: 'query', name: 'auth', path: ['query'] },
+        { operation: 'query', name: 'extendedData', path: ['query', 'user'] },
+        { operation: 'query', name: 'field', path: ['query'] },
+        { operation: 'query', name: 'isLoggedIn', path: ['query', 'auth'] },
+        { operation: 'query', name: 'me', path: ['query'] },
+        { operation: 'query', name: 'method', path: ['query', 'auth', 'nested'] },
+        { operation: 'query', name: 'name', path: ['query', 'me'] },
+        { operation: 'query', name: 'nested', path: ['query', 'auth'] },
+        { operation: 'query', name: 'roles', path: ['query', 'user'] },
+        { operation: 'query', name: 'some.index', path: ['query'] },
+        { operation: 'query', name: 'some.nested', path: ['query'] },
+        { operation: 'query', name: 'user', path: ['query'] },
+      ]);
+    });
+  });
+
   it('try to wrap all mutations', async () => {
     const logs: any[] = [];
     astVisitor(ast, {

src/astVisitor.ts

@@ -1,4 +1,10 @@
-import { AstRootTypeNode, AstDirNode, AstFileNode, AstRootNode } from './directoryToAst';
+import {
+  AstRootTypeNode,
+  AstDirNode,
+  AstFileNode,
+  AstRootNode,
+  RootTypeNames,
+} from './directoryToAst';
 
 /**
  * Do not traverse children
@@ -27,14 +33,23 @@ export type AstVisitor = {
 };
 
 export interface VisitInfo {
+  operation: RootTypeNames;
   parent: AstDirNode | AstRootTypeNode | AstRootNode;
   name: string;
   path: string[];
 }
 
 export function astVisitor(ast: AstRootNode, visitor: AstVisitor): void {
-  forEachKey(ast.children, (childNode, name) => {
-    if (childNode) visitNode(childNode, visitor, { parent: ast, name, path: [] });
+  (Object.keys(ast.children) as Array<keyof typeof ast.children>).forEach((operation) => {
+    const rootNode = ast.children[operation];
+    if (!rootNode) return;
+
+    visitNode(rootNode, visitor, {
+      parent: ast,
+      name: operation,
+      path: [],
+      operation,
+    });
   });
 }
 
@@ -73,6 +88,7 @@ export function visitNode(
         parent: result as AstDirNode,
         name,
         path: [...info.path, info.name],
+        operation: info.operation,
       });
     });
   }

src/directoryToAst.ts

@@ -43,9 +43,7 @@ export type RootTypeNames = 'query' | 'mutation' | 'subscription';
 
 export interface AstRootNode extends AstBaseNode {
   kind: 'root';
-  children: {
-    [T in RootTypeNames]?: AstRootTypeNode;
-  };
+  children: Record<RootTypeNames, AstRootTypeNode>;
 }
 
 export const defaultOptions: DirectoryToAstOptions = {
@@ -56,7 +54,7 @@ export function directoryToAst(
   m: NodeModule,
   options: DirectoryToAstOptions = defaultOptions
 ): AstRootNode {
-  // if no path was passed in, assume the equivelant of __dirname from caller
+  // if no path was passed in, assume the equivalent of __dirname from caller
   // otherwise, resolve path relative to the equivalent of __dirname
   const schemaPath = options?.relativePath
     ? resolve(dirname(m.filename), options.relativePath)

yarn.lock

@@ -908,6 +908,18 @@
     "@types/koa-compose" "*"
     "@types/node" "*"
 
+"@types/lodash.sortby@^4.7.6":
+  version "4.7.6"
+  resolved "https://registry.yarnpkg.com/@types/lodash.sortby/-/lodash.sortby-4.7.6.tgz#eed689835f274b553db4ae16a4a23f58b79618a1"
+  integrity sha512-EnvAOmKvEg7gdYpYrS6+fVFPw5dL9rBnJi3vcKI7wqWQcLJVF/KRXK9dH29HjGNVvFUj0s9prRP3J8jEGnGKDw==
+  dependencies:
+    "@types/lodash" "*"
+
+"@types/lodash@*":
+  version "4.14.167"
+  resolved "https://registry.yarnpkg.com/@types/lodash/-/lodash-4.14.167.tgz#ce7d78553e3c886d4ea643c37ec7edc20f16765e"
+  integrity sha512-w7tQPjARrvdeBkX/Rwg95S592JwxqOjmms3zWQ0XZgSyxSLdzWaYH3vErBhdVS/lRBX7F8aBYcYJYTr5TMGOzw==
+
 "@types/long@^4.0.0":
   version "4.0.0"
   resolved "https://registry.yarnpkg.com/@types/long/-/long-4.0.0.tgz#719551d2352d301ac8b81db732acb6bdc28dbdef"
@@ -2403,7 +2415,7 @@ debug@^3.1.0:
   dependencies:
     ms "^2.1.1"
 
-debuglog@*, debuglog@^1.0.1:
+debuglog@^1.0.1:
   version "1.0.1"
   resolved "https://registry.yarnpkg.com/debuglog/-/debuglog-1.0.1.tgz#aa24ffb9ac3df9a2351837cfb2d279360cd78492"
   integrity sha1-qiT/uaw9+aI1GDfPstJ5NgzXhJI=
@@ -3841,7 +3853,7 @@ import-local@^3.0.2:
     pkg-dir "^4.2.0"
     resolve-cwd "^3.0.0"
 
-imurmurhash@*, imurmurhash@^0.1.4:
+imurmurhash@^0.1.4:
   version "0.1.4"
   resolved "https://registry.yarnpkg.com/imurmurhash/-/imurmurhash-0.1.4.tgz#9218b9b2b928a238b13dc4fb6b6d576f231453ea"
   integrity sha1-khi5srkoojixPcT7a21XbyMUU+o=
@@ -5029,11 +5041,6 @@ lockfile@^1.0.4:
   dependencies:
     signal-exit "^3.0.2"
 
-lodash._baseindexof@*:
-  version "3.1.0"
-  resolved "https://registry.yarnpkg.com/lodash._baseindexof/-/lodash._baseindexof-3.1.0.tgz#fe52b53a1c6761e42618d654e4a25789ed61822c"
-  integrity sha1-/lK1OhxnYeQmGNZU5KJXie1hgiw=
-
 lodash._baseuniq@~4.6.0:
   version "4.6.0"
   resolved "https://registry.yarnpkg.com/lodash._baseuniq/-/lodash._baseuniq-4.6.0.tgz#0ebb44e456814af7905c6212fa2c9b2d51b841e8"
@@ -5042,33 +5049,11 @@ lodash._baseuniq@~4.6.0:
     lodash._createset "~4.0.0"
     lodash._root "~3.0.0"
 
-lodash._bindcallback@*:
-  version "3.0.1"
-  resolved "https://registry.yarnpkg.com/lodash._bindcallback/-/lodash._bindcallback-3.0.1.tgz#e531c27644cf8b57a99e17ed95b35c748789392e"
-  integrity sha1-5THCdkTPi1epnhftlbNcdIeJOS4=
-
-lodash._cacheindexof@*:
-  version "3.0.2"
-  resolved "https://registry.yarnpkg.com/lodash._cacheindexof/-/lodash._cacheindexof-3.0.2.tgz#3dc69ac82498d2ee5e3ce56091bafd2adc7bde92"
-  integrity sha1-PcaayCSY0u5ePOVgkbr9Ktx73pI=
-
-lodash._createcache@*:
-  version "3.1.2"
-  resolved "https://registry.yarnpkg.com/lodash._createcache/-/lodash._createcache-3.1.2.tgz#56d6a064017625e79ebca6b8018e17440bdcf093"
-  integrity sha1-VtagZAF2JeeevKa4AY4XRAvc8JM=
-  dependencies:
-    lodash._getnative "^3.0.0"
-
 lodash._createset@~4.0.0:
   version "4.0.3"
   resolved "https://registry.yarnpkg.com/lodash._createset/-/lodash._createset-4.0.3.tgz#0f4659fbb09d75194fa9e2b88a6644d363c9fe26"
   integrity sha1-D0ZZ+7CddRlPqeK4imZE02PJ/iY=
 
-lodash._getnative@*, lodash._getnative@^3.0.0:
-  version "3.9.1"
-  resolved "https://registry.yarnpkg.com/lodash._getnative/-/lodash._getnative-3.9.1.tgz#570bc7dede46d61cdcde687d65d3eecbaa3aaff5"
-  integrity sha1-VwvH3t5G1hzc3mh9ZdPuy6o6r/U=
-
 lodash._root@~3.0.0:
   version "3.0.1"
   resolved "https://registry.yarnpkg.com/lodash._root/-/lodash._root-3.0.1.tgz#fba1c4524c19ee9a5f8136b4609f017cf4ded692"
@@ -5114,11 +5099,6 @@ [email protected]:
   resolved "https://registry.yarnpkg.com/lodash.memoize/-/lodash.memoize-4.1.2.tgz#bcc6c49a42a2840ed997f323eada5ecd182e0bfe"
   integrity sha1-vMbEmkKihA7Zl/Mj6tpezRguC/4=
 
-lodash.restparam@*:
-  version "3.6.1"
-  resolved "https://registry.yarnpkg.com/lodash.restparam/-/lodash.restparam-3.6.1.tgz#936a4e309ef330a7645ed4145986c85ae5b20805"
-  integrity sha1-k2pOMJ7zMKdkXtQUWYbIWuWyCAU=
-
 lodash.set@^4.3.2:
   version "4.3.2"
   resolved "https://registry.yarnpkg.com/lodash.set/-/lodash.set-4.3.2.tgz#d8757b1da807dde24816b0d6a84bea1a76230b23"