@wise/dynamic-flow-client 5.8.1 → 5.9.0

package/build/tests/legacy/HiddenSchemas.test.js

@@ -0,0 +1,246 @@
+import { jsx as _jsx } from "react/jsx-runtime";
+import { screen, waitFor } from '@testing-library/react';
+import { userEvent } from '@testing-library/user-event';
+import { vi } from 'vitest';
+import { renderWithProviders, respondWith } from '../../test-utils';
+import DynamicFlowWise from '../../test-utils/DynamicFlowWise';
+import { createEmptyStep } from '../../test-utils/step-utils';
+// This file is a copy of the E2E test in legacy. It should remain as unchanged
+// as possible, to ensure the new client functionality matches the old one.
+const emptyStep = createEmptyStep();
+const initialStep = (schema) => ({
+    id: 'hidden-schema-test-step-id',
+    title: 'Hidden Schema Step Title',
+    layout: [
+        { type: 'form', schemaId: '#schema' },
+        {
+            type: 'button',
+            title: 'Submit',
+            action: { url: '/submit', method: 'POST' },
+        },
+    ],
+    schemas: [
+        Object.assign(Object.assign({}, schema), { $id: '#schema' }),
+    ],
+});
+const user = userEvent.setup({ advanceTimers: vi.advanceTimersByTime });
+const mockHttpClient = vi.fn((async (input, init) => Promise.resolve(respondWith(emptyStep))));
+const getProps = (schema, overrides = {}) => (Object.assign({ flowId: 'allof-schema-test-flow-id', initialStep: initialStep(schema), httpClient: mockHttpClient, onCompletion: vi.fn(), onError: vi.fn(), onEvent: vi.fn(), onLog: vi.fn() }, overrides));
+beforeEach(() => mockHttpClient.mockClear());
+describe('Given an object schema which is marked as hidden', () => {
+    const schema = {
+        type: 'object',
+        title: 'Hidden Object Schema Title',
+        hidden: true,
+        displayOrder: ['name', 'location'],
+        properties: {
+            name: { type: 'string', title: 'Name' },
+            location: { type: 'string', title: 'Location' },
+        },
+    };
+    it('does not render UI components for the hidden schema', async () => {
+        renderWithProviders(_jsx(DynamicFlowWise, Object.assign({}, getProps(schema))));
+        expect(screen.queryByLabelText('Hidden Object Schema Title')).not.toBeInTheDocument();
+        expect(screen.queryByLabelText('Name')).not.toBeInTheDocument();
+        expect(screen.queryByLabelText('Location')).not.toBeInTheDocument();
+    });
+});
+// this is a new test in revamp
+describe('Given an object schema which is marked as hidden with required properties', () => {
+    it('allows submission and ignores values that arent in the model', async () => {
+        var _a, _b;
+        const schema = {
+            type: 'object',
+            title: 'Hidden Object Schema Title',
+            hidden: true,
+            displayOrder: ['name', 'location'],
+            required: ['name', 'location'],
+            properties: {
+                name: { type: 'string', title: 'Name' },
+                location: { type: 'string', title: 'Location' },
+            },
+        };
+        renderWithProviders(_jsx(DynamicFlowWise, Object.assign({}, getProps(schema, { initialStep: Object.assign(Object.assign({}, initialStep(schema)), { model: { name: 'Bob' } }) }))));
+        await user.click(screen.getByText('Submit'));
+        await waitFor(() => expect(mockHttpClient).toHaveBeenCalledWith('/submit', expect.anything()));
+        const lastCall = (_a = mockHttpClient.mock.lastCall) !== null && _a !== void 0 ? _a : [];
+        const requestBody = JSON.parse((_b = lastCall[1]) === null || _b === void 0 ? void 0 : _b.body);
+        expect(requestBody).toEqual({ name: 'Bob' });
+    });
+});
+// this is a new test in revamp
+describe('Given an array tuple schema which is marked as hidden with required properties', () => {
+    it('allows submission and submits nulls when values are missing', async () => {
+        var _a, _b;
+        const schema = {
+            type: 'array',
+            items: [
+                {
+                    type: 'string',
+                    title: 'name',
+                },
+                {
+                    type: 'number',
+                    title: 'age',
+                },
+            ],
+            hidden: true,
+            title: 'Hidden Array Schema Title',
+        };
+        renderWithProviders(_jsx(DynamicFlowWise, Object.assign({}, getProps(schema, { initialStep: Object.assign(Object.assign({}, initialStep(schema)), { model: ['Bob'] }) }))));
+        await user.click(screen.getByText('Submit'));
+        await waitFor(() => expect(mockHttpClient).toHaveBeenCalledWith('/submit', expect.anything()));
+        const lastCall = (_a = mockHttpClient.mock.lastCall) !== null && _a !== void 0 ? _a : [];
+        const requestBody = JSON.parse((_b = lastCall[1]) === null || _b === void 0 ? void 0 : _b.body);
+        expect(requestBody).toEqual(['Bob', null]);
+    });
+});
+describe('Given a hidden object schema whose children have default values', () => {
+    it('submits the default values', async () => {
+        var _a, _b;
+        const schema = {
+            type: 'object',
+            title: 'Hidden Object Schema Title',
+            hidden: true,
+            displayOrder: ['name', 'location'],
+            properties: {
+                name: { type: 'string', title: 'Name', default: 'Bob' },
+                location: { type: 'string', title: 'Location', default: 'Earth' },
+            },
+        };
+        renderWithProviders(_jsx(DynamicFlowWise, Object.assign({}, getProps(schema))));
+        await user.click(screen.getByText('Submit'));
+        await waitFor(() => expect(mockHttpClient).toHaveBeenCalledWith('/submit', expect.anything()));
+        const lastCall = (_a = mockHttpClient.mock.lastCall) !== null && _a !== void 0 ? _a : [];
+        const requestBody = JSON.parse((_b = lastCall[1]) === null || _b === void 0 ? void 0 : _b.body);
+        expect(requestBody).toEqual({ name: 'Bob', location: 'Earth' });
+    });
+});
+describe('Given an object schema with one of its properties marked as hidden', () => {
+    const schema = {
+        type: 'object',
+        displayOrder: ['name', 'location'],
+        required: ['location'],
+        properties: {
+            name: { type: 'string', title: 'Name' },
+            location: { type: 'string', title: 'Location', hidden: true },
+        },
+    };
+    it('only renders the schemas that are not hidden', () => {
+        renderWithProviders(_jsx(DynamicFlowWise, Object.assign({}, getProps(schema))));
+        expect(screen.getByText('Name')).toBeInTheDocument();
+        expect(screen.queryByText('Location')).not.toBeInTheDocument();
+    });
+    it('allows submitting even if the required hidden schema is doesnt have a valid model', async () => {
+        const props = getProps(schema);
+        renderWithProviders(_jsx(DynamicFlowWise, Object.assign({}, props)));
+        await user.click(screen.getByText('Submit'));
+        await waitFor(() => expect(props.httpClient).toHaveBeenCalledWith('/submit', expect.anything()));
+    });
+    it('only submits the valid model parts', async () => {
+        var _a, _b;
+        const step = Object.assign(Object.assign({}, initialStep(schema)), { model: { name: 'Bob', location: 123 } });
+        const props = getProps(schema, { initialStep: step });
+        renderWithProviders(_jsx(DynamicFlowWise, Object.assign({}, props)));
+        await user.click(screen.getByText('Submit'));
+        await waitFor(() => expect(props.httpClient).toHaveBeenCalledWith('/submit', expect.anything()));
+        const lastCall = (_a = mockHttpClient.mock.lastCall) !== null && _a !== void 0 ? _a : [];
+        const requestBody = JSON.parse((_b = lastCall[1]) === null || _b === void 0 ? void 0 : _b.body);
+        expect(requestBody).not.toHaveProperty('location');
+        expect(requestBody).toEqual({ name: 'Bob' });
+    });
+});
+describe('Given an object schema with one of its properties being a const and hidden', () => {
+    const schema = {
+        type: 'object',
+        displayOrder: ['name', 'profileId'],
+        required: ['profileId'],
+        properties: {
+            name: { type: 'string', title: 'Name' },
+            profileId: { const: '12345678', hidden: true },
+        },
+    };
+    it('allows submitting because the hidden const provides its own value', async () => {
+        const props = getProps(schema);
+        renderWithProviders(_jsx(DynamicFlowWise, Object.assign({}, props)));
+        await user.click(screen.getByText('Submit'));
+        await waitFor(() => expect(props.httpClient).toHaveBeenCalledWith('/submit', expect.anything()));
+    });
+});
+describe('Given a oneOf schema with hidden const options', () => {
+    const schema = {
+        type: 'object',
+        displayOrder: ['currency'],
+        required: ['currency'],
+        properties: {
+            currency: {
+                title: 'Currency',
+                oneOf: [
+                    { const: 'EUR', title: 'EUR', hidden: true },
+                    { const: 'GBP', title: 'GBP', hidden: true },
+                    { const: 'USD', title: 'USD', hidden: true },
+                ],
+                control: 'radio',
+            },
+        },
+    };
+    it('renders all options, including the hidden ones', () => {
+        renderWithProviders(_jsx(DynamicFlowWise, Object.assign({}, getProps(schema))));
+        // We cannot hide hidden options because of backwards compatibility
+        // some flows may have hidden options by accident
+        expect(screen.getByLabelText('EUR')).toBeInTheDocument();
+        expect(screen.getByLabelText('GBP')).toBeInTheDocument();
+        expect(screen.getByLabelText('USD')).toBeInTheDocument();
+    });
+});
+describe('Given a oneOf schema with hidden non-const options', () => {
+    const schema = {
+        type: 'object',
+        displayOrder: ['recipientType'],
+        required: ['recipientType'],
+        properties: {
+            recipientType: {
+                title: 'Recipient Type',
+                oneOf: [
+                    {
+                        type: 'object',
+                        title: 'Person',
+                        displayOrder: ['name', 'something'],
+                        required: ['name', 'something'],
+                        properties: {
+                            name: { type: 'string', title: 'Name' },
+                            something: { type: 'string', title: 'Something', hidden: true },
+                        },
+                    },
+                    {
+                        type: 'object',
+                        title: 'Company',
+                        displayOrder: ['companyName', 'something'],
+                        required: ['companyName', 'something'],
+                        properties: {
+                            companyName: { type: 'string', title: 'Company Name' },
+                            something: { type: 'string', title: 'Something', hidden: true },
+                        },
+                    },
+                ],
+                control: 'tab',
+            },
+        },
+    };
+    it('renders all options, including the hidden ones', () => {
+        renderWithProviders(_jsx(DynamicFlowWise, Object.assign({}, getProps(schema))));
+        // We cannot hide hidden options because of backwards compatibility
+        // some flows may have hidden options by accident
+        expect(screen.getByLabelText('Person')).toBeInTheDocument();
+        expect(screen.getByLabelText('Company')).toBeInTheDocument();
+        expect(screen.getByLabelText('Name')).toBeInTheDocument();
+        expect(screen.queryByLabelText('Something')).not.toBeInTheDocument();
+    });
+    it('allows submission even if hidden properties inside the oneOf schema are not valid', async () => {
+        const props = getProps(schema);
+        renderWithProviders(_jsx(DynamicFlowWise, Object.assign({}, props)));
+        await user.type(screen.getByLabelText('Name'), 'John Doe');
+        await user.click(screen.getByText('Submit'));
+        await waitFor(() => expect(props.httpClient).toHaveBeenCalledWith('/submit', expect.anything()));
+    });
+});