Skip to content

The open alternative to Salesforce, designed for AI.

11.6 KB
Raw Blame
import { DEFAULT_WIDGET_SIZE } from 'twenty-shared/constants';

import { type DraftPageLayout } from '@/page-layout/types/DraftPageLayout';
import { type PageLayoutWidget } from '@/page-layout/types/PageLayoutWidget';
import { convertPageLayoutDraftToUpdateInput } from '@/page-layout/utils/convertPageLayoutDraftToUpdateInput';
import {
  PageLayoutTabLayoutMode,
  PageLayoutWidgetVerticalListHeightBehavior,
  PageLayoutType,
  WidgetType,
} from '~/generated-metadata/graphql';

const makeWidget = (
  overrides: Partial<PageLayoutWidget> & { id: string },
): PageLayoutWidget =>
  ({
    title: 'Widget',
    type: WidgetType.FIELDS,
    pageLayoutTabId: 'tab-1',
    position: {
      __typename: 'PageLayoutWidgetGridPosition' as const,
      layoutMode: PageLayoutTabLayoutMode.GRID,
      row: 0,
      column: 0,
      rowSpan: 1,
      columnSpan: 1,
    },
    configuration: null,
    objectMetadataId: null,
    ...overrides,
  }) as PageLayoutWidget;

const makeDraft = (tabs: DraftPageLayout['tabs']): DraftPageLayout =>
  ({
    id: 'layout-1',
    name: 'Layout',
    type: PageLayoutType.RECORD_PAGE,
    objectMetadataId: 'obj-1',
    tabs,
  }) as DraftPageLayout;

const makeTab = (
  id: string,
  widgets: PageLayoutWidget[],
  layoutMode?: PageLayoutTabLayoutMode,
  overrides?: Partial<DraftPageLayout['tabs'][number]>,
): DraftPageLayout['tabs'][number] =>
  ({
    id,
    title: 'Tab',
    position: 0,
    pageLayoutId: 'layout-1',
    applicationId: 'app-1',
    isActive: true,
    layoutMode,
    widgets,
    ...overrides,
  }) as DraftPageLayout['tabs'][number];

describe('convertPageLayoutDraftToUpdateInput', () => {
  it('should convert a draft layout to update input', () => {
    const widget = makeWidget({ id: 'w1' });
    const draft = makeDraft([makeTab('tab-1', [widget])]);

    const result = convertPageLayoutDraftToUpdateInput(draft);

    expect(result.name).toBe('Layout');
    expect(result.type).toBe(PageLayoutType.RECORD_PAGE);
    expect(result.objectMetadataId).toBe('obj-1');
    expect(result.tabs).toHaveLength(1);
    expect(result.tabs[0].widgets).toHaveLength(1);
    expect(result.tabs[0].widgets[0].id).toBe('w1');
  });

  it('should handle multiple widget types', () => {
    const fieldsWidget = makeWidget({ id: 'w1', type: WidgetType.FIELDS });
    const timelineWidget = makeWidget({
      id: 'w2',
      type: WidgetType.TIMELINE,
    });

    const draft = makeDraft([makeTab('tab-1', [fieldsWidget, timelineWidget])]);

    const result = convertPageLayoutDraftToUpdateInput(draft);

    expect(result.tabs[0].widgets).toHaveLength(2);
    expect(result.tabs[0].widgets.map((w) => w.id)).toEqual(['w1', 'w2']);
  });

  it('should map position correctly', () => {
    const widget = makeWidget({
      id: 'w1',
      position: {
        __typename: 'PageLayoutWidgetGridPosition' as const,
        layoutMode: PageLayoutTabLayoutMode.GRID,
        row: 2,
        column: 3,
        rowSpan: 4,
        columnSpan: 5,
      },
    });
    const draft = makeDraft([makeTab('tab-1', [widget])]);

    const result = convertPageLayoutDraftToUpdateInput(draft);

    expect(result.tabs[0].widgets[0].position).toEqual({
      layoutMode: PageLayoutTabLayoutMode.GRID,
      row: 2,
      column: 3,
      rowSpan: 4,
      columnSpan: 5,
    });
    expect(result.tabs[0].widgets[0].position).toEqual({
      layoutMode: 'GRID',
      row: 2,
      column: 3,
      rowSpan: 4,
      columnSpan: 5,
    });
  });

  it('should handle objectMetadataId as null when not provided', () => {
    const draft = makeDraft([makeTab('tab-1', [])]);
    draft.objectMetadataId = undefined;

    const result = convertPageLayoutDraftToUpdateInput(draft);

    expect(result.objectMetadataId).toBeNull();
  });

  it('should propagate tab icon to the update input', () => {
    const draft = makeDraft([
      makeTab('tab-1', [], PageLayoutTabLayoutMode.GRID, {
        icon: 'IconHome',
      }),
    ]);

    const result = convertPageLayoutDraftToUpdateInput(draft);

    expect(result.tabs[0].icon).toBe('IconHome');
  });

  it('should send null icon when tab icon is undefined', () => {
    const draft = makeDraft([makeTab('tab-1', [])]);

    const result = convertPageLayoutDraftToUpdateInput(draft);

    expect(result.tabs[0].icon).toBeNull();
  });

  it('should handle multiple tabs', () => {
    const draft = makeDraft([
      makeTab('tab-1', [makeWidget({ id: 'w1' })]),
      makeTab('tab-2', [makeWidget({ id: 'w2' })]),
    ]);

    const result = convertPageLayoutDraftToUpdateInput(draft);

    expect(result.tabs).toHaveLength(2);
    expect(result.tabs[0].id).toBe('tab-1');
    expect(result.tabs[1].id).toBe('tab-2');
  });

  it('should keep all widgets when multiple widget types exist', () => {
    const fieldsWidget = makeWidget({ id: 'w1', type: WidgetType.FIELDS });
    const timelineWidget = makeWidget({
      id: 'w2',
      type: WidgetType.TIMELINE,
    });
    const fieldWidget = makeWidget({
      id: 'w3',
      type: WidgetType.FIELD,
    });

    const draft = makeDraft([
      makeTab('tab-1', [fieldsWidget, fieldWidget, timelineWidget]),
    ]);

    const result = convertPageLayoutDraftToUpdateInput(draft);

    expect(result.tabs[0].widgets).toHaveLength(3);
    expect(result.tabs[0].widgets.map((w) => w.id)).toEqual(['w1', 'w3', 'w2']);
  });

  it('should produce VERTICAL_LIST position with index from widget.position when tab is VERTICAL_LIST', () => {
    const widget = makeWidget({
      id: 'w1',
      position: {
        __typename: 'PageLayoutWidgetVerticalListPosition',
        layoutMode: PageLayoutTabLayoutMode.VERTICAL_LIST,
        index: 3,
      },
    });
    const draft = makeDraft([
      makeTab('tab-1', [widget], PageLayoutTabLayoutMode.VERTICAL_LIST),
    ]);

    const result = convertPageLayoutDraftToUpdateInput(draft);

    expect(result.tabs[0].widgets[0].position).toEqual({
      layoutMode: PageLayoutTabLayoutMode.VERTICAL_LIST,
      index: 3,
    });
  });

  it('should preserve vertical-list height behavior', () => {
    const widget = makeWidget({
      id: 'w1',
      position: {
        __typename: 'PageLayoutWidgetVerticalListPosition',
        layoutMode: PageLayoutTabLayoutMode.VERTICAL_LIST,
        index: 0,
        heightBehavior: PageLayoutWidgetVerticalListHeightBehavior.TAB_VIEWPORT,
      },
    });
    const draft = makeDraft([
      makeTab('tab-1', [widget], PageLayoutTabLayoutMode.VERTICAL_LIST),
    ]);

    const result = convertPageLayoutDraftToUpdateInput(draft);

    expect(result.tabs[0].widgets[0].position).toEqual({
      layoutMode: PageLayoutTabLayoutMode.VERTICAL_LIST,
      index: 0,
      heightBehavior: PageLayoutWidgetVerticalListHeightBehavior.TAB_VIEWPORT,
    });
  });

  it('should fall back to array index for VERTICAL_LIST when widget position typename does not match', () => {
    const widget = makeWidget({
      id: 'w1',
      position: {
        __typename: 'PageLayoutWidgetCanvasPosition',
        layoutMode: PageLayoutTabLayoutMode.CANVAS,
      } as PageLayoutWidget['position'],
    });
    const draft = makeDraft([
      makeTab(
        'tab-1',
        [makeWidget({ id: 'w0' }), widget],
        PageLayoutTabLayoutMode.VERTICAL_LIST,
      ),
    ]);

    const result = convertPageLayoutDraftToUpdateInput(draft);

    expect(result.tabs[0].widgets[1].position).toEqual({
      layoutMode: PageLayoutTabLayoutMode.VERTICAL_LIST,
      index: 1,
    });
  });

  it('should produce CANVAS position when tab is CANVAS', () => {
    const widget = makeWidget({
      id: 'w1',
    });
    const draft = makeDraft([
      makeTab('tab-1', [widget], PageLayoutTabLayoutMode.CANVAS),
    ]);

    const result = convertPageLayoutDraftToUpdateInput(draft);

    expect(result.tabs[0].widgets[0].position).toEqual({
      layoutMode: PageLayoutTabLayoutMode.CANVAS,
    });
  });

  it('should produce CANVAS position regardless of widget position data', () => {
    const widget = makeWidget({
      id: 'w1',
      position: {
        __typename: 'PageLayoutWidgetVerticalListPosition',
        layoutMode: PageLayoutTabLayoutMode.VERTICAL_LIST,
        index: 5,
      },
    });
    const draft = makeDraft([
      makeTab('tab-1', [widget], PageLayoutTabLayoutMode.CANVAS),
    ]);

    const result = convertPageLayoutDraftToUpdateInput(draft);

    expect(result.tabs[0].widgets[0].position).toEqual({
      layoutMode: PageLayoutTabLayoutMode.CANVAS,
    });
  });

  it('should fall back to legacy grid coordinates when position is null', () => {
    const widget = makeWidget({
      id: 'w1',
      position: null,
      gridPosition: { row: 1, column: 2, rowSpan: 3, columnSpan: 4 },
    });
    const draft = makeDraft([makeTab('tab-1', [widget])]);

    const result = convertPageLayoutDraftToUpdateInput(draft);

    expect(result.tabs[0].widgets[0].position).toEqual({
      layoutMode: PageLayoutTabLayoutMode.GRID,
      row: 1,
      column: 2,
      rowSpan: 3,
      columnSpan: 4,
    });
  });

  it('should produce GRID position when tab layoutMode is explicitly GRID', () => {
    const widget = makeWidget({
      id: 'w1',
      position: {
        __typename: 'PageLayoutWidgetGridPosition' as const,
        layoutMode: PageLayoutTabLayoutMode.GRID,
        row: 5,
        column: 6,
        rowSpan: 7,
        columnSpan: 8,
      },
    });
    const draft = makeDraft([
      makeTab('tab-1', [widget], PageLayoutTabLayoutMode.GRID),
    ]);

    const result = convertPageLayoutDraftToUpdateInput(draft);

    expect(result.tabs[0].widgets[0].position).toEqual({
      layoutMode: PageLayoutTabLayoutMode.GRID,
      row: 5,
      column: 6,
      rowSpan: 7,
      columnSpan: 8,
    });
  });

  it('should use default grid coordinates when moving from another layout mode', () => {
    const widget = makeWidget({
      id: 'w1',
      position: {
        __typename: 'PageLayoutWidgetCanvasPosition',
        layoutMode: PageLayoutTabLayoutMode.CANVAS,
      },
    });
    const draft = makeDraft([
      makeTab('tab-1', [widget], PageLayoutTabLayoutMode.GRID),
    ]);

    const result = convertPageLayoutDraftToUpdateInput(draft);

    expect(result.tabs[0].widgets[0].position).toEqual({
      layoutMode: PageLayoutTabLayoutMode.GRID,
      row: 0,
      column: 0,
      rowSpan: DEFAULT_WIDGET_SIZE.default.h,
      columnSpan: DEFAULT_WIDGET_SIZE.default.w,
    });
  });

  it('should handle mixed tab layout modes in the same draft', () => {
    const verticalWidget = makeWidget({
      id: 'w1',
      position: {
        __typename: 'PageLayoutWidgetVerticalListPosition',
        layoutMode: PageLayoutTabLayoutMode.VERTICAL_LIST,
        index: 0,
      },
    });
    const canvasWidget = makeWidget({ id: 'w2' });
    const gridWidget = makeWidget({
      id: 'w3',
      position: {
        __typename: 'PageLayoutWidgetGridPosition' as const,
        layoutMode: PageLayoutTabLayoutMode.GRID,
        row: 1,
        column: 0,
        rowSpan: 2,
        columnSpan: 6,
      },
    });

    const draft = makeDraft([
      makeTab(
        'tab-vl',
        [verticalWidget],
        PageLayoutTabLayoutMode.VERTICAL_LIST,
      ),
      makeTab('tab-canvas', [canvasWidget], PageLayoutTabLayoutMode.CANVAS),
      makeTab('tab-grid', [gridWidget], PageLayoutTabLayoutMode.GRID),
    ]);

    const result = convertPageLayoutDraftToUpdateInput(draft);

    expect(result.tabs[0].widgets[0].position).toEqual({
      layoutMode: PageLayoutTabLayoutMode.VERTICAL_LIST,
      index: 0,
    });
    expect(result.tabs[1].widgets[0].position).toEqual({
      layoutMode: PageLayoutTabLayoutMode.CANVAS,
    });
    expect(result.tabs[2].widgets[0].position).toEqual({
      layoutMode: PageLayoutTabLayoutMode.GRID,
      row: 1,
      column: 0,
      rowSpan: 2,
      columnSpan: 6,
    });
  });
});