@dxos/react-ui-table 0.8.4-main.f9ba587 → 0.8.4-main.fcc0d83b33

package/src/components/Table/Relations.stories.tsx

@@ -0,0 +1,281 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { RegistryContext } from '@effect-atom/atom-react';
+import { type Meta, type StoryObj } from '@storybook/react-vite';
+import React, { useCallback, useContext, useEffect, useMemo, useState } from 'react';
+import { expect, userEvent, waitFor, within } from 'storybook/test';
+
+import { Obj, Type } from '@dxos/echo';
+import { View } from '@dxos/echo';
+import { invariant } from '@dxos/invariant';
+import { type DxGrid } from '@dxos/lit-grid';
+import { random } from '@dxos/random';
+import { useClientStory, withClientProvider } from '@dxos/react-client/testing';
+import { useAsyncEffect } from '@dxos/react-ui';
+import { translations as formTranslations } from '@dxos/react-ui-form/translations';
+import { withLayout, withTheme } from '@dxos/react-ui/testing';
+import { ViewModel } from '@dxos/schema';
+import { type ValueGenerator, createAsyncGenerator } from '@dxos/schema/testing';
+import { withRegistry } from '@dxos/storybook-utils';
+import { Organization, Person } from '@dxos/types';
+import '@dxos/lit-ui/dx-tag-picker.pcss';
+
+import { translations } from '#translations';
+
+import { useProjectionModel, useTableModel } from '../../hooks';
+import { type TableFeatures, TablePresentation, type TableRow } from '../../model';
+import { Table } from '../../types';
+import { Table as TableComponent } from './Table';
+
+random.seed(1);
+const generator: ValueGenerator = random as any;
+
+// TODO(burdon): Many-to-many relations.
+// TODO(burdon): Mutable and immutable views.
+// TODO(burdon): Reconcile schemas types and utils (see API PR).
+// TODO(burdon): Base type for T (with id); see ECHO API PR?
+const useTestModel = <S extends Type.AnyObj>(schema: S, count: number) => {
+  const registry = useContext(RegistryContext);
+  const { space } = useClientStory();
+  const [object, setObject] = useState<Table.Table>();
+
+  const features = useMemo<TableFeatures>(
+    () => ({ schemaEditable: false, dataEditable: true, selection: { enabled: false } }),
+    [],
+  );
+
+  useAsyncEffect(async () => {
+    if (!space) {
+      return;
+    }
+
+    const { view, jsonSchema } = await ViewModel.makeFromDatabase({ db: space.db, typename: Type.getTypename(schema) });
+    const object = Table.make({ view, jsonSchema });
+    setObject(object);
+    space.db.add(object);
+  }, [space, schema]);
+
+  const projection = useProjectionModel(schema, object, registry);
+  const model = useTableModel<TableRow>({ object, projection, db: space?.db, features });
+
+  useEffect(() => {
+    if (!model || !space) {
+      return;
+    }
+
+    const objectGenerator = createAsyncGenerator(generator, schema, { db: space?.db, force: true });
+    void objectGenerator.createObjects(count).then((objects) => {
+      model.setRows(objects);
+    });
+  }, [model, space]);
+
+  const presentation = useMemo(() => {
+    if (!model) {
+      return;
+    }
+
+    return new TablePresentation(registry, model);
+  }, [registry, model]);
+
+  return { model, presentation };
+};
+
+const DefaultStory = () => {
+  const { model: orgModel, presentation: orgPresentation } = useTestModel(Organization.Organization, 50);
+  const { model: contactModel, presentation: contactPresentation } = useTestModel(Person.Person, 50);
+  const { space } = useClientStory();
+
+  const handleCreate = useCallback(
+    (schema: Type.AnyEntity, values: any) => {
+      invariant(Type.isObjectSchema(schema));
+      invariant(space);
+      return space.db.add(Obj.make(schema, values));
+    },
+    [space],
+  );
+
+  return (
+    <div className='dx-expander grid grid-cols-2 divide-x divide-separator'>
+      <TableComponent.Root>
+        <TableComponent.Content
+          model={orgModel}
+          schema={Organization.Organization}
+          presentation={orgPresentation}
+          onCreate={handleCreate}
+          ignoreAttention
+          testId='relations-0'
+        />
+      </TableComponent.Root>
+      <TableComponent.Root>
+        <TableComponent.Content
+          model={contactModel}
+          schema={Person.Person}
+          presentation={contactPresentation}
+          onCreate={handleCreate}
+          ignoreAttention
+          testId='relations-1'
+        />
+      </TableComponent.Root>
+    </div>
+  );
+};
+
+const meta = {
+  title: 'ui/react-ui-table/Relations',
+  render: DefaultStory,
+  decorators: [
+    withTheme(),
+    withRegistry,
+    // TODO(thure): Shouldn't `layout: 'fullscreen'` below make this unnecessary?
+    withLayout({ classNames: 'fixed inset-0' }),
+    withClientProvider({
+      types: [View.View, Organization.Organization, Person.Person, Table.Table],
+      createIdentity: true,
+      createSpace: true,
+    }),
+  ],
+  parameters: {
+    layout: 'fullscreen',
+    controls: { disable: true },
+    translations: [...translations, ...formTranslations],
+  },
+} satisfies Meta<typeof DefaultStory>;
+
+export default meta;
+
+type Story = StoryObj<typeof meta>;
+
+export const Default: Story = {
+  // The play function exercises a deep timing race in dx-grid + React render
+  // pipeline (cell focus → keydown → `dispatchEditRequest` → `setEditing` →
+  // `FormCellEditor` `useEffect` → `Popover` mount). On chromium browser
+  // tests the combobox sometimes fails to render in time; local pass rate
+  // ~25%, which makes pure CI re-run lottery a poor fit. Excluding from
+  // automated test runs (the story still renders in Storybook for visual
+  // review and the production code path is covered by
+  // `playwright/smoke.spec.ts`). Re-enable once the underlying race is
+  // fixed — likely needs `dispatchEditRequest` to be synchronous from
+  // keydown and `FormCellEditor` to render the popover off `contextEditing`
+  // directly instead of mirroring it through local state.
+  tags: ['!test'],
+  play: async ({ canvasElement }) => {
+    const canvas = within(canvasElement);
+    const body = within(document.body);
+
+    // Get all dx-grid elements (should have 2 - one for each table)
+    const firstGrid = await canvas.findByTestId('relations-0', undefined, { timeout: 30_000 });
+    const secondGrid = await canvas.findByTestId('relations-1', undefined, { timeout: 30_000 });
+
+    // Focus on the second table (Person/contacts table)
+    await expect(secondGrid).toBeVisible();
+
+    // Wait for both grids' data generators to finish populating before
+    // interacting. `findByTestId` returns as soon as the cell DOM exists,
+    // but dx-grid's internal cell registry (used by `cellReadonly` and the
+    // edit-request dispatcher) is filled in lazily. If `keydown` lands
+    // before the registry has the row, `dispatchEditRequest` short-circuits
+    // and the combobox never opens — that's the "Unable to find combobox"
+    // flake. Wait for the first row of each grid to render non-empty
+    // content (a reliable proxy for "registry populated") BEFORE scrolling
+    // — once we scroll the second grid to column 4, dx-grid virtualizes
+    // columns 0-3 out of the DOM, so `grid.0.0` becomes unreachable.
+    await waitFor(
+      async () => {
+        const firstOrgCell = within(firstGrid).getByTestId('grid.0.0');
+        const orgText = (firstOrgCell.querySelector('.dx-grid__cell__content') as HTMLElement | null)?.textContent;
+        await expect(orgText).toBeTruthy();
+        const firstContactCell = within(secondGrid).getByTestId('grid.0.0');
+        const contactText = (firstContactCell.querySelector('.dx-grid__cell__content') as HTMLElement | null)
+          ?.textContent;
+        await expect(contactText).toBeTruthy();
+      },
+      { timeout: 10_000 },
+    );
+
+    // Scroll to the relations column (column 4) - this mimics the scrollToColumn call
+    (secondGrid.closest('dx-grid') as DxGrid).scrollToColumn(4);
+
+    // Find the target cell (first row, relations column).
+    const targetCell = await within(secondGrid).findByTestId('grid.4.0', undefined, { timeout: 10_000 });
+    await expect(targetCell).toBeVisible();
+
+    // Click to focus the cell.
+    await userEvent.click(targetCell as HTMLElement);
+    await expect(targetCell).toHaveFocus();
+    await userEvent.keyboard('{Enter}');
+
+    // Look for the combobox that should appear in edit mode.
+    const combobox = await body.findByRole('combobox', undefined, { timeout: 5000 });
+    await userEvent.click(combobox);
+
+    const searchField = await body.findByPlaceholderText('Search…');
+    await userEvent.click(searchField);
+
+    // Get the first organization name from the first table to search for
+    const orgCell = await within(firstGrid).findByTestId('grid.0.0', undefined, { timeout: 10_000 });
+
+    const orgName = (orgCell.querySelector('.dx-grid__cell__content') as HTMLElement).textContent;
+    // Type the first 4 characters to search
+    await userEvent.type(searchField, orgName.substring(0, 4));
+
+    // Look for an option to select
+    const option = await body.findAllByRole('option');
+    await expect(option[0]).toBeVisible();
+
+    // Press Enter to select
+    await userEvent.keyboard('{Enter}');
+
+    // Look for and click save button
+    const saveButton = await body.findByTestId('save-button');
+    await userEvent.click(saveButton);
+
+    // Verify the relation was set (cell should now contain the org name).
+    // Wait for the grid (Lit web component) to repaint after the reactive data update.
+    await waitFor(
+      async () => {
+        const updatedCell = within(secondGrid).getByTestId('grid.4.0');
+        await expect(updatedCell).toHaveTextContent(orgName.substring(0, 4));
+      },
+      { timeout: 5000 },
+    );
+
+    // Test object creation (new relations) - equivalent to "new relations work as expected" test
+    // Find a different cell to test object creation (second row, relations column)
+    const newTargetCell = await within(secondGrid).findByTestId('grid.4.1', undefined, { timeout: 10_000 });
+    await expect(newTargetCell).toBeTruthy();
+
+    // Click to focus the cell
+    await userEvent.click(newTargetCell as Element);
+
+    await userEvent.keyboard('{Enter}');
+
+    // Look for the combobox that should appear in edit mode
+    const newCombobox = await body.findByRole('combobox');
+    await userEvent.click(newCombobox);
+
+    const newSearchField = await body.findByPlaceholderText('Search…');
+    await userEvent.click(newSearchField);
+
+    // Type a new object name (this will create a new object).
+    const newOrgName = 'Salieri LLC';
+    await userEvent.type(newSearchField, newOrgName);
+
+    // Click the create option directly to open the create form.
+    const createOptionLabel = await body.findByText(/Create new object/, undefined, { timeout: 2000 });
+    await userEvent.click(createOptionLabel.closest('[role="option"]') as HTMLElement);
+
+    // Look for and click save button.
+    const createReferencedObjectForm = await body.findByTestId('create-referenced-object-form', undefined, {
+      timeout: 2000,
+    });
+    const saveObjectButton = await within(createReferencedObjectForm).findByTestId('save-button');
+    await expect(saveObjectButton).not.toBeDisabled();
+    await userEvent.click(saveObjectButton);
+
+    // Verify the relation was set by checking for the accessory link anchor in the cell.
+    const updatedNewCell = await within(secondGrid).findByTestId('grid.4.1', undefined, { timeout: 5000 });
+    await expect(updatedNewCell.querySelector('dx-anchor')).toBeTruthy();
+  },
+};

package/src/components/Table/RowActionsMenu.tsx

@@ -2,19 +2,21 @@
 // Copyright 2024 DXOS.org
 //
 
+import { useAtomValue } from '@effect-atom/atom-react';
 import React from 'react';
 
-import { DropdownMenu, useTranslation } from '@dxos/react-ui';
+import { DropdownMenu, toLocalizedString, useTranslation } from '@dxos/react-ui';
 
-import { type TableModel, type ModalController } from '../../model';
-import { translationKey } from '../../translations';
+import { translationKey } from '#translations';
+
+import { type ModalController, type TableModel } from '../../model';
 
 type RowActionsMenuProps = { model: TableModel; modals: ModalController };
 
 export const RowActionsMenu = ({ model, modals }: RowActionsMenuProps) => {
   const { t } = useTranslation(translationKey);
-  const hasSelection = model.selection.hasSelection.value;
-  const state = modals.state.value;
+  const hasSelection = model.selection.hasSelection;
+  const state = useAtomValue(modals.state);
   if (state?.type !== 'row') {
     return null;
   }
@@ -23,24 +25,32 @@ export const RowActionsMenu = ({ model, modals }: RowActionsMenuProps) => {
       <DropdownMenu.VirtualTrigger virtualRef={modals.trigger} />
       <DropdownMenu.Content>
         <DropdownMenu.Viewport>
+          {/* Custom actions */}
+          {model.rowActions?.length > 0 && (
+            <>
+              <DropdownMenu.Group>
+                {model.rowActions?.map((action) => (
+                  <DropdownMenu.Item
+                    key={action.id}
+                    data-testid={`row-action-${action.id}`}
+                    onClick={() => {
+                      modals.close();
+                      model.handleRowAction(action.id, state.rowIndex);
+                    }}
+                  >
+                    {toLocalizedString(action.label, t)}
+                  </DropdownMenu.Item>
+                ))}
+              </DropdownMenu.Group>
+              <DropdownMenu.Separator />
+            </>
+          )}
+          {/* Default actions */}
           {model.features.dataEditable !== false && (
             <DropdownMenu.Item data-testid='row-menu-delete' onClick={() => model.deleteRow(state.rowIndex)}>
               {t(hasSelection ? 'bulk delete row label' : 'delete row label')}
             </DropdownMenu.Item>
           )}
-          {/* Custom actions */}
-          {model.rowActions?.map((action) => (
-            <DropdownMenu.Item
-              key={action.id}
-              data-testid={`row-action-${action.id}`}
-              onClick={() => {
-                modals.close();
-                model.handleRowAction(action.id, state.rowIndex);
-              }}
-            >
-              {t(action.translationKey)}
-            </DropdownMenu.Item>
-          ))}
         </DropdownMenu.Viewport>
         <DropdownMenu.Arrow />
       </DropdownMenu.Content>