@wise/dynamic-flow-client 3.11.4-experiment-node20-aa45bc2 → 3.11.4

package/build/legacy/dynamicFlow/tests/DynamicFlow.spec.js

@@ -1,559 +0,0 @@
-var __assign = (this && this.__assign) || function () {
-    __assign = Object.assign || function(t) {
-        for (var s, i = 1, n = arguments.length; i < n; i++) {
-            s = arguments[i];
-            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
-                t[p] = s[p];
-        }
-        return t;
-    };
-    return __assign.apply(this, arguments);
-};
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-var __generator = (this && this.__generator) || function (thisArg, body) {
-    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
-    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
-    function verb(n) { return function (v) { return step([n, v]); }; }
-    function step(op) {
-        if (f) throw new TypeError("Generator is already executing.");
-        while (g && (g = 0, op[0] && (_ = 0)), _) try {
-            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
-            if (y = 0, t) op = [op[0] & 2, t.value];
-            switch (op[0]) {
-                case 0: case 1: t = op; break;
-                case 4: _.label++; return { value: op[1], done: false };
-                case 5: _.label++; y = op[1]; op = [0]; continue;
-                case 7: op = _.ops.pop(); _.trys.pop(); continue;
-                default:
-                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
-                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
-                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
-                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
-                    if (t[2]) _.ops.pop();
-                    _.trys.pop(); continue;
-            }
-            op = body.call(thisArg, _);
-        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
-        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
-    }
-};
-import { jsx as _jsx } from "react/jsx-runtime";
-/* eslint-disable @typescript-eslint/no-non-null-assertion */
-import { waitForElementToBeRemoved, screen, fireEvent, waitFor } from '@testing-library/react';
-import { userEvent } from '@testing-library/user-event';
-import { schemas, layouts } from '@wise/dynamic-flow-fixtures';
-import { act } from 'react-dom/test-utils';
-import { renderWithProviders } from '../../test-utils';
-import { getMockHttpClient, respondWith } from '../../../test-utils/fetch-utils';
-import DynamicFlow from '../DynamicFlow';
-var user = userEvent.setup({ advanceTimers: function (delay) { return jest.advanceTimersByTime(delay); } });
-describe('DynamicFlow', function () {
-    var onCompletion = jest.fn();
-    var onError = jest.fn();
-    beforeEach(function () {
-        jest.clearAllMocks();
-        jest.useFakeTimers();
-    });
-    afterEach(function () {
-        jest.useRealTimers();
-    });
-    describe('action response', function () {
-        it('performs an action if initial fetch contains an action', function () { return __awaiter(void 0, void 0, void 0, function () {
-            var mockHttpClient;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0:
-                        mockHttpClient = getMockHttpClient({
-                            '/form': function () {
-                                return respondWith({
-                                    action: {
-                                        url: '/action',
-                                        method: 'POST',
-                                        data: {
-                                            foo: 'bar',
-                                        },
-                                    },
-                                });
-                            },
-                            '/action': function () { return respondWith(schemas.object); },
-                        });
-                        renderWithProviders(_jsx(DynamicFlow, { flowId: "the-flow-id", httpClient: mockHttpClient, initialAction: { method: 'GET', url: '/form' }, onCompletion: onCompletion, onError: onError }));
-                        expect(screen.getByTestId('loader')).toBeInTheDocument();
-                        return [4 /*yield*/, waitForElementToBeRemoved(screen.queryByTestId('loader'))];
-                    case 1:
-                        _a.sent();
-                        expect(screen.getByText(schemas.object.title)).toBeInTheDocument();
-                        return [2 /*return*/];
-                }
-            });
-        }); });
-        it('performs an action if fetch response contains an action', function () { return __awaiter(void 0, void 0, void 0, function () {
-            var mockHttpClient;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0:
-                        mockHttpClient = getMockHttpClient({
-                            '/form': function () { return respondWith(schemas.object); },
-                            '/submit': function () {
-                                return respondWith({
-                                    action: {
-                                        url: '/action',
-                                        method: 'POST',
-                                        data: {
-                                            foo: 'bar',
-                                        },
-                                    },
-                                });
-                            },
-                            '/action': function () { return respondWith(layouts.alert); },
-                        });
-                        renderWithProviders(_jsx(DynamicFlow, { flowId: "the-flow-id", httpClient: mockHttpClient, initialAction: { method: 'GET', url: '/form' }, onCompletion: onCompletion, onError: onError }));
-                        expect(screen.getByTestId('loader')).toBeInTheDocument();
-                        return [4 /*yield*/, waitForElementToBeRemoved(screen.queryByTestId('loader'))];
-                    case 1:
-                        _a.sent();
-                        expect(screen.getByText(schemas.object.title)).toBeInTheDocument();
-                        fireEvent.click(screen.getByText('Submit'));
-                        return [4 /*yield*/, expect(screen.findByText(layouts.alert.title)).resolves.toBeInTheDocument()];
-                    case 2:
-                        _a.sent();
-                        return [2 /*return*/];
-                }
-            });
-        }); });
-        it('performs an action if refresh response contains an action', function () { return __awaiter(void 0, void 0, void 0, function () {
-            var formWithRefresh, mockHttpClient;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0:
-                        formWithRefresh = __assign(__assign({}, schemas.object), { schemas: [
-                                {
-                                    $id: '#the-schema',
-                                    type: 'object',
-                                    displayOrder: ['name'],
-                                    properties: {
-                                        name: {
-                                            title: 'Name',
-                                            type: 'string',
-                                            refreshStepOnChange: true,
-                                            refreshUrl: '/refresh',
-                                        },
-                                    },
-                                },
-                            ] });
-                        mockHttpClient = getMockHttpClient({
-                            '/form': function () { return respondWith(formWithRefresh); },
-                            '/refresh': function () {
-                                return respondWith({
-                                    action: {
-                                        url: '/action',
-                                        method: 'POST',
-                                        data: {
-                                            foo: 'bar',
-                                        },
-                                    },
-                                });
-                            },
-                            '/action': function () { return respondWith(layouts.alert); },
-                        });
-                        renderWithProviders(_jsx(DynamicFlow, { flowId: "the-flow-id", httpClient: mockHttpClient, initialAction: { method: 'GET', url: '/form' }, onCompletion: onCompletion, onError: onError }));
-                        expect(screen.getByTestId('loader')).toBeInTheDocument();
-                        return [4 /*yield*/, waitForElementToBeRemoved(screen.queryByTestId('loader'))];
-                    case 1:
-                        _a.sent();
-                        expect(screen.getByText(schemas.object.title)).toBeInTheDocument();
-                        return [4 /*yield*/, user.type(screen.getByLabelText('Name'), 'foo')];
-                    case 2:
-                        _a.sent();
-                        act(function () {
-                            jest.advanceTimersByTime(2000);
-                        });
-                        return [4 /*yield*/, expect(screen.findByText(layouts.alert.title)).resolves.toBeInTheDocument()];
-                    case 3:
-                        _a.sent();
-                        return [2 /*return*/];
-                }
-            });
-        }); });
-        it('performs an exit if initial fetch contains an action with exit true', function () { return __awaiter(void 0, void 0, void 0, function () {
-            var mockHttpClient, onCompletion;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0:
-                        mockHttpClient = getMockHttpClient({
-                            '/form': function () {
-                                return respondWith({
-                                    action: {
-                                        exit: true,
-                                        result: {
-                                            foo: 'bar',
-                                        },
-                                    },
-                                });
-                            },
-                        });
-                        onCompletion = jest.fn();
-                        renderWithProviders(_jsx(DynamicFlow, { flowId: "the-flow-id", httpClient: mockHttpClient, initialAction: { method: 'GET', url: '/form' }, onCompletion: onCompletion, onError: onError }));
-                        return [4 /*yield*/, waitFor(function () { return expect(onCompletion).toHaveBeenCalledWith({ foo: 'bar' }); })];
-                    case 1:
-                        _a.sent();
-                        return [2 /*return*/];
-                }
-            });
-        }); });
-    });
-    describe('step validation errors', function () {
-        describe('when a action request returns an identical step/schema with validation errors', function () {
-            var schema = {
-                $id: '#schema',
-                type: 'object',
-                displayOrder: ['name'],
-                properties: {
-                    name: { type: 'string', title: 'Name' },
-                },
-            };
-            var step = {
-                title: 'title',
-                type: 'form',
-                schemas: [schema],
-                layout: [
-                    {
-                        type: 'form',
-                        schemaId: schema.$id,
-                    },
-                    {
-                        type: 'button',
-                        title: 'Submit',
-                        action: { url: '/submit' },
-                    },
-                ],
-                errors: undefined,
-            };
-            var errors = {
-                validation: { name: 'Server-side error for "name" field' },
-            };
-            var httpClient = function () { return Promise.resolve(new Response(JSON.stringify(__assign(__assign({}, step), { errors: errors })))); };
-            var renderDFWithInitialStep = function () {
-                return renderWithProviders(_jsx(DynamicFlow, { flowId: "the-flow-id", httpClient: httpClient, initialStep: step, onCompletion: jest.fn(), onError: jest.fn() }));
-            };
-            describe('and a text field value has not been changed', function () {
-                it('displays the server-side validation errors', function () { return __awaiter(void 0, void 0, void 0, function () {
-                    return __generator(this, function (_a) {
-                        switch (_a.label) {
-                            case 0:
-                                renderDFWithInitialStep();
-                                return [4 /*yield*/, user.click(screen.getByText('Submit'))];
-                            case 1:
-                                _a.sent();
-                                return [4 /*yield*/, waitFor(function () {
-                                        expect(screen.getByText('Server-side error for "name" field')).toBeInTheDocument();
-                                    })];
-                            case 2:
-                                _a.sent();
-                                return [2 /*return*/];
-                        }
-                    });
-                }); });
-            });
-            describe('and a text field value had been changed', function () {
-                it('displays the server-side validation errors', function () { return __awaiter(void 0, void 0, void 0, function () {
-                    var input;
-                    return __generator(this, function (_a) {
-                        switch (_a.label) {
-                            case 0:
-                                renderDFWithInitialStep();
-                                input = screen.getByLabelText('Name');
-                                return [4 /*yield*/, user.type(input, 'Bob Loblaw')];
-                            case 1:
-                                _a.sent();
-                                expect(screen.getByDisplayValue('Bob Loblaw')).toBeInTheDocument();
-                                return [4 /*yield*/, user.clear(input)];
-                            case 2:
-                                _a.sent();
-                                return [4 /*yield*/, user.click(screen.getByText('Submit'))];
-                            case 3:
-                                _a.sent();
-                                return [4 /*yield*/, waitFor(function () {
-                                        expect(screen.getByText('Server-side error for "name" field')).toBeInTheDocument();
-                                    })];
-                            case 4:
-                                _a.sent();
-                                return [2 /*return*/];
-                        }
-                    });
-                }); });
-            });
-        });
-    });
-    describe('analytics', function () {
-        describe('on step fetch', function () {
-            var basicStep = {
-                title: 'title',
-                type: 'form',
-                schemas: [],
-                actions: [],
-                layout: [
-                    {
-                        type: 'button',
-                        action: {
-                            id: 'submit-action-id',
-                            url: '/submit',
-                            title: 'Submit',
-                            type: 'primary',
-                        },
-                    },
-                ],
-            };
-            describe('stepId', function () {
-                it('includes step id in analytics event metadata', function () { return __awaiter(void 0, void 0, void 0, function () {
-                    var onEvent;
-                    return __generator(this, function (_a) {
-                        switch (_a.label) {
-                            case 0:
-                                onEvent = jest.fn();
-                                renderWithProviders(_jsx(DynamicFlow, { flowId: "the-flow-id", httpClient: getMockHttpClient({}), initialStep: __assign(__assign({}, basicStep), { id: 'test-id' }), onCompletion: onCompletion, onError: onError, onEvent: onEvent }));
-                                return [4 /*yield*/, user.click(screen.getByText('Submit'))];
-                            case 1:
-                                _a.sent();
-                                expect(onEvent).toHaveBeenCalledWith('Dynamic Flow - Step Submitted', expect.objectContaining({ stepId: 'test-id' }));
-                                return [2 /*return*/];
-                        }
-                    });
-                }); });
-                it('includes step key in analytics event metadata when provided', function () { return __awaiter(void 0, void 0, void 0, function () {
-                    var onEvent;
-                    return __generator(this, function (_a) {
-                        switch (_a.label) {
-                            case 0:
-                                onEvent = jest.fn();
-                                renderWithProviders(_jsx(DynamicFlow, { flowId: "the-flow-id", httpClient: getMockHttpClient({}), initialStep: __assign(__assign({}, basicStep), { key: 'test-key' }), onCompletion: onCompletion, onError: onError, onEvent: onEvent }));
-                                return [4 /*yield*/, user.click(screen.getByText('Submit'))];
-                            case 1:
-                                _a.sent();
-                                expect(onEvent).toHaveBeenCalledWith('Dynamic Flow - Step Submitted', expect.objectContaining({ stepId: 'test-key' }));
-                                return [2 /*return*/];
-                        }
-                    });
-                }); });
-                it('prefers step id over key in analytics event metadata when provided', function () { return __awaiter(void 0, void 0, void 0, function () {
-                    var onEvent;
-                    return __generator(this, function (_a) {
-                        switch (_a.label) {
-                            case 0:
-                                onEvent = jest.fn();
-                                renderWithProviders(_jsx(DynamicFlow, { flowId: "the-flow-id", httpClient: getMockHttpClient({}), initialStep: __assign(__assign({}, basicStep), { key: 'test-key', id: 'test-id' }), onCompletion: onCompletion, onError: onError, onEvent: onEvent }));
-                                return [4 /*yield*/, user.click(screen.getByText('Submit'))];
-                            case 1:
-                                _a.sent();
-                                expect(onEvent).toHaveBeenCalledWith('Dynamic Flow - Step Submitted', expect.objectContaining({ stepId: 'test-id' }));
-                                return [2 /*return*/];
-                        }
-                    });
-                }); });
-            });
-            describe('actionId', function () {
-                var getStepWithAction = function (action) { return ({
-                    title: 'title',
-                    type: 'form',
-                    schemas: [],
-                    layout: [{ type: 'button', title: 'Submit', action: action }],
-                }); };
-                describe('when action.id is provided', function () {
-                    var step = getStepWithAction({
-                        id: 'submit-action-id',
-                        url: '/submit',
-                    });
-                    it('uses it as actionId in the analytics event', function () { return __awaiter(void 0, void 0, void 0, function () {
-                        var onEvent;
-                        return __generator(this, function (_a) {
-                            switch (_a.label) {
-                                case 0:
-                                    onEvent = jest.fn();
-                                    renderWithProviders(_jsx(DynamicFlow, { flowId: "the-flow-id", httpClient: getMockHttpClient({}), initialStep: step, onCompletion: onCompletion, onError: onError, onEvent: onEvent }));
-                                    return [4 /*yield*/, user.click(screen.getByText('Submit'))];
-                                case 1:
-                                    _a.sent();
-                                    expect(onEvent).toHaveBeenCalledWith('Dynamic Flow - Step Submitted', expect.objectContaining({ actionId: 'submit-action-id' }));
-                                    return [2 /*return*/];
-                            }
-                        });
-                    }); });
-                });
-                describe('when action.$id is provided', function () {
-                    var step = getStepWithAction({
-                        $id: 'submit-action-$id',
-                        url: '/submit',
-                    });
-                    it('uses it as actionId in the analytics event', function () { return __awaiter(void 0, void 0, void 0, function () {
-                        var onEvent;
-                        return __generator(this, function (_a) {
-                            switch (_a.label) {
-                                case 0:
-                                    onEvent = jest.fn();
-                                    renderWithProviders(_jsx(DynamicFlow, { flowId: "the-flow-id", httpClient: getMockHttpClient({}), initialStep: step, onCompletion: onCompletion, onError: onError, onEvent: onEvent }));
-                                    return [4 /*yield*/, user.click(screen.getByText('Submit'))];
-                                case 1:
-                                    _a.sent();
-                                    expect(onEvent).toHaveBeenCalledWith('Dynamic Flow - Step Submitted', expect.objectContaining({ actionId: 'submit-action-$id' }));
-                                    return [2 /*return*/];
-                            }
-                        });
-                    }); });
-                });
-                describe('when both action.id and action$id are provided', function () {
-                    var step = getStepWithAction({
-                        id: 'submit-action-id',
-                        $id: 'submit-action-$id',
-                        url: '/submit',
-                    });
-                    it('prefers action.id as actionId in the analytics event', function () { return __awaiter(void 0, void 0, void 0, function () {
-                        var onEvent;
-                        return __generator(this, function (_a) {
-                            switch (_a.label) {
-                                case 0:
-                                    onEvent = jest.fn();
-                                    renderWithProviders(_jsx(DynamicFlow, { flowId: "the-flow-id", httpClient: getMockHttpClient({}), initialStep: step, onCompletion: onCompletion, onError: onError, onEvent: onEvent }));
-                                    return [4 /*yield*/, user.click(screen.getByText('Submit'))];
-                                case 1:
-                                    _a.sent();
-                                    expect(onEvent).toHaveBeenCalledWith('Dynamic Flow - Step Submitted', expect.objectContaining({ actionId: 'submit-action-id' }));
-                                    return [2 /*return*/];
-                            }
-                        });
-                    }); });
-                });
-            });
-        });
-    });
-    describe('when given a step with an unreferenced schema', function () {
-        var unreferencedSchemaStep = {
-            id: 'unreferenced-schemas',
-            title: 'Unreferenced Schemas',
-            description: 'This step contains 2 schemas, but only one is referenced by a layout component.',
-            actions: [],
-            schemas: [
-                {
-                    $id: '#schema-1',
-                    type: 'object',
-                    properties: {
-                        name: {
-                            title: 'Full name',
-                            type: 'string',
-                        },
-                    },
-                    displayOrder: ['name'],
-                },
-                {
-                    $id: '#schema-2',
-                    type: 'object',
-                    properties: {
-                        city: {
-                            title: 'City',
-                            type: 'string',
-                        },
-                    },
-                    required: ['city'],
-                    displayOrder: ['city'],
-                },
-            ],
-            layout: [
-                {
-                    type: 'form',
-                    schemaId: '#schema-1',
-                },
-                {
-                    type: 'button',
-                    action: {
-                        url: '/submit',
-                        title: 'Submit',
-                        type: 'primary',
-                    },
-                },
-            ],
-        };
-        describe('and a form is submitted', function () {
-            it('form submits successfully', function () { return __awaiter(void 0, void 0, void 0, function () {
-                var onEvent;
-                return __generator(this, function (_a) {
-                    switch (_a.label) {
-                        case 0:
-                            onEvent = jest.fn();
-                            renderWithProviders(_jsx(DynamicFlow, { flowId: "the-flow-id", httpClient: getMockHttpClient({}), initialStep: unreferencedSchemaStep, onCompletion: onCompletion, onError: onError, onEvent: onEvent }));
-                            return [4 /*yield*/, user.click(screen.getByText('Submit'))];
-                        case 1:
-                            _a.sent();
-                            expect(onEvent).toHaveBeenCalledWith('Dynamic Flow - Step Submitted', expect.objectContaining({ stepId: 'unreferenced-schemas' }));
-                            return [2 /*return*/];
-                    }
-                });
-            }); });
-        });
-    });
-    describe('when given a step with no layout array', function () {
-        var stepWithNoLayout = {
-            id: 'no-layout',
-            type: 'final',
-            actions: [],
-            details: {
-                description: 'No layout description',
-                title: 'No layout',
-            },
-            success: true,
-        };
-        it('logs a deprecation warning if initial step has no layout', function () { return __awaiter(void 0, void 0, void 0, function () {
-            var onLog;
-            return __generator(this, function (_a) {
-                onLog = jest.fn();
-                renderWithProviders(_jsx(DynamicFlow, { flowId: "the-flow-id", httpClient: getMockHttpClient({}), initialStep: stepWithNoLayout, onCompletion: onCompletion, onError: onError, onLog: onLog }));
-                expect(onLog).toHaveBeenCalledWith('warning', 'Dynamic Flow warning - Deprecation warning - Support for steps with no layout is being dropped. Please add a layout array to your step.', { flowId: 'the-flow-id', stepId: 'no-layout' });
-                return [2 /*return*/];
-            });
-        }); });
-        it('logs a deprecation warning if an update results in a step with no layout', function () { return __awaiter(void 0, void 0, void 0, function () {
-            var mockHttpClient, stepWithLayout, onLog, submitButton;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0:
-                        mockHttpClient = getMockHttpClient({
-                            '/submit': function () { return respondWith(stepWithNoLayout); },
-                        });
-                        stepWithLayout = {
-                            id: 'no-layout',
-                            title: 'Normal Step',
-                            schemas: [],
-                            layout: [
-                                {
-                                    type: 'button',
-                                    title: 'Submit',
-                                    action: {
-                                        url: '/submit',
-                                    },
-                                },
-                            ],
-                        };
-                        onLog = jest.fn();
-                        renderWithProviders(_jsx(DynamicFlow, { flowId: "the-flow-id", httpClient: mockHttpClient, initialStep: stepWithLayout, onCompletion: onCompletion, onError: onError, onLog: onLog }));
-                        submitButton = screen.getByRole('button', { name: 'Submit' });
-                        act(function () {
-                            submitButton.click();
-                        });
-                        return [4 /*yield*/, waitFor(function () {
-                                expect(screen.getByText('No layout')).toBeInTheDocument();
-                            })];
-                    case 1:
-                        _a.sent();
-                        expect(onLog).toHaveBeenCalledWith('warning', 'Dynamic Flow warning - Deprecation warning - Support for steps with no layout is being dropped. Please add a layout array to your step.', { flowId: 'the-flow-id', stepId: 'no-layout' });
-                        return [2 /*return*/];
-                }
-            });
-        }); });
-    });
-});