Skip to content

Build your own AI office with Univer Office SDK. Bring editing, calculation, collaboration, and file processing into your product for people and AI agents. Built on an extensible open-source core.

15.4 KB
Raw Blame
/**
 * Copyright 2023-present DreamNum Co., Ltd.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

import type { ITableColorFilterItem } from '../../types/type';
import { CellValueType, ThemeColorType } from '@univerjs/core';
import { describe, expect, it } from 'vitest';
import { TABLE_FILTER_EMPTY_VALUE } from '../../const';
import {
    SheetsTableButtonStateEnum,
    SheetsTableSortStateEnum,
    TableColumnDataTypeEnum,
    TableColumnFilterTypeEnum,
    TableConditionTypeEnum,
    TableNumberCompareTypeEnum,
} from '../../types/enum';
import { Table } from '../table';
import { TableColumn } from '../table-column';
import { TableFilters } from '../table-filter';

describe('Table model', () => {
    it('restores a visible footer from constructor options', () => {
        const table = new Table(
            'table-1',
            'Sales',
            { startRow: 0, endRow: 4, startColumn: 0, endColumn: 1 },
            ['Region', 'Amount'],
            { showFooter: true }
        );

        expect(table.isShowFooter()).toBe(true);
        expect(table.getTableFilterRange()).toEqual({
            startRow: 1,
            endRow: 3,
            startColumn: 0,
            endColumn: 1,
        });
        expect(table.toJSON().options.showFooter).toBe(true);
    });

    it('preserves dormant totals row definitions while the footer is hidden', () => {
        const table = new Table('placeholder', 'Placeholder', { startRow: 0, endRow: 0, startColumn: 0, endColumn: 0 }, []);
        table.fromJSON({
            id: 'table-1',
            name: 'StartTbl',
            range: { startRow: 0, endRow: 4, startColumn: 0, endColumn: 0 },
            options: {
                showFooter: false,
            },
            filters: {},
            columns: [{
                id: 'column-time',
                displayName: 'Time',
                dataType: TableColumnDataTypeEnum.String,
                formula: '+StartTbl[Time]+0.5/24',
                formulaIsArray: true,
                totalsRowFunction: 'custom',
                totalsRowFormula: '+StartTbl[Time]+0.5/24',
                meta: {},
                style: {},
            }],
            meta: {},
        });

        const snapshot = table.toJSON();
        const restored = new Table('placeholder', 'Placeholder', { startRow: 0, endRow: 0, startColumn: 0, endColumn: 0 }, []);
        restored.fromJSON(snapshot);

        expect(restored.toJSON().options.showFooter).toBe(false);
        expect(restored.toJSON().columns.find((column) => column.id === 'column-time')).toEqual(expect.objectContaining({
            formulaIsArray: true,
            totalsRowFunction: 'custom',
            totalsRowFormula: '+StartTbl[Time]+0.5/24',
        }));
    });

    it('preserves table and column filter-button visibility', () => {
        const table = new Table('placeholder', 'Placeholder', { startRow: 0, endRow: 0, startColumn: 0, endColumn: 0 }, []);
        table.fromJSON({
            id: 'table-1',
            name: 'HiddenFilters',
            range: { startRow: 0, endRow: 2, startColumn: 0, endColumn: 1 },
            options: { showAutoFilter: false },
            filters: {},
            columns: [
                { id: 'c1', displayName: 'Visible', dataType: TableColumnDataTypeEnum.String, formula: '', meta: {}, style: {} },
                { id: 'c2', displayName: 'Hidden', dataType: TableColumnDataTypeEnum.String, formula: '', showFilterButton: false, meta: {}, style: {} },
            ],
            meta: {},
        });

        const snapshot = table.toJSON();
        expect(table.isShowAutoFilter()).toBe(false);
        expect(table.getTableInfo().showAutoFilter).toBe(false);
        expect(snapshot.options.showAutoFilter).toBe(false);
        expect(snapshot.columns[0].showFilterButton).toBe(true);
        expect(snapshot.columns[1].showFilterButton).toBe(false);
    });

    it('builds a table from headers, tracks metadata, and serializes user changes', () => {
        const table = new Table(
            'table-1',
            'QuarterlySales',
            { startRow: 0, endRow: 4, startColumn: 0, endColumn: 1 },
            ['Region', 'Amount'],
            {
                showHeader: true,
                tableStyleId: 'theme-2',
                columns: [
                    { id: 'column-region', displayName: 'Region', dataType: TableColumnDataTypeEnum.String, formula: '', meta: {}, style: {} },
                    { id: 'column-amount', displayName: 'Amount', dataType: TableColumnDataTypeEnum.String, formula: '', meta: {}, style: {} },
                ],
            }
        );

        table.setSubunitId('sheet-1');
        table.setTableMeta({ owner: 'ops' });
        table.insertColumn(2, new TableColumn('column-margin', 'Margin'));
        table.removeColumn(2);
        table.setDisplayName('FY Sales');
        table.setRange({ startRow: 1, endRow: 6, startColumn: 0, endColumn: 1 });

        expect(table.getTableFilterRange()).toEqual({
            startRow: 2,
            endRow: 6,
            startColumn: 0,
            endColumn: 1,
        });
        expect(table.getColumnsCount()).toBe(2);
        expect(table.getColumnNameByIndex(1)).toBe('Amount');
        expect(table.getTableInfo()).toEqual(expect.objectContaining({
            id: 'table-1',
            subUnitId: 'sheet-1',
            name: 'FY Sales',
            range: { startRow: 1, endRow: 6, startColumn: 0, endColumn: 1 },
            meta: { owner: 'ops' },
            showHeader: true,
            columns: expect.arrayContaining([
                expect.objectContaining({ id: 'column-region', displayName: 'Region' }),
                expect.objectContaining({ id: 'column-amount', displayName: 'Amount' }),
            ]),
        }));
        expect(table.getTableConfig()).toEqual({
            name: 'FY Sales',
            range: { startRow: 1, endRow: 6, startColumn: 0, endColumn: 1 },
            options: {
                showHeader: true,
                showFooter: false,
                showAutoFilter: true,
            },
            tableStyleId: 'theme-2',
        });

        const snapshot = table.toJSON();
        const restored = new Table('placeholder', 'Placeholder', { startRow: 0, endRow: 0, startColumn: 0, endColumn: 0 }, []);
        restored.fromJSON(snapshot);

        expect(restored.getDisplayName()).toBe('FY Sales');
        expect(restored.getRangeInfo()).toEqual({ startRow: 1, endRow: 6, startColumn: 0, endColumn: 1 });
        expect(restored.getTableMeta()).toEqual({ owner: 'ops' });
        expect(restored.toJSON().columns).toEqual(expect.arrayContaining([
            expect.objectContaining({ id: 'column-region', displayName: 'Region' }),
            expect.objectContaining({ id: 'column-amount', displayName: 'Amount' }),
        ]));

        restored.dispose();
        expect(restored.getColumnsCount()).toBe(0);
    });
});

describe('TableFilters', () => {
    it('filters rows by manual lists and condition rules like a real table filter popup', () => {
        const filters = new TableFilters();
        const sheet = {
            getCell(row: number, column: number) {
                const cells = [
                    [{ v: 'East' }, { v: 12, t: CellValueType.NUMBER }],
                    [{ v: 'West' }, { v: 5, t: CellValueType.NUMBER }],
                    [{ v: 'East' }, { v: 20, t: CellValueType.NUMBER }],
                    [null, { v: 30, t: CellValueType.NUMBER }],
                ];

                return cells[row]?.[column] ?? null;
            },
            getCellRaw(row: number, column: number) {
                return this.getCell(row, column);
            },
        };
        const range = { startRow: 0, endRow: 3, startColumn: 0, endColumn: 1 };

        filters.setColumnFilter(0, {
            filterType: TableColumnFilterTypeEnum.manual,
            values: ['East', TABLE_FILTER_EMPTY_VALUE],
        } as never);
        filters.setColumnFilter(1, {
            filterType: TableColumnFilterTypeEnum.condition,
            filterInfo: {
                conditionType: TableConditionTypeEnum.Number,
                compareType: TableNumberCompareTypeEnum.GreaterThan,
                expectedValue: [10],
            },
        } as never);
        filters.setSortState(0, SheetsTableSortStateEnum.Asc);

        const filteredOutRows = filters.doFilter(sheet as never, range);

        expect([...filteredOutRows]).toEqual([1]);
        expect(filters.getColumnFilter(0)).toEqual({
            filterType: TableColumnFilterTypeEnum.manual,
            values: ['East', TABLE_FILTER_EMPTY_VALUE],
        });
        expect(filters.getFilterState(0)).toBe(SheetsTableButtonStateEnum.FilteredSortAsc);
        expect(filters.getFilterStates(range)).toEqual([
            SheetsTableButtonStateEnum.FilteredSortAsc,
            SheetsTableButtonStateEnum.FilteredSortNone,
        ]);
        expect(filters.getFilterOutRows()).toBe(filteredOutRows);
        expect(filters.toJSON()).toEqual({
            tableColumnFilterList: [
                { filterType: TableColumnFilterTypeEnum.manual, values: ['East', TABLE_FILTER_EMPTY_VALUE] },
                {
                    filterType: TableColumnFilterTypeEnum.condition,
                    filterInfo: {
                        conditionType: TableConditionTypeEnum.Number,
                        compareType: TableNumberCompareTypeEnum.GreaterThan,
                        expectedValue: [10],
                    },
                },
            ],
            tableSortInfo: { columnIndex: 0, sortState: SheetsTableSortStateEnum.Asc },
        });

        filters.setColumnFilter(0, undefined);
        filters.setColumnFilter(1, {
            filterType: TableColumnFilterTypeEnum.manual,
            values: ['12', '20'],
        });
        expect([...filters.doFilter(sheet as never, range)]).toEqual([1, 3]);

        filters.dispose();
        expect(filters.toJSON().tableColumnFilterList).toEqual([]);
    });

    it('filters rows by cell fill colors', () => {
        const filters = new TableFilters();
        const cells = [
            { v: 'Red', s: { bg: { rgb: '#ff0000' } } },
            { v: 'Blue', s: { bg: { rgb: '#0000ff' } } },
            { v: 'Default' },
        ];
        const sheet = {
            getCell(row: number) {
                return cells[row] ?? null;
            },
            getCellRaw(row: number) {
                return this.getCell(row);
            },
            getComposedCellStyleByCellData(_row: number, _column: number, cell: typeof cells[number]) {
                return cell?.s ?? {};
            },
        };

        filters.setColumnFilter(0, {
            filterType: TableColumnFilterTypeEnum.color,
            cellFillColors: ['rgb(255, 0, 0)'],
        });

        expect([...filters.doFilter(sheet as never, {
            startRow: 0,
            endRow: 2,
            startColumn: 0,
            endColumn: 0,
        })]).toEqual([1, 2]);
    });

    it('filters rows by theme fill colors', () => {
        const filters = new TableFilters();
        const cells = [
            { v: 'Theme', s: { bg: { th: ThemeColorType.ACCENT1 } } },
            { v: 'Red', s: { bg: { rgb: '#ff0000' } } },
        ];
        const sheet = {
            getCell(row: number) {
                return cells[row] ?? null;
            },
            getCellRaw(row: number) {
                return this.getCell(row);
            },
            getComposedCellStyleByCellData(_row: number, _column: number, cell: typeof cells[number]) {
                return cell?.s ?? {};
            },
        };

        filters.setColumnFilter(0, {
            filterType: TableColumnFilterTypeEnum.color,
            cellFillColors: ['rgb(68, 114, 196)'],
        });

        expect([...filters.doFilter(sheet as never, {
            startRow: 0,
            endRow: 1,
            startColumn: 0,
            endColumn: 0,
        })]).toEqual([1]);
    });

    it('filters rows by the default fill color', () => {
        const filters = new TableFilters();
        const cells = [
            { v: 'Red', s: { bg: { rgb: '#ff0000' } } },
            { v: 'Default' },
        ];
        const sheet = {
            getCell(row: number) {
                return cells[row] ?? null;
            },
            getCellRaw(row: number) {
                return this.getCell(row);
            },
            getComposedCellStyleByCellData(_row: number, _column: number, cell: typeof cells[number]) {
                return cell?.s ?? {};
            },
        };

        filters.setColumnFilter(0, {
            filterType: TableColumnFilterTypeEnum.color,
            cellFillColors: [null],
        });

        expect([...filters.doFilter(sheet as never, {
            startRow: 0,
            endRow: 1,
            startColumn: 0,
            endColumn: 0,
        })]).toEqual([0]);
    });

    it('filters rows by cell text colors and preserves the filter in JSON', () => {
        const filters = new TableFilters();
        const cells = [
            { v: 'Red', s: { cl: { rgb: '#ff0000' } } },
            { v: 'Blue', s: { cl: { rgb: '#0000ff' } } },
            { v: 'Default' },
        ];
        const sheet = {
            getCell(row: number) {
                return cells[row] ?? null;
            },
            getCellRaw(row: number) {
                return this.getCell(row);
            },
            getComposedCellStyleByCellData(_row: number, _column: number, cell: typeof cells[number]) {
                return cell?.s ?? {};
            },
        };
        const filter: ITableColorFilterItem = {
            filterType: TableColumnFilterTypeEnum.color,
            cellTextColors: ['rgb(0, 0, 255)'],
        };

        filters.setColumnFilter(0, filter);

        expect([...filters.doFilter(sheet as never, {
            startRow: 0,
            endRow: 2,
            startColumn: 0,
            endColumn: 0,
        })]).toEqual([0, 2]);
        expect(filters.toJSON().tableColumnFilterList).toEqual([filter]);

        const restored = new TableFilters();
        restored.fromJSON(filters.toJSON());
        expect(restored.getColumnFilter(0)).toEqual(filter);
    });

    it('treats the default text color as black', () => {
        const filters = new TableFilters();
        const cells = [
            { v: 'Blue', s: { cl: { rgb: '#0000ff' } } },
            { v: 'Default', s: { cl: { rgb: null } } },
        ];
        const sheet = {
            getCell(row: number) {
                return cells[row] ?? null;
            },
            getCellRaw(row: number) {
                return this.getCell(row);
            },
            getComposedCellStyleByCellData(_row: number, _column: number, cell: typeof cells[number]) {
                return cell?.s ?? {};
            },
        };

        filters.setColumnFilter(0, {
            filterType: TableColumnFilterTypeEnum.color,
            cellTextColors: ['rgb(0, 0, 0)'],
        });

        expect([...filters.doFilter(sheet as never, {
            startRow: 0,
            endRow: 1,
            startColumn: 0,
            endColumn: 0,
        })]).toEqual([0]);
    });
});