github-issue-tower-defence-management 1.123.3 → 1.124.0

package/src/adapter/repositories/githubGraphqlClient.ts

@@ -0,0 +1,122 @@
+import ky from 'ky';
+
+export const GITHUB_GRAPHQL_ENDPOINT = 'https://api.github.com/graphql';
+
+export const RATE_LIMIT_SELECTION = 'rateLimit { cost remaining }';
+
+export type GithubGraphqlRateLimit = {
+  cost: number;
+  remaining: number;
+};
+
+export const isMutationOperation = (query: string): boolean =>
+  query.trimStart().startsWith('mutation');
+
+export const extractGraphqlOperationName = (query: string): string => {
+  const match = query.match(
+    /^\s*(?:query|mutation)\s+([A-Za-z_][A-Za-z0-9_]*)/,
+  );
+  return match ? match[1] : 'anonymous';
+};
+
+export const injectRateLimitSelection = (query: string): string => {
+  if (isMutationOperation(query)) {
+    return query;
+  }
+  const lastBraceIndex = query.lastIndexOf('}');
+  if (lastBraceIndex === -1) {
+    return query;
+  }
+  return `${query.slice(0, lastBraceIndex)}  ${RATE_LIMIT_SELECTION}\n${query.slice(lastBraceIndex)}`;
+};
+
+const extractRateLimit = (
+  responseBody: unknown,
+): GithubGraphqlRateLimit | null => {
+  if (
+    typeof responseBody !== 'object' ||
+    responseBody === null ||
+    !('data' in responseBody)
+  ) {
+    return null;
+  }
+  const data: unknown = responseBody.data;
+  if (typeof data !== 'object' || data === null || !('rateLimit' in data)) {
+    return null;
+  }
+  const rateLimit: unknown = data.rateLimit;
+  if (
+    typeof rateLimit !== 'object' ||
+    rateLimit === null ||
+    !('cost' in rateLimit) ||
+    !('remaining' in rateLimit)
+  ) {
+    return null;
+  }
+  const { cost, remaining } = rateLimit;
+  if (typeof cost !== 'number' || typeof remaining !== 'number') {
+    return null;
+  }
+  return { cost, remaining };
+};
+
+export const logGithubGraphqlCost = (
+  query: string,
+  responseBody: unknown,
+): void => {
+  const rateLimit = extractRateLimit(responseBody);
+  if (!rateLimit) {
+    return;
+  }
+  console.log(
+    `githubGraphqlClient: query=${extractGraphqlOperationName(query)} cost=${rateLimit.cost} remaining=${rateLimit.remaining}`,
+  );
+};
+
+export const postGithubGraphqlJson = async <T>(params: {
+  ghToken: string;
+  query: string;
+  variables?: Record<string, unknown>;
+}): Promise<T> => {
+  const response = await ky
+    .post(GITHUB_GRAPHQL_ENDPOINT, {
+      json: {
+        query: injectRateLimitSelection(params.query),
+        ...(params.variables !== undefined
+          ? { variables: params.variables }
+          : {}),
+      },
+      headers: {
+        Authorization: `Bearer ${params.ghToken}`,
+      },
+    })
+    .json<T>();
+  logGithubGraphqlCost(params.query, response);
+  return response;
+};
+
+export const fetchGithubGraphql = async (params: {
+  ghToken: string;
+  query: string;
+  variables?: Record<string, unknown>;
+}): Promise<Response> => {
+  const response = await fetch(GITHUB_GRAPHQL_ENDPOINT, {
+    method: 'POST',
+    headers: {
+      Authorization: `Bearer ${params.ghToken}`,
+      'Content-Type': 'application/json',
+    },
+    body: JSON.stringify({
+      query: injectRateLimitSelection(params.query),
+      variables: params.variables,
+    }),
+  });
+  if (response.ok) {
+    const responseBody: unknown = await response
+      .clone()
+      .json()
+      .catch((): null => null);
+    logGithubGraphqlCost(params.query, responseBody);
+  }
+  return response;
+};

package/src/adapter/repositories/issue/ApiV3CheerioRestIssueRepository.ts

@@ -20,6 +20,7 @@ import {
 import { LocalStorageCacheRepository } from '../LocalStorageCacheRepository';
 import typia from 'typia';
 import { BaseGitHubRepository } from '../BaseGitHubRepository';
+import { fetchGithubGraphql } from '../githubGraphqlClient';
 import { normalizeFieldName } from '../utils';
 import { LocalStorageRepository } from '../LocalStorageRepository';
 import { Member } from '../../../domain/entities/Member';
@@ -1160,7 +1161,7 @@ export class ApiV3CheerioRestIssueRepository
     mergeStateStatus: string | null;
   } | null> => {
     const query = `
-      query($owner: String!, $repo: String!, $prNumber: Int!) {
+      query PullRequestMergeability($owner: String!, $repo: String!, $prNumber: Int!) {
         repository(owner: $owner, name: $repo) {
           pullRequest(number: $prNumber) {
             mergeable
@@ -1183,16 +1184,10 @@ export class ApiV3CheerioRestIssueRepository
       }
 
       const response = await this.fetchWithRateLimitRetry(() =>
-        fetch('https://api.github.com/graphql', {
-          method: 'POST',
-          headers: {
-            Authorization: `Bearer ${this.ghToken}`,
-            'Content-Type': 'application/json',
-          },
-          body: JSON.stringify({
-            query,
-            variables: { owner, repo, prNumber },
-          }),
+        fetchGithubGraphql({
+          ghToken: this.ghToken,
+          query,
+          variables: { owner, repo, prNumber },
         }),
       );
 
@@ -1244,7 +1239,7 @@ export class ApiV3CheerioRestIssueRepository
     }
 
     const query = `
-      query($owner: String!, $repo: String!, $issueNumber: Int!, $after: String) {
+      query IssueRelatedOpenPullRequests($owner: String!, $repo: String!, $issueNumber: Int!, $after: String) {
         repository(owner: $owner, name: $repo) {
           issue(number: $issueNumber) {
             timelineItems(first: 100, after: $after, itemTypes: [CROSS_REFERENCED_EVENT]) {
@@ -1348,16 +1343,10 @@ export class ApiV3CheerioRestIssueRepository
 
     while (hasNextPage) {
       const response = await this.fetchWithRateLimitRetry(() =>
-        fetch('https://api.github.com/graphql', {
-          method: 'POST',
-          headers: {
-            Authorization: `Bearer ${this.ghToken}`,
-            'Content-Type': 'application/json',
-          },
-          body: JSON.stringify({
-            query,
-            variables: { owner, repo, issueNumber, after },
-          }),
+        fetchGithubGraphql({
+          ghToken: this.ghToken,
+          query,
+          variables: { owner, repo, issueNumber, after },
         }),
       );
 
@@ -1488,7 +1477,7 @@ export class ApiV3CheerioRestIssueRepository
     const { owner, repo, issueNumber: prNumber } = parsedUrl;
 
     const query = `
-      query($owner: String!, $repo: String!, $prNumber: Int!) {
+      query PullRequestStatus($owner: String!, $repo: String!, $prNumber: Int!) {
         repository(owner: $owner, name: $repo) {
           pullRequest(number: $prNumber) {
             url
@@ -1565,16 +1554,10 @@ export class ApiV3CheerioRestIssueRepository
     `;
 
     const response = await this.fetchWithRateLimitRetry(() =>
-      fetch('https://api.github.com/graphql', {
-        method: 'POST',
-        headers: {
-          Authorization: `Bearer ${this.ghToken}`,
-          'Content-Type': 'application/json',
-        },
-        body: JSON.stringify({
-          query,
-          variables: { owner, repo, prNumber },
-        }),
+      fetchGithubGraphql({
+        ghToken: this.ghToken,
+        query,
+        variables: { owner, repo, prNumber },
       }),
     );
 

package/src/adapter/repositories/issue/GraphqlProjectItemRepository.test.ts

@@ -22,6 +22,8 @@ import { HTTPError } from 'ky';
 import {
   GraphqlProjectItemRepository,
   PAGINATION_DELAY_MS,
+  PROJECT_ITEM_ASSIGNEES_FIRST,
+  PROJECT_ITEM_LABELS_FIRST,
   RATE_LIMIT_MAX_RETRIES,
   callWithRateLimitRetry,
 } from './GraphqlProjectItemRepository';
@@ -160,6 +162,66 @@ describe('GraphqlProjectItemRepository', () => {
       mockPost.mockReset();
     });
 
+    it('requests the reduced labels and assignees selection sizes', async () => {
+      const repository = new GraphqlProjectItemRepository(
+        new LocalStorageRepository(),
+        'dummy-token',
+      );
+      mockPost.mockReturnValueOnce(makePageResponse(false, 'cursor-1', 1));
+
+      await repository.fetchProjectItems('test-project-id');
+
+      expect(PROJECT_ITEM_LABELS_FIRST).toBe(20);
+      expect(PROJECT_ITEM_ASSIGNEES_FIRST).toBe(10);
+      const sentQuery = extractRequestedQueryFromMockCall(
+        mockPost.mock.calls[0],
+      );
+      expect(sentQuery).toContain(
+        `labels(first: ${PROJECT_ITEM_LABELS_FIRST})`,
+      );
+      expect(sentQuery).toContain(
+        `assignees(first: ${PROJECT_ITEM_ASSIGNEES_FIRST})`,
+      );
+      expect(sentQuery).not.toContain('labels(first: 100)');
+      expect(sentQuery).not.toContain('assignees(first: 20)');
+    });
+
+    it('logs the rateLimit cost of the request in one line', async () => {
+      const repository = new GraphqlProjectItemRepository(
+        new LocalStorageRepository(),
+        'dummy-token',
+      );
+      mockPost.mockReturnValueOnce(
+        mockJsonResponse({
+          data: {
+            node: {
+              items: {
+                totalCount: 0,
+                pageInfo: {
+                  endCursor: 'cursor-1',
+                  startCursor: 'cursor-start',
+                  hasNextPage: false,
+                },
+                nodes: [],
+              },
+            },
+            rateLimit: { cost: 3, remaining: 4200 },
+          },
+        }),
+      );
+      const consoleLogSpy = jest
+        .spyOn(console, 'log')
+        .mockImplementation(() => {});
+      try {
+        await repository.fetchProjectItems('test-project-id');
+        expect(consoleLogSpy).toHaveBeenCalledWith(
+          'githubGraphqlClient: query=GetProjectItems cost=3 remaining=4200',
+        );
+      } finally {
+        consoleLogSpy.mockRestore();
+      }
+    });
+
     it('should sleep between paginated requests to avoid 403', async () => {
       const localStorageRepository = new LocalStorageRepository();
       const repository = new GraphqlProjectItemRepository(