From cb42ae9f5afbac9d515251634a1a387d73878faf Mon Sep 17 00:00:00 2001 From: OOMEcho <228389787@qq.com> Date: Wed, 30 Sep 2026 18:59:56 +0800 Subject: [PATCH] feat(grid): match columns by comments in filter search --- apps/desktop/src/components/grid/DataGrid.vue | 2 + .../useDataGridFilterBuilder.spec.ts | 45 +++++++++++++++++++ .../composables/useDataGridFilterBuilder.ts | 4 +- 3 files changed, 50 insertions(+), 1 deletion(-) diff --git a/apps/desktop/src/components/grid/DataGrid.vue b/apps/desktop/src/components/grid/DataGrid.vue index 83272d5982..5fd259d7b4 100644 --- a/apps/desktop/src/components/grid/DataGrid.vue +++ b/apps/desktop/src/components/grid/DataGrid.vue @@ -1243,12 +1243,14 @@ async function buildStructuredFilterCondition(rule: StructuredFilterRule): Promi const filterBuilder = useDataGridFilterBuilder({ columns: filterBuilderColumnOptions, + commentByColumn: columnCommentMap, createId: uuid, isComplete: isStructuredFilterRuleComplete, buildCondition: buildStructuredFilterCondition, }); const conditionalBulkEditFilterBuilder = useDataGridFilterBuilder({ columns: filterBuilderColumnOptions, + commentByColumn: columnCommentMap, createId: uuid, isComplete: isStructuredFilterRuleComplete, buildCondition: buildStructuredFilterCondition, diff --git a/apps/desktop/src/composables/__tests__/useDataGridFilterBuilder.spec.ts b/apps/desktop/src/composables/__tests__/useDataGridFilterBuilder.spec.ts index 9273294fde..2e9a1e9415 100644 --- a/apps/desktop/src/composables/__tests__/useDataGridFilterBuilder.spec.ts +++ b/apps/desktop/src/composables/__tests__/useDataGridFilterBuilder.spec.ts @@ -1,7 +1,52 @@ import { describe, expect, it, vi } from "vitest"; +import { ref } from "vue"; import { buildDataGridStructuredWhere, createDataGridFilterConditionCache, moveDataGridStructuredFilterRule, useDataGridFilterBuilder, type DataGridStructuredFilterRule } from "@/composables/useDataGridFilterBuilder"; describe("useDataGridFilterBuilder", () => { + it("finds columns by comments and keeps the column name when building a condition", async () => { + const buildCondition = vi.fn(async (rule: DataGridStructuredFilterRule) => `${rule.columnName} = 'Alice'`); + const builder = useDataGridFilterBuilder({ + columns: ["id", "customer_name", "email"], + commentByColumn: new Map([["customer_name", "客户名称 / Customer Name"]]), + createId: () => "rule-1", + isComplete: () => true, + buildCondition, + }); + + for (const query of ["客户", " CUSTOMER ", "name"]) { + builder.columnSearch.value = query; + expect(builder.filteredColumns.value).toEqual(["customer_name"]); + } + builder.ensureRule(); + builder.updateRule("rule-1", { columnName: builder.filteredColumns.value[0], rawValue: "Alice" }); + expect(await builder.buildWhere()).toBe("customer_name = 'Alice'"); + expect(buildCondition).toHaveBeenCalledWith(expect.objectContaining({ columnName: "customer_name" })); + + builder.columnSearch.value = "missing"; + expect(builder.filteredColumns.value).toEqual([]); + builder.columnSearch.value = " "; + expect(builder.filteredColumns.value).toEqual(["id", "customer_name", "email"]); + }); + + it("reacts to refreshed comments and columns without including comments from absent columns", () => { + const columns = ref(["id", "customer_name"]); + const comments = ref( + new Map([ + ["customer_name", "客户名称"], + ["removed", "客户历史"], + ]), + ); + const builder = useDataGridFilterBuilder({ columns, commentByColumn: () => comments.value, isComplete: () => true, buildCondition: async () => "" }); + builder.columnSearch.value = "客户"; + expect(builder.filteredColumns.value).toEqual(["customer_name"]); + comments.value = new Map([["customer_name", "姓名"]]); + expect(builder.filteredColumns.value).toEqual([]); + builder.columnSearch.value = "姓名"; + expect(builder.filteredColumns.value).toEqual(["customer_name"]); + columns.value = ["id"]; + expect(builder.filteredColumns.value).toEqual([]); + }); + it("searches columns by camel-case initials and any-position text", () => { const builder = useDataGridFilterBuilder({ columns: ["userProfile", "order_id", "created_at"], createId: () => "rule-1", isComplete: () => true, buildCondition: async () => "" }); diff --git a/apps/desktop/src/composables/useDataGridFilterBuilder.ts b/apps/desktop/src/composables/useDataGridFilterBuilder.ts index 573fdcebff..ca7de1bacf 100644 --- a/apps/desktop/src/composables/useDataGridFilterBuilder.ts +++ b/apps/desktop/src/composables/useDataGridFilterBuilder.ts @@ -16,6 +16,7 @@ export type DataGridStructuredFilterRule = { export type UseDataGridFilterBuilderOptions = { columns: MaybeRefOrGetter; + commentByColumn?: MaybeRefOrGetter>; createId?: () => string; isComplete: (rule: DataGridStructuredFilterRule) => boolean; buildCondition: (rule: DataGridStructuredFilterRule) => Promise; @@ -76,7 +77,8 @@ export function useDataGridFilterBuilder(options: UseDataGridFilterBuilderOption const appliedWhereInput = ref(""); const filteredColumns = computed(() => { const query = columnSearch.value.trim(); - return query ? toValue(options.columns).filter((column) => matchesIdentifierSearch(column, query)) : [...toValue(options.columns)]; + const comments = toValue(options.commentByColumn); + return query ? toValue(options.columns).filter((column) => matchesIdentifierSearch(column, query) || matchesIdentifierSearch(comments?.get(column) ?? comments?.get(column.toLowerCase()) ?? "", query)) : [...toValue(options.columns)]; }); const activeCount = computed(() => rules.value.filter((rule) => !rule.disabled && rule.columnName && options.isComplete(rule)).length);