|
| 1 | +// Copyright (c) 2026 ObjectStack. Licensed under the Apache-2.0 license. |
| 2 | + |
| 3 | +/** |
| 4 | + * New package: the first step asks only for a name (objectstack#27833). |
| 5 | + * |
| 6 | + * Measured on the card: Home → New → New Package opened on a reverse-domain |
| 7 | + * id, an object namespace, a SemVer version and a package type, all up front, |
| 8 | + * under developer help. The id, namespace and version were already filled in |
| 9 | + * from the name (objectui#11792, objectui#12512); what was missing was a first |
| 10 | + * step a non-developer can answer. The technical rows now sit behind one |
| 11 | + * collapsed Advanced disclosure, and a line under the name says what was |
| 12 | + * filled in. |
| 13 | + * |
| 14 | + * "Closed" is read the way a browser hides it: the disclosure's content |
| 15 | + * carries `hidden`, so its rows leave the accessibility tree (`getByRole` |
| 16 | + * cannot reach them) while staying mounted. |
| 17 | + */ |
| 18 | + |
| 19 | +import '@testing-library/jest-dom/vitest'; |
| 20 | +import * as React from 'react'; |
| 21 | +import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest'; |
| 22 | +import { cleanup, fireEvent, render, screen, within } from '@testing-library/react'; |
| 23 | +import userEvent from '@testing-library/user-event'; |
| 24 | +import { PackageFormDialog } from './PackageFormDialog'; |
| 25 | +import { t, tFormat } from './i18n'; |
| 26 | + |
| 27 | +vi.mock('./i18n', async (importOriginal) => ({ |
| 28 | + ...(await importOriginal<Record<string, unknown>>()), |
| 29 | + useMetadataLocale: () => 'en-US', |
| 30 | +})); |
| 31 | + |
| 32 | +let fetchMock: ReturnType<typeof vi.fn>; |
| 33 | +beforeEach(() => { |
| 34 | + fetchMock = vi.fn( |
| 35 | + async () => ({ ok: true, status: 201, text: async () => '{"success":true,"data":{}}' }) as Response, |
| 36 | + ); |
| 37 | + vi.stubGlobal('fetch', fetchMock); |
| 38 | +}); |
| 39 | +afterEach(() => { |
| 40 | + cleanup(); |
| 41 | + vi.unstubAllGlobals(); |
| 42 | +}); |
| 43 | + |
| 44 | +const label = (key: string) => t(key, 'en-US'); |
| 45 | + |
| 46 | +function openCreate() { |
| 47 | + render(<PackageFormDialog mode="create" open onOpenChange={vi.fn()} />); |
| 48 | + const byLabel = (key: string) => screen.getByLabelText(label(key), { exact: false }) as HTMLInputElement; |
| 49 | + return { |
| 50 | + name: () => byLabel('engine.packages.create.name'), |
| 51 | + id: () => byLabel('engine.packages.create.id'), |
| 52 | + ns: () => byLabel('engine.packages.create.namespace'), |
| 53 | + toggle: () => screen.getByTestId('package-form-advanced-toggle'), |
| 54 | + content: () => screen.getByTestId('package-form-id').parentElement as HTMLElement, |
| 55 | + submit: () => screen.getByTestId('package-form-submit'), |
| 56 | + }; |
| 57 | +} |
| 58 | + |
| 59 | +describe('the first step asks only for a name (objectstack#27833)', () => { |
| 60 | + it('opens with the name and the description in reach, the technical rows folded away', () => { |
| 61 | + const f = openCreate(); |
| 62 | + const basics = screen.getByTestId('package-form-basics'); |
| 63 | + expect(within(basics).getAllByRole('textbox')).toEqual([ |
| 64 | + f.name(), |
| 65 | + screen.getByLabelText(label('engine.packages.detail.description'), { exact: false }), |
| 66 | + ]); |
| 67 | + |
| 68 | + expect(f.toggle()).toHaveAttribute('aria-expanded', 'false'); |
| 69 | + expect(f.content()).toHaveAttribute('hidden'); |
| 70 | + // Mounted, but out of the accessibility tree while closed. |
| 71 | + expect(screen.queryByRole('textbox', { name: new RegExp(label('engine.packages.create.id')) })).toBeNull(); |
| 72 | + expect(screen.queryByRole('textbox', { name: new RegExp(label('engine.packages.create.version')) })).toBeNull(); |
| 73 | + }); |
| 74 | + |
| 75 | + it('a name alone creates the package, with the id and namespace it derived', async () => { |
| 76 | + const user = userEvent.setup(); |
| 77 | + const f = openCreate(); |
| 78 | + await user.type(f.name(), 'Field Service'); |
| 79 | + |
| 80 | + expect(screen.getByTestId('package-form-derived-summary')).toHaveTextContent( |
| 81 | + tFormat('engine.packages.create.derivedSummary', 'en-US', { |
| 82 | + id: 'com.field-service', |
| 83 | + namespace: 'field_service', |
| 84 | + }), |
| 85 | + ); |
| 86 | + expect(f.toggle()).toHaveAttribute('aria-expanded', 'false'); |
| 87 | + |
| 88 | + await user.click(f.submit()); |
| 89 | + expect(fetchMock).toHaveBeenCalledTimes(1); |
| 90 | + const [url, init] = fetchMock.mock.calls[0] as [string, RequestInit]; |
| 91 | + expect(url).toBe('/api/v1/packages'); |
| 92 | + expect(JSON.parse(String(init.body)).manifest).toMatchObject({ |
| 93 | + id: 'com.field-service', |
| 94 | + namespace: 'field_service', |
| 95 | + name: 'Field Service', |
| 96 | + version: '0.1.0', |
| 97 | + type: 'app', |
| 98 | + }); |
| 99 | + }); |
| 100 | + |
| 101 | + it('Advanced shows the derived id and namespace, and both are editable there', async () => { |
| 102 | + const user = userEvent.setup(); |
| 103 | + const f = openCreate(); |
| 104 | + await user.type(f.name(), 'Field Service'); |
| 105 | + await user.click(f.toggle()); |
| 106 | + |
| 107 | + expect(f.content()).not.toHaveAttribute('hidden'); |
| 108 | + const id = screen.getByRole('textbox', { name: new RegExp(label('engine.packages.create.id')) }); |
| 109 | + const ns = screen.getByRole('textbox', { name: new RegExp(label('engine.packages.create.namespace')) }); |
| 110 | + expect(id).toHaveValue('com.field-service'); |
| 111 | + expect(ns).toHaveValue('field_service'); |
| 112 | + |
| 113 | + await user.clear(ns); |
| 114 | + await user.type(ns, 'fs'); |
| 115 | + expect(ns).toHaveValue('fs'); |
| 116 | + expect(screen.getByTestId('package-form-derived-summary')).toHaveTextContent( |
| 117 | + tFormat('engine.packages.create.derivedSummary', 'en-US', { id: 'com.field-service', namespace: 'fs' }), |
| 118 | + ); |
| 119 | + }); |
| 120 | + |
| 121 | + it('an edited id never moves when the name changes again', async () => { |
| 122 | + const user = userEvent.setup(); |
| 123 | + const f = openCreate(); |
| 124 | + await user.type(f.name(), 'Field Service'); |
| 125 | + await user.click(f.toggle()); |
| 126 | + await user.clear(f.id()); |
| 127 | + await user.type(f.id(), 'com.acme.repairs'); |
| 128 | + |
| 129 | + await user.clear(f.name()); |
| 130 | + await user.type(f.name(), 'Repairs Center'); |
| 131 | + expect(f.id()).toHaveValue('com.acme.repairs'); |
| 132 | + expect(f.ns()).toHaveValue('repairs'); |
| 133 | + }); |
| 134 | + |
| 135 | + it('a hand-typed id the spec refuses is refused in words, Create waits, and Advanced cannot fold it away', async () => { |
| 136 | + const user = userEvent.setup(); |
| 137 | + const f = openCreate(); |
| 138 | + await user.type(f.name(), 'Field Service'); |
| 139 | + await user.click(f.toggle()); |
| 140 | + await user.clear(f.id()); |
| 141 | + await user.type(f.id(), 'acme'); |
| 142 | + |
| 143 | + expect(screen.getByTestId('pkg-id-format-hint')).toHaveTextContent( |
| 144 | + tFormat('engine.packages.idRule.formatHint', 'en-US', { example: 'com.acme.crm' }), |
| 145 | + ); |
| 146 | + expect(f.submit()).toBeDisabled(); |
| 147 | + expect(screen.queryByTestId('package-form-derived-summary')).toBeNull(); |
| 148 | + |
| 149 | + await user.click(f.toggle()); |
| 150 | + expect(f.content()).not.toHaveAttribute('hidden'); |
| 151 | + expect(screen.getByTestId('pkg-id-format-hint')).toBeVisible(); |
| 152 | + }); |
| 153 | + |
| 154 | + it('a name that derives no id opens Advanced by itself, at the line that says why', () => { |
| 155 | + const f = openCreate(); |
| 156 | + fireEvent.change(f.name(), { target: { value: '工单中心' } }); |
| 157 | + |
| 158 | + expect(f.submit()).toBeDisabled(); |
| 159 | + expect(f.toggle()).toHaveAttribute('aria-expanded', 'true'); |
| 160 | + expect(f.content()).not.toHaveAttribute('hidden'); |
| 161 | + expect(screen.getByTestId('package-form-id-missing')).toHaveTextContent( |
| 162 | + tFormat('engine.packages.idRule.notDerived', 'en-US', { example: 'com.acme.crm' }), |
| 163 | + ); |
| 164 | + }); |
| 165 | +}); |
| 166 | + |
| 167 | +describe('editing an existing package keeps its fields (objectstack#27833)', () => { |
| 168 | + it('has no Advanced disclosure of its own and shows the locked id with the other rows', () => { |
| 169 | + const manifest = { id: 'com.acme.crm', name: 'Acme CRM', version: '1.0.0', type: 'app', namespace: 'crm' }; |
| 170 | + render(<PackageFormDialog mode="edit" open onOpenChange={vi.fn()} manifest={manifest} />); |
| 171 | + |
| 172 | + expect(screen.queryByTestId('package-form-advanced')).toBeNull(); |
| 173 | + expect(screen.queryByTestId('package-form-derived-summary')).toBeNull(); |
| 174 | + const id = screen.getByLabelText(label('engine.packages.create.id'), { exact: false }) as HTMLInputElement; |
| 175 | + expect(id).toHaveValue('com.acme.crm'); |
| 176 | + expect(id).toHaveAttribute('readonly'); |
| 177 | + expect(screen.getByRole('textbox', { name: new RegExp(label('engine.packages.create.version')) })).toHaveValue( |
| 178 | + '1.0.0', |
| 179 | + ); |
| 180 | + }); |
| 181 | +}); |
0 commit comments