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

package/build/revamp/tests/legacy/MultipleFileUploadSchema.spec.js

@@ -0,0 +1,447 @@
+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 no-console */
+import { screen, waitFor } from '@testing-library/react';
+import { userEvent } from '@testing-library/user-event';
+import { renderWithProviders } from '../../../test-utils';
+import DynamicFlowWise from '../../DynamicFlowWise';
+var user = userEvent.setup();
+// 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.
+describe('Given a multiple file upload schema', function () {
+    var accepts = ['image/png', 'image/jpg', 'application/pdf'];
+    var maxSize = 5242000;
+    var description = 'PNG, JPG, or PDF, less than 5mb';
+    var idProperty = 'responseKey';
+    var param = 'bodyAttribute';
+    var uploadTitle = 'Invoice (optional)';
+    var getArraySchema = function (overrides) { return (__assign({ type: 'array', title: 'upload schema title', minItems: 1, maxItems: 2, addItemTitle: '', editItemTitle: '', items: {
+            type: 'string',
+            persistAsync: {
+                url: 'http://localhost:3001/v1/save-file/',
+                method: 'POST',
+                param: param,
+                idProperty: idProperty,
+                schema: {
+                    // Modification: we now read the analytics id from the inner schema
+                    $id: 'upload-id',
+                    type: 'string',
+                    format: 'base64url',
+                    title: uploadTitle,
+                    description: description,
+                    maxSize: maxSize,
+                    accepts: accepts,
+                    validationMessages: {
+                        maxSize: 'Your file is too large',
+                    },
+                },
+            },
+        } }, overrides)); };
+    var getMultipleFileUploadSchemaObject = function (arraySchema) {
+        if (arraySchema === void 0) { arraySchema = getArraySchema({}); }
+        return ({
+            type: 'object',
+            $id: '#schema',
+            displayOrder: ['files'],
+            required: ['files'],
+            title: 'upload schema title',
+            properties: {
+                files: __assign({ $id: 'upload-id' }, arraySchema),
+            },
+        });
+    };
+    var getMultipleFileUploadSchemaObjectWithoutId = function () {
+        return ({
+            type: 'object',
+            $id: '#schema',
+            displayOrder: ['files'],
+            required: ['files'],
+            title: 'upload schema title',
+            properties: {
+                files: __assign(__assign({}, getArraySchema({})), { minItems: 2, maxItems: 3, validationMessages: {
+                        minItems: 'minimum items not met error (from schema)',
+                        maxItems: 'maximum items uploaded already (from schema)',
+                    } }),
+            },
+            validationMessages: {
+                minItems: 'minimum items not met error (from schema)',
+                maxItems: 'maximum items uploaded already (from schema)',
+            },
+        });
+    };
+    var testFile = new File([], 'test-file.pdf', { type: 'application/pdf' });
+    var mockHttpClient = jest.fn();
+    var initialStep = {
+        id: 'multiple-file-upload-schema-test-step-id',
+        title: 'OneOf Schema Step Title',
+        layout: [
+            { type: 'form', schemaId: '#schema' },
+            {
+                type: 'button',
+                title: 'Submit',
+                action: { url: '/submit', method: 'POST' },
+            },
+        ],
+        schemas: [getMultipleFileUploadSchemaObject()],
+        model: {},
+        errors: {},
+    };
+    var onEvent = jest.fn();
+    var getProps = function (overrides) {
+        if (overrides === void 0) { overrides = {}; }
+        return (__assign({ flowId: 'multiple-file-upload-schema-test-flow-id', initialStep: initialStep, httpClient: mockHttpClient, onCompletion: jest.fn(), onError: jest.fn(), onEvent: onEvent, onLog: jest.fn() }, overrides));
+    };
+    // We have some duplicate key warnings because we're mocking the random id generator
+    // But I want to keep this file as close to the original as possible, so I'm not going to fix it
+    var originalError = console.error;
+    beforeEach(function () {
+        var _a;
+        mockHttpClient.mockResolvedValue({
+            ok: true,
+            status: 200,
+            json: jest.fn().mockResolvedValue((_a = {}, _a[idProperty] = 'mockFileId', _a)),
+        });
+        console.error = jest.fn();
+    });
+    afterEach(function () {
+        jest.clearAllMocks();
+        onEvent.mockClear();
+        console.error = originalError;
+    });
+    describe('and the schema has an $id prop', function () {
+        // We use the inner id now (and it doesn't really matter anyway)
+        it.skip('should be the $id given to the input component', function () {
+            renderWithProviders(_jsx(DynamicFlowWise, __assign({}, getProps())));
+            expect(screen.getByLabelText('upload schema title')).toBeInTheDocument();
+            expect(screen.getByLabelText('upload schema title')).toHaveAttribute('id', 'upload-id');
+        });
+    });
+    describe('and the schema has no $id prop', function () {
+        it.skip('should be a generated id given to the input component', function () {
+            renderWithProviders(_jsx(DynamicFlowWise, __assign({}, getProps({
+                initialStep: __assign(__assign({}, initialStep), { schemas: [getMultipleFileUploadSchemaObjectWithoutId()] }),
+            }))));
+            expect(screen.getByLabelText('upload schema title')).toBeInTheDocument();
+            expect(screen.getByLabelText('upload schema title')).toHaveAttribute('id', 'DUMMY_GENERATED_UNIQUE_ID');
+        });
+    });
+    it('should render the file input', function () {
+        renderWithProviders(_jsx(DynamicFlowWise, __assign({}, getProps())));
+        expect(screen.getByLabelText('upload schema title')).toHaveAttribute('type', 'file');
+    });
+    describe('when upload successful', function () {
+        it('the files should show as uploaded', function () { return __awaiter(void 0, void 0, void 0, function () {
+            var props;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        props = getProps();
+                        renderWithProviders(_jsx(DynamicFlowWise, __assign({}, props)));
+                        onEvent.mockClear();
+                        return [4 /*yield*/, user.upload(screen.getByLabelText('upload schema title'), testFile)];
+                    case 1:
+                        _a.sent();
+                        return [4 /*yield*/, waitFor(function () { return expect(onEvent).toHaveBeenCalledTimes(2); })];
+                    case 2:
+                        _a.sent();
+                        // Modification (we've changed the events):
+                        expect(onEvent).toHaveBeenCalledWith('Dynamic Flow - PersistAsync Triggered', expect.objectContaining({
+                            flowId: 'multiple-file-upload-schema-test-flow-id',
+                            stepId: 'multiple-file-upload-schema-test-step-id',
+                            schema: 'upload-id',
+                        }));
+                        expect(onEvent).toHaveBeenCalledWith('Dynamic Flow - PersistAsync Succeeded', expect.objectContaining({
+                            flowId: 'multiple-file-upload-schema-test-flow-id',
+                            stepId: 'multiple-file-upload-schema-test-step-id',
+                            schema: 'upload-id',
+                        }));
+                        // Original:
+                        // expect(onEvent).toHaveBeenCalledWith(
+                        //   'Dynamic Flow - PersistAsync',
+                        //   expect.objectContaining({ status: 'pending' }),
+                        // );
+                        // expect(onEvent).toHaveBeenCalledWith(
+                        //   'Dynamic Flow - PersistAsync',
+                        //   expect.objectContaining({ status: 'success' }),
+                        // );
+                        expect(screen.getByText('test-file.pdf')).toBeInTheDocument();
+                        expect(screen.getByText('Uploaded')).toBeInTheDocument();
+                        return [2 /*return*/];
+                }
+            });
+        }); });
+        it('the file IDs should be in the payload on submission', function () { return __awaiter(void 0, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        renderWithProviders(_jsx(DynamicFlowWise, __assign({}, getProps())));
+                        onEvent.mockClear();
+                        return [4 /*yield*/, user.upload(screen.getByLabelText('upload schema title'), testFile)];
+                    case 1:
+                        _a.sent();
+                        return [4 /*yield*/, waitFor(function () { return expect(onEvent).toHaveBeenCalledTimes(2); })];
+                    case 2:
+                        _a.sent();
+                        return [4 /*yield*/, user.click(screen.getByText('Submit'))];
+                    case 3:
+                        _a.sent();
+                        return [4 /*yield*/, waitFor(function () {
+                                return expect(mockHttpClient).toHaveBeenCalledWith('/submit', expect.objectContaining({ body: JSON.stringify({ files: ['mockFileId'] }) }));
+                            })];
+                    case 4:
+                        _a.sent();
+                        return [2 /*return*/];
+                }
+            });
+        }); });
+    });
+    describe('when upload fails', function () {
+        it('shows error message to the user', function () { return __awaiter(void 0, void 0, void 0, function () {
+            var errorMessage;
+            var _a;
+            return __generator(this, function (_b) {
+                switch (_b.label) {
+                    case 0:
+                        errorMessage = 'Error uploading';
+                        mockHttpClient.mockResolvedValueOnce({
+                            ok: false,
+                            status: 422,
+                            json: jest.fn().mockResolvedValue({ validation: (_a = {}, _a[param] = errorMessage, _a) }),
+                        });
+                        renderWithProviders(_jsx(DynamicFlowWise, __assign({}, getProps())));
+                        onEvent.mockClear();
+                        return [4 /*yield*/, user.upload(screen.getByLabelText('upload schema title'), testFile)];
+                    case 1:
+                        _b.sent();
+                        return [4 /*yield*/, waitFor(function () { return expect(onEvent).toHaveBeenCalledTimes(2); })];
+                    case 2:
+                        _b.sent();
+                        // Modification (we've changed the events):
+                        expect(onEvent).toHaveBeenCalledWith('Dynamic Flow - PersistAsync Triggered', expect.objectContaining({
+                            flowId: 'multiple-file-upload-schema-test-flow-id',
+                            stepId: 'multiple-file-upload-schema-test-step-id',
+                            schema: 'upload-id',
+                        }));
+                        expect(onEvent).toHaveBeenCalledWith('Dynamic Flow - PersistAsync Failed', expect.objectContaining({
+                            flowId: 'multiple-file-upload-schema-test-flow-id',
+                            stepId: 'multiple-file-upload-schema-test-step-id',
+                            schema: 'upload-id',
+                        }));
+                        // Original
+                        // expect(onEvent).toHaveBeenCalledWith(
+                        //   'Dynamic Flow - PersistAsync',
+                        //   expect.objectContaining({ status: 'pending' }),
+                        // );
+                        // expect(onEvent).toHaveBeenCalledWith(
+                        //   'Dynamic Flow - PersistAsync',
+                        //   expect.objectContaining({ status: 'failure' }),
+                        // );
+                        expect(screen.getByText('test-file.pdf')).toBeInTheDocument();
+                        expect(screen.getByText('Error uploading')).toBeInTheDocument();
+                        return [2 /*return*/];
+                }
+            });
+        }); });
+        it('model is NOT updated', function () { return __awaiter(void 0, void 0, void 0, function () {
+            var errorMessage;
+            var _a;
+            return __generator(this, function (_b) {
+                switch (_b.label) {
+                    case 0:
+                        errorMessage = 'Error uploading';
+                        renderWithProviders(_jsx(DynamicFlowWise, __assign({}, getProps())));
+                        onEvent.mockClear();
+                        return [4 /*yield*/, user.upload(screen.getByLabelText('upload schema title'), testFile)];
+                    case 1:
+                        _b.sent();
+                        mockHttpClient.mockResolvedValueOnce({
+                            ok: false,
+                            status: 422,
+                            json: jest.fn().mockResolvedValue({ validation: (_a = {}, _a[param] = errorMessage, _a) }),
+                        });
+                        return [4 /*yield*/, user.upload(screen.getByLabelText('upload schema title'), new File([], 'test-file2.pdf', { type: 'application/pdf' }))];
+                    case 2:
+                        _b.sent();
+                        return [4 /*yield*/, waitFor(function () { return expect(onEvent).toHaveBeenCalledTimes(4); })];
+                    case 3:
+                        _b.sent();
+                        return [4 /*yield*/, user.click(screen.getByText('Submit'))];
+                    case 4:
+                        _b.sent();
+                        // only valid file is added to model
+                        return [4 /*yield*/, waitFor(function () {
+                                return expect(mockHttpClient).toHaveBeenCalledWith('/submit', expect.objectContaining({ body: JSON.stringify({ files: ['mockFileId'] }) }));
+                            })];
+                    case 5:
+                        // only valid file is added to model
+                        _b.sent();
+                        return [2 /*return*/];
+                }
+            });
+        }); });
+    });
+    describe('when uploading fewer files than required', function () {
+        it('should show default min items error when submitted with no. of files less than expected if no custom validation message is given', function () { return __awaiter(void 0, void 0, void 0, function () {
+            var props;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        props = getProps({
+                            initialStep: {
+                                id: 'multiple-file-upload-schema-test-step-id',
+                                title: 'OneOf Schema Step Title',
+                                layout: [
+                                    { type: 'form', schemaId: '#schema' },
+                                    {
+                                        type: 'button',
+                                        title: 'Submit',
+                                        action: { url: '/submit', method: 'POST' },
+                                    },
+                                ],
+                                schemas: [
+                                    getMultipleFileUploadSchemaObject(getArraySchema({ minItems: 2, maxItems: 2 })),
+                                ],
+                                model: {},
+                                errors: {},
+                            },
+                        });
+                        renderWithProviders(_jsx(DynamicFlowWise, __assign({}, props)));
+                        return [4 /*yield*/, user.upload(screen.getByLabelText('upload schema title'), testFile)];
+                    case 1:
+                        _a.sent();
+                        return [4 /*yield*/, user.click(screen.getByText('Submit'))];
+                    case 2:
+                        _a.sent();
+                        return [4 /*yield*/, waitFor(function () {
+                                expect(screen.getByText('Please upload at least 2 file(s).')).toBeInTheDocument();
+                            })];
+                    case 3:
+                        _a.sent();
+                        return [2 /*return*/];
+                }
+            });
+        }); });
+        it('should show min items error from schema, when submitted with no. of files less than expected', function () { return __awaiter(void 0, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        renderWithProviders(_jsx(DynamicFlowWise, __assign({}, getProps({
+                            initialStep: __assign(__assign({}, initialStep), { schemas: [getMultipleFileUploadSchemaObjectWithoutId()] }),
+                        }))));
+                        return [4 /*yield*/, user.upload(screen.getByLabelText('upload schema title'), testFile)];
+                    case 1:
+                        _a.sent();
+                        return [4 /*yield*/, user.click(screen.getByText('Submit'))];
+                    case 2:
+                        _a.sent();
+                        expect(screen.getByText('minimum items not met error (from schema)')).toBeInTheDocument();
+                        return [2 /*return*/];
+                }
+            });
+        }); });
+    });
+    // Currently Neptune's UploadInput handles all the max upload errors on drag-drop, bulk upload cases.
+    describe('when trying to upload more files than are allowed', function () {
+        it('should show the maximum allowed number of file uploads', function () { return __awaiter(void 0, void 0, void 0, function () {
+            var it, httpClient;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        it = 0;
+                        httpClient = jest.fn().mockImplementation(function () {
+                            var _a;
+                            return ({
+                                ok: true,
+                                status: 200,
+                                // eslint-disable-next-line no-plusplus
+                                json: jest.fn().mockResolvedValue((_a = {}, _a[idProperty] = "mockFileId".concat(it++), _a)),
+                            });
+                        });
+                        renderWithProviders(_jsx(DynamicFlowWise, __assign({}, getProps({
+                            initialStep: __assign(__assign({}, initialStep), { schemas: [getMultipleFileUploadSchemaObjectWithoutId()] }),
+                            httpClient: httpClient,
+                        }))));
+                        onEvent.mockClear();
+                        // upload 4 items
+                        return [4 /*yield*/, user.upload(screen.getByLabelText('upload schema title'), new File([], 'test-file1.pdf', { type: 'application/pdf' }))];
+                    case 1:
+                        // upload 4 items
+                        _a.sent();
+                        return [4 /*yield*/, user.upload(screen.getByLabelText('upload schema title'), new File([], 'test-file2.pdf', { type: 'application/pdf' }))];
+                    case 2:
+                        _a.sent();
+                        return [4 /*yield*/, user.upload(screen.getByLabelText('upload schema title'), new File([], 'test-file3.pdf', { type: 'application/pdf' }))];
+                    case 3:
+                        _a.sent();
+                        return [4 /*yield*/, user.upload(screen.getByLabelText('upload schema title'), new File([], 'test-file4.pdf', { type: 'application/pdf' }))];
+                    case 4:
+                        _a.sent();
+                        // only 3 shown
+                        return [4 /*yield*/, expect(waitFor(function () { return __awaiter(void 0, void 0, void 0, function () { return __generator(this, function (_a) {
+                                return [2 /*return*/, screen.findAllByText('Uploaded')];
+                            }); }); })).resolves.toHaveLength(3)];
+                    case 5:
+                        // only 3 shown
+                        _a.sent();
+                        return [4 /*yield*/, user.click(screen.getByText('Submit'))];
+                    case 6:
+                        _a.sent();
+                        return [4 /*yield*/, waitFor(function () {
+                                return expect(httpClient).toHaveBeenCalledWith('/submit', expect.objectContaining({
+                                    body: JSON.stringify({ files: ['mockFileId0', 'mockFileId1', 'mockFileId2'] }),
+                                }));
+                            })];
+                    case 7:
+                        _a.sent();
+                        return [2 /*return*/];
+                }
+            });
+        }); });
+    });
+});