redhat-developer
diff --git a/‎workspaces/bulk-import/.changeset/long-schools-learn.md‎
Lines changed: 5 additions & 0 deletions b/‎workspaces/bulk-import/.changeset/long-schools-learn.md‎
Lines changed: 5 additions & 0 deletions
diff --git a/‎workspaces/bulk-import/plugins/bulk-import-backend/__fixtures__/handlers.ts‎
Lines changed: 7 additions & 0 deletions b/‎workspaces/bulk-import/plugins/bulk-import-backend/__fixtures__/handlers.ts‎
Lines changed: 7 additions & 0 deletions
diff --git a/‎workspaces/bulk-import/plugins/bulk-import-backend/api-docs/Apis/OrganizationApi.md‎
Lines changed: 1 addition & 1 deletion b/‎workspaces/bulk-import/plugins/bulk-import-backend/api-docs/Apis/OrganizationApi.md‎
Lines changed: 1 addition & 1 deletion
diff --git a/‎workspaces/bulk-import/plugins/bulk-import-backend/api-docs/Apis/RepositoryApi.md‎
Lines changed: 1 addition & 1 deletion b/‎workspaces/bulk-import/plugins/bulk-import-backend/api-docs/Apis/RepositoryApi.md‎
Lines changed: 1 addition & 1 deletion
diff --git a/‎workspaces/bulk-import/plugins/bulk-import-backend/src/github/githubApiService.test.ts‎
Lines changed: 58 additions & 39 deletions b/‎workspaces/bulk-import/plugins/bulk-import-backend/src/github/githubApiService.test.ts‎
Lines changed: 58 additions & 39 deletions
diff --git a/‎workspaces/bulk-import/plugins/bulk-import-backend/src/github/githubApiService.ts‎
Lines changed: 2 additions & 14 deletions b/‎workspaces/bulk-import/plugins/bulk-import-backend/src/github/githubApiService.ts‎
Lines changed: 2 additions & 14 deletions
diff --git a/‎workspaces/bulk-import/plugins/bulk-import-backend/src/github/types.ts‎
Lines changed: 14 additions & 0 deletions b/‎workspaces/bulk-import/plugins/bulk-import-backend/src/github/types.ts‎
Lines changed: 14 additions & 0 deletions
@@ -0,0 +1,5 @@
+---
+'@red-hat-developer-hub/backstage-plugin-bulk-import-backend': minor
+---
+
+**BREAKING** Changes the behavior of the bulk-import backend plugin to return only repositories that are yet to be imported by filtering out the already imported ones. Therefore, the frontend will not display already imported repositories with status displayed as "Imported" anymore. The frontend fetches all repositories at once on the first page load and then all the pagination and search is done client-side.
@@ -21,6 +21,9 @@ export const LOCAL_ADDR = `http://${localHostAndPort}`;
 
 export const LOCAL_GITLAB_ADDR = `https://gitlab.com/api/v4`;
 
+export const CATALOG_API_LOCATIONS_LOCAL_ADDR =
+  /^https?:\/\/localhost:\d+\/api\/catalog\/locations$/;
+
 export function loadTestFixture(filePathFromFixturesDir: string) {
   return require(`${__dirname}/${filePathFromFixturesDir}`);
 }
@@ -499,4 +502,8 @@ export const DEFAULT_TEST_HANDLERS: RestHandler<
       return res(ctx.status(404));
     },
   ),
+
+  rest.get(CATALOG_API_LOCATIONS_LOCAL_ADDR, (_, res, ctx) =>
+    res(ctx.status(200), ctx.json([])),
+  ),
 ];
@@ -52,7 +52,7 @@ Fetch Repositories in the specified GitHub organization, provided it is accessib
 | **sizePerIntegration** | **Integer**| the number of items per Integration to return per page | [optional] [default to 20] |
 | **search** | **String**| returns only the items that match the search string | [optional] [default to null] |
 | **approvalTool** | **String**| the approvalTool to use | [optional] [default to GIT] |
-| **x-scm-tokens** | **String**| **Required.** JSON-encoded map of SCM host URL to user OAuth token. Used to fetch repositories on behalf of the signed-in user. The value must be a JSON object whose keys are SCM integration base URLs and whose values are OAuth bearer tokens (e.g. `{"https://github.com":"ghp_xxx"}`). Requests that omit this header, supply an empty object, or exceed 4 KB are rejected with HTTP 401.  | [required] [default to null] |
+| **x-scm-tokens** | **String**| Optional JSON-encoded map of SCM host URL to user authentication token. Used to fetch repositories on behalf of the user for each configured SCM host. The value must be a JSON string whose structure matches SCMTokenMap (keys are SCM base URLs, values are OAuth bearer tokens).  | [optional] [default to null] |
 
 ### Return type
 
 
@@ -22,7 +22,7 @@ Fetch Organization Repositories accessible by Backstage Github Integrations
 | **sizePerIntegration** | **Integer**| the number of items per Integration to return per page | [optional] [default to 20] |
 | **search** | **String**| returns only the items that match the search string | [optional] [default to null] |
 | **approvalTool** | **String**| the approvalTool to use | [optional] [default to GIT] |
-| **x-scm-tokens** | **String**| **Required.** JSON-encoded map of SCM host URL to user OAuth token. Used to fetch repositories on behalf of the signed-in user. The value must be a JSON object whose keys are SCM integration base URLs and whose values are OAuth bearer tokens (e.g. `{"https://github.com":"ghp_xxx"}`). Requests that omit this header, supply an empty object, or exceed 4 KB are rejected with HTTP 401.  | [required] [default to null] |
+| **x-scm-tokens** | **String**| Optional JSON-encoded map of SCM host URL to user authentication token. Used to fetch repositories on behalf of the user for each configured SCM host. The value must be a JSON string whose structure matches SCMTokenMap (keys are SCM base URLs, values are OAuth bearer tokens).  | [optional] [default to null] |
 
 ### Return type
 
 
@@ -23,14 +23,17 @@ const octokit = {
   paginate: async (fn: any) => {
     const res = await fn();
     if (res) {
+      if (Array.isArray(res?.data?.repositories)) {
+        return res.data.repositories;
+      }
       return res.data;
     }
     return [];
   },
-  apps: {
-    listReposAccessibleToInstallation: jest.fn().mockReturnValue({ data: [] }),
-  },
   rest: {
+    apps: {
+      listReposAccessibleToInstallation: jest.fn(),
+    },
     repos: {
       listForAuthenticatedUser: jest.fn(),
       listForOrg: jest.fn(),
@@ -134,6 +137,16 @@ describe('GithubApiService tests', () => {
         },
       },
     });
+    octokit.rest.apps.listReposAccessibleToInstallation.mockReturnValue({
+      data: {
+        repositories: [],
+        total_count: 0,
+        repository_selection: 'all',
+      },
+    });
+    octokit.rest.repos.listForAuthenticatedUser.mockReturnValue({
+      data: [],
+    });
     octokit.rest.repos.listForOrg.mockReturnValue({ data: [] });
     octokit.rest.users.getByUsername.mockReturnValue({
       data: {
@@ -211,9 +224,12 @@ describe('GithubApiService tests', () => {
         type: 'User',
       },
     });
-    octokit.rest.repos.listForAuthenticatedUser.mockReturnValue({ data: [] });
-    octokit.apps.listReposAccessibleToInstallation.mockReturnValue({
-      data: ghRepos,
+    octokit.rest.apps.listReposAccessibleToInstallation.mockReturnValue({
+      data: {
+        repositories: ghRepos,
+        total_count: ghRepos.length,
+        repository_selection: 'all',
+      },
     });
 
     const result = await githubApiService.getRepositoriesFromIntegrations();
@@ -239,28 +255,36 @@ describe('GithubApiService tests', () => {
     );
   });
 
-  it('returns an a list of unique repositories and no errors', async () => {
-    octokit.apps.listReposAccessibleToInstallation
+  it('returns a list of unique repositories and no errors', async () => {
+    octokit.rest.apps.listReposAccessibleToInstallation
       .mockReturnValueOnce({
-        data: ghRepos,
+        data: {
+          repositories: ghRepos,
+          total_count: ghRepos.length,
+          repository_selection: 'all',
+        },
       })
       .mockReturnValue({
-        data: [
-          {
-            name: 'B',
-            full_name: 'backstage/B',
-            url: 'https://api.github.com/repos/backstage/B',
-            html_url: 'https://github.com/backstage/B',
-            default_branch: 'main',
-          },
-          {
-            name: 'C',
-            full_name: 'backstage/C',
-            url: 'https://api.github.com/repos/backstage/C',
-            html_url: 'https://github.com/backstage/C',
-            default_branch: 'default',
-          },
-        ],
+        data: {
+          repositories: [
+            {
+              name: 'B',
+              full_name: 'backstage/B',
+              url: 'https://api.github.com/repos/backstage/B',
+              html_url: 'https://github.com/backstage/B',
+              default_branch: 'main',
+            },
+            {
+              name: 'C',
+              full_name: 'backstage/C',
+              url: 'https://api.github.com/repos/backstage/C',
+              html_url: 'https://github.com/backstage/C',
+              default_branch: 'default',
+            },
+          ],
+          total_count: 2,
+          repository_selection: 'all',
+        },
       });
 
     const result = await githubApiService.getRepositoriesFromIntegrations();
@@ -311,14 +335,18 @@ describe('GithubApiService tests', () => {
         throw customError;
       },
     );
-    octokit.apps.listReposAccessibleToInstallation
+    octokit.rest.apps.listReposAccessibleToInstallation
       .mockImplementationOnce(async () => {
         const unauthorizedError = new Error('Bad credentials');
         unauthorizedError.name = '401 Unauthorized';
         throw unauthorizedError;
       })
       .mockReturnValue({
-        data: ghRepos,
+        data: {
+          repositories: ghRepos,
+          total_count: ghRepos.length,
+          repository_selection: 'all',
+        },
       });
 
     const result = await githubApiService.getRepositoriesFromIntegrations();
@@ -351,9 +379,6 @@ describe('GithubApiService tests', () => {
     octokit.rest.repos.listForAuthenticatedUser.mockReturnValue({
       data: ghRepos,
     });
-    octokit.apps.listReposAccessibleToInstallation.mockReturnValue({
-      data: [],
-    });
 
     const result = await githubApiService.getRepositoriesFromIntegrations();
 
@@ -384,13 +409,11 @@ describe('GithubApiService tests', () => {
       octokit.rest.repos.listForAuthenticatedUser.mockReturnValue({
         data: ghRepos,
       });
-      octokit.apps.listReposAccessibleToInstallation.mockReturnValue({
+      octokit.rest.apps.listReposAccessibleToInstallation.mockReturnValue({
         data: [],
       });
 
       const result = await githubApiService.getRepositoriesFromIntegrations(
-        undefined,
-        undefined,
         undefined,
         { 'https://github.com': 'user-oauth-token' },
       );
@@ -403,8 +426,6 @@ describe('GithubApiService tests', () => {
 
     it('returns empty repositories when userTokens is provided but no host matches an integration', async () => {
       const result = await githubApiService.getRepositoriesFromIntegrations(
-        undefined,
-        undefined,
         undefined,
         { 'https://some-other-host.com': 'user-oauth-token' },
       );
@@ -418,7 +439,7 @@ describe('GithubApiService tests', () => {
       octokit.rest.repos.listForAuthenticatedUser.mockReturnValue({
         data: ghRepos,
       });
-      octokit.apps.listReposAccessibleToInstallation.mockReturnValue({
+      octokit.rest.apps.listReposAccessibleToInstallation.mockReturnValue({
         data: [],
       });
 
@@ -433,13 +454,11 @@ describe('GithubApiService tests', () => {
       octokit.rest.repos.listForAuthenticatedUser.mockReturnValue({
         data: ghRepos,
       });
-      octokit.apps.listReposAccessibleToInstallation.mockReturnValue({
+      octokit.rest.apps.listReposAccessibleToInstallation.mockReturnValue({
         data: [],
       });
 
       const result = await githubApiService.getRepositoriesFromIntegrations(
-        undefined,
-        undefined,
         undefined,
         {},
       );
 
@@ -335,13 +335,10 @@ export class GithubApiService implements GitApiService {
               },
               octokit,
               credential,
-              ghConfig,
               repositories,
               dataFetchErrors,
               {
                 search,
-                pageNumber,
-                pageSize,
               },
             );
           } else {
@@ -356,8 +353,6 @@ export class GithubApiService implements GitApiService {
               dataFetchErrors,
               {
                 search,
-                pageNumber,
-                pageSize,
               },
             );
           }
@@ -383,8 +378,6 @@ export class GithubApiService implements GitApiService {
    */
   async getRepositoriesFromIntegrations(
     search?: string,
-    pageNumber: number = DefaultPageNumber,
-    pageSize: number = DefaultPageSize,
     userTokens?: Record<string, string>,
   ): Promise<GithubRepositoryResponse> {
     const repositories = new Map<string, GithubRepository>();
@@ -404,7 +397,7 @@ export class GithubApiService implements GitApiService {
               userCredential,
               repositories,
               dataFetchErrors,
-              { search, pageNumber, pageSize },
+              { search },
             ),
         );
       const repoList = Array.from(repositories.values());
@@ -429,13 +422,10 @@ export class GithubApiService implements GitApiService {
                 },
                 octokit,
                 credential,
-                ghConfig,
                 repositories,
                 dataFetchErrors,
                 {
                   search,
-                  pageNumber,
-                  pageSize,
                 },
               )
             : await addGithubTokenRepositories(
@@ -448,8 +438,6 @@ export class GithubApiService implements GitApiService {
                 dataFetchErrors,
                 {
                   search,
-                  pageNumber,
-                  pageSize,
                 },
               );
           this.logger.debug(
@@ -463,7 +451,7 @@ export class GithubApiService implements GitApiService {
       },
     );
 
-    return this.buildRepositoryResponse(repositories, result, pageSize);
+    return this.buildRepositoryResponse(repositories, result, DefaultPageSize);
   }
 
   async filterLocationsAccessibleFromIntegrations(
 
@@ -19,6 +19,8 @@ import type {
   GithubCredentialsProvider,
 } from '@backstage/integration';
 
+import { type RestEndpointMethodTypes } from '@octokit/rest';
+
 export type {
   SCMFetchError as GithubFetchError,
   SCMOrganization as GithubOrganization,
@@ -64,3 +66,15 @@ export interface ExtendedGithubCredentialsProvider extends GithubCredentialsProv
     host: string;
   }) => Promise<ExtendedGithubCredentials[]>;
 }
+
+export type AuthenticatedUserRepositoryResponse =
+  RestEndpointMethodTypes['repos']['listForAuthenticatedUser']['response'];
+
+export type AuthenticatedUserRepositoryList =
+  AuthenticatedUserRepositoryResponse['data'];
+
+export type AppInstallationRepositoriesResponse =
+  RestEndpointMethodTypes['apps']['listReposAccessibleToInstallation']['response'];
+
+export type AppInstallationRepositories =
+  AppInstallationRepositoriesResponse['data'];
-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +'@red-hat-developer-hub/backstage-plugin-bulk-import-backend': minor
 +---
++
 +**BREAKING** Changes the behavior of the bulk-import backend plugin to return only repositories that are yet to be imported by filtering out the already imported ones. Therefore, the frontend will not display already imported repositories with status displayed as "Imported" anymore. The frontend fetches all repositories at once on the first page load and then all the pagination and search is done client-side.