Merge pull request #3 from mayademcom/loading-from-gql-files

feat: added withQuery and withVariables methods.

Author: afbora

package.json

@@ -17,12 +17,14 @@
     "test": "jest",
     "test:watch": "jest --watch",
     "test:cov": "jest --coverage",
-    "test:debug": "node --inspect-brk --require ts-node/register --require tsconfig-paths/register ./node_modules/jest/bin/jest.js --runInBand --no-cache",
-    "test:e2e": "jest --config ./test/jest-e2e.json"
+    "test:debug": "node --inspect-brk --require ts-node/register --require tsconfig-paths/register ./node_modules/jest/bin/jest.js --runInBand --no-cache"
   },
   "peerDependencies": {
     "@nestjs/common": "^11.x"
   },
+  "dependencies": {
+    "graphql-request": "^7.4.0"
+  },
   "devDependencies": {
     "@eslint/eslintrc": "^3.2.0",
     "@eslint/js": "^9.18.0",
@@ -56,7 +58,7 @@
       "json",
       "ts"
     ],
-    "rootDir": "src",
+    "rootDir": ".",
     "testRegex": ".*\\.spec\\.ts$",
     "transform": {
       "^.+\\.(t|j)s$": "ts-jest"
@@ -66,10 +68,11 @@
       "!**/*.spec.ts",
       "!**/index.ts"
     ],
-    "coverageDirectory": "../coverage",
-    "testEnvironment": "node"
-  },
-  "dependencies": {
-    "graphql-request": "^7.4.0"
+    "coverageDirectory": "coverage",
+    "testEnvironment": "node",
+    "roots": [
+      "<rootDir>/src/",
+      "<rootDir>/test/"
+    ]
   }
-}
+}

sonar-project.properties

@@ -3,5 +3,4 @@ sonar.organization=mayademcom
 sonar.sources=src
 sonar.exclusions=**/node_modules/**,**/dist/**,**/*.spec.ts
 sonar.javascript.node.maxspace=4096
-sonar.javascript.lcov.reportPaths=./coverage/lcov.info
-
+sonar.javascript.lcov.reportPaths=./coverage/lcov.info

src/graphql-loader/graphql-loader.service.spec.ts

@@ -0,0 +1,78 @@
+import * as fs from 'fs';
+import * as path from 'path';
+
+import { Test, TestingModule } from '@nestjs/testing';
+
+import { GraphQLLoaderService } from './graphql-loader.service';
+
+jest.mock('fs');
+jest.mock('path');
+
+describe('GraphQLLoaderService', () => {
+  let service: GraphQLLoaderService;
+
+  const mockFilePath = 'queries/test.graphql';
+  const mockFullPath = '/app/queries/test.graphql';
+  const mockQuery = 'query Test { test }';
+  const mockedReadFileSync = fs.readFileSync as jest.MockedFunction<
+    typeof fs.readFileSync
+  >;
+
+  beforeEach(async () => {
+    jest.clearAllMocks();
+
+    (path.join as jest.Mock).mockReturnValue(mockFullPath);
+
+    const module: TestingModule = await Test.createTestingModule({
+      providers: [GraphQLLoaderService],
+    }).compile();
+
+    service = module.get<GraphQLLoaderService>(GraphQLLoaderService);
+  });
+
+  it('should be defined', () => {
+    expect(service).toBeDefined();
+  });
+
+  it('should load query from file when cache is empty', () => {
+    mockedReadFileSync.mockReturnValue(mockQuery as string);
+
+    const result = service.loadQuery(mockFilePath);
+
+    expect(result).toBe(mockQuery);
+    expect(fs.readFileSync).toHaveBeenCalledWith(mockFullPath, 'utf-8');
+  });
+
+  it('should cache the query after loading from file', () => {
+    mockedReadFileSync.mockReturnValue(mockQuery as string);
+
+    service.loadQuery(mockFilePath);
+    mockedReadFileSync.mockClear();
+
+    const cachedResult = service.loadQuery(mockFilePath);
+
+    expect(cachedResult).toBe(mockQuery);
+    expect(mockedReadFileSync).not.toHaveBeenCalled();
+  });
+
+  it('should throw error if file read fails', () => {
+    (fs.readFileSync as jest.Mock).mockImplementation(() => {
+      throw new Error('File not found');
+    });
+
+    expect(() => service.loadQuery(mockFilePath)).toThrow(
+      `Failed to load GraphQL query from ${mockFilePath}: File not found`,
+    );
+  });
+
+  it('should clear cache', () => {
+    (fs.readFileSync as jest.Mock).mockReturnValue(mockQuery);
+
+    service.loadQuery(mockFilePath);
+    service.clearCache();
+
+    service.loadQuery(mockFilePath);
+
+    expect(fs.readFileSync).toHaveBeenCalledTimes(2);
+  });
+});

src/graphql-loader/graphql-loader.service.ts

@@ -0,0 +1,44 @@
+import * as fs from 'node:fs';
+import * as path from 'node:path';
+
+import { Injectable } from '@nestjs/common';
+
+@Injectable()
+export class GraphQLLoaderService {
+  private readonly queryCache = new Map<string, string>();
+
+  loadQuery(filePath: string): string {
+    let query = this.loadQueryFromCache(filePath);
+    if (!query) query = this.loadQueryFromFile(filePath);
+    this.saveQueryToCache(filePath, query);
+    return query;
+  }
+
+  private loadQueryFromCache(filePath: string) {
+    let query: string | null = null;
+    if (this.queryCache.has(filePath)) {
+      query = this.queryCache.get(filePath)!;
+    }
+    return query;
+  }
+
+  private loadQueryFromFile(filePath: string) {
+    try {
+      const fullPath = path.join(process.cwd(), filePath);
+      const query = fs.readFileSync(fullPath, 'utf-8');
+      return query;
+    } catch (error) {
+      throw new Error(
+        `Failed to load GraphQL query from ${filePath}: ${(error as Error).message}`,
+      );
+    }
+  }
+
+  private saveQueryToCache(filePath: string, query: string) {
+    this.queryCache.set(filePath, query);
+  }
+
+  clearCache(): void {
+    this.queryCache.clear();
+  }
+}

src/hasura.module.ts

@@ -1,6 +1,7 @@
 import { DynamicModule, Module } from '@nestjs/common';
 import { HasuraAsyncConfig, HasuraConfig } from './models';
 
+import { GraphQLLoaderService } from './graphql-loader/graphql-loader.service';
 import { HasuraService } from './hasura.service';
 
 @Module({})
@@ -27,6 +28,7 @@ export class HasuraModule {
       module: HasuraModule,
       global: false,
       providers: [
+        GraphQLLoaderService,
         HasuraService,
         {
           provide: 'HASURA_CONFIG',
@@ -64,6 +66,7 @@ export class HasuraModule {
       global: false,
       imports: config.imports,
       providers: [
+        GraphQLLoaderService,
         HasuraService,
         {
           provide: 'HASURA_CONFIG',