Database governance built for humans and agents — controlling changes and access across every major database.
Go cicddata-governancedata-maskingdata-securitydatabase-accessdatabase-governancedevopsdevsecopsflywaygitopsliquibasemongodbmysqloraclepostgresqlschema-migrationssecuritysql-clientsqlservertidb
fix: filter database in backend (#21136)
ecmadaoad787dbbee83
diff --git a/frontend/src/routes/project/ProjectSyncSchemaPage.test.tsx b/frontend/src/routes/project/ProjectSyncSchemaPage.test.tsxnew file mode 100644index 0000000000..b4716621bf--- /dev/null+++ b/frontend/src/routes/project/ProjectSyncSchemaPage.test.tsx@@ -0,0 +1,268 @@+import { act, type ReactNode } from "react";+import { createRoot } from "react-dom/client";+import { afterEach, beforeEach, describe, expect, test, vi } from "vitest";++(+ globalThis as { IS_REACT_ACT_ENVIRONMENT?: boolean }+).IS_REACT_ACT_ENVIRONMENT = true;++const mocks = vi.hoisted(() => ({+ fetchDatabases: vi.fn(),+ getOrFetchChangelogByName: vi.fn(async () => ({+ name: "instances/source/databases/source-db/changelogs/1",+ schema: "CREATE TABLE t(id INT);",+ })),+ routeQuery: {+ changelog: "instances/source/databases/source-db/changelogs/1",+ } as Record<string, string>,+ sourceDatabase: {+ name: "instances/source/databases/source-db",+ effectiveEnvironment: "",+ instanceResource: {+ name: "instances/source",+ title: "Source instance",+ engine: 1,+ },+ },+}));++vi.mock("react-i18next", () => ({+ initReactI18next: { type: "3rdParty", init: () => {} },+ useTranslation: () => ({ t: (key: string) => key }),+}));++vi.mock("@/app/router", () => ({+ router: {+ beforeEach: () => () => {},+ currentRoute: {+ get value() {+ return { query: mocks.routeQuery };+ },+ },+ push: vi.fn(),+ },+}));++vi.mock("@/app/router/routeHelpers", () => ({+ buildPlanCreateRoute: vi.fn(),+}));++vi.mock("@/components/EngineIcon", () => ({+ EngineIcon: () => null,+}));++vi.mock("@/components/DatabaseSelect", () => ({+ DatabaseSelect: ({+ onChange,+ }: {+ onChange: (name: string, database: typeof mocks.sourceDatabase) => void;+ }) => (+ <button+ data-testid="select-source-database"+ type="button"+ onClick={() => onChange(mocks.sourceDatabase.name, mocks.sourceDatabase)}+ />+ ),+}));++vi.mock("@/components/EnvironmentSelect", () => ({+ EnvironmentSelect: () => null,+}));++vi.mock("@/components/LearnMoreLink", () => ({+ LearnMoreLink: () => null,+}));++vi.mock("@/components/ProjectPageLayout", () => ({+ ProjectPageContent: ({ children }: { children: ReactNode }) => (+ <div>{children}</div>+ ),+ ProjectPageInfo: () => null,+ ProjectPageLayout: ({ children }: { children: ReactNode }) => (+ <div>{children}</div>+ ),+}));++vi.mock("@/components/ui/sheet", () => ({+ Sheet: ({ children }: { children: ReactNode }) => <div>{children}</div>,+ SheetBody: ({ children }: { children: ReactNode }) => <div>{children}</div>,+ SheetContent: ({ children }: { children: ReactNode }) => (+ <div>{children}</div>+ ),+ SheetFooter: ({ children }: { children: ReactNode }) => (+ <div>{children}</div>+ ),+ SheetHeader: ({ children }: { children: ReactNode }) => (+ <div>{children}</div>+ ),+ SheetTitle: ({ children }: { children: ReactNode }) => <h2>{children}</h2>,+}));++vi.mock("@/hooks/useProjectByName", () => ({+ useProjectByName: () => ({ name: "projects/project", title: "Project" }),+}));++vi.mock("@/components/monaco/core", () => ({+ createMonacoDiffEditor: vi.fn(),+ createMonacoEditor: vi.fn(),+ loadMonacoEditor: vi.fn(),+ setMonacoModelLanguage: vi.fn(),+}));++vi.mock("@/stores/app", () => {+ const state = {+ environmentList: [],+ fetchPreviousChangelog: vi.fn(),+ getOrFetchChangelogByName: mocks.getOrFetchChangelogByName,+ listChangelogs: vi.fn(async () => ({+ changelogs: [+ {+ name: "instances/source/databases/source-db/changelogs/1",+ planTitle: "Source changelog",+ },+ ],+ nextPageToken: "",+ })),+ projectsByName: {},+ };+ const getState = () => ({+ ...state,+ fetchDatabaseSchema: vi.fn(async () => ({ schema: "" })),+ fetchDatabases: mocks.fetchDatabases,+ getDatabaseByName: () => mocks.sourceDatabase,+ getEnvironmentByName: vi.fn(),+ getOrFetchDatabaseByName: vi.fn(async () => mocks.sourceDatabase),+ });+ return {+ useAppStore: Object.assign(+ (selector: (appState: typeof state) => unknown) => selector(state),+ { getState }+ ),+ };+});++vi.mock("@/stores/modules/v1/common", async () => {+ const actual = await vi.importActual<+ typeof import("@/stores/modules/v1/common")+ >("@/stores/modules/v1/common");+ return { ...actual, projectNamePrefix: "projects/" };+});++vi.mock("@/utils", async () => {+ const actual = await vi.importActual<typeof import("@/utils")>("@/utils");+ return {+ ...actual,+ getDatabaseEnvironment: () => ({ title: "Test" }),+ getDefaultPagination: () => 50,+ getInstanceResource: (database: typeof mocks.sourceDatabase) =>+ database.instanceResource,+ };+});++import { ProjectSyncSchemaPage } from "./ProjectSyncSchemaPage";++const flush = async () => {+ await act(async () => {+ await Promise.resolve();+ await Promise.resolve();+ await new Promise((resolve) => setTimeout(resolve, 0));+ });+};++const click = async (element: HTMLElement) => {+ act(() => {+ element.dispatchEvent(+ new MouseEvent("click", { bubbles: true, cancelable: true })+ );+ });+ await flush();+};++describe("ProjectSyncSchemaPage target database search", () => {+ let container: HTMLDivElement;+ let root: ReturnType<typeof createRoot>;++ beforeEach(() => {+ mocks.routeQuery = {+ changelog: "instances/source/databases/source-db/changelogs/1",+ };+ mocks.fetchDatabases.mockReset();+ mocks.fetchDatabases.mockImplementation(+ async ({ filter }: { filter?: { query?: string } }) => ({+ databases: [],+ nextPageToken: filter?.query ? "filtered-page-2" : "",+ })+ );+ container = document.createElement("div");+ document.body.appendChild(container);+ root = createRoot(container);+ });++ afterEach(() => {+ act(() => root.unmount());+ container.remove();+ });++ test("uses the database name query for the first page and load more", async () => {+ act(() => {+ root.render(<ProjectSyncSchemaPage projectId="project" />);+ });+ await flush();++ const selectButton = Array.from(container.querySelectorAll("button")).find(+ (button) => button.textContent === "common.select"+ );+ expect(selectButton).toBeDefined();+ await click(selectButton!);++ const searchInput = container.querySelector("input");+ expect(searchInput).not.toBeNull();+ act(() => {+ Object.getOwnPropertyDescriptor(+ HTMLInputElement.prototype,+ "value"+ )?.set?.call(searchInput, "Payroll");+ searchInput!.dispatchEvent(new Event("input", { bubbles: true }));+ });+ await flush();++ expect(mocks.fetchDatabases).toHaveBeenCalledWith({+ parent: "projects/project",+ pageSize: 50,+ filter: { engines: [1], query: "Payroll" },+ });++ const loadMoreButton = Array.from(+ container.querySelectorAll("button")+ ).find((button) => button.textContent === "common.load-more");+ expect(loadMoreButton).toBeDefined();+ await click(loadMoreButton!);++ expect(mocks.fetchDatabases).toHaveBeenCalledWith({+ parent: "projects/project",+ pageSize: 50,+ pageToken: "filtered-page-2",+ filter: { engines: [1], query: "Payroll" },+ });+ });++ test("allows an environmentless source database with a valid changelog", async () => {+ mocks.routeQuery = {};+ act(() => {+ root.render(<ProjectSyncSchemaPage projectId="project" />);+ });+ await flush();++ const selectSourceDatabase = container.querySelector<HTMLElement>(+ '[data-testid="select-source-database"]'+ );+ expect(selectSourceDatabase).not.toBeNull();+ await click(selectSourceDatabase!);++ const nextButton = Array.from(container.querySelectorAll("button")).find(+ (button) => button.textContent === "common.next"+ );+ expect(nextButton).toBeDefined();+ expect(nextButton).not.toBeDisabled();+ });+});diff --git a/frontend/src/routes/project/ProjectSyncSchemaPage.tsx b/frontend/src/routes/project/ProjectSyncSchemaPage.tsxindex 7ba59b7a57..d51c9b1ac0 100644--- a/frontend/src/routes/project/ProjectSyncSchemaPage.tsx+++ b/frontend/src/routes/project/ProjectSyncSchemaPage.tsx@@ -58,7 +58,6 @@ import { projectNamePrefix } from "@/stores/modules/v1/common";import {getDateForPbTimestampProtoEs,isValidDatabaseName,- isValidEnvironmentName,type Language,languageOfEngineV1,} from "@/types";@@ -334,7 +333,6 @@ export function ProjectSyncSchemaPage({ projectId }: { projectId: string }) {if (currentStep === Step.SELECT_SOURCE_SCHEMA) {if (sourceSchemaType === SourceSchemaType.SCHEMA_HISTORY_VERSION) {return (- isValidEnvironmentName(changelogSource.environmentName) &&isValidDatabaseName(changelogSource.databaseName) &&!!changelogSource.changelogName);@@ -1926,57 +1924,56 @@ function TargetDatabasesSelectPanel({const [databases, setDatabases] = useState<Database[]>([]);const [loading, setLoading] = useState(true);const [dbNextPageToken, setDbNextPageToken] = useState("");- const [loadingMoreDbs, setLoadingMoreDbs] = useState(false);+ const requestGenerationRef = useRef(0);useEscapeKey(true, onClose);+ const fetchDatabasePage = useCallback(+ async (pageToken?: string) => {+ const generation = pageToken+ ? requestGenerationRef.current+ : ++requestGenerationRef.current;+ if (!pageToken) {+ setDatabases([]);+ setDbNextPageToken("");+ }+ setLoading(true);+ try {+ const { databases: fetched, nextPageToken: token } = await useAppStore+ .getState()+ .fetchDatabases({+ parent: project,+ pageSize: getDefaultPagination(),+ ...(pageToken ? { pageToken } : {}),+ filter: {+ query: searchQuery,+ engines:+ engine === Engine.ENGINE_UNSPECIFIED ? undefined : [engine],+ },+ });+ if (generation !== requestGenerationRef.current) return;+ setDatabases((current) =>+ pageToken ? [...current, ...fetched] : fetched+ );+ setDbNextPageToken(token);+ } finally {+ if (generation === requestGenerationRef.current) {+ setLoading(false);+ }+ }+ },+ [engine, project, searchQuery]+ );+// Fetch first page of databasesuseEffect(() => {- (async () => {- setLoading(true);- const { databases: fetched, nextPageToken: token } = await useAppStore- .getState()- .fetchDatabases({- parent: project,- pageSize: getDefaultPagination(),- });- setDatabases(fetched);- setDbNextPageToken(token);- setLoading(false);- })();- }, [project]);+ void fetchDatabasePage();+ }, [fetchDatabasePage]);- const loadMoreDatabases = useCallback(async () => {- if (!dbNextPageToken || loadingMoreDbs) return;- setLoadingMoreDbs(true);- const { databases: more, nextPageToken: token } = await useAppStore- .getState()- .fetchDatabases({- parent: project,- pageSize: getDefaultPagination(),- pageToken: dbNextPageToken,- });- setDatabases((prev) => [...prev, ...more]);- setDbNextPageToken(token);- setLoadingMoreDbs(false);- }, [dbNextPageToken, loadingMoreDbs, project]);-- const filteredDatabases = useMemo(() => {- const q = searchQuery.toLowerCase();- return databases.filter((db) => {- const dbName = extractDatabaseResourceName(- db.name- ).databaseName.toLowerCase();- const envName = getDatabaseEnvironment(db).title.toLowerCase();- const instName = getInstanceResource(db).title.toLowerCase();- const matchesQuery =- !q || dbName.includes(q) || envName.includes(q) || instName.includes(q);- const matchesEngine =- engine === Engine.ENGINE_UNSPECIFIED ||- getInstanceResource(db).engine === engine;- return matchesQuery && matchesEngine;- });- }, [databases, searchQuery, engine]);+ const loadMoreDatabases = useCallback(() => {+ if (!dbNextPageToken || loading) return;+ void fetchDatabasePage(dbNextPageToken);+ }, [dbNextPageToken, fetchDatabasePage, loading]);const toggleDatabase = useCallback((name: string) => {setSelected((prev) => {@@ -1991,18 +1988,18 @@ function TargetDatabasesSelectPanel({}, []);const toggleAll = useCallback(() => {- const allFilteredNames = filteredDatabases.map((db) => db.name);+ const allDatabaseNames = databases.map((db) => db.name);setSelected((prev) => {- const allSelected = allFilteredNames.every((name) => prev.has(name));+ const allSelected = allDatabaseNames.every((name) => prev.has(name));const next = new Set(prev);if (allSelected) {- allFilteredNames.forEach((name) => next.delete(name));+ allDatabaseNames.forEach((name) => next.delete(name));} else {- allFilteredNames.forEach((name) => next.add(name));+ allDatabaseNames.forEach((name) => next.add(name));}return next;});- }, [filteredDatabases]);+ }, [databases]);const handleConfirm = useCallback(() => {onUpdate(Array.from(selected));@@ -2027,7 +2024,7 @@ function TargetDatabasesSelectPanel({{/* Database list */}<SheetBody className="px-6 py-2">- {loading ? (+ {loading && databases.length === 0 ? (<div className="flex items-center justify-center py-8"><div className="animate-spin rounded-full size-6 border-b-2 border-control-placeholder" /></div>@@ -2039,8 +2036,8 @@ function TargetDatabasesSelectPanel({<th className="py-2 px-2 w-8 text-left"><Checkboxchecked={- filteredDatabases.length > 0 &&- filteredDatabases.every((db) => selected.has(db.name))+ databases.length > 0 &&+ databases.every((db) => selected.has(db.name))}onCheckedChange={toggleAll}/>@@ -2057,7 +2054,7 @@ function TargetDatabasesSelectPanel({</tr></thead><tbody>- {filteredDatabases.map((db) => (+ {databases.map((db) => (<trkey={db.name}className="border-b hover:bg-control-bg cursor-pointer"@@ -2096,12 +2093,10 @@ function TargetDatabasesSelectPanel({<Buttonappearance="secondary"size="sm"- disabled={loadingMoreDbs}+ disabled={loading}onClick={loadMoreDatabases}>- {loadingMoreDbs- ? t("common.loading")- : t("common.load-more")}+ {loading ? t("common.loading") : t("common.load-more")}</Button></div>)}diff --git a/frontend/src/stores/app/utils.test.ts b/frontend/src/stores/app/utils.test.tsnew file mode 100644index 0000000000..2dab85acb9--- /dev/null+++ b/frontend/src/stores/app/utils.test.ts@@ -0,0 +1,10 @@+import { describe, expect, test } from "vitest";+import { buildDatabaseFilter } from "./utils";++describe("buildDatabaseFilter", () => {+ test("escapes the database name query as a CEL string literal", () => {+ expect(buildDatabaseFilter({ query: 'Payroll "Q3"\\West\nArchive' })).toBe(+ 'name.contains("payroll \\"q3\\"\\\\west\\narchive")'+ );+ });+});diff --git a/frontend/src/stores/app/utils.ts b/frontend/src/stores/app/utils.tsindex f5c35a7340..ef22ae0f65 100644--- a/frontend/src/stores/app/utils.ts+++ b/frontend/src/stores/app/utils.ts@@ -17,6 +17,7 @@ import {} from "@/types/v1/environment";import { isValidInstanceName } from "@/types/v1/instance";import { workspaceCacheScope } from "@/utils/storage-keys";+import { escapeCELStringLiteral } from "@/utils/v1/cel";import type { AppStoreState } from "./types";export const MAX_RECENT_PROJECT = 5;@@ -133,7 +134,7 @@ export function buildDatabaseFilter(filter: DatabaseFilter): string {}const keyword = filter.query?.trim()?.toLowerCase();if (keyword) {- params.push(`name.contains("${keyword}")`);+ params.push(`name.contains("${escapeCELStringLiteral(keyword)}")`);}if (filter.labels) {params.push(...getLabelFilter(filter.labels));