@raydiant/playlist-window-manager 0.0.0-test-27 → 0.0.0-test-28

package/build/PresentationWindow.js

@@ -94,6 +94,18 @@ var isValidAnalyticsEvent = function (value) {
             value.productCategory === undefined ||
             value.productCategory === null);
 };
+var isValidChargeRequest = function (value) {
+    return value &&
+        typeof value === 'object' &&
+        typeof value.requestId === 'string' &&
+        typeof value.amount === 'number' &&
+        (value.tags === undefined ||
+            value.tags === null ||
+            typeof value.tags === 'object') &&
+        (value.idempotencyId === undefined ||
+            value.idempotencyId === null ||
+            typeof value.idempotencyId === 'string');
+};
 var PresentationWindow = /** @class */ (function () {
     function PresentationWindow(options) {
         var _this = this;
@@ -114,6 +126,7 @@ var PresentationWindow = /** @class */ (function () {
         this.enableInterruptLockCallback = null;
         this.disableInterruptLockCallback = null;
         this.analyticsEventCallback = null;
+        this.chargeRequestCallback = null;
         this.forceMute = false;
         this.error = null;
         this.workerState = {};
@@ -121,6 +134,7 @@ var PresentationWindow = /** @class */ (function () {
         this.runtimeSubscriptions = new Set();
         this.previewSubscriptions = new Set();
         this.previewState = { inputs: {} };
+        this.paymentSubscriptions = new Set();
         this.createObjectURLResolvers = {};
         this.createObjectURLTimeouts = {};
         this.handleEmbeddedMessage = function (type, payload) { return __awaiter(_this, void 0, void 0, function () {
@@ -200,8 +214,13 @@ var PresentationWindow = /** @class */ (function () {
                         break;
                     }
                     case 'analytics-event': {
-                        if (this.analyticsEventCallback && isValidAnalyticsEvent(payload)) {
-                            this.analyticsEventCallback(payload);
+                        if (isValidAnalyticsEvent(payload)) {
+                            if (this.analyticsEventCallback) {
+                                this.analyticsEventCallback(payload);
+                            }
+                        }
+                        else {
+                            this.logWarning("Invalid payload for analytics-event message: ".concat(payload));
                         }
                         break;
                     }
@@ -245,6 +264,44 @@ var PresentationWindow = /** @class */ (function () {
                         }
                         break;
                     }
+                    case 'payments-charge-request': {
+                        if (isValidChargeRequest(payload)) {
+                            if (this.chargeRequestCallback) {
+                                this.chargeRequestCallback(payload);
+                            }
+                        }
+                        else {
+                            this.logWarning("Invalid payload for payments-charge-request message: ".concat(payload));
+                        }
+                        break;
+                    }
+                    case 'payments-subscribe': {
+                        if (typeof payload === 'string') {
+                            this.logInfo("Received 'worker-subscribe' from window '".concat(windowId, "'"));
+                            // The payload is the payment subscription type (ex. 'charge', 'terminal')
+                            this.paymentSubscriptions.add(payload);
+                            // Immediately send terminal when subscribing.
+                            if (payload === 'terminal' && this.options.getTerminal) {
+                                this.sendMessageObject('payments-terminal-event', {
+                                    terminal: this.options.getTerminal(),
+                                });
+                            }
+                        }
+                        else {
+                            this.logWarning("Invalid payload for payments-subscribe message: ".concat(payload));
+                        }
+                        break;
+                    }
+                    case 'payments-unsubscribe': {
+                        if (typeof payload === 'string') {
+                            this.logInfo("Received 'payments-unsubscribe' from window '".concat(windowId, "'"));
+                            this.paymentSubscriptions.delete(payload);
+                        }
+                        else {
+                            this.logWarning("Invalid payload for payments-unsubscribe message: ".concat(payload));
+                        }
+                        break;
+                    }
                     default: {
                         this.logWarning("Received unknown embedded message type: ".concat(type));
                     }
@@ -480,6 +537,9 @@ var PresentationWindow = /** @class */ (function () {
     PresentationWindow.prototype.onAnalyticsEvent = function (callback) {
         this.analyticsEventCallback = callback;
     };
+    PresentationWindow.prototype.onChargeRequest = function (callback) {
+        this.chargeRequestCallback = callback;
+    };
     PresentationWindow.prototype.isReady = function () {
         // TODO: To support the 'ready' event in embedded apps, they will need to tell the
         // runtime that it should wait for ready instead of DOMLoaded. This could be a "wait
@@ -571,6 +631,39 @@ var PresentationWindow = /** @class */ (function () {
             });
         });
     };
+    PresentationWindow.prototype.sendChargeResponse = function (response) {
+        // TODO: Instead of sending the charge to all windows, we should only send it to the app
+        // that requested the charge. We probably don't want to use the windowId to avoid missing
+        // the events in case the window was closed/restarted. Since we are only sending the charge
+        // id and status this seems ok for now but need to be mindful of sending any sensitive data.
+        this.sendMessageObject('payments-charge-response', {
+            requestId: response.requestId,
+            charge: response.charge,
+            error: response.error,
+        });
+        // Forward the event to the child window managers.
+        Object.values(this.windowManagers).forEach(function (wm) {
+            return wm.sendChargeResponse(response);
+        });
+    };
+    PresentationWindow.prototype.sendCharge = function (charge) {
+        // TODO: Instead of sending the charge to all windows, we should only send it to the app
+        // that requested the charge.
+        if (this.paymentSubscriptions.has('charge')) {
+            this.sendMessageObject('payments-charge-event', { charge: charge });
+        }
+        // Forward the event to the child window managers.
+        Object.values(this.windowManagers).forEach(function (wm) { return wm.sendCharge(charge); });
+    };
+    PresentationWindow.prototype.sendTerminal = function (terminal) {
+        if (this.paymentSubscriptions.has('terminal')) {
+            this.sendMessageObject('payments-terminal-event', { terminal: terminal });
+        }
+        // Forward the event to the child window managers.
+        Object.values(this.windowManagers).forEach(function (wm) {
+            return wm.sendTerminal(terminal);
+        });
+    };
     PresentationWindow.prototype.isEmbeddedApp = function () {
         var _a = this.options, applicationVersion = _a.applicationVersion, isPreview = _a.isPreview;
         // If the application has a source url, always use it for rendering the preview.
@@ -657,17 +750,15 @@ var PresentationWindow = /** @class */ (function () {
     };
     PresentationWindow.prototype.createAndLoadWindow = function (url, backgroundColor, receiveMessageCallback) {
         return __awaiter(this, void 0, void 0, function () {
-            var _a, windowId, parentWindowId, renderer, bounds, logger;
+            var _a, windowId, parentWindowId, renderer, bounds;
             return __generator(this, function (_b) {
                 switch (_b.label) {
                     case 0:
-                        _a = this.options, windowId = _a.windowId, parentWindowId = _a.parentWindowId, renderer = _a.renderer, bounds = _a.bounds, logger = _a.logger;
-                        logger.info("playlist-window-manager/src/PresentationWindow.ts createAndLoadWindow1: ".concat(JSON.stringify(bounds)));
+                        _a = this.options, windowId = _a.windowId, parentWindowId = _a.parentWindowId, renderer = _a.renderer, bounds = _a.bounds;
                         renderer.createWindow({
                             windowId: windowId,
                             parentWindowId: parentWindowId,
                             bounds: bounds,
-                            logger: logger,
                             backgroundColor: backgroundColor,
                             receiveMessageCallback: receiveMessageCallback,
                             errorCallback: this.handleError,
@@ -820,9 +911,7 @@ var PresentationWindow = /** @class */ (function () {
                         didBoundsChange = prevBounds
                             ? !(0, fast_deep_equal_1.default)(bounds, prevBounds)
                             : true;
-                        this.logInfo("playlist-window-manager/src/PresentationWindow.ts openChildWindow1: ".concat(JSON.stringify(prevBounds)));
                         if (didBoundsChange) {
-                            this.logInfo("playlist-window-manager/src/PresentationWindow.ts openChildWindow2: ".concat(JSON.stringify(bounds)));
                             windowManager.updateBounds(bounds);
                         }
                         didForceMuteChange = forceMute !== prevForceMute;
@@ -842,7 +931,6 @@ var PresentationWindow = /** @class */ (function () {
                         }
                         return [3 /*break*/, 3];
                     case 1:
-                        this.logInfo("playlist-window-manager/src/PresentationWindow.ts openChildWindow3: ".concat(JSON.stringify(bounds)));
                         windowManager = new PlaylistWindowManager_1.default({
                             parentWindowId: windowId,
                             windowName: windowName,
@@ -864,6 +952,7 @@ var PresentationWindow = /** @class */ (function () {
                             isPreview: isPreview,
                             onEnableInterruptLock: function () { return _this.enableInteruptLock(windowName); },
                             onDisableInterruptLock: function () { return _this.disableInteruptLock(windowName); },
+                            getTerminal: this.options.getTerminal,
                         });
                         // Hook up child window manager events to bubble up to the parent.
                         if (parentWindowManager) {
@@ -882,6 +971,9 @@ var PresentationWindow = /** @class */ (function () {
                             windowManager.on('window_analytics_event', function (metadata) {
                                 parentWindowManager.emit('window_analytics_event', metadata);
                             });
+                            windowManager.on('window_charge_request', function (metadata) {
+                                parentWindowManager.emit('window_charge_request', metadata);
+                            });
                         }
                         this.windowManagers[windowName] = windowManager;
                         windowManager.setRenderer(renderer);

package/build/PresentationWindow.test.js

@@ -238,4 +238,103 @@ describe('embedded apps', function () {
         });
     }); });
 });
+describe('payments', function () {
+    test('charge request', function () { return __awaiter(void 0, void 0, void 0, function () {
+        var testRenderer, window, callback;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    testRenderer = (0, testUtils_1.createRenderer)();
+                    window = (0, testUtils_1.createPresentationWindow)({
+                        windowId: 'test-charge-request',
+                        presentation: (0, testUtils_1.createPresentation)(),
+                        applicationVersion: (0, testUtils_1.createApplicationVersion)({
+                            embeddedUrlFormat: 'http://test.local/:input',
+                        }),
+                        renderer: testRenderer,
+                    });
+                    callback = jest.fn();
+                    window.onChargeRequest(callback);
+                    return [4 /*yield*/, window.load()];
+                case 1:
+                    _a.sent();
+                    testRenderer.runReceiveMessageCallback('payments-charge-request', {
+                        requestId: 'test',
+                        amount: 100,
+                    });
+                    expect(callback).toHaveBeenCalledWith({
+                        requestId: 'test',
+                        amount: 100,
+                    });
+                    // Send charge response.
+                    window.sendChargeResponse({
+                        requestId: 'test',
+                        charge: { id: '1', status: 'pending' },
+                    });
+                    expect(testRenderer.sendMessageObject).toHaveBeenCalledWith('test-charge-request', 'payments-charge-response', { requestId: 'test', charge: { id: '1', status: 'pending' } });
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+    test('subscribe to charge', function () { return __awaiter(void 0, void 0, void 0, function () {
+        var testRenderer, window;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    testRenderer = (0, testUtils_1.createRenderer)();
+                    window = (0, testUtils_1.createPresentationWindow)({
+                        windowId: 'test-payments-subscribe-charge',
+                        presentation: (0, testUtils_1.createPresentation)(),
+                        applicationVersion: (0, testUtils_1.createApplicationVersion)({
+                            embeddedUrlFormat: 'http://test.local/:input',
+                        }),
+                        renderer: testRenderer,
+                    });
+                    return [4 /*yield*/, window.load()];
+                case 1:
+                    _a.sent();
+                    testRenderer.runReceiveMessageCallback('payments-subscribe', 'charge');
+                    window.sendCharge({ id: 'test', status: 'success' });
+                    expect(testRenderer.sendMessageObject).toHaveBeenCalledWith('test-payments-subscribe-charge', 'payments-charge-event', { charge: { id: 'test', status: 'success' } });
+                    // Unsubscribe should not send a message.
+                    testRenderer.runReceiveMessageCallback('payments-unsubscribe', 'charge');
+                    window.sendCharge({ id: 'test2', status: 'success' });
+                    expect(testRenderer.sendMessageObject).toHaveBeenCalledTimes(1);
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+    test('subscribe to terminal', function () { return __awaiter(void 0, void 0, void 0, function () {
+        var testRenderer, window;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    testRenderer = (0, testUtils_1.createRenderer)();
+                    window = (0, testUtils_1.createPresentationWindow)({
+                        windowId: 'test-payments-subscribe-terminal',
+                        presentation: (0, testUtils_1.createPresentation)(),
+                        applicationVersion: (0, testUtils_1.createApplicationVersion)({
+                            embeddedUrlFormat: 'http://test.local/:input',
+                        }),
+                        renderer: testRenderer,
+                        getTerminal: function () { return null; },
+                    });
+                    return [4 /*yield*/, window.load()];
+                case 1:
+                    _a.sent();
+                    testRenderer.runReceiveMessageCallback('payments-subscribe', 'terminal');
+                    // Terminal subscriptions should receive the current terminal immediately after subscribing.
+                    expect(testRenderer.sendMessageObject).toHaveBeenCalledWith('test-payments-subscribe-terminal', 'payments-terminal-event', { terminal: null });
+                    // Send terminal update event.
+                    window.sendTerminal({ status: 'open' });
+                    expect(testRenderer.sendMessageObject).toHaveBeenCalledWith('test-payments-subscribe-terminal', 'payments-terminal-event', { terminal: { status: 'open' } });
+                    // Unsubscribe should not send a message.
+                    testRenderer.runReceiveMessageCallback('payments-unsubscribe', 'terminal');
+                    window.sendTerminal({ status: 'closed' });
+                    expect(testRenderer.sendMessageObject).toHaveBeenCalledTimes(2);
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+});
 // TODO: Backfill tests for all legacy and embedded apps.

package/build/testUtils.js

@@ -98,6 +98,7 @@ function createPresentationWindow(overrides) {
             muteWindow: function () { },
             unMuteWindow: function () { },
         },
+        getTerminal: overrides.getTerminal,
     });
 }
 exports.createPresentationWindow = createPresentationWindow;

package/build/types.d.ts

@@ -82,7 +82,6 @@ export interface CreateWindowOptions {
     windowId: string;
     parentWindowId?: string;
     bounds?: WindowBounds;
-    logger: Logger;
     backgroundColor?: string;
     receiveMessageCallback?: (type: string, payload?: any) => void;
     errorCallback: (err: any) => void;
@@ -141,3 +140,23 @@ export interface AnalyticsEvent {
     source: string;
     productCategory?: string | null;
 }
+export interface ChargeRequest {
+    requestId: string;
+    amount: number;
+    tags?: Record<string, undefined | null | boolean | number | string>;
+    idempotencyId?: string;
+}
+export interface Charge {
+    id: string;
+    status: string;
+}
+export interface ChargeResponse {
+    requestId: string;
+    charge?: Charge;
+    error?: {
+        message: string;
+    };
+}
+export interface Terminal {
+    status: string;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@raydiant/playlist-window-manager",
-  "version": "0.0.0-test-27",
+  "version": "0.0.0-test-28",
   "description": "Window manager for playlist playback.",
   "main": "build/index.js",
   "scripts": {
@@ -11,20 +11,18 @@
     "deploy": "sh tasks/npm-publish.sh"
   },
   "dependencies": {
-    "@raydiant/playlist-rule-engine": "3.2.2",
-    "eventemitter3": "^4.0.7",
     "fast-deep-equal": "^3.1.3",
-    "lodash": "^4.17.21",
+    "@raydiant/playlist-rule-engine": "3.2.2",
     "raydiant-kit": "4.7.3",
-    "uuid": "^8.3.0"
+    "uuid": "^8.3.0",
+    "eventemitter3": "^4.0.7"
   },
   "devDependencies": {
     "@babel/core": "^7.5.5",
-    "@types/jest": "^24.0.15",
     "@types/jschannel": "^1.0.1",
-    "@types/lodash": "^4.14.200",
+    "@types/jest": "^24.0.15",
     "@types/uuid": "8.3.0",
-    "electron": "10.3.2",
+    "electron": "28.1.2",
     "jest": "^24.8.0",
     "ts-jest": "^24.0.2",
     "typescript": "^4.1.2"

package/src/BrowserViewRenderer.ts

@@ -30,16 +30,9 @@ export default class BrowserViewRenderer implements PresentationWindowRenderer {
     windowId,
     parentWindowId,
     bounds,
-    logger,
     backgroundColor,
     receiveMessageCallback,
   }: CreateWindowOptions) {
-    logger.info(
-      `playlist-window-manager/src/BrowserViewRenderer.ts createWindow1 ${JSON.stringify(
-        bounds || { ...this.mainWindow.getBounds(), x: 0, y: 0 }
-      )}`
-    );
-
     const window = {
       view: new BrowserView({
         webPreferences: {
@@ -65,17 +58,7 @@ export default class BrowserViewRenderer implements PresentationWindowRenderer {
     ipcMain.on(windowId, window.receiveMessageCallback);
 
     this.offscreenWindow.addBrowserView(window.view);
-    logger.info(
-      `playlist-window-manager/src/BrowserViewRenderer.ts createWindow2 ${JSON.stringify(
-        window.bounds
-      )}`
-    );
     window.view.setBounds(window.bounds);
-    logger.info(
-      `playlist-window-manager/src/BrowserViewRenderer.ts createWindow3 ${JSON.stringify(
-        window.view.getBounds()
-      )}`
-    );
 
     if (backgroundColor) {
       window.view.setBackgroundColor(backgroundColor);
@@ -107,7 +90,7 @@ export default class BrowserViewRenderer implements PresentationWindowRenderer {
         `Failed to update window bounds, missing window id '${windowId}'`
       );
     }
-    // TODO log bounds
+
     window.bounds = bounds;
     window.view.setBounds(window.bounds);
   }