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.8 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 { ICommandService } from '@univerjs/core';
import { SHEET_VIEWPORT_KEY, TRANSFORM_CHANGE_OBSERVABLE_TYPE } from '@univerjs/engine-render';
import { SetFrozenCommand, SetWorksheetActiveOperation, SheetSkeletonService } from '@univerjs/sheets';
import { BehaviorSubject } from 'rxjs';
import { describe, expect, it, vi } from 'vitest';
import { SheetScrollManagerService } from '../../../services/scroll-manager.service';
import { SheetSkeletonManagerService } from '../../../services/sheet-skeleton-manager.service';
import { HeaderFreezeRenderController } from '../freeze.render-controller';
import { createRenderTestBed } from './render-test-bed';

describe('HeaderFreezeRenderController', () => {
    it.each([
        { startRow: 3, startColumn: -1, ySplit: 3, xSplit: 0 },
        { startRow: 3, startColumn: 2, ySplit: 3, xSplit: 2 },
    ])('keeps the leading Table title gap visible with freeze config %j', (freeze) => {
        const testBed = createRenderTestBed();
        const { sheet, context, viewportMap } = testBed;
        const injector = testBed.injector.createChild();
        injector.add([SheetSkeletonService]);
        injector.add([SheetSkeletonManagerService, {
            useFactory: function createSkeletonManager() {
                return injector.createInstance(SheetSkeletonManagerService, context);
            },
        }]);
        injector.add([SheetScrollManagerService, {
            useFactory: function createScrollManager() {
                return injector.createInstance(SheetScrollManagerService, context);
            },
        }]);
        injector.add([HeaderFreezeRenderController, {
            useFactory: function createFreezeController() {
                return injector.createInstance(HeaderFreezeRenderController, context);
            },
        }]);

        try {
            const manager = injector.get(SheetSkeletonManagerService);
            const worksheet = sheet.getActiveSheet();
            manager.setCurrent({ sheetId: worksheet.getSheetId() });
            const skeleton = manager.getCurrentSkeleton()!;
            const frozenRowsHeight = skeleton.getNoMergeCellWithCoordByIndex(3, 0, false).startY;
            const headerHeight = skeleton.columnHeaderHeightAndMarginTop;
            skeleton.setGapConfig({ rowGaps: { 0: { size: 32 } } });
            worksheet.getConfig().freeze = freeze;
            injector.get(HeaderFreezeRenderController);
            // A scene scale refresh also applies the initial freeze layout.
            testBed.scene.onTransformChange$.emit({
                type: TRANSFORM_CHANGE_OBSERVABLE_TYPE.scale,
                value: { scaleX: 1, scaleY: 1 },
            }, { stopPropagation: () => {} });

            const viewMain = viewportMap.get(SHEET_VIEWPORT_KEY.VIEW_MAIN)!;
            const viewMainTop = viewportMap.get(SHEET_VIEWPORT_KEY.VIEW_MAIN_TOP)!;
            const viewRowTop = viewportMap.get(SHEET_VIEWPORT_KEY.VIEW_ROW_TOP)!;
            const viewMainLeftTop = viewportMap.get(SHEET_VIEWPORT_KEY.VIEW_MAIN_LEFT_TOP)!;
            expect(viewMainTop.viewportScrollY).toBe(0);
            expect(viewRowTop.viewportScrollY).toBe(0);
            expect(viewMainTop.height).toBe(frozenRowsHeight + 32);
            expect(viewMain.top).toBe(headerHeight + frozenRowsHeight + 32);
            if (freeze.xSplit > 0) {
                expect(viewMainLeftTop.viewportScrollY).toBe(0);
                expect(viewMainLeftTop.height).toBe(frozenRowsHeight + 32);
            }

            // Removing and recreating the top Table must resize an existing frozen area too.
            skeleton.setGapConfig({});
            expect(viewMainTop.height).toBe(frozenRowsHeight);
            expect(viewMain.top).toBe(headerHeight + frozenRowsHeight);
            skeleton.setGapConfig({ rowGaps: { 0: { size: 32 } } });
            expect(viewMainTop.height).toBe(frozenRowsHeight + 32);
            expect(viewMainTop.viewportScrollY).toBe(0);

            // A frozen range starting below row 1 must still skip the preceding rows and gap.
            worksheet.getConfig().freeze = { ...freeze, startRow: 5 };
            testBed.scene.onTransformChange$.emit({
                type: TRANSFORM_CHANGE_OBSERVABLE_TYPE.scale,
                value: { scaleX: 1, scaleY: 1 },
            }, { stopPropagation: () => {} });
            expect(viewMainTop.viewportScrollY).toBe(skeleton.getNoMergeCellWithCoordByIndex(2, 0, false).startY);

            worksheet.getConfig().freeze = { startRow: -1, startColumn: -1, ySplit: 0, xSplit: 0 };
            testBed.scene.onTransformChange$.emit({
                type: TRANSFORM_CHANGE_OBSERVABLE_TYPE.scale,
                value: { scaleX: 1, scaleY: 1 },
            }, { stopPropagation: () => {} });
            expect(viewMainTop.isActive).toBe(false);
            expect(viewMain.top).toBe(headerHeight);
        } finally {
            injector.dispose();
            testBed.univer.dispose();
        }
    });

    it('refreshes viewports when switching sheets and freeze is enabled', () => {
        const validViewportScrollInfo$ = new BehaviorSubject<any>(null);
        const scrollManagerService = {
            validViewportScrollInfo$,
            getCurrentScrollState: () => ({
                sheetViewStartRow: 0,
                sheetViewStartColumn: 0,
                offsetX: 0,
                offsetY: 0,
            }),
        };

        const testBed = createRenderTestBed({
            dependencies: [
                [SheetScrollManagerService, { useValue: scrollManagerService }],
            ],
        });

        const { sheet, injector, viewportMap, sheetSkeletonManagerService, context } = testBed;

        // Ensure active worksheet has a freeze config (freeze first 2 rows).
        const worksheet = sheet.getActiveSheet();
        const config = worksheet.getConfig();
        config.freeze = { startRow: 2, startColumn: -1, ySplit: 2, xSplit: 0 };

        injector.get(ICommandService);

        injector.createInstance(HeaderFreezeRenderController, context as any);

        // Switching sheet tabs triggers currentSkeleton$ with SetWorksheetActiveOperation.id,
        // and the controller should re-apply the freeze layout.
        sheetSkeletonManagerService.emitCurrentSkeleton({
            commandId: SetWorksheetActiveOperation.id,
        });

        const viewMainTop = viewportMap.get(SHEET_VIEWPORT_KEY.VIEW_MAIN_TOP) as any;
        const viewRowTop = viewportMap.get(SHEET_VIEWPORT_KEY.VIEW_ROW_TOP) as any;
        const viewMain = viewportMap.get(SHEET_VIEWPORT_KEY.VIEW_MAIN) as any;

        expect(viewMainTop.isActive).toBe(true);
        expect(viewRowTop.isActive).toBe(true);
        expect(viewMain.top).toBeGreaterThan(0);

        testBed.univer.dispose();
    });

    it('applies different freeze layouts when sheet freeze config changes', () => {
        const validViewportScrollInfo$ = new BehaviorSubject<any>(null);
        const scrollManagerService = {
            validViewportScrollInfo$,
            getCurrentScrollState: () => ({
                sheetViewStartRow: 0,
                sheetViewStartColumn: 0,
                offsetX: 0,
                offsetY: 0,
            }),
        };

        const testBed = createRenderTestBed({
            dependencies: [
                [SheetScrollManagerService, { useValue: scrollManagerService }],
            ],
        });

        const { sheet, injector, viewportMap, sheetSkeletonManagerService, context } = testBed;

        injector.createInstance(HeaderFreezeRenderController, context as any);

        const worksheet = sheet.getActiveSheet();
        const applyFreeze = (freeze: any) => {
            worksheet.getConfig().freeze = freeze;
            sheetSkeletonManagerService.emitCurrentSkeleton({
                commandId: SetWorksheetActiveOperation.id,
            });
        };

        const viewMainLeftTop = viewportMap.get(SHEET_VIEWPORT_KEY.VIEW_MAIN_LEFT_TOP) as any;
        const viewMainTop = viewportMap.get(SHEET_VIEWPORT_KEY.VIEW_MAIN_TOP) as any;
        const viewMainLeft = viewportMap.get(SHEET_VIEWPORT_KEY.VIEW_MAIN_LEFT) as any;
        const viewRowTop = viewportMap.get(SHEET_VIEWPORT_KEY.VIEW_ROW_TOP) as any;
        const viewColumnLeft = viewportMap.get(SHEET_VIEWPORT_KEY.VIEW_COLUMN_LEFT) as any;

        applyFreeze({ startRow: 2, startColumn: -1, ySplit: 2, xSplit: 0 });
        expect(viewMainTop.isActive).toBe(true);
        expect(viewRowTop.isActive).toBe(true);
        expect(viewMainLeft.isActive).toBe(false);
        expect(viewColumnLeft.isActive).toBe(false);

        applyFreeze({ startRow: -1, startColumn: 2, ySplit: 0, xSplit: 2 });
        expect(viewMainTop.isActive).toBe(false);
        expect(viewRowTop.isActive).toBe(false);
        expect(viewMainLeft.isActive).toBe(true);
        expect(viewColumnLeft.isActive).toBe(true);

        applyFreeze({ startRow: 2, startColumn: 2, ySplit: 2, xSplit: 2 });
        expect(viewMainLeftTop.isActive).toBe(true);
        expect(viewMainTop.isActive).toBe(true);
        expect(viewMainLeft.isActive).toBe(true);
        expect(viewRowTop.isActive).toBe(true);
        expect(viewColumnLeft.isActive).toBe(true);

        applyFreeze({ startRow: -1, startColumn: -1, ySplit: 0, xSplit: 0 });
        expect(viewMainLeftTop.isActive).toBe(false);
        expect(viewMainTop.isActive).toBe(false);
        expect(viewMainLeft.isActive).toBe(false);
        expect(viewRowTop.isActive).toBe(false);
        expect(viewColumnLeft.isActive).toBe(false);

        testBed.univer.dispose();
    });

    it('syncs freeze-side viewports with valid viewport scroll state', () => {
        const validViewportScrollInfo$ = new BehaviorSubject<any>(null);
        const scrollManagerService = {
            validViewportScrollInfo$,
            getCurrentScrollState: () => ({
                sheetViewStartRow: 0,
                sheetViewStartColumn: 0,
                offsetX: 0,
                offsetY: 0,
            }),
        };

        const testBed = createRenderTestBed({
            dependencies: [
                [SheetScrollManagerService, { useValue: scrollManagerService }],
            ],
        });

        const { sheet, injector, viewportMap, context, sheetSkeletonManagerService } = testBed;
        injector.createInstance(HeaderFreezeRenderController, context as any);

        sheet.getActiveSheet().getConfig().freeze = { startRow: 2, startColumn: 2, ySplit: 2, xSplit: 2 };
        sheetSkeletonManagerService.emitCurrentSkeleton({
            commandId: SetWorksheetActiveOperation.id,
        });

        validViewportScrollInfo$.next({
            scrollX: 36,
            scrollY: 48,
            viewportScrollX: 320,
            viewportScrollY: 260,
        });

        const viewRowBottom = viewportMap.get(SHEET_VIEWPORT_KEY.VIEW_ROW_BOTTOM) as any;
        const viewColumnRight = viewportMap.get(SHEET_VIEWPORT_KEY.VIEW_COLUMN_RIGHT) as any;
        const viewMainLeft = viewportMap.get(SHEET_VIEWPORT_KEY.VIEW_MAIN_LEFT) as any;
        const viewMainTop = viewportMap.get(SHEET_VIEWPORT_KEY.VIEW_MAIN_TOP) as any;

        expect(viewRowBottom.scrollY).toBe(48);
        expect(viewRowBottom.viewportScrollY).toBe(260);
        expect(viewColumnRight.scrollX).toBe(36);
        expect(viewColumnRight.viewportScrollX).toBe(320);
        expect(viewMainLeft.viewportScrollY).toBe(260);
        expect(viewMainTop.viewportScrollX).toBe(320);

        testBed.univer.dispose();
    });

    it('refreshes freeze layout on scene scale transform changes', () => {
        const validViewportScrollInfo$ = new BehaviorSubject<any>(null);
        const scrollManagerService = {
            validViewportScrollInfo$,
            getCurrentScrollState: () => ({
                sheetViewStartRow: 0,
                sheetViewStartColumn: 0,
                offsetX: 0,
                offsetY: 0,
            }),
        };

        const testBed = createRenderTestBed({
            dependencies: [
                [SheetScrollManagerService, { useValue: scrollManagerService }],
            ],
        });

        const { sheet, injector, viewportMap, context, scene, sheetSkeletonManagerService } = testBed;
        injector.createInstance(HeaderFreezeRenderController, context as any);

        const worksheet = sheet.getActiveSheet();
        worksheet.getConfig().freeze = { startRow: -1, startColumn: -1, ySplit: 0, xSplit: 0 };
        sheetSkeletonManagerService.emitCurrentSkeleton({
            commandId: SetWorksheetActiveOperation.id,
        });

        const viewMainTop = viewportMap.get(SHEET_VIEWPORT_KEY.VIEW_MAIN_TOP) as any;
        const viewMainLeft = viewportMap.get(SHEET_VIEWPORT_KEY.VIEW_MAIN_LEFT) as any;
        expect(viewMainTop.isActive).toBe(false);
        expect(viewMainLeft.isActive).toBe(false);

        worksheet.getConfig().freeze = { startRow: 1, startColumn: 1, ySplit: 1, xSplit: 1 };
        scene.onTransformChange$.emit({
            type: TRANSFORM_CHANGE_OBSERVABLE_TYPE.scale,
        }, { stopPropagation: () => { } });

        expect(viewMainTop.isActive).toBe(true);
        expect(viewMainLeft.isActive).toBe(true);

        testBed.univer.dispose();
    });

    it('updates sheet freeze config after dragging the row freeze divider', () => {
        const validViewportScrollInfo$ = new BehaviorSubject<any>(null);
        const scrollManagerService = {
            validViewportScrollInfo$,
            getCurrentScrollState: () => ({
                sheetViewStartRow: 0,
                sheetViewStartColumn: 0,
                offsetX: 0,
                offsetY: 0,
            }),
        };

        const testBed = createRenderTestBed({
            dependencies: [
                [SheetScrollManagerService, { useValue: scrollManagerService }],
            ],
        });

        const { sheet, injector, context, scene, viewportMap, commandService } = testBed;
        const controller = injector.createInstance(HeaderFreezeRenderController, context as any);
        const executeCommand = vi.spyOn(commandService, 'executeCommand');
        const worksheet = sheet.getActiveSheet();
        worksheet.getConfig().freeze = { startRow: 2, startColumn: -1, ySplit: 2, xSplit: 0 };
        (viewportMap.get(SHEET_VIEWPORT_KEY.VIEW_MAIN) as any).isHit = () => true;

        const headerRect = {
            transformByState: vi.fn(() => headerRect),
            setProps: vi.fn(() => headerRect),
        };
        const mainRect = {
            transformByState: vi.fn(() => mainRect),
            setProps: vi.fn(() => mainRect),
        };

        (controller as any)._freezeDown({ offsetX: 120, offsetY: 40 }, headerRect, mainRect);
        scene.onPointerMove$.emit({ offsetX: 120, offsetY: 90 }, { stopPropagation: () => { } });
        scene.onPointerUp$.emit({}, { stopPropagation: () => { } });

        expect(scene.getViewports().some((viewport: any) => viewport.isHit?.({ x: 120, y: 90 }))).toBe(true);
        expect(headerRect.transformByState).toHaveBeenCalledWith({ top: 79 });
        expect(mainRect.transformByState).toHaveBeenCalledWith({ top: 79 });
        expect(executeCommand).toHaveBeenCalledWith(SetFrozenCommand.id, {
            startRow: 4,
            startColumn: -1,
            ySplit: 4,
            xSplit: 0,
            unitId: sheet.getUnitId(),
            subUnitId: worksheet.getSheetId(),
        });

        testBed.univer.dispose();
    });
});