Skip to content

Automate browser based workflows with AI

SKY-5679: Add search to the credentials page (#6299)

Suchintan8550cbcfde31
diff --git a/skyvern-frontend/src/components/TableSearchInput.tsx b/skyvern-frontend/src/components/TableSearchInput.tsx
index ec5ca89e4..0bf8d9e01 100644
--- a/skyvern-frontend/src/components/TableSearchInput.tsx
+++ b/skyvern-frontend/src/components/TableSearchInput.tsx
@@ -10,6 +10,7 @@ type TableSearchInputProps = {
className?: string;
inputClassName?: string;
disabled?: boolean;
+ maxLength?: number;
};
function TableSearchInput({
@@ -19,6 +20,7 @@ function TableSearchInput({
className,
inputClassName,
disabled,
+ maxLength,
}: TableSearchInputProps) {
function handleChange(event: ChangeEvent<HTMLInputElement>) {
onChange(event.target.value);
@@ -34,6 +36,7 @@ function TableSearchInput({
onChange={handleChange}
placeholder={placeholder}
disabled={disabled}
+ maxLength={maxLength}
className={cn("pl-9", inputClassName)}
/>
</div>
diff --git a/skyvern-frontend/src/routes/credentials/CredentialsList.test.tsx b/skyvern-frontend/src/routes/credentials/CredentialsList.test.tsx
new file mode 100644
index 000000000..34fc1b53b
--- /dev/null
+++ b/skyvern-frontend/src/routes/credentials/CredentialsList.test.tsx
@@ -0,0 +1,98 @@
+// @vitest-environment jsdom
+
+import { cleanup, render, screen } from "@testing-library/react";
+import { afterEach, describe, expect, it, vi } from "vitest";
+
+import type { CredentialApiResponse } from "@/api/types";
+import { useCredentialsQuery } from "@/routes/workflows/hooks/useCredentialsQuery";
+import { CredentialsList } from "./CredentialsList";
+
+vi.mock("@/routes/workflows/hooks/useCredentialsQuery", () => ({
+ useCredentialsQuery: vi.fn(),
+}));
+
+vi.mock("./CredentialItem", () => ({
+ CredentialItem: ({ credential }: { credential: CredentialApiResponse }) => (
+ <div data-testid="credential-item">{credential.name}</div>
+ ),
+}));
+
+const mockedUseCredentialsQuery = vi.mocked(useCredentialsQuery);
+
+function mockResult(data: CredentialApiResponse[]) {
+ mockedUseCredentialsQuery.mockReturnValue({
+ data,
+ isLoading: false,
+ } as unknown as ReturnType<typeof useCredentialsQuery>);
+}
+
+function makeCredential(
+ overrides: Partial<CredentialApiResponse> = {},
+): CredentialApiResponse {
+ return {
+ credential_id: "cred_1",
+ name: "Example",
+ credential_type: "password",
+ credential: { username: "[email protected]", totp_type: "none" },
+ ...overrides,
+ };
+}
+
+afterEach(() => {
+ cleanup();
+ vi.clearAllMocks();
+});
+
+describe("CredentialsList — server-side search + type filtering (SKY-5679)", () => {
+ it("requests the active tab's credential_type and the trimmed search term", () => {
+ mockResult([]);
+
+ render(<CredentialsList filter="password" search=" ohio " />);
+
+ expect(mockedUseCredentialsQuery).toHaveBeenCalledWith(
+ expect.objectContaining({ credential_type: "password", search: "ohio" }),
+ );
+ });
+
+ it("omits the search param when the term is only whitespace", () => {
+ mockResult([]);
+
+ render(<CredentialsList filter="secret" search=" " />);
+
+ expect(mockedUseCredentialsQuery).toHaveBeenCalledWith(
+ expect.objectContaining({ credential_type: "secret", search: undefined }),
+ );
+ });
+
+ it("renders every credential the server returns (no client-side type filter)", () => {
+ mockResult([
+ makeCredential({ credential_id: "cred_1", name: "Alpha" }),
+ makeCredential({ credential_id: "cred_2", name: "Beta" }),
+ ]);
+
+ render(<CredentialsList filter="password" />);
+
+ expect(screen.getAllByTestId("credential-item")).toHaveLength(2);
+ expect(screen.getByText("Alpha")).toBeTruthy();
+ expect(screen.getByText("Beta")).toBeTruthy();
+ });
+
+ it("shows a search-aware empty state when a search yields no results", () => {
+ mockResult([]);
+
+ render(<CredentialsList filter="password" search="zzz" />);
+
+ expect(screen.getByText(/No credentials match/)).toBeTruthy();
+ expect(screen.getByText(/zzz/)).toBeTruthy();
+ });
+
+ it("shows the type-specific empty state when there is no search", () => {
+ mockResult([]);
+
+ render(<CredentialsList filter="password" />);
+
+ expect(
+ screen.getByText("No password credentials stored yet."),
+ ).toBeTruthy();
+ });
+});
diff --git a/skyvern-frontend/src/routes/credentials/CredentialsList.tsx b/skyvern-frontend/src/routes/credentials/CredentialsList.tsx
index 5d33a756a..0d73fa56a 100644
--- a/skyvern-frontend/src/routes/credentials/CredentialsList.tsx
+++ b/skyvern-frontend/src/routes/credentials/CredentialsList.tsx
@@ -16,6 +16,7 @@ type CredentialFilter = "password" | "credit_card" | "secret";
type Props = {
filter?: CredentialFilter;
+ search?: string;
onStartBackgroundTest?: (
credentialId: string,
url: string,
@@ -31,11 +32,27 @@ const EMPTY_MESSAGE: Record<CredentialFilter, string> = {
const PAGE_SIZE = 25;
-function CredentialsList({ filter, onStartBackgroundTest }: Props = {}) {
+function CredentialsList({
+ filter,
+ search,
+ onStartBackgroundTest,
+}: Props = {}) {
+ const trimmedSearch = search?.trim() ?? "";
const [page, setPage] = useState(1);
+ const [prevSearch, setPrevSearch] = useState(trimmedSearch);
+
+ // Reset to page 1 synchronously when the search changes — avoids the extra
+ // fetch with the stale page that a post-render effect would trigger.
+ if (prevSearch !== trimmedSearch) {
+ setPrevSearch(trimmedSearch);
+ setPage(1);
+ }
+
const { data: credentials, isLoading } = useCredentialsQuery({
page,
page_size: PAGE_SIZE,
+ credential_type: filter,
+ search: trimmedSearch || undefined,
});
if (isLoading) {
@@ -51,22 +68,15 @@ function CredentialsList({ filter, onStartBackgroundTest }: Props = {}) {
return null;
}
- const filteredCredentials = (() => {
- if (!credentials) {
- return [];
- }
- if (!filter) {
- return credentials;
- }
- return credentials.filter(
- (credential) => credential.credential_type === filter,
- );
- })();
-
- if (filteredCredentials.length === 0 && page === 1) {
+ if (credentials.length === 0 && page === 1) {
+ const emptyMessage = trimmedSearch
+ ? `No credentials match “${trimmedSearch}”.`
+ : filter
+ ? EMPTY_MESSAGE[filter]
+ : "No credentials stored yet.";
return (
<div className="rounded-md border border-slate-700 bg-slate-elevation1 p-6 text-sm text-neutral-600 dark:text-slate-300">
- {filter ? EMPTY_MESSAGE[filter] : "No credentials stored yet."}
+ {emptyMessage}
</div>
);
}
@@ -76,7 +86,7 @@ function CredentialsList({ filter, onStartBackgroundTest }: Props = {}) {
return (
<div className="space-y-5">
<div className="space-y-5">
- {filteredCredentials.map((credential) => (
+ {credentials.map((credential) => (
<CredentialItem
key={credential.credential_id}
credential={credential}
diff --git a/skyvern-frontend/src/routes/credentials/CredentialsPage.tsx b/skyvern-frontend/src/routes/credentials/CredentialsPage.tsx
index 3d855981a..d24de4ede 100644
--- a/skyvern-frontend/src/routes/credentials/CredentialsPage.tsx
+++ b/skyvern-frontend/src/routes/credentials/CredentialsPage.tsx
@@ -1,5 +1,7 @@
-import { useEffect } from "react";
+import { useEffect, useState } from "react";
+import { useDebounce } from "use-debounce";
import { Button } from "@/components/ui/button";
+import { TableSearchInput } from "@/components/TableSearchInput";
import { CardStackIcon, LockClosedIcon, PlusIcon } from "@radix-ui/react-icons";
import {
CredentialModalTypes,
@@ -34,6 +36,8 @@ const DEFAULT_TAB: TabValue = "passwords";
function CredentialsPage() {
const { setIsOpen, setType } = useCredentialModalState();
const { startBackgroundTest } = useBackgroundCredentialTest();
+ const [search, setSearch] = useState("");
+ const [debouncedSearch] = useDebounce(search, 250);
const [searchParams, setSearchParams] = useSearchParams();
const tabParam = searchParams.get("tab");
const matchedTab = TAB_VALUES.find((tab) => tab === tabParam);
@@ -106,16 +110,28 @@ function CredentialsPage() {
className="space-y-4"
onValueChange={handleTabChange}
>
- <TabsList className="bg-slate-elevation1">
- <TabsTrigger value="passwords">Passwords</TabsTrigger>
- <TabsTrigger value="creditCards">Credit Cards</TabsTrigger>
- <TabsTrigger value="secrets">Secrets</TabsTrigger>
- <TabsTrigger value="twoFactor">2FA</TabsTrigger>
- </TabsList>
+ <div className="flex flex-wrap items-center justify-between gap-4">
+ <TabsList className="bg-slate-elevation1">
+ <TabsTrigger value="passwords">Passwords</TabsTrigger>
+ <TabsTrigger value="creditCards">Credit Cards</TabsTrigger>
+ <TabsTrigger value="secrets">Secrets</TabsTrigger>
+ <TabsTrigger value="twoFactor">2FA</TabsTrigger>
+ </TabsList>
+ {activeTab !== "twoFactor" && (
+ <TableSearchInput
+ value={search}
+ onChange={setSearch}
+ placeholder="Search credentials…"
+ className="w-72"
+ maxLength={200}
+ />
+ )}
+ </div>
<TabsContent value="passwords" className="space-y-4">
<CredentialsList
filter="password"
+ search={debouncedSearch}
onStartBackgroundTest={startBackgroundTest}
/>
</TabsContent>
@@ -123,6 +139,7 @@ function CredentialsPage() {
<TabsContent value="creditCards" className="space-y-4">
<CredentialsList
filter="credit_card"
+ search={debouncedSearch}
onStartBackgroundTest={startBackgroundTest}
/>
</TabsContent>
@@ -130,6 +147,7 @@ function CredentialsPage() {
<TabsContent value="secrets" className="space-y-4">
<CredentialsList
filter="secret"
+ search={debouncedSearch}
onStartBackgroundTest={startBackgroundTest}
/>
</TabsContent>
diff --git a/skyvern-frontend/src/routes/workflows/hooks/useCredentialsQuery.test.tsx b/skyvern-frontend/src/routes/workflows/hooks/useCredentialsQuery.test.tsx
new file mode 100644
index 000000000..8794f7707
--- /dev/null
+++ b/skyvern-frontend/src/routes/workflows/hooks/useCredentialsQuery.test.tsx
@@ -0,0 +1,81 @@
+// @vitest-environment jsdom
+
+import { QueryClient, QueryClientProvider } from "@tanstack/react-query";
+import { renderHook, waitFor } from "@testing-library/react";
+import { ReactNode } from "react";
+import { afterEach, describe, expect, it, vi } from "vitest";
+
+import { getClient } from "@/api/AxiosClient";
+import { useCredentialsQuery } from "./useCredentialsQuery";
+
+vi.mock("@/api/AxiosClient", () => ({
+ getClient: vi.fn(),
+}));
+vi.mock("@/hooks/useCredentialGetter", () => ({
+ useCredentialGetter: () => null,
+}));
+
+const mockedGetClient = vi.mocked(getClient);
+
+function makeWrapper() {
+ const queryClient = new QueryClient({
+ defaultOptions: { queries: { retry: false } },
+ });
+ return function Wrapper({ children }: { children: ReactNode }) {
+ return (
+ <QueryClientProvider client={queryClient}>{children}</QueryClientProvider>
+ );
+ };
+}
+
+function stubClient() {
+ const getMock = vi.fn().mockResolvedValue({ data: [] });
+ mockedGetClient.mockResolvedValue({
+ get: getMock,
+ } as unknown as Awaited<ReturnType<typeof getClient>>);
+ return getMock;
+}
+
+function lastParams(getMock: ReturnType<typeof vi.fn>): URLSearchParams {
+ const call = getMock.mock.calls[0];
+ if (!call) {
+ throw new Error("client.get was not called");
+ }
+ return (call[1] as { params: URLSearchParams }).params;
+}
+
+afterEach(() => {
+ vi.clearAllMocks();
+});
+
+describe("useCredentialsQuery — search + type query params (SKY-5679)", () => {
+ it("sends search and credential_type when provided", async () => {
+ const getMock = stubClient();
+
+ renderHook(
+ () =>
+ useCredentialsQuery({ search: "ohio", credential_type: "password" }),
+ { wrapper: makeWrapper() },
+ );
+
+ await waitFor(() => expect(getMock).toHaveBeenCalled());
+ expect(getMock).toHaveBeenCalledWith("/credentials", expect.anything());
+ const params = lastParams(getMock);
+ expect(params.get("search")).toBe("ohio");
+ expect(params.get("credential_type")).toBe("password");
+ });
+
+ it("omits search and credential_type when they are not provided", async () => {
+ const getMock = stubClient();
+
+ renderHook(() => useCredentialsQuery(), { wrapper: makeWrapper() });
+
+ await waitFor(() => expect(getMock).toHaveBeenCalled());
+ const params = lastParams(getMock);
+ expect(params.has("search")).toBe(false);
+ expect(params.has("credential_type")).toBe(false);
+ // pagination params are always present
+ expect(params.get("page")).toBe("1");
+ expect(params.get("page_size")).toBe("25");
+ });
+});
diff --git a/skyvern-frontend/src/routes/workflows/hooks/useCredentialsQuery.ts b/skyvern-frontend/src/routes/workflows/hooks/useCredentialsQuery.ts
index 5ac63d12a..30d63154f 100644
--- a/skyvern-frontend/src/routes/workflows/hooks/useCredentialsQuery.ts
+++ b/skyvern-frontend/src/routes/workflows/hooks/useCredentialsQuery.ts
@@ -13,14 +13,30 @@ type Props = UseQueryOptions & {
page?: number;
page_size?: number;
vault_type?: string;
+ credential_type?: "password" | "credit_card" | "secret";
+ search?: string;
};
function useCredentialsQuery(props: Props = {}) {
- const { page = 1, page_size = 25, vault_type, ...queryOptions } = props;
+ const {
+ page = 1,
+ page_size = 25,
+ vault_type,
+ credential_type,
+ search,
+ ...queryOptions
+ } = props;
const credentialGetter = useCredentialGetter();
return useQuery<Array<CredentialApiResponse>>({
- queryKey: ["credentials", page, page_size, vault_type],
+ queryKey: [
+ "credentials",
+ page,
+ page_size,
+ vault_type,
+ credential_type,
+ search,
+ ],
queryFn: async () => {
const client = await getClient(credentialGetter);
const params = new URLSearchParams();
@@ -29,6 +45,12 @@ function useCredentialsQuery(props: Props = {}) {
if (vault_type) {
params.set("vault_type", vault_type);
}
+ if (credential_type) {
+ params.set("credential_type", credential_type);
+ }
+ if (search) {
+ params.set("search", search);
+ }
return client.get("/credentials", { params }).then((res) => res.data);
},
refetchOnMount: "always",
diff --git a/skyvern/forge/sdk/db/repositories/credentials.py b/skyvern/forge/sdk/db/repositories/credentials.py
index a4e3c9906..70873fdd3 100644
--- a/skyvern/forge/sdk/db/repositories/credentials.py
+++ b/skyvern/forge/sdk/db/repositories/credentials.py
@@ -2,7 +2,7 @@ from __future__ import annotations
from datetime import datetime, timezone
-from sqlalchemy import select
+from sqlalchemy import or_, select
from skyvern.forge.sdk.db._error_handling import db_operation
from skyvern.forge.sdk.db.base_repository import BaseRepository
@@ -86,6 +86,8 @@ class CredentialRepository(BaseRepository):
page: int = 1,
page_size: int = 10,
vault_type: str | None = None,
+ credential_type: str | None = None,
+ search: str | None = None,
) -> list[Credential]:
async with self.Session() as session:
query = (
@@ -95,6 +97,21 @@ class CredentialRepository(BaseRepository):
)
if vault_type is not None:
query = query.filter(CredentialModel.vault_type == vault_type)
+ if credential_type is not None:
+ query = query.filter(CredentialModel.credential_type == credential_type)
+ if search:
+ # Escape LIKE wildcards so a literal % or _ in the query narrows rather than broadens.
+ escaped = search.replace("\\", "\\\\").replace("%", "\\%").replace("_", "\\_")
+ search_pattern = f"%{escaped}%"
+ query = query.filter(
+ or_(
+ CredentialModel.name.ilike(search_pattern, escape="\\"),
+ CredentialModel.username.ilike(search_pattern, escape="\\"),
+ CredentialModel.secret_label.ilike(search_pattern, escape="\\"),
+ CredentialModel.card_brand.ilike(search_pattern, escape="\\"),
+ CredentialModel.card_last4.ilike(search_pattern, escape="\\"),
+ )
+ )
credentials = (
await session.scalars(
query.order_by(CredentialModel.created_at.desc()).offset((page - 1) * page_size).limit(page_size)
diff --git a/skyvern/forge/sdk/routes/credentials.py b/skyvern/forge/sdk/routes/credentials.py
index 72e2a14be..dc408d22b 100644
--- a/skyvern/forge/sdk/routes/credentials.py
+++ b/skyvern/forge/sdk/routes/credentials.py
@@ -1453,6 +1453,15 @@ async def get_credentials(
default=None,
description="Filter credentials by vault type (e.g. 'custom', 'bitwarden', 'azure_vault')",
),
+ credential_type: CredentialType | None = Query(
+ default=None,
+ description="Filter credentials by type (e.g. 'password', 'credit_card', 'secret')",
+ ),
+ search: str | None = Query(
+ default=None,
+ max_length=200,
+ description="Case-insensitive search across credential name, username, secret label, and card details",
+ ),
) -> list[CredentialResponse]:
"""Return non-sensitive metadata for all credentials (paginated).
@@ -1464,6 +1473,8 @@ async def get_credentials(
page=page,
page_size=page_size,
vault_type=vault_type.value if isinstance(vault_type, CredentialVaultType) else None,
+ credential_type=credential_type.value if isinstance(credential_type, CredentialType) else None,
+ search=search if isinstance(search, str) else None,
)
return [_convert_to_response(credential) for credential in credentials]
diff --git a/tests/unit/test_get_credentials_query_defaults.py b/tests/unit/test_get_credentials_query_defaults.py
new file mode 100644
index 000000000..343e01cb8
--- /dev/null
+++ b/tests/unit/test_get_credentials_query_defaults.py
@@ -0,0 +1,35 @@
+"""Regression: the GET /credentials route is also called directly (not via FastAPI
+dependency injection) by the scenario suite, e.g.
+``credentials.get_credentials(org, page=1, page_size=10)``. When invoked that way,
+unset parameters keep their ``Query(...)`` default *objects* rather than ``None``.
+
+``search`` was previously forwarded raw, so it reached the repository as a truthy
+``Query`` object and built a ``%<repr>%`` ILIKE pattern that matched no rows —
+making ``get_credentials`` return an empty list (SKY-5679). Guard all three
+optional filters so a direct call behaves like no filter.
+"""
+
+import asyncio
+from unittest.mock import AsyncMock, MagicMock, patch
+
+from skyvern.forge.sdk.routes.credentials import get_credentials
+
+
+def test_unset_query_params_are_passed_as_none() -> None:
+ fake_org = MagicMock()
+ fake_org.organization_id = "org_test"
+ repo = AsyncMock(return_value=[])
+
+ with patch("skyvern.forge.sdk.routes.credentials.app") as app_mock:
+ app_mock.DATABASE.credentials.get_credentials = repo
+ result = asyncio.run(get_credentials(current_org=fake_org, page=1, page_size=10))
+
+ assert result == []
+ repo.assert_awaited_once()
+ assert repo.await_args.args[0] == "org_test"
+ kwargs = repo.await_args.kwargs
+ assert kwargs["search"] is None
+ assert kwargs["credential_type"] is None
+ assert kwargs["vault_type"] is None
+ assert kwargs["page"] == 1
+ assert kwargs["page_size"] == 10