fix(grid): copy NULL cells as empty fields

This commit is contained in:
李子凡 authored and GitHub committed 2026-08-31 16:57:33 +08:00
1 parent 27f62fe6e2
commit 0e9f92c917
11 files changed
+113 -16

No files matched your search

@@ -730,6 +730,66 @@ describe("useDataGridExport prepared row statements", () => {
expect(copyToClipboard).toHaveBeenCalledWith(text); expect(copyToClipboard).toHaveBeenCalledWith(text);
}); });
it("copies a NULL cell as an empty clipboard value", async () => {
const state = createExportState(editableTable, ["id", "name"], undefined, [1, null], undefined, undefined, [], DEFAULT_DATA_GRID_EXTRACTOR_OPTIONS, false, undefined, false, 1, 1);
await state.copyCell();
expect(copyToClipboard).toHaveBeenCalledWith("");
});
it("copies all rows with empty fields for NULL cells", async () => {
const text = "id\tname\n1\t\n2\tAda";
const state = createExportState(editableTable, ["id", "name"], undefined, undefined, undefined, [
[1, null],
[2, "Ada"],
]);
await state.copyAll();
expect(copyToClipboard).toHaveBeenCalledWith(text);
expect(parseDataGridClipboard(text)).toEqual([
["id", "name"],
["1", null],
["2", "Ada"],
]);
});
it("copies a NULL smart single-cell selection as an empty value", async () => {
const matrix: CellSelectionMatrix = {
rowIndexes: [0],
columnIndexes: [1],
columns: ["name"],
rows: [[null]],
};
vi.mocked(extractDataGridSelection).mockResolvedValueOnce({ text: "", mimeType: "text/plain", fileExtension: "txt", rowCount: 1, columnCount: 1 });
const state = createExportState(editableTable, ["id", "name"], matrix, [1, null]);
await expect(state.copyWithPreference("smart")).resolves.toBe(true);
expect(copyToClipboard).toHaveBeenCalledWith("");
});
it("uses an empty default NULL text for TSV clipboard output", async () => {
const matrix: CellSelectionMatrix = {
rowIndexes: [0],
columnIndexes: [0, 1],
columns: ["id", "name"],
rows: [[1, null]],
};
vi.mocked(extractDataGridSelection).mockResolvedValueOnce({ text: "1\t", mimeType: "text/tab-separated-values", fileExtension: "tsv", rowCount: 1, columnCount: 2 });
const state = createExportState(editableTable, ["id", "name"], matrix, [1, null]);
await expect(state.copyWithExtractor("tsv")).resolves.toBe(true);
expect(extractDataGridSelection).toHaveBeenCalledWith(
expect.objectContaining({
options: expect.objectContaining({ dsv: expect.objectContaining({ nullText: "" }) }),
}),
);
expect(copyToClipboard).toHaveBeenCalledWith("1\t");
});
it("preserves JSON-column text in a single-cell smart copy", async () => { it("preserves JSON-column text in a single-cell smart copy", async () => {
const tableMeta: DataGridTableMeta = { const tableMeta: DataGridTableMeta = {
tableName: "events", tableName: "events",
@@ -8,7 +8,7 @@ import { type CellSelectionMatrix, type CellSelectionRange, type SelectionData }
import type { DataGridExtractRequest, DataGridExtractorOptions } from "@/lib/dataGrid/dataGridCopyExtractor"; import type { DataGridExtractRequest, DataGridExtractorOptions } from "@/lib/dataGrid/dataGridCopyExtractor";
import { useToast } from "@/composables/useToast"; import { useToast } from "@/composables/useToast";
import { useExportTracker } from "@/composables/useExportTracker"; import { useExportTracker } from "@/composables/useExportTracker";
import { displayCellValue, type CellValue } from "@/lib/dataGrid/cellValue"; import { clipboardCellValue, type CellValue } from "@/lib/dataGrid/cellValue";
import { tryStartExclusiveActivation, type ActionActivationGuard } from "@/lib/connection/actionActivation"; import { tryStartExclusiveActivation, type ActionActivationGuard } from "@/lib/connection/actionActivation";
import { copyToClipboard } from "@/lib/common/clipboard"; import { copyToClipboard } from "@/lib/common/clipboard";
import { clearDataGridClipboardCopy, rememberDataGridClipboardCopy } from "@/lib/dataGrid/dataGridClipboard"; import { clearDataGridClipboardCopy, rememberDataGridClipboardCopy } from "@/lib/dataGrid/dataGridClipboard";
@@ -529,7 +529,7 @@ export function useDataGridExport(options: UseDataGridExportOptions) {
const sourceIndex = visibleColumnIndexes.value[contextCell.value.col] ?? contextCell.value.col; const sourceIndex = visibleColumnIndexes.value[contextCell.value.col] ?? contextCell.value.col;
const [resolvedItem] = await resolveVisibleRowValues([item], [sourceIndex]); const [resolvedItem] = await resolveVisibleRowValues([item], [sourceIndex]);
const val = resolvedItem?.data[contextCell.value.col] ?? null; const val = resolvedItem?.data[contextCell.value.col] ?? null;
await copyText(displayCellValue(val), { rows: [[val]] }); await copyText(clipboardCellValue(val), { rows: [[val]] });
} }
async function copyRow() { async function copyRow() {
@@ -671,10 +671,8 @@ export function useDataGridExport(options: UseDataGridExportOptions) {
}); });
async function copyAll() { async function copyAll() {
const header = columns.value.join("\t");
const rows = (await resolveVisibleRowValues(displayItems.value.filter((item) => !item.isDraft))).map((item) => item.data); const rows = (await resolveVisibleRowValues(displayItems.value.filter((item) => !item.isDraft))).map((item) => item.data);
const body = rows.map((row) => row.map((cell) => displayCellValue(cell)).join("\t")).join("\n"); await copyText(formatTsv(columns.value, rows), { rows, header: columns.value });
await copyText(`${header}\n${body}`, { rows, header: columns.value });
} }
// --- Export functions --- // --- Export functions ---
@@ -329,7 +329,7 @@ export function useDataGridExtractor(options: UseDataGridExtractorOptions) {
const request = await resolveRequestSourceValues(initialRequest); const request = await resolveRequestSourceValues(initialRequest);
const mongoResult = await resolveMongoExtractorResult(extractor, request); const mongoResult = await resolveMongoExtractorResult(extractor, request);
const result = mongoResult ?? (await api.extractDataGridSelection(request)); const result = mongoResult ?? (await api.extractDataGridSelection(request));
if (!result.text) return false; if (!result.text && !extractorAllowsEmptyOutput(extractor)) return false;
// Derive the grid paste-back payload from the effective request schema so // Derive the grid paste-back payload from the effective request schema so
// hidden support columns, row headers, NULLs, tabs, and newlines keep the // hidden support columns, row headers, NULLs, tabs, and newlines keep the
// same shape and values as the rendered raw text or TSV. // same shape and values as the rendered raw text or TSV.
@@ -365,7 +365,7 @@ export function useDataGridExtractor(options: UseDataGridExtractorOptions) {
const request = await resolveRequestSourceValues(initialRequest, previewRowCount); const request = await resolveRequestSourceValues(initialRequest, previewRowCount);
const mongoResult = await resolveMongoExtractorResult(extractor, request, previewRowCount); const mongoResult = await resolveMongoExtractorResult(extractor, request, previewRowCount);
const result = mongoResult ?? (await api.extractDataGridSelection(request)); const result = mongoResult ?? (await api.extractDataGridSelection(request));
if (!result.text) throw new Error(t("grid.copyExtractorEmptySelection")); if (!result.text && !extractorAllowsEmptyOutput(extractor)) throw new Error(t("grid.copyExtractorEmptySelection"));
return { ...result, sourceRowCount, truncated: sourceRowCount > result.rowCount }; return { ...result, sourceRowCount, truncated: sourceRowCount > result.rowCount };
} }
@@ -396,6 +396,10 @@ export function useDataGridExtractor(options: UseDataGridExtractorOptions) {
return { copyWithExtractor, copyWithPreference, previewWithExtractor, previewWithPreference, canCopyWithExtractor }; return { copyWithExtractor, copyWithPreference, previewWithExtractor, previewWithPreference, canCopyWithExtractor };
} }
function extractorAllowsEmptyOutput(extractor: DataGridCopyExtractorId): boolean {
return DATA_GRID_COPY_EXTRACTOR_DESCRIPTORS[extractor].category === "raw" || DATA_GRID_COPY_EXTRACTOR_DESCRIPTORS[extractor].category === "delimited";
}
function compactTableMeta(tableMeta: DataGridTableMeta | undefined, requiredColumns: string[]): DataGridTableMeta | undefined { function compactTableMeta(tableMeta: DataGridTableMeta | undefined, requiredColumns: string[]): DataGridTableMeta | undefined {
if (!tableMeta?.columns) return tableMeta; if (!tableMeta?.columns) return tableMeta;
const requiredNames = new Set(requiredColumns.map(normalizeName)); const requiredNames = new Set(requiredColumns.map(normalizeName));
@@ -3,6 +3,11 @@ import { describe, expect, it } from "vitest";
import { DEFAULT_DATA_GRID_EXTRACTOR_OPTIONS, normalizeDataGridCopyPreference, normalizeDataGridExtractorOptions, resolveDataGridCopyPreference, validateDataGridExtractorOptions } from "@/lib/dataGrid/dataGridCopyExtractor"; import { DEFAULT_DATA_GRID_EXTRACTOR_OPTIONS, normalizeDataGridCopyPreference, normalizeDataGridExtractorOptions, resolveDataGridCopyPreference, validateDataGridExtractorOptions } from "@/lib/dataGrid/dataGridCopyExtractor";
describe("data-grid extractor options", () => { describe("data-grid extractor options", () => {
it("defaults DSV NULL output to an empty spreadsheet field", () => {
expect(DEFAULT_DATA_GRID_EXTRACTOR_OPTIONS.dsv.nullText).toBe("");
expect(normalizeDataGridExtractorOptions({}).dsv.nullText).toBe("");
});
it("resolves smart copy to raw for one cell and TSV otherwise", () => { it("resolves smart copy to raw for one cell and TSV otherwise", () => {
expect(normalizeDataGridCopyPreference(undefined)).toBe("smart"); expect(normalizeDataGridCopyPreference(undefined)).toBe("smart");
expect(normalizeDataGridCopyPreference("smart")).toBe("smart"); expect(normalizeDataGridCopyPreference("smart")).toBe("smart");
@@ -1,5 +1,5 @@
import { describe, expect, it } from "vitest"; import { describe, expect, it } from "vitest";
import { buildDeleteRowConfirmDetails } from "../dataGridDetail"; import { buildDeleteRowConfirmDetails, dataGridColumnDetailTsv, dataGridRowDetailTsv, type DataGridColumnDetail, type DataGridRowDetail } from "../dataGridDetail";
type TestRow = string[]; type TestRow = string[];
@@ -131,3 +131,14 @@ describe("buildDeleteRowConfirmDetails", () => {
expect(result).toBe('Table: people\n{"id":"custom:1","name":"custom:Alice"}'); expect(result).toBe('Table: people\n{"id":"custom:1","name":"custom:Alice"}');
}); });
}); });
describe("data grid detail TSV", () => {
it("leaves NULL cells empty while preserving literal NULL text", () => {
const fields = [{ value: null }, { value: "NULL" }] as unknown as DataGridRowDetail["fields"];
const rowDetail = { fields } as DataGridRowDetail;
const columnDetail = { fields } as DataGridColumnDetail;
expect(dataGridRowDetailTsv(rowDetail)).toBe("\tNULL");
expect(dataGridColumnDetailTsv(columnDetail)).toBe("\nNULL");
});
});
@@ -10,6 +10,10 @@ export function displayCellValue(value: CellValue): string {
return String(value); return String(value);
} }
export function clipboardCellValue(value: CellValue): string {
return value === null ? "" : displayCellValue(value);
}
export function firstLineCellDisplayValue(value: string, flatteningMultiLine: boolean): string { export function firstLineCellDisplayValue(value: string, flatteningMultiLine: boolean): string {
const lineBreakPattern = /\r\n|\r|\n/g; const lineBreakPattern = /\r\n|\r|\n/g;
if (flatteningMultiLine) { if (flatteningMultiLine) {
@@ -136,7 +136,7 @@ export const DEFAULT_DATA_GRID_EXTRACTOR_OPTIONS: DataGridExtractorOptions = {
dsv: { dsv: {
columnSeparator: ",", columnSeparator: ",",
rowSeparator: "\n", rowSeparator: "\n",
nullText: "NULL", nullText: "",
quote: '"', quote: '"',
quotePolicy: "minimal", quotePolicy: "minimal",
includeColumnHeader: false, includeColumnHeader: false,
@@ -1,5 +1,5 @@
import { cellImagePreviewUrl } from "@/lib/dataGrid/cellImageUrl"; import { cellImagePreviewUrl } from "@/lib/dataGrid/cellImageUrl";
import { displayCellValue, type CellValue } from "@/lib/dataGrid/cellValue"; import { clipboardCellValue, displayCellValue, type CellValue } from "@/lib/dataGrid/cellValue";
import { formatJsonText } from "@/lib/dataGrid/cellDetailPresentation"; import { formatJsonText } from "@/lib/dataGrid/cellDetailPresentation";
import type { DatabaseType } from "@/types/database"; import type { DatabaseType } from "@/types/database";
@@ -215,7 +215,7 @@ export function jsonDetailDisplayValue(value: unknown): unknown {
} }
export function dataGridRowDetailTsv(detail: DataGridRowDetail): string { export function dataGridRowDetailTsv(detail: DataGridRowDetail): string {
return detail.fields.map((field) => displayCellValue(field.value)).join("\t"); return detail.fields.map((field) => clipboardCellValue(field.value)).join("\t");
} }
export function dataGridColumnDetailJson(detail: DataGridColumnDetail): string { export function dataGridColumnDetailJson(detail: DataGridColumnDetail): string {
@@ -230,7 +230,7 @@ export function dataGridColumnDetailJson(detail: DataGridColumnDetail): string {
} }
export function dataGridColumnDetailTsv(detail: DataGridColumnDetail): string { export function dataGridColumnDetailTsv(detail: DataGridColumnDetail): string {
return detail.fields.map((field) => displayCellValue(field.value)).join("\n"); return detail.fields.map((field) => clipboardCellValue(field.value)).join("\n");
} }
export interface BuildDeleteRowConfirmDetailsOptions<TRow> { export interface BuildDeleteRowConfirmDetailsOptions<TRow> {
@@ -2,7 +2,8 @@ use super::{value_text, write_bytes, DataGridExtractError, ExtractContext};
use std::io::Write; use std::io::Write;
/// Writes selected cell values without DSV escaping. Tabs and newlines retain /// Writes selected cell values without DSV escaping. Tabs and newlines retain
/// the selection shape, while each value itself remains unchanged. /// the selection shape, while NULL cells remain empty for spreadsheet-friendly
/// clipboard output.
pub(super) fn write_raw(context: &ExtractContext<'_>, output: &mut dyn Write) -> Result<(), DataGridExtractError> { pub(super) fn write_raw(context: &ExtractContext<'_>, output: &mut dyn Write) -> Result<(), DataGridExtractError> {
for (row_index, row) in context.request.rows.iter().enumerate() { for (row_index, row) in context.request.rows.iter().enumerate() {
if row_index > 0 { if row_index > 0 {
@@ -12,7 +13,9 @@ pub(super) fn write_raw(context: &ExtractContext<'_>, output: &mut dyn Write) ->
if column_index > 0 { if column_index > 0 {
write_bytes(output, b"\t")?; write_bytes(output, b"\t")?;
} }
write_bytes(output, value_text(&row[*source_index]).as_bytes())?; if !row[*source_index].is_null() {
write_bytes(output, value_text(&row[*source_index]).as_bytes())?;
}
} }
} }
Ok(()) Ok(())
@@ -65,6 +65,18 @@ fn extracts_raw_values_without_escaping_quotes() {
assert_eq!(result.mime_type, "text/plain"); assert_eq!(result.mime_type, "text/plain");
} }
#[test]
fn raw_exports_null_as_an_empty_value() {
let mut request = request(DataGridExtractorId::Raw);
request.columns = vec![column("name", 0)];
request.selected_column_indexes = vec![0];
request.rows = vec![vec![Value::Null]];
let result = extract_data_grid_selection(request).expect("raw extraction");
assert_eq!(result.text, "");
}
#[test] #[test]
fn raw_rejects_multiple_selected_cells() { fn raw_rejects_multiple_selected_cells() {
let error = let error =
+2 -2
View File
@@ -222,7 +222,7 @@ test("dataGridRowDetailJson and dataGridRowDetailTsv format copy payloads", () =
assert.equal(dataGridRowDetailJson(detail), '{\n "id": 1,\n "name": "Ada",\n "nickname": null\n}'); assert.equal(dataGridRowDetailJson(detail), '{\n "id": 1,\n "name": "Ada",\n "nickname": null\n}');
assert.equal(dataGridRowDetailJson(detail, { id: 1, profile: { city: "Shanghai" } }), '{\n "id": 1,\n "profile": {\n "city": "Shanghai"\n }\n}'); assert.equal(dataGridRowDetailJson(detail, { id: 1, profile: { city: "Shanghai" } }), '{\n "id": 1,\n "profile": {\n "city": "Shanghai"\n }\n}');
assert.equal(dataGridRowDetailTsv(detail), "1\tAda\tNULL"); assert.equal(dataGridRowDetailTsv(detail), "1\tAda\t");
}); });
test("dataGridRowDetailJson uses the original MongoDB document for nested values", () => { test("dataGridRowDetailJson uses the original MongoDB document for nested values", () => {
@@ -305,7 +305,7 @@ test("dataGridColumnDetailJson and dataGridColumnDetailTsv format copy payloads"
assert.ok(detail); assert.ok(detail);
assert.equal(dataGridColumnDetailJson(detail), '[\n {\n "row": 1,\n "value": "Ada"\n },\n {\n "row": 2,\n "value": null\n }\n]'); assert.equal(dataGridColumnDetailJson(detail), '[\n {\n "row": 1,\n "value": "Ada"\n },\n {\n "row": 2,\n "value": null\n }\n]');
assert.equal(dataGridColumnDetailTsv(detail), "Ada\nNULL"); assert.equal(dataGridColumnDetailTsv(detail), "Ada\n");
}); });
const detailFields: DataGridCellDetail[] = [ const detailFields: DataGridCellDetail[] = [