|
| 1 | +/** |
| 2 | + * ObjectUI |
| 3 | + * Copyright (c) 2024-present ObjectStack Inc. |
| 4 | + * |
| 5 | + * This source code is licensed under the MIT license found in the |
| 6 | + * LICENSE file in the root directory of this source tree. |
| 7 | + */ |
| 8 | + |
| 9 | +/** |
| 10 | + * Regression (create modal ignored the object's form view): the "New <object>" |
| 11 | + * modal rendered every field from the raw object schema, in schema order, |
| 12 | + * ignoring the curated sections + field selection/order defined in the object's |
| 13 | + * default FORM VIEW. |
| 14 | + * |
| 15 | + * This pins the END-TO-END contract the fix relies on: resolve the form-view |
| 16 | + * layout from the object definition (exactly as `AppContent`'s global New/Edit |
| 17 | + * modal and `useActionModal` now do) and feed it to the real `<ModalForm>`. The |
| 18 | + * modal must then render ONLY the curated fields — proving the view drives the |
| 19 | + * create form, not the raw schema. The resolver's own branch coverage lives in |
| 20 | + * `utils/__tests__/recordFormNavigation.test.ts`; this test guards the wiring + |
| 21 | + * rendering so the two can't silently drift back to "show every field". |
| 22 | + */ |
| 23 | + |
| 24 | +import { describe, it, expect, vi, beforeEach } from 'vitest'; |
| 25 | +import { render, screen, waitFor } from '@testing-library/react'; |
| 26 | +import React from 'react'; |
| 27 | +import { registerAllFields } from '@object-ui/fields'; |
| 28 | +import { ModalForm } from '@object-ui/plugin-form'; |
| 29 | +import { resolveFormViewLayout } from '../../utils/recordFormNavigation'; |
| 30 | + |
| 31 | +registerAllFields(); |
| 32 | + |
| 33 | +// An object whose RAW schema (what `getObjectSchema` returns) has three fields… |
| 34 | +const makeDataSource = (): any => ({ |
| 35 | + getObjectSchema: vi.fn().mockResolvedValue({ |
| 36 | + name: 'project', |
| 37 | + fields: { |
| 38 | + title: { type: 'text', label: 'Title' }, |
| 39 | + summary: { type: 'textarea', label: 'Summary' }, |
| 40 | + // …plus a field the form view deliberately leaves OUT. |
| 41 | + secret_internal: { type: 'text', label: 'Secret Internal' }, |
| 42 | + }, |
| 43 | + }), |
| 44 | + create: vi.fn().mockResolvedValue({ id: '1' }), |
| 45 | + findOne: vi.fn(), |
| 46 | +}); |
| 47 | + |
| 48 | +// …but whose DEFAULT FORM VIEW curates only two of them, grouped under a section |
| 49 | +// and re-ordered (summary before title) relative to the schema. |
| 50 | +const objectDef = { |
| 51 | + name: 'project', |
| 52 | + form: { |
| 53 | + type: 'simple', |
| 54 | + sections: [ |
| 55 | + { name: 'basics', label: 'Basics', fields: [{ field: 'summary' }, { field: 'title' }] }, |
| 56 | + ], |
| 57 | + }, |
| 58 | +}; |
| 59 | + |
| 60 | +beforeEach(() => vi.clearAllMocks()); |
| 61 | + |
| 62 | +describe('create modal honors the object form view (sections + field selection)', () => { |
| 63 | + it('renders only the curated fields, not the whole object schema', async () => { |
| 64 | + // Exactly what AppContent / useActionModal now do: resolve the form-view |
| 65 | + // layout from the object definition and spread it into the modal schema. |
| 66 | + const layout = resolveFormViewLayout(objectDef as any); |
| 67 | + expect(layout.sections).toHaveLength(1); |
| 68 | + |
| 69 | + render( |
| 70 | + <ModalForm |
| 71 | + schema={{ |
| 72 | + objectName: 'project', |
| 73 | + mode: 'create', |
| 74 | + title: 'New Project', |
| 75 | + open: true, |
| 76 | + onOpenChange: vi.fn(), |
| 77 | + ...layout, |
| 78 | + } as any} |
| 79 | + dataSource={makeDataSource()} |
| 80 | + />, |
| 81 | + ); |
| 82 | + |
| 83 | + // The curated section header + both selected fields render… |
| 84 | + await waitFor(() => expect(screen.getByText('Basics')).toBeTruthy()); |
| 85 | + expect(screen.getByText('Title')).toBeTruthy(); |
| 86 | + expect(screen.getByText('Summary')).toBeTruthy(); |
| 87 | + |
| 88 | + // …and the field the form view omitted is absent. Before the fix the modal |
| 89 | + // fell back to the raw object schema and rendered all three (incl. this one). |
| 90 | + expect(screen.queryByText('Secret Internal')).toBeNull(); |
| 91 | + }); |
| 92 | + |
| 93 | + it('falls back to the full schema when the object declares no form view', async () => { |
| 94 | + // No `form` / `formViews` → resolver returns {}, the modal keeps its prior |
| 95 | + // behavior (flat list from the raw schema). This is the un-curated baseline |
| 96 | + // the fix must NOT change. |
| 97 | + const layout = resolveFormViewLayout({ name: 'project' } as any); |
| 98 | + expect(layout).toEqual({}); |
| 99 | + |
| 100 | + render( |
| 101 | + <ModalForm |
| 102 | + schema={{ |
| 103 | + objectName: 'project', |
| 104 | + mode: 'create', |
| 105 | + title: 'New Project', |
| 106 | + open: true, |
| 107 | + onOpenChange: vi.fn(), |
| 108 | + ...layout, |
| 109 | + } as any} |
| 110 | + dataSource={makeDataSource()} |
| 111 | + />, |
| 112 | + ); |
| 113 | + |
| 114 | + // Every schema field is present, including the one a form view would curate out. |
| 115 | + await waitFor(() => expect(screen.getByText('Title')).toBeTruthy()); |
| 116 | + expect(screen.getByText('Summary')).toBeTruthy(); |
| 117 | + expect(screen.getByText('Secret Internal')).toBeTruthy(); |
| 118 | + }); |
| 119 | +}); |
0 commit comments