github-issue-tower-defence-management 2.19.1 → 2.19.2

package/src/adapter/repositories/githubGraphqlClient.test.ts

@@ -1,479 +0,0 @@
-const mockPost = jest.fn();
-
-jest.mock('ky', () => ({
-  default: {
-    post: mockPost,
-    get: jest.fn(),
-    put: jest.fn(),
-    patch: jest.fn(),
-    delete: jest.fn(),
-    extend: jest.fn(),
-    create: jest.fn(),
-    stop: jest.fn(),
-  },
-  __esModule: true,
-}));
-
-import net from 'node:net';
-import {
-  GITHUB_GRAPHQL_ENDPOINT,
-  GITHUB_GRAPHQL_REQUEST_TIMEOUT_MS,
-  RATE_LIMIT_SELECTION,
-  extractGraphqlCallSite,
-  extractGraphqlOperationName,
-  fetchGithubGraphql,
-  injectRateLimitSelection,
-  isMutationOperation,
-  logGithubGraphqlCost,
-  postGithubGraphqlJson,
-} from './githubGraphqlClient';
-
-const isRecord = (value: unknown): value is Record<string, unknown> =>
-  typeof value === 'object' && value !== null;
-
-const expectRecord = (value: unknown): Record<string, unknown> => {
-  if (!isRecord(value)) {
-    throw new Error(`Expected an object but got: ${String(value)}`);
-  }
-  return value;
-};
-
-const getMockCallArguments = (
-  mock: jest.Mock,
-  callIndex: number,
-): unknown[] => {
-  const call: unknown = mock.mock.calls[callIndex];
-  if (!Array.isArray(call)) {
-    throw new Error('Expected a recorded mock call');
-  }
-  return call.map((argument: unknown) => argument);
-};
-
-describe('githubGraphqlClient', () => {
-  let consoleLogSpy: jest.SpyInstance;
-
-  beforeEach(() => {
-    jest.clearAllMocks();
-    consoleLogSpy = jest.spyOn(console, 'log').mockImplementation(() => {});
-  });
-
-  afterEach(() => {
-    consoleLogSpy.mockRestore();
-  });
-
-  describe('isMutationOperation', () => {
-    it('returns true for a mutation operation', () => {
-      expect(isMutationOperation('mutation AddItem { x }')).toBe(true);
-      expect(isMutationOperation('\n  mutation { x }')).toBe(true);
-    });
-
-    it('returns false for query operations', () => {
-      expect(isMutationOperation('query GetItem { x }')).toBe(false);
-      expect(isMutationOperation('\n  query($a: Int!) { x }')).toBe(false);
-    });
-  });
-
-  describe('extractGraphqlOperationName', () => {
-    it('extracts the operation name from a named query', () => {
-      expect(
-        extractGraphqlOperationName('query GetProjectItems($id: ID!) { x }'),
-      ).toBe('GetProjectItems');
-    });
-
-    it('extracts the operation name from a named mutation', () => {
-      expect(
-        extractGraphqlOperationName('mutation AddIssueToProject { x }'),
-      ).toBe('AddIssueToProject');
-    });
-
-    it('returns anonymous for an unnamed query', () => {
-      expect(extractGraphqlOperationName('query($a: Int!) { x }')).toBe(
-        'anonymous',
-      );
-    });
-  });
-
-  describe('injectRateLimitSelection', () => {
-    it('injects the rateLimit selection before the closing brace of a query', () => {
-      const injected = injectRateLimitSelection(
-        'query GetItem($id: ID!) {\n  node(id: $id) { id }\n}',
-      );
-      expect(injected).toContain(RATE_LIMIT_SELECTION);
-      expect(injected.trimEnd().endsWith('}')).toBe(true);
-      const rateLimitIndex = injected.indexOf(RATE_LIMIT_SELECTION);
-      const lastBraceIndex = injected.lastIndexOf('}');
-      expect(rateLimitIndex).toBeLessThan(lastBraceIndex);
-    });
-
-    it('does not modify a mutation', () => {
-      const mutation = 'mutation AddItem { addItem { id } }';
-      expect(injectRateLimitSelection(mutation)).toBe(mutation);
-    });
-
-    it('injects into an anonymous query', () => {
-      const injected = injectRateLimitSelection(
-        '\n  query($a: Int!) {\n    node { id }\n  }\n',
-      );
-      expect(injected).toContain(RATE_LIMIT_SELECTION);
-    });
-  });
-
-  describe('extractGraphqlCallSite', () => {
-    it('names the nearest modules outside the graphql client', () => {
-      const stack = [
-        'Error',
-        '    at captureGraphqlCallSite (/app/bin/adapter/repositories/githubGraphqlClient.js:80:20)',
-        '    at postGithubGraphqlJson (/app/bin/adapter/repositories/githubGraphqlClient.js:120:22)',
-        '    at GraphqlProjectItemRepository.fetchProjectItemByUrl (/app/bin/adapter/repositories/issue/GraphqlProjectItemRepository.js:1042:11)',
-        '    at ApiV3CheerioRestIssueRepository.getIssueByUrl (/app/bin/adapter/repositories/issue/ApiV3CheerioRestIssueRepository.js:813:11)',
-        '    at async ChangeStatusByStoryColorUseCase.run (/app/bin/domain/usecases/ChangeStatusByStoryColorUseCase.js:63:31)',
-        '    at async HandleScheduledEventUseCase.runSlowSweepUseCases (/app/bin/domain/usecases/HandleScheduledEventUseCase.js:552:5)',
-      ].join('\n');
-
-      expect(extractGraphqlCallSite(stack)).toBe(
-        'GraphqlProjectItemRepository<-ApiV3CheerioRestIssueRepository<-ChangeStatusByStoryColorUseCase',
-      );
-    });
-
-    it('collapses the retry and fallback wrappers into their own module so the owning repository and use case are named', () => {
-      const stack = [
-        'Error',
-        '    at postGithubGraphqlJson (/app/bin/adapter/repositories/githubGraphqlClient.js:120:22)',
-        '    at callWithRateLimitRetry (/app/bin/adapter/repositories/issue/GraphqlProjectItemRepository.js:255:15)',
-        '    at callGraphql (/app/bin/adapter/repositories/issue/GraphqlProjectItemRepository.js:280:12)',
-        '    at callGraphqlWithHalvingFallback (/app/bin/adapter/repositories/issue/GraphqlProjectItemRepository.js:310:12)',
-        '    at GraphqlProjectItemRepository.fetchProjectItems (/app/bin/adapter/repositories/issue/GraphqlProjectItemRepository.js:410:11)',
-        '    at async StartPreparationUseCase.run (/app/bin/domain/usecases/StartPreparationUseCase.js:456:11)',
-      ].join('\n');
-
-      expect(extractGraphqlCallSite(stack)).toBe(
-        'GraphqlProjectItemRepository<-StartPreparationUseCase',
-      );
-    });
-
-    it('names the same call site whether or not the engine qualifies a nested helper with its class name', () => {
-      const frames = (nestedHelperFrameName: string): string =>
-        [
-          'Error',
-          '    at postGithubGraphqlJson (/app/bin/adapter/repositories/githubGraphqlClient.js:120:22)',
-          `    at ${nestedHelperFrameName} (/app/bin/adapter/repositories/issue/GraphqlProjectItemRepository.js:310:12)`,
-          '    at GraphqlProjectItemRepository.fetchProjectItems (/app/bin/adapter/repositories/issue/GraphqlProjectItemRepository.js:410:11)',
-          '    at async StartPreparationUseCase.run (/app/bin/domain/usecases/StartPreparationUseCase.js:456:11)',
-        ].join('\n');
-
-      expect(
-        extractGraphqlCallSite(frames('callGraphqlWithHalvingFallback')),
-      ).toBe('GraphqlProjectItemRepository<-StartPreparationUseCase');
-      expect(
-        extractGraphqlCallSite(
-          frames('GraphqlProjectItemRepository.callGraphqlWithHalvingFallback'),
-        ),
-      ).toBe('GraphqlProjectItemRepository<-StartPreparationUseCase');
-    });
-
-    it('names the module of a frame that carries a file location instead of a function name', () => {
-      const stack = [
-        'Error',
-        '    at postGithubGraphqlJson (/app/bin/adapter/repositories/githubGraphqlClient.js:120:22)',
-        '    at /app/bin/domain/usecases/AnonymousCaller.js:12:9',
-        '    at StartPreparationUseCase.run (/app/bin/domain/usecases/StartPreparationUseCase.js:456:11)',
-      ].join('\n');
-
-      expect(extractGraphqlCallSite(stack)).toBe(
-        'AnonymousCaller<-StartPreparationUseCase',
-      );
-    });
-
-    it('skips test runner and node internal frames so the caller of a test run is still named', () => {
-      const stack = [
-        'Error',
-        '    at postGithubGraphqlJson (/app/src/adapter/repositories/githubGraphqlClient.ts:139:42)',
-        '    at GraphqlProjectItemRepository.fetchProjectItems (/app/src/adapter/repositories/issue/GraphqlProjectItemRepository.ts:566:26)',
-        '    at Object.<anonymous> (/app/src/adapter/repositories/issue/GraphqlProjectItemRepository.test.ts:288:26)',
-        '    at Promise.finally.completed (/app/node_modules/jest-circus/build/jestAdapterInit.js:1561:28)',
-        '    at new Promise (<anonymous>)',
-        '    at processTicksAndRejections (node:internal/process/task_queues:104:5)',
-      ].join('\n');
-
-      expect(extractGraphqlCallSite(stack)).toBe(
-        'GraphqlProjectItemRepository',
-      );
-    });
-
-    it('names the caller when the package runs from inside node_modules, as the published build does', () => {
-      const packageRoot =
-        '/home/user/.local/share/tdpm/current/node_modules/github-issue-tower-defence-management';
-      const stack = [
-        'Error',
-        `    at captureGraphqlCallSite (${packageRoot}/bin/adapter/repositories/githubGraphqlClient.js:80:20)`,
-        `    at postGithubGraphqlJson (${packageRoot}/bin/adapter/repositories/githubGraphqlClient.js:120:22)`,
-        `    at GraphqlProjectItemRepository.fetchProjectItems (${packageRoot}/bin/adapter/repositories/issue/GraphqlProjectItemRepository.js:410:11)`,
-        `    at async StartPreparationUseCase.run (${packageRoot}/bin/domain/usecases/StartPreparationUseCase.js:456:11)`,
-      ].join('\n');
-
-      expect(
-        extractGraphqlCallSite(
-          stack,
-          `${packageRoot}/bin/adapter/repositories/githubGraphqlClient.js`,
-        ),
-      ).toBe('GraphqlProjectItemRepository<-StartPreparationUseCase');
-    });
-
-    it('names the caller when the published package sits under a scoped directory', () => {
-      const packageRoot = '/srv/app/node_modules/@hiromishikata/tdpm';
-      const stack = [
-        'Error',
-        `    at postGithubGraphqlJson (${packageRoot}/bin/adapter/repositories/githubGraphqlClient.js:120:22)`,
-        `    at GraphqlProjectItemRepository.fetchProjectItems (${packageRoot}/bin/adapter/repositories/issue/GraphqlProjectItemRepository.js:410:11)`,
-      ].join('\n');
-
-      expect(
-        extractGraphqlCallSite(
-          stack,
-          `${packageRoot}/bin/adapter/repositories/githubGraphqlClient.js`,
-        ),
-      ).toBe('GraphqlProjectItemRepository');
-    });
-
-    it('skips a dependency nested inside the installed package so no third party module is named', () => {
-      const packageRoot =
-        '/home/user/.local/share/tdpm/current/node_modules/github-issue-tower-defence-management';
-      const stack = [
-        'Error',
-        `    at postGithubGraphqlJson (${packageRoot}/bin/adapter/repositories/githubGraphqlClient.js:120:22)`,
-        `    at Object.ky (${packageRoot}/node_modules/ky/distribution/index.js:44:9)`,
-        `    at GraphqlProjectItemRepository.fetchProjectItems (${packageRoot}/bin/adapter/repositories/issue/GraphqlProjectItemRepository.js:410:11)`,
-      ].join('\n');
-
-      expect(
-        extractGraphqlCallSite(
-          stack,
-          `${packageRoot}/bin/adapter/repositories/githubGraphqlClient.js`,
-        ),
-      ).toBe('GraphqlProjectItemRepository');
-    });
-
-    it('returns unknown when no stack is available', () => {
-      expect(extractGraphqlCallSite(undefined)).toBe('unknown');
-    });
-
-    it('returns unknown when every frame is inside the graphql client', () => {
-      const stack = [
-        'Error',
-        '    at postGithubGraphqlJson (/app/bin/adapter/repositories/githubGraphqlClient.js:120:22)',
-      ].join('\n');
-
-      expect(extractGraphqlCallSite(stack)).toBe('unknown');
-    });
-  });
-
-  describe('logGithubGraphqlCost', () => {
-    it('logs one line with query name, cost and remaining', () => {
-      logGithubGraphqlCost({
-        query: 'query GetProjectItems { x }',
-        responseBody: { data: { rateLimit: { cost: 3, remaining: 4200 } } },
-        callSite: 'GraphqlProjectItemRepository<-StartPreparationUseCase',
-        now: () => new Date('2026-08-14T09:00:00.000Z'),
-      });
-      expect(consoleLogSpy).toHaveBeenCalledTimes(1);
-      expect(consoleLogSpy).toHaveBeenCalledWith(
-        '2026-08-14T09:00:00.000Z githubGraphqlClient: query=GetProjectItems cost=3 remaining=4200 caller=GraphqlProjectItemRepository<-StartPreparationUseCase',
-      );
-    });
-
-    it('opens the line with the time the cost was charged, so a point maps to a rate-limit window', () => {
-      logGithubGraphqlCost({
-        query: 'query GetProjectItems { x }',
-        responseBody: { data: { rateLimit: { cost: 4, remaining: 4200 } } },
-        callSite: 'GraphqlProjectItemRepository<-StartPreparationUseCase',
-        now: () => new Date('2026-08-14T23:45:12.345Z'),
-      });
-      expect(consoleLogSpy).toHaveBeenCalledWith(
-        '2026-08-14T23:45:12.345Z githubGraphqlClient: query=GetProjectItems cost=4 remaining=4200 caller=GraphqlProjectItemRepository<-StartPreparationUseCase',
-      );
-    });
-
-    it('does not log when rateLimit is absent', () => {
-      logGithubGraphqlCost({
-        query: 'query GetProjectItems { x }',
-        responseBody: { data: { node: null } },
-      });
-      expect(consoleLogSpy).not.toHaveBeenCalled();
-    });
-
-    it('does not log when the body is not an object', () => {
-      logGithubGraphqlCost({
-        query: 'query GetProjectItems { x }',
-        responseBody: undefined,
-      });
-      expect(consoleLogSpy).not.toHaveBeenCalled();
-    });
-  });
-
-  describe('postGithubGraphqlJson', () => {
-    it('sends the query with the injected rateLimit selection and logs the cost', async () => {
-      mockPost.mockReturnValue({
-        json: jest.fn().mockResolvedValue({
-          data: {
-            node: { id: 'x' },
-            rateLimit: { cost: 1, remaining: 4999 },
-          },
-        }),
-      });
-      const response = await postGithubGraphqlJson<{
-        data: { node: { id: string } };
-      }>({
-        ghToken: 'token-a',
-        query: 'query GetItem($id: ID!) { node(id: $id) { id } }',
-        variables: { id: 'x' },
-      });
-      expect(response.data.node.id).toBe('x');
-      expect(mockPost).toHaveBeenCalledTimes(1);
-      const call = getMockCallArguments(mockPost, 0);
-      expect(call[0]).toBe(GITHUB_GRAPHQL_ENDPOINT);
-      const options = expectRecord(call[1]);
-      const json = expectRecord(options.json);
-      const headers = expectRecord(options.headers);
-      expect(json.query).toContain(RATE_LIMIT_SELECTION);
-      expect(json.variables).toEqual({ id: 'x' });
-      expect(headers.Authorization).toBe('Bearer token-a');
-      expect(consoleLogSpy).toHaveBeenCalledWith(
-        expect.stringMatching(
-          /^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z githubGraphqlClient: query=GetItem cost=1 remaining=4999 caller=\S+$/,
-        ),
-      );
-    });
-
-    it('sends a mutation unchanged and does not log', async () => {
-      mockPost.mockReturnValue({
-        json: jest.fn().mockResolvedValue({
-          data: { addItem: { id: 'x' } },
-        }),
-      });
-      const mutation = 'mutation AddItem { addItem { id } }';
-      await postGithubGraphqlJson({
-        ghToken: 'token-a',
-        query: mutation,
-      });
-      const call = getMockCallArguments(mockPost, 0);
-      const options = expectRecord(call[1]);
-      const json = expectRecord(options.json);
-      expect(json.query).toBe(mutation);
-      expect(consoleLogSpy).not.toHaveBeenCalled();
-    });
-  });
-
-  describe('fetchGithubGraphql', () => {
-    const originalFetch = global.fetch;
-
-    afterEach(() => {
-      global.fetch = originalFetch;
-    });
-
-    it('sends the query with the injected rateLimit selection and logs the cost', async () => {
-      const responseBody = {
-        data: {
-          repository: { issue: null },
-          rateLimit: { cost: 2, remaining: 4321 },
-        },
-      };
-      const fetchMock = jest
-        .fn()
-        .mockResolvedValue(
-          new Response(JSON.stringify(responseBody), { status: 200 }),
-        );
-      global.fetch = fetchMock;
-      const response = await fetchGithubGraphql({
-        ghToken: 'token-b',
-        query: 'query PullRequestStatus($a: Int!) { x }',
-        variables: { a: 1 },
-      });
-      expect(response.ok).toBe(true);
-      await expect(response.json()).resolves.toEqual(responseBody);
-      expect(fetchMock).toHaveBeenCalledTimes(1);
-      const call = getMockCallArguments(fetchMock, 0);
-      expect(call[0]).toBe(GITHUB_GRAPHQL_ENDPOINT);
-      const init = expectRecord(call[1]);
-      const headers = expectRecord(init.headers);
-      expect(init.method).toBe('POST');
-      expect(headers.Authorization).toBe('Bearer token-b');
-      if (typeof init.body !== 'string') {
-        throw new Error('Expected the request body to be a string');
-      }
-      const sentBody = expectRecord(JSON.parse(init.body));
-      expect(sentBody.query).toContain(RATE_LIMIT_SELECTION);
-      expect(sentBody.variables).toEqual({ a: 1 });
-      expect(consoleLogSpy).toHaveBeenCalledWith(
-        expect.stringMatching(
-          /^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z githubGraphqlClient: query=PullRequestStatus cost=2 remaining=4321 caller=\S+$/,
-        ),
-      );
-    });
-
-    it('returns the response without logging when the request failed', async () => {
-      const fetchMock = jest
-        .fn()
-        .mockResolvedValue(new Response('rate limited', { status: 403 }));
-      global.fetch = fetchMock;
-      const response = await fetchGithubGraphql({
-        ghToken: 'token-b',
-        query: 'query PullRequestStatus($a: Int!) { x }',
-      });
-      expect(response.status).toBe(403);
-      expect(consoleLogSpy).not.toHaveBeenCalled();
-    });
-
-    it('has a default request timeout bound of 120 seconds', () => {
-      expect(GITHUB_GRAPHQL_REQUEST_TIMEOUT_MS).toBe(120_000);
-    });
-
-    it('passes an abort signal to fetch by default', async () => {
-      const fetchMock = jest
-        .fn()
-        .mockResolvedValue(new Response('{}', { status: 200 }));
-      global.fetch = fetchMock;
-      await fetchGithubGraphql({
-        ghToken: 'token-b',
-        query: 'query PullRequestStatus($a: Int!) { x }',
-      });
-      const call = getMockCallArguments(fetchMock, 0);
-      const init = expectRecord(call[1]);
-      expect(init.signal).toBeInstanceOf(AbortSignal);
-    });
-
-    it('rejects with a TimeoutError within the bound when the server never responds', async () => {
-      const realFetch = originalFetch;
-      const openSockets = new Set<net.Socket>();
-      const server = net.createServer((socket) => {
-        openSockets.add(socket);
-        socket.on('close', () => openSockets.delete(socket));
-      });
-      await new Promise<void>((resolve) =>
-        server.listen(0, '127.0.0.1', resolve),
-      );
-      const address = server.address();
-      if (address === null || typeof address === 'string') {
-        throw new Error('Expected the server to listen on a TCP port');
-      }
-      const localEndpoint = `http://127.0.0.1:${address.port}/`;
-      global.fetch = (_input: RequestInfo | URL, init?: RequestInit) =>
-        realFetch(localEndpoint, init);
-      try {
-        const startedAt = Date.now();
-        await expect(
-          fetchGithubGraphql({
-            ghToken: 'token-b',
-            query: 'query PullRequestStatus($a: Int!) { x }',
-            timeoutMs: 300,
-          }),
-        ).rejects.toMatchObject({ name: 'TimeoutError' });
-        expect(Date.now() - startedAt).toBeLessThan(4000);
-      } finally {
-        for (const socket of openSockets) {
-          socket.destroy();
-        }
-        await new Promise<void>((resolve) => server.close(() => resolve()));
-      }
-    });
-  });
-});