refactor(index.js): replace glob package with fast-glob package for faster and more efficient file globbing

build(package.json): add fast-glob package as a dependency to the project
test(purifier.spec.ts): update mock imports from glob to fast-glob for consistency and efficiency
refactor(index.ts): replace glob package with fast-glob package for faster and more efficient file globbing

Author: danil-iglu

dist/index.js

@@ -7,8 +7,7 @@ exports.GraphQLQueryPurifier = void 0;
 const fs_1 = __importDefault(require("fs"));
 const graphql_1 = require("graphql");
 const path_1 = __importDefault(require("path"));
-// @ts-ignore
-const glob_1 = __importDefault(require("glob"));
+const fast_glob_1 = __importDefault(require("fast-glob"));
 const merge_1 = require("./merge");
 const get_allowed_query_1 = require("./get-allowed-query");
 class GraphQLQueryPurifier {
@@ -84,7 +83,7 @@ class GraphQLQueryPurifier {
      * @private
      */
     loadQueries() {
-        const files = glob_1.default.sync(`${this.gqlPath}/**/*.gql`.replace(/\\/g, '/'));
+        const files = fast_glob_1.default.sync(`${this.gqlPath}/**/*.gql`, { absolute: true });
         if (!files || files.length === 0) {
             console.warn(`No GraphQL files found in path: ${this.gqlPath}`);
             return;

package.json

@@ -38,5 +38,8 @@
     "terser": "^5.26.0",
     "ts-jest": "^29.1.1",
     "typescript": "^5.3.3"
+  },
+  "dependencies": {
+    "fast-glob": "^3.3.3"
   }
 }

src/__tests__/purifier.spec.ts

@@ -1,10 +1,10 @@
 import { GraphQLQueryPurifier } from '..';
 import { Request, Response, NextFunction } from 'express';
 import fs from 'fs';
-import glob from 'glob';
+import fg from 'fast-glob';
 
 jest.mock('fs');
-jest.mock('glob');
+jest.mock('fast-glob');
 
 describe('GraphQLQueryPurifier', () => {
   let purifier: GraphQLQueryPurifier;
@@ -33,7 +33,7 @@ describe('GraphQLQueryPurifier', () => {
       }
     `);
 
-    (glob.sync as jest.Mock).mockReturnValue(['./graphql/queries/test.gql']);
+    (fg.sync as jest.Mock).mockReturnValue(['./graphql/queries/test.gql']);
   });
 
   afterEach(() => {
@@ -100,7 +100,7 @@ describe('GraphQLQueryPurifier', () => {
   });
 
   test('should throw error for duplicate operation names when loading queries', () => {
-    (glob.sync as jest.Mock).mockReturnValue([
+    (fg.sync as jest.Mock).mockReturnValue([
       './graphql/queries/findMyJobs1.gql',
       './graphql/queries/findMyJobs2.gql',
     ]);
@@ -134,8 +134,7 @@ describe('GraphQLQueryPurifier', () => {
     `);
 
     expect(() => {
-      // @ts-ignore
-      purifier.loadQueries();
+      purifier['loadQueries']();
     }).toThrowError('Duplicate operation name detected: FindMyJobs.');
   });
 });

src/index.ts

@@ -2,8 +2,7 @@ import { NextFunction, Request, Response } from 'express';
 import fs from 'fs';
 import { FieldNode, OperationDefinitionNode, parse } from 'graphql';
 import path from 'path';
-// @ts-ignore
-import glob from 'glob';
+import fg from 'fast-glob';
 import { mergeQueries } from './merge';
 import { getAllowedQueryForRequest } from './get-allowed-query';
 
@@ -82,7 +81,7 @@ export class GraphQLQueryPurifier {
    * @private
    */
   private loadQueries() {
-    const files = glob.sync(`${this.gqlPath}/**/*.gql`.replace(/\\/g, '/'));
+    const files = fg.sync(`${this.gqlPath}/**/*.gql`, { absolute: true });
     if (!files || files.length === 0) {
       console.warn(`No GraphQL files found in path: ${this.gqlPath}`);
       return;

yarn.lock

@@ -808,14 +808,14 @@ __metadata:
   languageName: node
   linkType: hard
 
-"@nodelib/fs.stat@npm:2.0.5":
+"@nodelib/fs.stat@npm:2.0.5, @nodelib/fs.stat@npm:^2.0.2":
   version: 2.0.5
   resolution: "@nodelib/fs.stat@npm:2.0.5"
   checksum: 012480b5ca9d97bff9261571dbbec7bbc6033f69cc92908bc1ecfad0792361a5a1994bc48674b9ef76419d056a03efadfce5a6cf6dbc0a36559571a7a483f6f0
   languageName: node
   linkType: hard
 
-"@nodelib/fs.walk@npm:^1.2.8":
+"@nodelib/fs.walk@npm:^1.2.3, @nodelib/fs.walk@npm:^1.2.8":
   version: 1.2.8
   resolution: "@nodelib/fs.walk@npm:1.2.8"
   dependencies:
@@ -1376,6 +1376,15 @@ __metadata:
   languageName: node
   linkType: hard
 
+"braces@npm:^3.0.3":
+  version: 3.0.3
+  resolution: "braces@npm:3.0.3"
+  dependencies:
+    fill-range: ^7.1.1
+  checksum: b95aa0b3bd909f6cd1720ffcf031aeaf46154dd88b4da01f9a1d3f7ea866a79eba76a6d01cbc3c422b2ee5cdc39a4f02491058d5df0d7bf6e6a162a832df1f69
+  languageName: node
+  linkType: hard
+
 "browserslist@npm:^4.21.9":
   version: 4.22.1
   resolution: "browserslist@npm:4.22.1"
@@ -1950,6 +1959,19 @@ __metadata:
   languageName: node
   linkType: hard
 
+"fast-glob@npm:^3.3.3":
+  version: 3.3.3
+  resolution: "fast-glob@npm:3.3.3"
+  dependencies:
+    "@nodelib/fs.stat": ^2.0.2
+    "@nodelib/fs.walk": ^1.2.3
+    glob-parent: ^5.1.2
+    merge2: ^1.3.0
+    micromatch: ^4.0.8
+  checksum: 0704d7b85c0305fd2cef37777337dfa26230fdd072dce9fb5c82a4b03156f3ffb8ed3e636033e65d45d2a5805a4e475825369a27404c0307f2db0c8eb3366fbd
+  languageName: node
+  linkType: hard
+
 "fast-json-stable-stringify@npm:2.x, fast-json-stable-stringify@npm:^2.0.0, fast-json-stable-stringify@npm:^2.1.0":
   version: 2.1.0
   resolution: "fast-json-stable-stringify@npm:2.1.0"
@@ -2000,6 +2022,15 @@ __metadata:
   languageName: node
   linkType: hard
 
+"fill-range@npm:^7.1.1":
+  version: 7.1.1
+  resolution: "fill-range@npm:7.1.1"
+  dependencies:
+    to-regex-range: ^5.0.1
+  checksum: b4abfbca3839a3d55e4ae5ec62e131e2e356bf4859ce8480c64c4876100f4df292a63e5bb1618e1d7460282ca2b305653064f01654474aa35c68000980f17798
+  languageName: node
+  linkType: hard
+
 "find-up@npm:^4.0.0, find-up@npm:^4.1.0":
   version: 4.1.0
   resolution: "find-up@npm:4.1.0"
@@ -2127,6 +2158,15 @@ __metadata:
   languageName: node
   linkType: hard
 
+"glob-parent@npm:^5.1.2":
+  version: 5.1.2
+  resolution: "glob-parent@npm:5.1.2"
+  dependencies:
+    is-glob: ^4.0.1
+  checksum: f4f2bfe2425296e8a47e36864e4f42be38a996db40420fe434565e4480e3322f18eb37589617a98640c5dc8fdec1a387007ee18dbb1f3f5553409c34d17f425e
+  languageName: node
+  linkType: hard
+
 "glob-parent@npm:^6.0.2":
   version: 6.0.2
   resolution: "glob-parent@npm:6.0.2"
@@ -2204,6 +2244,7 @@ __metadata:
     "@types/jest": ^29.5.11
     "@types/node": ^20.10.6
     eslint: ^8.56.0
+    fast-glob: ^3.3.3
     graphql: ^16.8.1
     jest: ^29.7.0
     prettier: ^3.1.1
@@ -2397,7 +2438,7 @@ __metadata:
   languageName: node
   linkType: hard
 
-"is-glob@npm:^4.0.0, is-glob@npm:^4.0.3":
+"is-glob@npm:^4.0.0, is-glob@npm:^4.0.1, is-glob@npm:^4.0.3":
   version: 4.0.3
   resolution: "is-glob@npm:4.0.3"
   dependencies:
@@ -3189,6 +3230,13 @@ __metadata:
   languageName: node
   linkType: hard
 
+"merge2@npm:^1.3.0":
+  version: 1.4.1
+  resolution: "merge2@npm:1.4.1"
+  checksum: 7268db63ed5169466540b6fb947aec313200bcf6d40c5ab722c22e242f651994619bcd85601602972d3c85bd2cc45a358a4c61937e9f11a061919a1da569b0c2
+  languageName: node
+  linkType: hard
+
 "micromatch@npm:^4.0.4":
   version: 4.0.5
   resolution: "micromatch@npm:4.0.5"
@@ -3199,6 +3247,16 @@ __metadata:
   languageName: node
   linkType: hard
 
+"micromatch@npm:^4.0.8":
+  version: 4.0.8
+  resolution: "micromatch@npm:4.0.8"
+  dependencies:
+    braces: ^3.0.3
+    picomatch: ^2.3.1
+  checksum: 79920eb634e6f400b464a954fcfa589c4e7c7143209488e44baf627f9affc8b1e306f41f4f0deedde97e69cb725920879462d3e750ab3bd3c1aed675bb3a8966
+  languageName: node
+  linkType: hard
+
 "mimic-fn@npm:^2.1.0":
   version: 2.1.0
   resolution: "mimic-fn@npm:2.1.0"