Files
calendar/apps/web/test/lib/generateCsv.test.ts
T

229 lines
6.6 KiB
TypeScript

import type { Table } from "@tanstack/react-table";
import { describe, it, expect, vi } from "vitest";
import type { UserTableUser } from "@calcom/features/users/components/UserTable/types";
import { generateCsvRaw, generateHeaderFromReactTable } from "@calcom/lib/csvUtils";
import type { MembershipRole } from "@calcom/prisma/enums";
function createMockTable(data: UserTableUser[]): Table<UserTableUser> {
return {
getHeaderGroups: vi.fn().mockReturnValue([
{
headers: [
{
id: "select",
column: { columnDef: { header: "" } },
getContext: () => ({}),
},
{
id: "member",
column: { columnDef: { header: "Members" } },
getContext: () => ({}),
},
{
id: "role",
column: { columnDef: { header: "Role" } },
getContext: () => ({}),
},
{
id: "teams",
column: { columnDef: { header: "Teams" } },
getContext: () => ({}),
},
{
id: "attr1",
column: { columnDef: { header: () => "Attribute 1" } },
getContext: () => ({}),
},
{
id: "attr2",
column: { columnDef: { header: () => "Attribute 2" } },
getContext: () => ({}),
},
{
id: "actions",
column: { columnDef: { header: "" } },
getContext: () => ({}),
},
],
},
]),
getRowModel: vi.fn().mockReturnValue({ rows: data.map((item) => ({ original: item })) }),
} as unknown as Table<UserTableUser>;
}
describe("generate Csv for Org Users Table", () => {
const mockAttributeIds = ["attr1", "attr2"];
const HEADER_IDS_TO_EXCLUDE = ["select", "actions"];
const mockUser: UserTableUser = {
id: 1,
username: "testuser",
email: "test@example.com",
timeZone: "UTC",
role: "MEMBER" as MembershipRole,
avatarUrl: null,
accepted: true,
disableImpersonation: false,
completedOnboarding: true,
teams: [],
attributes: [],
};
it("should return null if no headers", () => {
const mockTableNoHeaders = {
getHeaderGroups: vi.fn().mockReturnValue([]),
} as unknown as Table<UserTableUser>;
expect(generateCsvRaw([], [], mockAttributeIds)).toBeNull();
});
it("should generate correct CSV headers", () => {
const mockTable = createMockTable([]);
const csv = generateCsvRaw(
generateHeaderFromReactTable(mockTable, HEADER_IDS_TO_EXCLUDE) ?? [],
[],
mockAttributeIds
);
const headers = csv?.split("\n")[0];
expect(headers).toBe("Members,Role,Teams,Attribute 1,Attribute 2");
});
it("should handle user with single attribute value", () => {
const mockData: UserTableUser[] = [
{
...mockUser,
teams: [{ id: 1, name: "Team1", slug: "team1" }],
attributes: [{ id: "1", attributeId: "attr1", value: "value1", slug: "slug1" }],
},
];
const mockTable = createMockTable(mockData);
const csv = generateCsvRaw(
generateHeaderFromReactTable(mockTable, HEADER_IDS_TO_EXCLUDE) ?? [],
mockData,
mockAttributeIds
);
expect(csv).toMatchInlineSnapshot(`
"Members,Role,Teams,Attribute 1,Attribute 2
test@example.com,MEMBER,Team1,value1,"
`);
});
it("should handle user with multiple attribute values for same attribute", () => {
const mockData: UserTableUser[] = [
{
...mockUser,
teams: [{ id: 1, name: "Team1", slug: "team1" }],
attributes: [
{ id: "1", attributeId: "attr1", value: "value1", slug: "slug1" },
{ id: "2", attributeId: "attr1", value: "value2", slug: "slug1" },
],
},
];
const mockTable = createMockTable(mockData);
const csv = generateCsvRaw(
generateHeaderFromReactTable(mockTable, HEADER_IDS_TO_EXCLUDE) ?? [],
mockData,
mockAttributeIds
);
expect(csv).toMatchInlineSnapshot(`
"Members,Role,Teams,Attribute 1,Attribute 2
test@example.com,MEMBER,Team1,"value1,value2","
`);
});
it("should handle user with multiple teams", () => {
const mockData: UserTableUser[] = [
{
...mockUser,
teams: [
{ id: 1, name: "Team1", slug: "team1" },
{ id: 2, name: "Team2", slug: "team2" },
],
attributes: [],
},
];
const mockTable = createMockTable(mockData);
const csv = generateCsvRaw(
generateHeaderFromReactTable(mockTable, HEADER_IDS_TO_EXCLUDE) ?? [],
mockData,
mockAttributeIds
);
expect(csv).toMatchInlineSnapshot(`
"Members,Role,Teams,Attribute 1,Attribute 2
test@example.com,MEMBER,"Team1,Team2",,"
`);
});
it("should handle values that need sanitization", () => {
const mockData: UserTableUser[] = [
{
...mockUser,
teams: [{ id: 1, name: "Team,1", slug: "team1" }],
attributes: [{ id: "1", attributeId: "attr1", value: "value,1", slug: "slug1" }],
},
];
const mockTable = createMockTable(mockData);
const csv = generateCsvRaw(
generateHeaderFromReactTable(mockTable, HEADER_IDS_TO_EXCLUDE) ?? [],
mockData,
mockAttributeIds
);
expect(csv).toMatchInlineSnapshot(`
"Members,Role,Teams,Attribute 1,Attribute 2
test@example.com,MEMBER,"Team,1","value,1","
`);
});
it("should handle all membership roles", () => {
const roles: MembershipRole[] = ["OWNER", "ADMIN", "MEMBER"];
const mockData: UserTableUser[] = roles.map((role) => ({
...mockUser,
role,
email: `${role.toLowerCase()}@example.com`,
}));
const mockTable = createMockTable(mockData);
const csv = generateCsvRaw(
generateHeaderFromReactTable(mockTable, HEADER_IDS_TO_EXCLUDE) ?? [],
mockData,
mockAttributeIds
);
expect(csv).toMatchInlineSnapshot(`
"Members,Role,Teams,Attribute 1,Attribute 2
owner@example.com,OWNER,,,
admin@example.com,ADMIN,,,
member@example.com,MEMBER,,,"
`);
});
it("should handle users without teams and attributes", () => {
const mockData: UserTableUser[] = [
{
...mockUser,
username: null,
avatarUrl: null,
},
];
const mockTable = createMockTable(mockData);
const csv = generateCsvRaw(
generateHeaderFromReactTable(mockTable, HEADER_IDS_TO_EXCLUDE) ?? [],
mockData,
mockAttributeIds
);
expect(csv).toMatchInlineSnapshot(`
"Members,Role,Teams,Attribute 1,Attribute 2
test@example.com,MEMBER,,,"
`);
});
});