Skip to content

πŸ™Œ OpenHands: AI-Driven Development

Migrate git-service API to V1 endpoints (#13877)

Tim O'Farrell7f2534850647
diff --git a/frontend/__tests__/components/features/home/repo-connector.test.tsx b/frontend/__tests__/components/features/home/repo-connector.test.tsx
index 1dad4e3dc3..20dbfe736e 100644
--- a/frontend/__tests__/components/features/home/repo-connector.test.tsx
+++ b/frontend/__tests__/components/features/home/repo-connector.test.tsx
@@ -90,14 +90,15 @@ describe("RepoConnector", () => {
"retrieveUserGitRepositories",
);
retrieveUserGitRepositoriesSpy.mockResolvedValue({
- data: MOCK_RESPOSITORIES,
- nextPage: null,
+ items: MOCK_RESPOSITORIES,
+ next_page_id: null,
});
// Mock the search function that's used by the dropdown
- vi.spyOn(GitService, "searchGitRepositories").mockResolvedValue(
- MOCK_RESPOSITORIES,
- );
+ vi.spyOn(GitService, "searchGitRepositories").mockResolvedValue({
+ items: MOCK_RESPOSITORIES,
+ next_page_id: null,
+ });
renderRepoConnector();
@@ -127,8 +128,8 @@ describe("RepoConnector", () => {
"retrieveUserGitRepositories",
);
retrieveUserGitRepositoriesSpy.mockResolvedValue({
- data: MOCK_RESPOSITORIES,
- nextPage: null,
+ items: MOCK_RESPOSITORIES,
+ next_page_id: null,
});
renderRepoConnector();
@@ -138,14 +139,11 @@ describe("RepoConnector", () => {
// Mock the repository branches API call
vi.spyOn(GitService, "getRepositoryBranches").mockResolvedValue({
- branches: [
+ items: [
{ name: "main", commit_sha: "123", protected: false },
{ name: "develop", commit_sha: "456", protected: false },
],
- has_next_page: false,
- current_page: 1,
- per_page: 30,
- total_count: 2,
+ next_page_id: null,
});
// First select the provider
@@ -199,8 +197,8 @@ describe("RepoConnector", () => {
"retrieveUserGitRepositories",
);
retrieveUserGitRepositoriesSpy.mockResolvedValue({
- data: MOCK_RESPOSITORIES,
- nextPage: null,
+ items: MOCK_RESPOSITORIES,
+ next_page_id: null,
});
renderRepoConnector();
@@ -246,8 +244,8 @@ describe("RepoConnector", () => {
"retrieveUserGitRepositories",
);
retrieveUserGitRepositoriesSpy.mockResolvedValue({
- data: MOCK_RESPOSITORIES,
- nextPage: null,
+ items: MOCK_RESPOSITORIES,
+ next_page_id: null,
});
renderRepoConnector();
@@ -290,8 +288,8 @@ describe("RepoConnector", () => {
"retrieveUserGitRepositories",
);
retrieveUserGitRepositoriesSpy.mockResolvedValue({
- data: MOCK_RESPOSITORIES,
- nextPage: null,
+ items: MOCK_RESPOSITORIES,
+ next_page_id: null,
});
renderRepoConnector();
@@ -347,8 +345,8 @@ describe("RepoConnector", () => {
"retrieveUserGitRepositories",
);
retrieveUserGitRepositoriesSpy.mockResolvedValue({
- data: MOCK_RESPOSITORIES,
- nextPage: null,
+ items: MOCK_RESPOSITORIES,
+ next_page_id: null,
});
renderRepoConnector();
@@ -363,14 +361,11 @@ describe("RepoConnector", () => {
// Mock the repository branches API call
vi.spyOn(GitService, "getRepositoryBranches").mockResolvedValue({
- branches: [
+ items: [
{ name: "main", commit_sha: "123", protected: false },
{ name: "develop", commit_sha: "456", protected: false },
],
- has_next_page: false,
- current_page: 1,
- per_page: 30,
- total_count: 2,
+ next_page_id: null,
});
// First select the provider
@@ -427,20 +422,17 @@ describe("RepoConnector", () => {
"retrieveUserGitRepositories",
);
retrieveUserGitRepositoriesSpy.mockResolvedValue({
- data: MOCK_RESPOSITORIES,
- nextPage: null,
+ items: MOCK_RESPOSITORIES,
+ next_page_id: null,
});
// Mock the repository branches API call
vi.spyOn(GitService, "getRepositoryBranches").mockResolvedValue({
- branches: [
+ items: [
{ name: "main", commit_sha: "123", protected: false },
{ name: "develop", commit_sha: "456", protected: false },
],
- has_next_page: false,
- current_page: 1,
- per_page: 30,
- total_count: 2,
+ next_page_id: null,
});
renderRepoConnector();
diff --git a/frontend/__tests__/components/features/home/repo-selection-form.test.tsx b/frontend/__tests__/components/features/home/repo-selection-form.test.tsx
index db7b2626a9..7b0fcb7e18 100644
--- a/frontend/__tests__/components/features/home/repo-selection-form.test.tsx
+++ b/frontend/__tests__/components/features/home/repo-selection-form.test.tsx
@@ -187,7 +187,7 @@ describe("RepositorySelectionForm", () => {
},
];
mockUseGitRepositories.mockReturnValue({
- data: { pages: [{ data: MOCK_REPOS }] },
+ data: { pages: [{ items: MOCK_REPOS }] },
isLoading: false,
isError: false,
hasNextPage: false,
@@ -229,7 +229,7 @@ describe("RepositorySelectionForm", () => {
// Create a spy on the API call
const searchGitReposSpy = vi.spyOn(GitService, "searchGitRepositories");
- searchGitReposSpy.mockResolvedValue(MOCK_SEARCH_REPOS);
+ searchGitReposSpy.mockResolvedValue({ items: MOCK_SEARCH_REPOS, next_page_id: null });
mockUseGitRepositories.mockReturnValue({
data: { pages: [] },
@@ -267,7 +267,7 @@ describe("RepositorySelectionForm", () => {
];
mockUseGitRepositories.mockReturnValue({
- data: { pages: [{ data: MOCK_SEARCH_REPOS }] },
+ data: { pages: [{ items: MOCK_SEARCH_REPOS }] },
isLoading: false,
isError: false,
hasNextPage: false,
diff --git a/frontend/__tests__/components/features/home/task-card.test.tsx b/frontend/__tests__/components/features/home/task-card.test.tsx
index ec4fb57147..e2f204bbbd 100644
--- a/frontend/__tests__/components/features/home/task-card.test.tsx
+++ b/frontend/__tests__/components/features/home/task-card.test.tsx
@@ -115,8 +115,8 @@ describe("TaskCard", () => {
"retrieveUserGitRepositories",
);
retrieveUserGitRepositoriesSpy.mockResolvedValue({
- data: MOCK_RESPOSITORIES,
- nextPage: null,
+ items: MOCK_RESPOSITORIES,
+ next_page_id: null,
});
});
diff --git a/frontend/__tests__/routes/home-screen.test.tsx b/frontend/__tests__/routes/home-screen.test.tsx
index 98c1271dca..9ba7f076a1 100644
--- a/frontend/__tests__/routes/home-screen.test.tsx
+++ b/frontend/__tests__/routes/home-screen.test.tsx
@@ -228,20 +228,17 @@ describe("HomeScreen", () => {
"retrieveUserGitRepositories",
);
retrieveUserGitRepositoriesSpy.mockResolvedValue({
- data: MOCK_RESPOSITORIES,
- nextPage: null,
+ items: MOCK_RESPOSITORIES,
+ next_page_id: null,
});
// Mock the repository branches API call
vi.spyOn(GitService, "getRepositoryBranches").mockResolvedValue({
- branches: [
+ items: [
{ name: "main", commit_sha: "123", protected: false },
{ name: "develop", commit_sha: "456", protected: false },
],
- has_next_page: false,
- current_page: 1,
- per_page: 30,
- total_count: 2,
+ next_page_id: null,
});
renderHomeScreen();
@@ -272,20 +269,17 @@ describe("HomeScreen", () => {
"retrieveUserGitRepositories",
);
retrieveUserGitRepositoriesSpy.mockResolvedValue({
- data: MOCK_RESPOSITORIES,
- nextPage: null,
+ items: MOCK_RESPOSITORIES,
+ next_page_id: null,
});
// Mock the repository branches API call
vi.spyOn(GitService, "getRepositoryBranches").mockResolvedValue({
- branches: [
+ items: [
{ name: "main", commit_sha: "123", protected: false },
{ name: "develop", commit_sha: "456", protected: false },
],
- has_next_page: false,
- current_page: 1,
- per_page: 30,
- total_count: 2,
+ next_page_id: null,
});
renderHomeScreen();
@@ -332,14 +326,11 @@ describe("HomeScreen", () => {
// Mock the repository branches API call
vi.spyOn(GitService, "getRepositoryBranches").mockResolvedValue({
- branches: [
+ items: [
{ name: "main", commit_sha: "123", protected: false },
{ name: "develop", commit_sha: "456", protected: false },
],
- has_next_page: false,
- current_page: 1,
- per_page: 30,
- total_count: 2,
+ next_page_id: null,
});
// Select a repository to enable the repo launch button
@@ -371,8 +362,8 @@ describe("HomeScreen", () => {
"retrieveUserGitRepositories",
);
retrieveUserGitRepositoriesSpy.mockResolvedValue({
- data: MOCK_RESPOSITORIES,
- nextPage: null,
+ items: MOCK_RESPOSITORIES,
+ next_page_id: null,
});
});
diff --git a/frontend/src/api/git-service/git-service.api.ts b/frontend/src/api/git-service/git-service.api.ts
index 8fd62d6ae7..25bc8b50d5 100644
--- a/frontend/src/api/git-service/git-service.api.ts
+++ b/frontend/src/api/git-service/git-service.api.ts
@@ -1,7 +1,5 @@
import { openHands } from "../open-hands-axios";
-import { Provider } from "#/types/settings";
-import { GitRepository, PaginatedBranchesResponse, Branch } from "#/types/git";
-import { extractNextPageFromLink } from "#/utils/extract-next-page-from-link";
+import { RepositoryPage, BranchPage, InstallationPage } from "#/types/git";
import { GitChange, GitChangeDiff } from "../open-hands.types";
import ConversationService from "../conversation-service/conversation-service.api";
@@ -12,130 +10,122 @@ class GitService {
/**
* Search for Git repositories
* @param query Search query
- * @param per_page Number of results per page
- * @param selected_provider Git provider to search in
- * @returns List of matching repositories
+ * @param provider Git provider to search in (required)
+ * @param limit Number of results per page
+ * @param pageId Cursor for pagination
+ * @param installationId Filter by installation ID
+ * @param sortOrder Sort order (asc or desc)
+ * @returns Paginated repository response
*/
static async searchGitRepositories(
query: string,
- per_page = 100,
- selected_provider?: Provider,
- ): Promise<GitRepository[]> {
- const response = await openHands.get<GitRepository[]>(
- "/api/user/search/repositories",
+ provider: string,
+ limit = 100,
+ pageId?: string,
+ installationId?: string,
+ ): Promise<RepositoryPage> {
+ const { data } = await openHands.get<RepositoryPage>(
+ "/api/v1/git/repositories/search",
{
params: {
+ provider,
query,
- per_page,
- selected_provider,
+ limit,
+ page_id: pageId,
+ installation_id: installationId,
},
},
);
- return response.data;
+ return data;
}
/**
* Retrieve user's Git repositories
- * @param selected_provider Git provider
- * @param page Page number
- * @param per_page Number of results per page
+ * @param provider Git provider
+ * @param pageId Cursor for pagination
+ * @param limit Number of results per page
+ * @param installationId Filter by installation ID
+ * @param sortOrder Sort order (asc or desc)
* @returns User's repositories with pagination info
*/
static async retrieveUserGitRepositories(
- selected_provider: Provider,
- page = 1,
- per_page = 30,
- ) {
- const { data } = await openHands.get<GitRepository[]>(
- "/api/user/repositories",
+ provider: string,
+ pageId?: string,
+ limit = 30,
+ installationId?: string,
+ ): Promise<RepositoryPage> {
+ const { data } = await openHands.get<RepositoryPage>(
+ "/api/v1/git/repositories/search",
{
params: {
- selected_provider,
- sort: "pushed",
- page,
- per_page,
+ provider,
+ limit,
+ page_id: pageId,
+ installation_id: installationId,
},
},
);
- const link =
- data.length > 0 && data[0].link_header ? data[0].link_header : "";
- const nextPage = extractNextPageFromLink(link);
-
- return { data, nextPage };
+ return data;
}
/**
* Retrieve repositories from a specific installation
- * @param selected_provider Git provider
+ * @param provider Git provider
* @param installationIndex Current installation index
* @param installations List of installation IDs
- * @param page Page number
- * @param per_page Number of results per page
+ * @param pageId Cursor for pagination
+ * @param limit Number of results per page
* @returns Installation repositories with pagination info
*/
static async retrieveInstallationRepositories(
- selected_provider: Provider,
+ provider: string,
installationIndex: number,
installations: string[],
- page = 1,
- per_page = 30,
- ) {
+ pageId?: string,
+ limit = 30,
+ ): Promise<RepositoryPage> {
const installationId = installations[installationIndex];
- const response = await openHands.get<GitRepository[]>(
- "/api/user/repositories",
+ const { data } = await openHands.get<RepositoryPage>(
+ "/api/v1/git/repositories/search",
{
params: {
- selected_provider,
- sort: "pushed",
- page,
- per_page,
+ provider,
+ limit,
+ page_id: pageId,
installation_id: installationId,
},
},
);
- const link =
- response.data.length > 0 && response.data[0].link_header
- ? response.data[0].link_header
- : "";
- const nextPage = extractNextPageFromLink(link);
- let nextInstallation: number | null;
- if (nextPage) {
- nextInstallation = installationIndex;
- } else if (installationIndex + 1 < installations.length) {
- nextInstallation = installationIndex + 1;
- } else {
- nextInstallation = null;
- }
- return {
- data: response.data,
- nextPage,
- installationIndex: nextInstallation,
- };
+ return data;
}
/**
* Get repository branches
* @param repository Repository name
- * @param page Page number
- * @param perPage Number of results per page
+ * @param provider Git provider (required)
+ * @param query Search query (required - can be empty string)
+ * @param pageId Cursor for pagination
+ * @param limit Number of results per page
* @returns Paginated branches response
*/
static async getRepositoryBranches(
repository: string,
- page: number = 1,
- perPage: number = 30,
- selectedProvider?: Provider,
- ): Promise<PaginatedBranchesResponse> {
- const { data } = await openHands.get<PaginatedBranchesResponse>(
- `/api/user/repository/branches`,
+ provider: string,
+ query: string = "",
+ pageId?: string,
+ limit = 30,
+ ): Promise<BranchPage> {
+ const { data } = await openHands.get<BranchPage>(
+ "/api/v1/git/branches/search",
{
params: {
+ provider,
repository,
- page,
- per_page: perPage,
- selected_provider: selectedProvider,
+ query,
+ page_id: pageId,
+ limit,
},
},
);
@@ -145,40 +135,51 @@ class GitService {
/**
* Search repository branches
+ * @deprecated Use getRepositoryBranches instead - this method is identical
* @param repository Repository name
+ * @param provider Git provider (required)
* @param query Search query
- * @param perPage Number of results per page
- * @param selectedProvider Git provider
+ * @param pageId Cursor for pagination
+ * @param limit Number of results per page
* @returns List of matching branches
*/
static async searchRepositoryBranches(
repository: string,
+ provider: string,
query: string,
- perPage: number = 30,
- selectedProvider?: Provider,
- ): Promise<Branch[]> {
- const { data } = await openHands.get<Branch[]>(
- `/api/user/search/branches`,
- {
- params: {
- repository,
- query,
- per_page: perPage,
- selected_provider: selectedProvider,
- },
- },
+ pageId?: string,
+ limit = 30,
+ ): Promise<BranchPage> {
+ return this.getRepositoryBranches(
+ repository,
+ provider,
+ query,
+ pageId,
+ limit,
);
- return data;
}
/**
* Get the user installation IDs
* @param provider The provider to get installation IDs for (github, bitbucket, etc.)
- * @returns List of installation IDs
+ * @param pageId Cursor for pagination
+ * @param limit Max number of results
+ * @returns Paginated installation response
*/
- static async getUserInstallationIds(provider: Provider): Promise<string[]> {
- const { data } = await openHands.get<string[]>(
- `/api/user/installations?provider=${provider}`,
+ static async getUserInstallations(
+ provider: string,
+ pageId?: string,
+ limit = 100,
+ ): Promise<InstallationPage> {
+ const { data } = await openHands.get<InstallationPage>(
+ "/api/v1/git/installations/search",
+ {
+ params: {
+ provider,
+ page_id: pageId,
+ limit,
+ },
+ },
);
return data;
}
diff --git a/frontend/src/components/features/home/git-repo-dropdown/use-repository-data.tsx b/frontend/src/components/features/home/git-repo-dropdown/use-repository-data.tsx
index e7acabb728..679374cfd1 100644
--- a/frontend/src/components/features/home/git-repo-dropdown/use-repository-data.tsx
+++ b/frontend/src/components/features/home/git-repo-dropdown/use-repository-data.tsx
@@ -38,7 +38,7 @@ export function useRepositoryData(
// Combine all repositories from paginated data
const allRepositories = useMemo(
- () => repoData?.pages?.flatMap((page) => page.data) || [],
+ () => repoData?.pages?.flatMap((page) => page.items) || [],
[repoData],
);
diff --git a/frontend/src/components/features/home/git-repo-dropdown/use-url-search.tsx b/frontend/src/components/features/home/git-repo-dropdown/use-url-search.tsx
index 76199c0666..e8ace43de1 100644
--- a/frontend/src/components/features/home/git-repo-dropdown/use-url-search.tsx
+++ b/frontend/src/components/features/home/git-repo-dropdown/use-url-search.tsx
@@ -18,11 +18,11 @@ export function useUrlSearch(inputValue: string, provider: Provider) {
try {
const repositories = await GitService.searchGitRepositories(
repoName,
- 3,
provider,
+ 3,
);
- setUrlSearchResults(repositories);
+ setUrlSearchResults(repositories.items);
} catch {
setUrlSearchResults([]);
} finally {
diff --git a/frontend/src/hooks/query/use-app-installations.ts b/frontend/src/hooks/query/use-app-installations.ts
index 20ea6855ef..2a3fa259a2 100644
--- a/frontend/src/hooks/query/use-app-installations.ts
+++ b/frontend/src/hooks/query/use-app-installations.ts
@@ -6,6 +6,9 @@ import { useUserProviders } from "../use-user-providers";
import { Provider } from "#/types/settings";
import { shouldUseInstallationRepos } from "#/utils/utils";
+/**
+ * Get the first page of app installations for the provider given.
+ */
export const useAppInstallations = (selectedProvider: Provider | null) => {
const { data: config } = useConfig();
const { data: userIsAuthenticated } = useIsAuthed();
@@ -13,7 +16,7 @@ export const useAppInstallations = (selectedProvider: Provider | null) => {
return useQuery({
queryKey: ["installations", providers || [], selectedProvider],
- queryFn: () => GitService.getUserInstallationIds(selectedProvider!),
+ queryFn: () => GitService.getUserInstallations(selectedProvider!),
enabled:
userIsAuthenticated &&
!!selectedProvider &&
diff --git a/frontend/src/hooks/query/use-branch-data.ts b/frontend/src/hooks/query/use-branch-data.ts
index fafaed068c..da3de04df8 100644
--- a/frontend/src/hooks/query/use-branch-data.ts
+++ b/frontend/src/hooks/query/use-branch-data.ts
@@ -30,9 +30,11 @@ export function useBranchData(
provider,
);
- // Combine all branches from paginated data
+ // Combine all branches from paginated data - use .items for V1 response
const allBranches = useMemo(
- () => branchData?.pages?.flatMap((page) => page.branches) || [],
+ () =>
+ branchData?.pages?.flatMap((page: { items: Branch[] }) => page.items) ||
+ [],
[branchData],
);
@@ -40,7 +42,7 @@ export function useBranchData(
const defaultBranchInLoaded = useMemo(
() =>
defaultBranch
- ? allBranches.find((branch) => branch.name === defaultBranch)
+ ? allBranches.find((branch: Branch) => branch.name === defaultBranch)
: null,
[allBranches, defaultBranch],
);
@@ -75,7 +77,7 @@ export function useBranchData(
if (defaultBranch) {
// Use the already computed defaultBranchInLoaded or check in current branches
let defaultBranchObj = shouldUseSearch
- ? branchesToUse.find((branch) => branch.name === defaultBranch)
+ ? branchesToUse.find((branch: Branch) => branch.name === defaultBranch)
: defaultBranchInLoaded;
// If not found in current branches, check if we have it from the default branch search
diff --git a/frontend/src/hooks/query/use-git-repositories.ts b/frontend/src/hooks/query/use-git-repositories.ts
index bbf09162f4..3b2fbcc2b4 100644
--- a/frontend/src/hooks/query/use-git-repositories.ts
+++ b/frontend/src/hooks/query/use-git-repositories.ts
@@ -1,8 +1,8 @@
-import { useInfiniteQuery } from "@tanstack/react-query";
+import { useInfiniteQuery, InfiniteData } from "@tanstack/react-query";
import { useConfig } from "./use-config";
import { useUserProviders } from "../use-user-providers";
import { useAppInstallations } from "./use-app-installations";
-import { GitRepository } from "../../types/git";
+import { RepositoryPage } from "../../types/git";
import { Provider } from "../../types/settings";
import GitService from "#/api/git-service/git-service.api";
import { shouldUseInstallationRepos } from "#/utils/utils";
@@ -13,29 +13,27 @@ interface UseGitRepositoriesOptions {
enabled?: boolean;
}
-interface UserRepositoriesResponse {
- data: GitRepository[];
- nextPage: number | null;
-}
-
-interface InstallationRepositoriesResponse {
- data: GitRepository[];
- nextPage: number | null;
- installationIndex: number | null;
-}
+type InstallationCursor = { installationIndex: number; pageId: string | null };
+type UserCursor = string | null;
+type Cursor = InstallationCursor | UserCursor;
export function useGitRepositories(options: UseGitRepositoriesOptions) {
const { provider, pageSize = 30, enabled = true } = options;
const { providers } = useUserProviders();
const { data: config } = useConfig();
- const { data: installations } = useAppInstallations(provider);
+ const { data: page } = useAppInstallations(provider);
+ const installations = page?.items;
const useInstallationRepos = provider
? shouldUseInstallationRepos(provider, config?.app_mode)
: false;
const repos = useInfiniteQuery<
- UserRepositoriesResponse | InstallationRepositoriesResponse
+ RepositoryPage,
+ Error,
+ InfiniteData<RepositoryPage>,
+ [string, string[], Provider | null, boolean, number, ...unknown[]],
+ Cursor
>({
queryKey: [
"repositories",
@@ -51,56 +49,52 @@ export function useGitRepositories(options: UseGitRepositoriesOptions) {
}
if (useInstallationRepos) {
- const { repoPage, installationIndex } = pageParam as {
- installationIndex: number | null;
- repoPage: number | null;
- };
-
if (!installations) {
throw new Error("Missing installation list");
}
- return GitService.retrieveInstallationRepositories(
+ const cursor = pageParam as InstallationCursor;
+ const result = await GitService.retrieveInstallationRepositories(
provider,
- installationIndex || 0,
+ cursor.installationIndex,
installations,
- repoPage || 1,
+ cursor.pageId ?? undefined,
pageSize,
);
+ return result;
}
- return GitService.retrieveUserGitRepositories(
+ const cursor = pageParam as UserCursor;
+ const result = await GitService.retrieveUserGitRepositories(
provider,
- pageParam as number,
+ cursor ?? undefined,
pageSize,
);
+ return result;
},
- getNextPageParam: (lastPage) => {
- if (useInstallationRepos) {
- const installationPage = lastPage as InstallationRepositoriesResponse;
- if (installationPage.nextPage) {
+ getNextPageParam: (lastPage, allPages, lastPageParam) => {
+ if (useInstallationRepos && installations) {
+ // Installation-based pagination
+ const currentCursor = lastPageParam as InstallationCursor;
+ if (lastPage.next_page_id) {
return {
- installationIndex: installationPage.installationIndex,
- repoPage: installationPage.nextPage,
+ installationIndex: currentCursor.installationIndex,
+ pageId: lastPage.next_page_id,
};
}
-
- if (installationPage.installationIndex !== null) {
- return {
- installationIndex: installationPage.installationIndex,
- repoPage: 1,
- };
+ // Advance to next installation
+ const nextInstallationIndex = currentCursor.installationIndex + 1;
+ if (nextInstallationIndex < installations.length) {
+ return { installationIndex: nextInstallationIndex, pageId: null };
}
-
- return null;
+ return undefined;
}
-
- const userPage = lastPage as UserRepositoriesResponse;
- return userPage.nextPage;
+ // User repositories pagination
+ return lastPage.next_page_id;
},
initialPageParam: useInstallationRepos
- ? { installationIndex: 0, repoPage: 1 }
- : 1,
+ ? { installationIndex: 0, pageId: null }
+ : null,
enabled:
enabled &&
(providers || []).length > 0 &&
diff --git a/frontend/src/hooks/query/use-repository-branches.ts b/frontend/src/hooks/query/use-repository-branches.ts
index 31c7432487..7d32199ce6 100644
--- a/frontend/src/hooks/query/use-repository-branches.ts
+++ b/frontend/src/hooks/query/use-repository-branches.ts
@@ -1,35 +1,20 @@
-import { useQuery, useInfiniteQuery } from "@tanstack/react-query";
+import { useInfiniteQuery, InfiniteData } from "@tanstack/react-query";
import GitService from "#/api/git-service/git-service.api";
-import { Branch, PaginatedBranchesResponse } from "#/types/git";
+import { BranchPage } from "#/types/git";
import { Provider } from "#/types/settings";
-export const useRepositoryBranches = (
- repository: string | null,
- selectedProvider?: Provider,
-) =>
- useQuery<Branch[]>({
- queryKey: ["repository", repository, "branches", selectedProvider],
- queryFn: async () => {
- if (!repository) return [];
- const response = await GitService.getRepositoryBranches(
- repository,
- 1,
- 30,
- selectedProvider,
- );
- // Ensure we return an array even if the response is malformed
- return Array.isArray(response.branches) ? response.branches : [];
- },
- enabled: !!repository,
- staleTime: 1000 * 60 * 5, // 5 minutes
- });
-
export const useRepositoryBranchesPaginated = (
repository: string | null,
perPage: number = 30,
selectedProvider?: Provider,
-) =>
- useInfiniteQuery<PaginatedBranchesResponse, Error>({
+) => {
+ const result = useInfiniteQuery<
+ BranchPage,
+ Error,
+ InfiniteData<BranchPage>,
+ [string, string | null, ...unknown[]],
+ string | null
+ >({
queryKey: [
"repository",
repository,
@@ -38,27 +23,29 @@ export const useRepositoryBranchesPaginated = (
perPage,
selectedProvider,
],
- queryFn: async ({ pageParam = 1 }) => {
- if (!repository) {
+ queryFn: async ({ pageParam }) => {
+ if (!repository || !selectedProvider) {
return {
- branches: [],
- has_next_page: false,
- current_page: 1,
- per_page: perPage,
- total_count: 0,
+ items: [],
+ next_page_id: null,
};
}
return GitService.getRepositoryBranches(
repository,
- pageParam as number,
- perPage,
selectedProvider,
+ "", // query (empty = list all)
+ pageParam ?? undefined,
+ perPage,
);
},
- enabled: !!repository,
+ enabled: !!repository && !!selectedProvider,
staleTime: 1000 * 60 * 5, // 5 minutes
getNextPageParam: (lastPage) =>
- // Use the has_next_page flag from the API response
- lastPage.has_next_page ? lastPage.current_page + 1 : undefined,
- initialPageParam: 1,
+ lastPage.next_page_id ? lastPage.next_page_id : undefined,
+ initialPageParam: null,
});
+
+ return {
+ ...result,
+ };
+};
diff --git a/frontend/src/hooks/query/use-search-branches.ts b/frontend/src/hooks/query/use-search-branches.ts
index 73b94dc56f..b02fd53ec1 100644
--- a/frontend/src/hooks/query/use-search-branches.ts
+++ b/frontend/src/hooks/query/use-search-branches.ts
@@ -20,15 +20,17 @@ export function useSearchBranches(
selectedProvider,
],
queryFn: async () => {
- if (!repository || !query) return [];
- return GitService.searchRepositoryBranches(
+ if (!repository || !query || !selectedProvider) return [];
+ const response = await GitService.searchRepositoryBranches(
repository,
+ selectedProvider,
query,
+ undefined, // pageId
perPage,
- selectedProvider,
);
+ return response.items;
},
- enabled: !!repository && !!query,
+ enabled: !!repository && !!query && !!selectedProvider,
staleTime: 1000 * 60 * 5,
gcTime: 1000 * 60 * 15,
});
diff --git a/frontend/src/hooks/query/use-search-repositories.ts b/frontend/src/hooks/query/use-search-repositories.ts
index b963cb91ac..aba124db9a 100644
--- a/frontend/src/hooks/query/use-search-repositories.ts
+++ b/frontend/src/hooks/query/use-search-repositories.ts
@@ -1,5 +1,6 @@
import { useQuery } from "@tanstack/react-query";
import GitService from "#/api/git-service/git-service.api";
+import { GitRepository } from "#/types/git";
import { Provider } from "#/types/settings";
export function useSearchRepositories(
@@ -8,14 +9,20 @@ export function useSearchRepositories(
disabled?: boolean,
pageSize: number = 100,
) {
- return useQuery({
+ // For backward compatibility, return the items array directly
+ return useQuery<GitRepository[]>({
queryKey: ["repositories", "search", query, selectedProvider, pageSize],
- queryFn: () =>
- GitService.searchGitRepositories(
+ queryFn: async () => {
+ if (!selectedProvider) {
+ return [];
+ }
+ const response = await GitService.searchGitRepositories(
query,
+ selectedProvider, // provider (required)
pageSize,
- selectedProvider || undefined,
- ),
+ );
+ return response.items;
+ },
enabled: !!query && !!selectedProvider && !disabled,
staleTime: 1000 * 60 * 5, // 5 minutes
gcTime: 1000 * 60 * 15, // 15 minutes
diff --git a/frontend/src/types/git.d.ts b/frontend/src/types/git.d.ts
index 9a5eb62ee5..c9e15813ed 100644
--- a/frontend/src/types/git.d.ts
+++ b/frontend/src/types/git.d.ts
@@ -30,6 +30,30 @@ interface PaginatedBranchesResponse {
total_count?: number;
}
+/**
+ * V1 API response for paginated branch search (cursor-based)
+ */
+interface BranchPage {
+ items: Branch[];
+ next_page_id: string | null;
+}
+
+/**
+ * V1 API response for paginated repository search (cursor-based)
+ */
+interface RepositoryPage {
+ items: GitRepository[];
+ next_page_id: string | null;
+}
+
+/**
+ * V1 API response for paginated installation search (cursor-based)
+ */
+interface InstallationPage {
+ items: string[];
+ next_page_id: string | null;
+}
+
interface GitRepository {
id: string;
full_name: string;
diff --git a/openhands/app_server/git/git_router.py b/openhands/app_server/git/git_router.py
index e1f1deec2c..932cc053cd 100644
--- a/openhands/app_server/git/git_router.py
+++ b/openhands/app_server/git/git_router.py
@@ -241,13 +241,30 @@ async def search_branches(
if decoded_page_id is not None:
page = decoded_page_id
- # Get search results - we'll handle pagination ourselves
- branches: list[Branch] = await client.search_branches(
- selected_provider=provider,
- repository=repository,
- query=query,
- per_page=limit + 1, # We'll handle pagination ourselves
- )
+ if query:
+ if page != 1:
+ # TODO(#13883): Support pagination for branch search after refactoring.
+ # The search_branches method does not support paging in the same way as
+ # get_branches - those should be merged into a single paginated method
+ raise HTTPException(
+ status_code=status.HTTP_400_BAD_REQUEST,
+ detail='Pagination not yet supported for branch search queries. Use empty query to list all branches with pagination.',
+ )
+ # Get search results - we'll handle pagination ourselves
+ branches: list[Branch] = await client.search_branches(
+ selected_provider=provider,
+ repository=repository,
+ query=query,
+ per_page=limit + 1,
+ )
+ else:
+ current_page = await client.get_branches(
+ repository=repository,
+ specified_provider=provider,
+ page=page,
+ per_page=limit + 1,
+ )
+ branches = current_page.branches
next_page_id = None
if len(branches) > limit: