@luigi-project/testing-utilities 1.24.1-dev.20220992341 → 1.25.0

package/index.d.ts

@@ -1 +1,2 @@
-export { LuigiMockUtil } from './luigi-mock-util';
+export { LuigiMockUtil } from './luigi-mock-util.js';
+export { LuigiMockEngine } from './luigi-mock-engine.js';

package/index.js

@@ -1,6 +1,2 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.LuigiMockUtil = void 0;
-var luigi_mock_util_1 = require("./luigi-mock-util");
-Object.defineProperty(exports, "LuigiMockUtil", { enumerable: true, get: function () { return luigi_mock_util_1.LuigiMockUtil; } });
-//# sourceMappingURL=index.js.map
+export { LuigiMockUtil } from './luigi-mock-util.js';
+export { LuigiMockEngine } from './luigi-mock-engine.js';

package/luigi-mock-engine.d.ts

@@ -0,0 +1,4 @@
+export declare class LuigiMockEngine {
+    static initPostMessageHook(): () => Promise<void>;
+    static visualize(data: string): void;
+}

package/luigi-mock-engine.js

@@ -0,0 +1,152 @@
+/*
+ * This class mocks Luigi Core related functionality.
+ *
+ * Micro Frontends that use Luigi Client would usually communicate with Luigi Core
+ * back and forth. When testing Luigi Client based components, Luigi Core might
+ * not be present which leads into limitations on integration/e2e testing for standalone
+ * microfrontends.
+ *
+ * This module adds a hook to the window postMessage API by adding an event listener to the
+ * global message event of the window object and mocking the callback.
+ * In the normal workflow this message would picked up by Luigi Core which then sends the response back.
+ */
+export class LuigiMockEngine {
+    // Add a hook to the post message api to mock the LuigiCore response to the Client
+    static initPostMessageHook() {
+        return async () => {
+            // Check if Luigi Client is running standalone
+            if (window.parent === window) {
+                console.debug('Detected standalone mode');
+                // Check and skip if Luigi environment is already mocked
+                if (window.luigiMockEnvironment) {
+                    return;
+                }
+                // mock target origin
+                if (window.LuigiClient) {
+                    window.LuigiClient.setTargetOrigin('*');
+                }
+                window.luigiMockEnvironment = {
+                    msgListener: function (e) {
+                        if (e.data.msg && (e.data.msg.startsWith('luigi.') || e.data.msg === 'storage')) {
+                            console.debug('Luigi msg', e.data);
+                            if (e.data.msg === 'luigi.get-context') {
+                                window.postMessage({
+                                    msg: 'luigi.init',
+                                    emulated: true,
+                                    internal: {
+                                        viewStackSize: 1
+                                    },
+                                    context: e.data.context
+                                }, '*');
+                            }
+                            // vizualise retrieved event data
+                            LuigiMockEngine.visualize(JSON.stringify(e.data));
+                            // Check and run mocked callback if it exists
+                            const mockListener = window.luigiMockEnvironment.mockListeners[e.data.msg];
+                            if (mockListener) {
+                                mockListener(e);
+                            }
+                        }
+                    },
+                    mockListeners: {
+                        'luigi.navigation.pathExists': (event) => {
+                            const mockData = window.sessionStorage.getItem('luigiMockData');
+                            let mockDataParsed = mockData ? JSON.parse(mockData) : undefined;
+                            const inputPath = event.data.data.link;
+                            const pathExists = mockDataParsed && mockDataParsed.pathExists && mockDataParsed.pathExists[inputPath];
+                            const response = {
+                                msg: 'luigi.navigation.pathExists.answer',
+                                data: {
+                                    correlationId: event.data.data.id,
+                                    pathExists: pathExists ? pathExists : false
+                                },
+                                emulated: true
+                            };
+                            window.postMessage(response, '*');
+                        },
+                        //ux
+                        'luigi.ux.confirmationModal.show': (event) => {
+                            const response = {
+                                msg: 'luigi.ux.confirmationModal.hide',
+                                data: event.data,
+                                emulated: true
+                            };
+                            window.postMessage(response, '*');
+                        },
+                        'luigi.ux.alert.show': (event) => {
+                            const response = {
+                                msg: 'luigi.ux.alert.hide',
+                                data: event.data,
+                                emulated: true
+                            };
+                            window.postMessage(response, '*');
+                        },
+                        'luigi.ux.set-current-locale': (event) => {
+                            const response = {
+                                msg: 'luigi.current-locale-changed',
+                                currentLocale: event.data.data.currentLocale,
+                                emulated: true
+                            };
+                            window.postMessage(response, '*');
+                        },
+                        // linkManager
+                        'luigi.navigation.open': (event) => {
+                            const response = {
+                                msg: 'luigi.navigate.ok',
+                                data: event.data,
+                                emulated: true
+                            };
+                            window.postMessage(response, '*');
+                        },
+                        'luigi.navigation.splitview.close': (event) => {
+                            const response = {
+                                msg: 'luigi.navigate.ok',
+                                data: event.data,
+                                emulated: true
+                            };
+                            window.postMessage(response, '*');
+                        },
+                        'luigi.navigation.splitview.collapse': (event) => {
+                            const response = {
+                                msg: 'luigi.navigate.ok',
+                                data: event.data,
+                                emulated: true
+                            };
+                            window.postMessage(response, '*');
+                        },
+                        'luigi.navigation.splitview.expand': (event) => {
+                            const response = {
+                                msg: 'luigi.navigate.ok',
+                                data: event.data,
+                                emulated: true
+                            };
+                            window.postMessage(response, '*');
+                        },
+                        // storage
+                        storage: () => { }
+                    }
+                };
+                // Listen to the global 'message' event of the window object
+                window.addEventListener('message', window.luigiMockEnvironment.msgListener);
+            }
+        };
+    }
+    /*
+     * This method takes a data object of type 'any' and vizualizes a simple container
+     * which holds data that is useful for e2e testing.
+     */
+    static visualize(data) {
+        let luigiVisualizationContainer = document.querySelector('#luigi-debug-vis-cnt');
+        // Construct element structure if not already constructed
+        if (!luigiVisualizationContainer) {
+            luigiVisualizationContainer = document.createElement('div');
+            luigiVisualizationContainer.setAttribute('id', 'luigi-debug-vis-cnt');
+            // Hide the added DOM element to avoid interferring/overlapping with other elements during testing.
+            luigiVisualizationContainer.setAttribute('style', 'display:none');
+            document.body.appendChild(luigiVisualizationContainer);
+        }
+        const line = document.createElement('div');
+        line.textContent = data;
+        luigiVisualizationContainer.appendChild(line);
+    }
+}

package/luigi-mock-util.js

@@ -1,16 +1,4 @@
-"use strict";
-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());
-    });
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.LuigiMockUtil = void 0;
-class LuigiMockUtil {
+export class LuigiMockUtil {
     constructor(browser) {
         /**
          * Mocks the context by sending luigi context messegaes with the desired mocked context as parameter.
@@ -54,25 +42,23 @@ class LuigiMockUtil {
     /**
      * Parses the elements added by LuigiMockModule into the DOM and assigns them to the local this.messages variable
      */
-    parseLuigiMockedMessages() {
-        return __awaiter(this, void 0, void 0, function* () {
-            try {
-                const textElements = yield this.browser.executeScript(() => Array.from(document.getElementById('luigi-debug-vis-cnt').childNodes).map(item => item.textContent));
-                this.messages = textElements
-                    .map((item) => {
-                    try {
-                        return JSON.parse(item);
-                    }
-                    catch (error) {
-                        return undefined;
-                    }
-                })
-                    .filter(item => item !== undefined);
-            }
-            catch (e) {
-                console.debug('Failed to parse luigi mocked messages: ', e);
-            }
-        });
+    async parseLuigiMockedMessages() {
+        try {
+            const textElements = await this.browser.executeScript(() => Array.from(document.getElementById('luigi-debug-vis-cnt').childNodes).map(item => item.textContent));
+            this.messages = textElements
+                .map((item) => {
+                try {
+                    return JSON.parse(item);
+                }
+                catch (error) {
+                    return undefined;
+                }
+            })
+                .filter(item => item !== undefined);
+        }
+        catch (e) {
+            console.debug('Failed to parse luigi mocked messages: ', e);
+        }
     }
     /**
      * Checks on the printed DOM Luigi message responses for a modal with given title
@@ -100,29 +86,27 @@ class LuigiMockUtil {
      * }
      *
      */
-    modalOpenedWithTitle(title) {
-        return __awaiter(this, void 0, void 0, function* () {
-            // parse messages into a readable array
-            yield this.parseLuigiMockedMessages();
-            // traverse the array and find the modal message response
-            // check if its modal option has the title
-            const indexFoundModalMessageWTitle = this.messages.findIndex(message => {
-                const msgExists = message.msg &&
-                    message.msg === 'luigi.navigation.open' &&
-                    message.params &&
-                    message.params.modal &&
-                    message.params.modal.title;
-                if (msgExists) {
-                    return message.params.modal.title === title;
-                }
-                return false;
-            });
-            if (indexFoundModalMessageWTitle >= 0) {
-                return true;
+    async modalOpenedWithTitle(title) {
+        // parse messages into a readable array
+        await this.parseLuigiMockedMessages();
+        // traverse the array and find the modal message response
+        // check if its modal option has the title
+        const indexFoundModalMessageWTitle = this.messages.findIndex(message => {
+            const msgExists = message.msg &&
+                message.msg === 'luigi.navigation.open' &&
+                message.params &&
+                message.params.modal &&
+                message.params.modal.title;
+            if (msgExists) {
+                return message.params.modal.title === title;
             }
-            console.debug('Could not find modal with title: ', title);
             return false;
         });
+        if (indexFoundModalMessageWTitle >= 0) {
+            return true;
+        }
+        console.debug('Could not find modal with title: ', title);
+        return false;
     }
     /**
      * Return list of messages, representing message elements added in the DOM for testing.
@@ -131,5 +115,3 @@ class LuigiMockUtil {
         return this.messages;
     }
 }
-exports.LuigiMockUtil = LuigiMockUtil;
-//# sourceMappingURL=luigi-mock-util.js.map

package/package.json

@@ -31,5 +31,5 @@
     "microfrontends",
     "testing"
   ],
-  "version": "1.24.1-dev.20220992341"
-}
+  "version": "1.25.0"
+}

package/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,qDAAkD;AAAzC,gHAAA,aAAa,OAAA"}

package/luigi-mock-util.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"luigi-mock-util.js","sourceRoot":"","sources":["../src/luigi-mock-util.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,MAAa,aAAa;IAIxB,YAAY,OAAY;QA2BxB;;;WAGG;QACH,gBAAW,GAAG,CAAC,WAAgB,EAAE,EAAE;YACjC,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC,WAAgB,EAAE,EAAE;gBAC9C,UAAU,CAAC,WAAW,CAAC,EAAE,GAAG,EAAE,mBAAmB,EAAE,OAAO,EAAE,WAAW,EAAE,EAAE,GAAG,CAAC,CAAC;YAClF,CAAC,EAAE,WAAW,CAAC,CAAC;QAClB,CAAC,CAAC;QAEF;;;;;;;;;;;;;;;WAeG;QACH,mBAAc,GAAG,CAAC,IAAY,EAAE,MAAe,EAAE,EAAE;YACjD,IAAI,CAAC,OAAO,CAAC,aAAa,CACxB,CAAC,IAAY,EAAE,MAAe,EAAE,EAAE;gBAChC,UAAU,CAAC,cAAc,CAAC,KAAK,EAAE,CAAC;gBAClC,IAAI,kBAAkB,GAAG;oBACvB,UAAU,EAAE;wBACV,CAAC,IAAI,CAAC,EAAE,MAAM;qBACf;iBACF,CAAC;gBACF,UAAU,CAAC,cAAc,CAAC,OAAO,CAAC,eAAe,EAAE,IAAI,CAAC,SAAS,CAAC,kBAAkB,CAAC,CAAC,CAAC;YACzF,CAAC,EACD,IAAI,EACJ,MAAM,CACP,CAAC;QACJ,CAAC,CAAC;QAlEA,IAAI,CAAC,QAAQ,GAAG,EAAE,CAAC;QACnB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IACzB,CAAC;IAED;;OAEG;IACG,wBAAwB;;YAC5B,IAAI;gBACF,MAAM,YAAY,GAAa,MAAM,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,GAAG,EAAE,CACnE,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC,qBAAqB,CAAC,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,CACpG,CAAC;gBACF,IAAI,CAAC,QAAQ,GAAG,YAAY;qBACzB,GAAG,CAAC,CAAC,IAAY,EAAE,EAAE;oBACpB,IAAI;wBACF,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;qBACzB;oBAAC,OAAO,KAAK,EAAE;wBACd,OAAO,SAAS,CAAC;qBAClB;gBACH,CAAC,CAAC;qBACD,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC;aACvC;YAAC,OAAO,CAAC,EAAE;gBACV,OAAO,CAAC,KAAK,CAAC,yCAAyC,EAAE,CAAC,CAAC,CAAC;aAC7D;QACH,CAAC;KAAA;IA4CD;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACG,oBAAoB,CAAC,KAAa;;YACtC,uCAAuC;YACvC,MAAM,IAAI,CAAC,wBAAwB,EAAE,CAAC;YAEtC,yDAAyD;YACzD,0CAA0C;YAC1C,MAAM,4BAA4B,GAAG,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE;gBACrE,MAAM,SAAS,GACb,OAAO,CAAC,GAAG;oBACX,OAAO,CAAC,GAAG,KAAK,uBAAuB;oBACvC,OAAO,CAAC,MAAM;oBACd,OAAO,CAAC,MAAM,CAAC,KAAK;oBACpB,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC;gBAC7B,IAAI,SAAS,EAAE;oBACb,OAAO,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,KAAK,KAAK,CAAC;iBAC7C;gBACD,OAAO,KAAK,CAAC;YACf,CAAC,CAAC,CAAC;YACH,IAAI,4BAA4B,IAAI,CAAC,EAAE;gBACrC,OAAO,IAAI,CAAC;aACb;YACD,OAAO,CAAC,KAAK,CAAC,mCAAmC,EAAE,KAAK,CAAC,CAAC;YAC1D,OAAO,KAAK,CAAC;QACf,CAAC;KAAA;IAED;;OAEG;IACH,MAAM;QACJ,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;CACF;AAlID,sCAkIC"}