fix(feishu): clean up bitable placeholder rows with empty defaults

Preserve the Feishu-local cleanup path while matching the Lark SDK record value shapes: recursively delete default-empty strings, nulls, arrays, and nested text spans, but keep meaningful links, attachments, users, locations, numbers, and booleans.\n\nCarries forward #40602. Thanks @boat2moon.
This commit is contained in:
openclaw-clownfish[bot]
2026-04-30 04:01:49 +01:00
committed by GitHub
parent 0e97f962ac
commit 873df76132
3 changed files with 162 additions and 1 deletions

View File

@@ -0,0 +1,131 @@
import type * as Lark from "@larksuiteoapi/node-sdk";
import { beforeEach, describe, expect, it, vi } from "vitest";
import type { OpenClawPluginApi } from "../runtime-api.js";
import { createToolFactoryHarness } from "./tool-factory-test-harness.js";
const createFeishuClientMock = vi.hoisted(() => vi.fn());
vi.mock("./client.js", () => ({
createFeishuClient: createFeishuClientMock,
}));
import { registerFeishuBitableTools } from "./bitable.js";
type MockRecord = {
record_id?: string;
fields?: Record<string, unknown>;
};
function createConfig(): OpenClawPluginApi["config"] {
return {
channels: {
feishu: {
enabled: true,
accounts: {
default: {
appId: "cli_default",
appSecret: "secret_default", // pragma: allowlist secret
},
},
},
},
} as OpenClawPluginApi["config"];
}
function createBitableClient(records: MockRecord[]) {
const batchDelete = vi.fn(async () => ({ code: 0 }));
const client = {
bitable: {
app: {
create: vi.fn(async () => ({
code: 0,
data: {
app: {
app_token: "app_token",
name: "Project Tracker",
url: "https://example.feishu.cn/base/app_token",
},
},
})),
},
appTable: {
list: vi.fn(async () => ({
code: 0,
data: { items: [{ table_id: "tbl_main", name: "Table 1" }] },
})),
},
appTableField: {
list: vi.fn(async () => ({ code: 0, data: { items: [] } })),
update: vi.fn(async () => ({ code: 0 })),
delete: vi.fn(async () => ({ code: 0 })),
},
appTableRecord: {
list: vi.fn(async () => ({ code: 0, data: { items: records } })),
batchDelete,
delete: vi.fn(async () => ({ code: 0 })),
},
},
} as unknown as Lark.Client;
return { batchDelete, client };
}
describe("feishu bitable create app cleanup", () => {
beforeEach(() => {
createFeishuClientMock.mockReset();
});
it("deletes placeholder rows whose fields contain only default empty values", async () => {
const { batchDelete, client } = createBitableClient([
{ record_id: "rec_missing_fields" },
{ record_id: "rec_empty_fields", fields: {} },
{
record_id: "rec_empty_defaults",
fields: {
Name: "",
Status: [],
Attachments: [],
Started: null,
EmptyObject: {},
},
},
{
record_id: "rec_empty_rich_text",
fields: { Notes: [{ type: "text", text: "" }] },
},
{
record_id: "rec_empty_nested",
fields: { Notes: { value: "", segments: [{ type: "text", text: "" }] } },
},
{ record_id: "rec_text", fields: { Name: "Milestone" } },
{ record_id: "rec_number", fields: { Estimate: 0 } },
{ record_id: "rec_boolean", fields: { Done: false } },
{ record_id: "rec_link", fields: { Link: { text: "", link: "https://example.com" } } },
{ record_id: "rec_attachment", fields: { Attachments: [{ file_token: "boxcn_token" }] } },
{ record_id: "rec_user", fields: { Assignee: [{ id: "ou_1", name: "" }] } },
{ record_id: "rec_location", fields: { Location: { name: "", location: "116,39" } } },
]);
createFeishuClientMock.mockReturnValue(client);
const { api, resolveTool } = createToolFactoryHarness(createConfig());
registerFeishuBitableTools(api);
const result = await resolveTool("feishu_bitable_create_app").execute("call", {
name: "Project Tracker",
});
expect(result.details.cleaned_placeholder_rows).toBe(5);
expect(batchDelete).toHaveBeenCalledWith({
path: { app_token: "app_token", table_id: "tbl_main" },
data: {
records: [
"rec_missing_fields",
"rec_empty_fields",
"rec_empty_defaults",
"rec_empty_rich_text",
"rec_empty_nested",
],
},
});
});
});

View File

@@ -245,6 +245,35 @@ type CleanupLogger = {
/** Default field types created for new Bitable tables (to be cleaned up) */
const DEFAULT_CLEANUP_FIELD_TYPES = new Set([3, 5, 17]); // SingleSelect, DateTime, Attachment
function isDefaultEmptyBitableFieldValue(value: unknown): boolean {
if (value === undefined || value === null || value === "") {
return true;
}
if (Array.isArray(value)) {
return value.every(isDefaultEmptyBitableFieldValue);
}
if (typeof value === "object") {
const record = value as Record<string, unknown>;
const keys = Object.keys(record);
if (keys.length === 0) {
return true;
}
if ("text" in record && keys.every((key) => key === "text" || key === "type")) {
return record.text === undefined || record.text === null || record.text === "";
}
return Object.values(record).every(isDefaultEmptyBitableFieldValue);
}
return false;
}
function isPlaceholderBitableRecord(fields: unknown): boolean {
if (!fields || typeof fields !== "object" || Array.isArray(fields)) {
return true;
}
const values = Object.values(fields);
return values.every(isDefaultEmptyBitableFieldValue);
}
/** Clean up default placeholder rows and fields in a newly created Bitable table */
async function cleanupNewBitable(
client: Lark.Client,
@@ -315,7 +344,7 @@ async function cleanupNewBitable(
if (recordsRes.code === 0 && recordsRes.data?.items) {
const emptyRecordIds = recordsRes.data.items
.filter((r) => !r.fields || Object.keys(r.fields).length === 0)
.filter((r) => isPlaceholderBitableRecord(r.fields))
.map((r) => r.record_id)
.filter((id): id is string => Boolean(id));