refactor: use Octokit paginate in getTranslationIssues and update unit tests

Author: Gumball12

src/github/getTranslationIssues.ts

@@ -24,56 +24,30 @@ export const getTranslationIssues = async (
 
   const issues: Issue[] = [];
 
-  let page = 1;
-
-  while (true) {
-    log('I', `getTranslationIssues :: Fetching page ${page}`);
-
-    const { data } = await github.api.issues.listForRepo({
-      ...github.ownerAndRepo,
-      state,
-      per_page: 100,
-      page,
-    });
-
-    log(
-      'I',
-      `getTranslationIssues :: Page ${page} returned ${data.length} issues`,
-    );
-
-    if (data.length === 0) {
-      break;
-    }
-
-    const openedIssuesWithoutHash = data.map<Omit<Issue, 'hash'>>(item => ({
-      number: item.number,
-      body: item.body ?? '',
-      isoDate: item.created_at,
-      labels: item.labels
-        .map(convGithubIssueLabelToString)
-        .filter(isNotEmpty)
-        .sort(),
-    }));
-
-    const openedYukiNoIssues = openedIssuesWithoutHash
-      .filter(issue => isYukiNoIssue(github.configuredLabels, issue))
-      .map(issue => ({ ...issue, hash: extractHashFromIssue(issue) }))
-      .filter(hasHash);
-
-    log(
-      'I',
-      `getTranslationIssues :: Found ${openedYukiNoIssues.length} Yuki-no issues on page ${page}`,
-    );
-
-    issues.push(...openedYukiNoIssues);
-
-    page++;
-
-    if (data.length < 100) {
-      break;
-    }
-  }
-
+  const all = await github.api.paginate(github.api.issues.listForRepo, {
+    ...github.ownerAndRepo,
+    state,
+    per_page: 100,
+  });
+
+  log('I', `getTranslationIssues :: Total issues fetched: ${all.length}`);
+
+  const openedIssuesWithoutHash = all.map<Omit<Issue, 'hash'>>(item => ({
+    number: item.number,
+    body: item.body ?? '',
+    isoDate: item.created_at,
+    labels: item.labels
+      .map(convGithubIssueLabelToString)
+      .filter(isNotEmpty)
+      .sort(),
+  }));
+
+  const openedYukiNoIssues = openedIssuesWithoutHash
+    .filter(issue => isYukiNoIssue(github.configuredLabels, issue))
+    .map(issue => ({ ...issue, hash: extractHashFromIssue(issue) }))
+    .filter(hasHash);
+
+  issues.push(...openedYukiNoIssues);
   issues.sort((a, b) => (a.isoDate > b.isoDate ? 1 : -1));
 
   log(

src/tests/github/getOpenedIssues.test.ts

@@ -5,7 +5,7 @@ import { beforeEach, expect, it, vi } from 'vitest';
 
 vi.mock('../../github/core', () => ({
   GitHub: vi.fn().mockImplementation(() => ({
-    api: { issues: { listForRepo: vi.fn() } },
+    api: { paginate: vi.fn(), issues: { listForRepo: vi.fn() } },
     ownerAndRepo: { owner: 'test-owner', repo: 'test-repo' },
     configuredLabels: ['label1', 'label2'],
   })),
@@ -18,32 +18,28 @@ beforeEach(() => {
 });
 
 it('Should return an empty array when there are no issues', async () => {
-  (mockGitHub.api.issues.listForRepo as any).mockResolvedValue({
-    data: [],
-  });
+(mockGitHub.api.paginate as any).mockResolvedValue([]);
 
   const result = await GetOpenedIssuesModule.getOpenedIssues(mockGitHub);
 
   expect(result).toEqual([]);
 });
 
 it('Issues with only different labels from the configuration or without body should be filtered out', async () => {
-  (mockGitHub.api.issues.listForRepo as any).mockResolvedValue({
-    data: [
-      {
-        number: 1,
-        body: 'body',
-        labels: [{ name: 'other-label' }],
-        created_at: '2023-01-01T12:00:00Z',
-      },
-      {
-        number: 2,
-        body: undefined,
-        labels: ['label1', 'label2'],
-        created_at: '2023-01-01T12:00:00Z',
-      },
-    ],
-  });
+(mockGitHub.api.paginate as any).mockResolvedValue([
+  {
+    number: 1,
+    body: 'body',
+    labels: [{ name: 'other-label' }],
+    created_at: '2023-01-01T12:00:00Z',
+  },
+  {
+    number: 2,
+    body: undefined,
+    labels: ['label1', 'label2'],
+    created_at: '2023-01-01T12:00:00Z',
+  },
+]);
 
   const result = await GetOpenedIssuesModule.getOpenedIssues(mockGitHub);
 
@@ -53,21 +49,19 @@ it('Issues with only different labels from the configuration or without body sho
 it('Should return only issues that have all configured labels', async () => {
   const EXPECTED_HASH = 'abcd123';
 
-  (mockGitHub.api.issues.listForRepo as any).mockResolvedValue({
-    data: [
-      {
-        number: 1,
-        body: `https://github.com/org/name/commit/${EXPECTED_HASH}`,
-        created_at: '2023-01-01T12:00:00Z',
-        labels: [
-          'label1',
-          { name: 'label2' },
-          { name: undefined },
-          'extra-label',
-        ],
-      },
+(mockGitHub.api.paginate as any).mockResolvedValue([
+  {
+    number: 1,
+    body: `https://github.com/org/name/commit/${EXPECTED_HASH}`,
+    created_at: '2023-01-01T12:00:00Z',
+    labels: [
+      'label1',
+      { name: 'label2' },
+      { name: undefined },
+      'extra-label',
     ],
-  });
+  },
+]);
 
   const result = await GetOpenedIssuesModule.getOpenedIssues(mockGitHub);
 
@@ -83,22 +77,20 @@ it('Should return only issues that have all configured labels', async () => {
 it('Issues without a hash should be filtered out', async () => {
   const EXPECTED_HASH = 'abcd123';
 
-  (mockGitHub.api.issues.listForRepo as any).mockResolvedValue({
-    data: [
-      {
-        number: 1,
-        body: `https://github.com/org/repo/commit/${EXPECTED_HASH}`,
-        created_at: '2023-01-01T12:00:00Z',
-        labels: [{ name: 'label1' }, { name: 'label2' }],
-      },
-      {
-        number: 2,
-        body: 'Issue body without hash',
-        created_at: '2023-01-01T12:00:00Z',
-        labels: [{ name: 'label1' }, { name: 'label2' }],
-      },
-    ],
-  });
+(mockGitHub.api.paginate as any).mockResolvedValue([
+  {
+    number: 1,
+    body: `https://github.com/org/repo/commit/${EXPECTED_HASH}`,
+    created_at: '2023-01-01T12:00:00Z',
+    labels: [{ name: 'label1' }, { name: 'label2' }],
+  },
+  {
+    number: 2,
+    body: 'Issue body without hash',
+    created_at: '2023-01-01T12:00:00Z',
+    labels: [{ name: 'label1' }, { name: 'label2' }],
+  },
+]);
 
   const result = await GetOpenedIssuesModule.getOpenedIssues(mockGitHub);