Skip to content

Database governance built for humans and agents — controlling changes and access across every major database.

chore: optimize sql review layout in mobile (#20735)

ecmadao6188dc1166d6
diff --git a/frontend/src/react/components/sql-review/RuleTable.test.tsx b/frontend/src/react/components/sql-review/RuleTable.test.tsx
index a8b980b703..062655ef5e 100644
--- a/frontend/src/react/components/sql-review/RuleTable.test.tsx
+++ b/frontend/src/react/components/sql-review/RuleTable.test.tsx
@@ -2,6 +2,7 @@ import type { ReactElement } from "react";
import { act } from "react";
import { createRoot } from "react-dom/client";
import { beforeEach, describe, expect, test, vi } from "vitest";
+import { getRuleKey } from "@/react/lib/sql-review/utils";
import { Engine } from "@/types/proto-es/v1/common_pb";
import type { RuleTemplateV2 } from "@/types/sqlReview";
import { getRuleLocalization, ruleTemplateMapV2 } from "@/types/sqlReview";
@@ -12,6 +13,7 @@ import { getRuleLocalization, ruleTemplateMapV2 } from "@/types/sqlReview";
const mocks = vi.hoisted(() => ({
ruleLevelSwitch: vi.fn(),
+ searchInputOnChange: vi.fn(),
}));
vi.mock("react-i18next", () => ({
@@ -31,10 +33,15 @@ vi.mock("@/react/components/ui/button", () => ({
Button: ({
children,
onClick,
+ ...props
}: {
children: React.ReactNode;
onClick?: () => void;
- }) => <button onClick={onClick}>{children}</button>,
+ } & React.ButtonHTMLAttributes<HTMLButtonElement>) => (
+ <button onClick={onClick} {...props}>
+ {children}
+ </button>
+ ),
}));
vi.mock("@/react/components/ui/checkbox", () => ({
@@ -71,6 +78,41 @@ vi.mock("@/react/components/ui/table", () => ({
),
}));
+vi.mock("@/react/components/ui/search-input", () => ({
+ SearchInput: (props: React.InputHTMLAttributes<HTMLInputElement>) => {
+ mocks.searchInputOnChange = vi.fn(props.onChange);
+ return <input aria-label="rule-search" {...props} />;
+ },
+}));
+
+vi.mock("@/react/components/ui/tabs", () => ({
+ Tabs: ({
+ children,
+ onValueChange: _onValueChange,
+ value: _value,
+ }: {
+ children: React.ReactNode;
+ onValueChange?: (value: string) => void;
+ value?: string;
+ }) => <div>{children}</div>,
+ TabsList: ({ children }: { children: React.ReactNode }) => (
+ <div>{children}</div>
+ ),
+ TabsTrigger: ({
+ children,
+ value,
+ onClick,
+ }: {
+ children: React.ReactNode;
+ value: string;
+ onClick?: () => void;
+ }) => (
+ <button data-value={value} onClick={onClick}>
+ {children}
+ </button>
+ ),
+}));
+
vi.mock("./RuleComponents", () => ({
RuleConfig: () => <div data-testid="rule-config" />,
RuleEditDialog: () => <div data-testid="rule-edit-dialog" />,
@@ -82,31 +124,49 @@ vi.mock("./RuleComponents", () => ({
}));
let RuleTable: typeof import("./RuleTable").RuleTable;
+let RuleTableWithFilter: typeof import("./RuleTable").RuleTableWithFilter;
const renderIntoContainer = (element: ReactElement) => {
const container = document.createElement("div");
+ document.body.appendChild(container);
const root = createRoot(container);
return {
container,
- render: () =>
+ render: (nextElement = element) =>
act(() => {
- root.render(element);
+ root.render(nextElement);
}),
unmount: () =>
act(() => {
root.unmount();
+ container.remove();
}),
};
};
beforeEach(async () => {
vi.clearAllMocks();
+ Object.defineProperty(window, "requestAnimationFrame", {
+ configurable: true,
+ value: (callback: FrameRequestCallback) => {
+ callback(0);
+ return 0;
+ },
+ });
+ Object.defineProperty(window, "matchMedia", {
+ configurable: true,
+ value: vi.fn(() => ({
+ matches: true,
+ addEventListener: vi.fn(),
+ removeEventListener: vi.fn(),
+ })),
+ });
Object.defineProperty(Element.prototype, "scrollIntoView", {
configurable: true,
value: vi.fn(),
});
- ({ RuleTable } = await import("./RuleTable"));
+ ({ RuleTable, RuleTableWithFilter } = await import("./RuleTable"));
});
describe("RuleTable", () => {
@@ -180,4 +240,121 @@ describe("RuleTable", () => {
unmount();
});
+
+ test("repeated focus signals clear active filters for the same invalid rule", () => {
+ const rule = ruleList[0].ruleList[0];
+ const focusRuleKey = getRuleKey(rule);
+ const { container, render, unmount } = renderIntoContainer(
+ <RuleTableWithFilter
+ engine={Engine.MYSQL}
+ ruleList={[rule]}
+ editable
+ focusRuleKey={focusRuleKey}
+ focusRuleSignal={1}
+ />
+ );
+
+ render();
+
+ const searchInput = container.querySelector<HTMLInputElement>(
+ 'input[aria-label="rule-search"]'
+ );
+ expect(searchInput).toBeTruthy();
+ act(() => {
+ mocks.searchInputOnChange({
+ target: { value: "does-not-match-any-rule" },
+ });
+ });
+ expect(container.textContent).toContain("common.no-data");
+
+ render(
+ <RuleTableWithFilter
+ engine={Engine.MYSQL}
+ ruleList={[rule]}
+ editable
+ focusRuleKey={focusRuleKey}
+ focusRuleSignal={2}
+ />
+ );
+
+ expect(container.textContent).not.toContain("common.no-data");
+
+ unmount();
+ });
+
+ test("focus scroll targets the mobile rule card on small screens", () => {
+ vi.mocked(window.matchMedia).mockReturnValue({
+ matches: false,
+ addEventListener: vi.fn(),
+ removeEventListener: vi.fn(),
+ } as unknown as MediaQueryList);
+ const scrollTargets: Element[] = [];
+ Object.defineProperty(Element.prototype, "scrollIntoView", {
+ configurable: true,
+ value: vi.fn(function (this: Element) {
+ scrollTargets.push(this);
+ }),
+ });
+ const rule = ruleList[0].ruleList[0];
+ const focusRuleKey = getRuleKey(rule);
+ const { render, unmount } = renderIntoContainer(
+ <RuleTable
+ ruleList={[{ value: "all", label: "All", ruleList: [rule] }]}
+ editable
+ focusRuleKey={focusRuleKey}
+ focusRuleSignal={1}
+ />
+ );
+
+ render();
+
+ expect(scrollTargets[0]?.tagName).toBe("DIV");
+
+ unmount();
+ });
+
+ test("mobile rule row uses compact matched actions with vertical padding", () => {
+ const rule = {
+ ...ruleList[0].ruleList[0],
+ category: "ENGINE",
+ };
+ const { container, render, unmount } = renderIntoContainer(
+ <RuleTable
+ ruleList={[{ value: "all", label: "All", ruleList: [rule] }]}
+ editable
+ />
+ );
+
+ render();
+
+ const mobileRow = container.querySelector(
+ '[data-sql-review-rule-view="mobile"]'
+ );
+ expect(mobileRow).toBeTruthy();
+ expect(mobileRow?.className).toContain("py-4");
+ expect(mobileRow?.className).not.toContain("pt-4");
+ expect(
+ mobileRow?.querySelector('[data-testid="mobile-rule-title-row"]')
+ ?.className
+ ).not.toContain("grid-cols-[minmax(0,1fr)_auto]");
+ expect(
+ mobileRow?.querySelector('[data-testid="mobile-rule-action-list"]')
+ ?.className
+ ).toContain("absolute");
+ const mobileEditButton = mobileRow?.querySelector<HTMLButtonElement>(
+ 'button[aria-label="common.edit"]'
+ );
+ const mobileDeleteButton = mobileRow?.querySelector<HTMLButtonElement>(
+ 'button[aria-label="common.delete"]'
+ );
+ expect(mobileEditButton).toBeTruthy();
+ expect(mobileDeleteButton).toBeTruthy();
+ expect(mobileEditButton?.className).toContain("size-7");
+ expect(mobileDeleteButton?.className).toContain("size-7");
+ expect(mobileEditButton?.className).not.toContain("size-8");
+ expect(mobileDeleteButton?.className).not.toContain("size-8");
+ expect(mobileDeleteButton?.textContent).toBe("");
+
+ unmount();
+ });
});
diff --git a/frontend/src/react/components/sql-review/RuleTable.tsx b/frontend/src/react/components/sql-review/RuleTable.tsx
index e5fcd832bc..6f075caf46 100644
--- a/frontend/src/react/components/sql-review/RuleTable.tsx
+++ b/frontend/src/react/components/sql-review/RuleTable.tsx
@@ -1,4 +1,10 @@
-import { ChevronDown, ChevronRight, ExternalLink, Pencil } from "lucide-react";
+import {
+ ChevronDown,
+ ChevronRight,
+ ExternalLink,
+ Pencil,
+ Trash2,
+} from "lucide-react";
import { memo, useCallback, useEffect, useMemo, useState } from "react";
import { useTranslation } from "react-i18next";
import { Button } from "@/react/components/ui/button";
@@ -32,6 +38,8 @@ import {
type RuleListWithCategory,
} from "./RuleComponents";
+const DESKTOP_RULE_MEDIA_QUERY = "(min-width: 1024px)";
+
// ---- Types ----
export interface SQLRuleFilterParams {
@@ -280,9 +288,15 @@ export function RuleTable({
if (!focusRuleKey) return;
setHighlightedRuleKey(focusRuleKey);
window.requestAnimationFrame(() => {
- document
- .querySelector(`[data-sql-review-rule-key="${focusRuleKey}"]`)
- ?.scrollIntoView({ block: "center", behavior: "smooth" });
+ const ruleView = window.matchMedia(DESKTOP_RULE_MEDIA_QUERY).matches
+ ? "desktop"
+ : "mobile";
+ const target =
+ document.querySelector(
+ `[data-sql-review-rule-key="${focusRuleKey}"][data-sql-review-rule-view="${ruleView}"]`
+ ) ??
+ document.querySelector(`[data-sql-review-rule-key="${focusRuleKey}"]`);
+ target?.scrollIntoView({ block: "center", behavior: "smooth" });
});
const timer = window.setTimeout(() => {
setHighlightedRuleKey(undefined);
@@ -367,7 +381,7 @@ export function RuleTable({
</div>
{/* Mobile cards */}
- <div className="flex flex-col lg:hidden border px-2 pb-4 divide-y divide-block-border">
+ <div className="flex flex-col lg:hidden border px-2 divide-y divide-block-border">
{category.ruleList.map((rule) => {
const key = getRuleKey(rule);
const highlighted = highlightedRuleKey === key;
@@ -457,6 +471,7 @@ function RuleTableRow({
<>
<TableRow
data-sql-review-rule-key={ruleKey}
+ data-sql-review-rule-view="desktop"
className={cn(
supportSelect ? "cursor-pointer" : "",
highlighted &&
@@ -614,15 +629,22 @@ const MobileRuleTableRow = memo(function MobileRuleTableRow({
return (
<div
data-sql-review-rule-key={ruleKey}
+ data-sql-review-rule-view="mobile"
className={cn(
- "pt-4 flex flex-col gap-y-3",
+ "relative py-4 flex flex-col gap-y-3",
highlighted &&
"rounded-sm outline outline-1 outline-error outline-offset-[-1px] bg-error/5"
)}
>
- <div className="flex justify-between items-center gap-x-2">
- <div className="flex items-center gap-x-1">
- <span>
+ <div
+ data-testid="mobile-rule-title-row"
+ className={cn(
+ "min-w-0 pr-20",
+ supportSelect ? "flex items-start justify-between gap-x-3 pr-0" : ""
+ )}
+ >
+ <div className="min-w-0 flex-1">
+ <span className="break-words">
{loc.title}
<a
href={`https://docs.bytebase.com/sql-review/review-rules#${rule.type}`}
@@ -637,20 +659,31 @@ const MobileRuleTableRow = memo(function MobileRuleTableRow({
{supportSelect ? (
<Checkbox checked={isSelected} onCheckedChange={onToggleRule} />
) : (
- <div className="flex items-center gap-x-2">
+ <div
+ data-testid="mobile-rule-action-list"
+ className="absolute right-0 top-4 flex shrink-0 items-center gap-x-1"
+ >
{editable && (
- <Pencil
- className="w-4 h-4 cursor-pointer hover:text-accent"
+ <Button
+ type="button"
+ variant="ghost"
+ size="sm"
+ className="size-7 p-0 text-control hover:text-accent"
+ aria-label={t("common.edit")}
onClick={() => setEditing(true)}
- />
+ >
+ <Pencil className="size-4" />
+ </Button>
)}
{editable && !isBuiltinRule(rule) && (
<Button
- variant="ghost-destructive"
+ variant="ghost"
size="sm"
+ className="size-7 p-0 text-error hover:bg-error/10 hover:text-error"
+ aria-label={t("common.delete")}
onClick={() => onRuleRemove?.(rule)}
>
- {t("common.delete")}
+ <Trash2 className="size-4" />
</Button>
)}
</div>
@@ -722,7 +755,7 @@ export function RuleTableWithFilter({
if (focusRuleKey) {
events.reset();
}
- }, [focusRuleKey, events]);
+ }, [focusRuleKey, focusRuleSignal, events]);
const toggleSelectAll = useCallback(
(select: boolean) => {