@gooddata/react-components/src/components/core/pivotTable/tests/agGridDataSourceUtils.spec.ts

GoodData.UI - A powerful JavaScript library for building analytical applications

// (C) 2019-2020 GoodData Corporation
import { IGridTotalsRow } from "../agGridTypes";
import { areTotalsChanged, isInvalidGetRowsRequest, wrapGetPageWithCaching } from "../agGridDataSourceUtils";
import * as fixtures from "../../../../../stories/test_data/fixtures";

describe("getGridDataSourceUtils", () => {
    describe("isInvalidGetRowsRequest", () => {
        function mockGridApi(bottomRowIndex: number | null): any {
            return {
                paginationProxy: {
                    bottomRowIndex,
                },
            };
        }

        it("should return false is bottom row index is null", () => {
            const startRow = 0;
            const bottomRowIndex: null = null;
            const gridApi = mockGridApi(bottomRowIndex);

            expect(isInvalidGetRowsRequest(startRow, gridApi)).toEqual(false);
        });

        it("should return false is start row of request is below bottom row index", () => {
            const startRow = 0;
            const bottomRowIndex = 1;
            const gridApi = mockGridApi(bottomRowIndex);

            expect(isInvalidGetRowsRequest(startRow, gridApi)).toEqual(false);
        });

        it("should return true is start row of request is above bottom row index", () => {
            const startRow = 1;
            const bottomRowIndex = 0;
            const gridApi = mockGridApi(bottomRowIndex);

            expect(isInvalidGetRowsRequest(startRow, gridApi)).toEqual(true);
        });
    });

    describe("areTotalsChanged", () => {
        function mockGridApi(totals: any[] = []): any {
            return {
                getPinnedBottomRowCount: () => totals.length,
                getPinnedBottomRow: (i: number) => ({ data: totals[i] }),
            };
        }
        const totalSum = {
            type: "rowTotal",
            colSpan: {
                count: 1,
                headerKey: "foo",
            },
        };
        const emptyTotalRows: IGridTotalsRow[] = [];
        const noTotalRows: IGridTotalsRow[] = null;
        const oneTotalRows: IGridTotalsRow[] = [totalSum];

        it.each([
            [true, "no", "one", noTotalRows, [totalSum]],
            [false, "no", "no", noTotalRows, []],
            [true, "empty", "one", emptyTotalRows, [totalSum]],
            [false, "empty", "no", emptyTotalRows, []],
            [true, "one", "no", oneTotalRows, []],
            [false, "one", "one", oneTotalRows, [totalSum]],
        ])(
            "should return %s when %s total passed and %s total present in bottom pinned row",
            (
                expectedValue: boolean,
                _passed: string,
                _table: string,
                passedTotals: any[],
                tableTotals: any[],
            ) => {
                const gridApi = mockGridApi(tableTotals);

                expect(areTotalsChanged(gridApi, passedTotals)).toBe(expectedValue);
            },
        );
    });

    describe("wrapGetPageWithCaching", () => {
        it("should call getPage only once if the execution params are the same", async () => {
            const execution = fixtures.pivotTableWithColumnAndRowAttributes.executionRequest;

            const getPage = jest.fn(() => Promise.resolve(execution));
            const getPageWithCaching = wrapGetPageWithCaching(getPage);

            await getPageWithCaching(execution.resultSpec, [0], [1]);
            await getPageWithCaching(execution.resultSpec, [0], [1]);
            expect(getPage).toHaveBeenCalledTimes(1);
        });

        it("should call getPage only once when called without awaiting", async () => {
            const execution = fixtures.pivotTableWithColumnAndRowAttributes.executionRequest;

            const getPage = jest.fn(() => Promise.resolve(execution));

            const getPageWithCaching = wrapGetPageWithCaching(getPage);
            const first = getPageWithCaching(execution.resultSpec, [0], [1]);
            const second = getPageWithCaching(execution.resultSpec, [0], [1]);

            expect(getPage).toHaveBeenCalledTimes(1);
            expect(await first).toBe(await second);
        });

        it("should call getPage each time if execution params changes", async () => {
            const execution = fixtures.pivotTableWithColumnAndRowAttributes.executionRequest;
            const differentResultSpec =
                fixtures.pivotTableWithColumnRowAttributesAndTotals.executionRequest.resultSpec;

            const getPage = jest.fn(() => Promise.resolve(execution));
            const getPageWithCaching = wrapGetPageWithCaching(getPage);

            await getPageWithCaching(execution.resultSpec, [0], [0]);
            await getPageWithCaching(execution.resultSpec, [0], [1]);
            await getPageWithCaching(execution.resultSpec, [1], [0]);
            await getPageWithCaching(execution.resultSpec, [1], [1]);
            await getPageWithCaching(differentResultSpec, [1], [1]);
            expect(getPage).toHaveBeenCalledTimes(5);
        });
    });
});