@raydiant/playlist-window-manager 0.0.0-test-32 → 0.0.0-test30

package/build/BrowserViewRenderer.js

@@ -87,6 +87,7 @@ var BrowserViewRenderer = /** @class */ (function () {
                     view: new electron_1.BrowserView({
                         webPreferences: {
                             preload: path.join(__dirname, 'preload.js'),
+                            contextIsolation: false,
                         },
                     }),
                     bounds: bounds || __assign(__assign({}, this.mainWindow.getBounds()), { x: 0, y: 0 }),

package/build/BrowserWindowRenderer.d.ts

@@ -10,6 +10,7 @@ interface BrowserWindowRendererOptions {
     renderChildWindowsAsBrowserViews: boolean;
     useWindowPool: boolean;
     logger: Logger;
+    fullscreen?: boolean;
     proxySettings?: ProxySettings;
     windowCrashHandler?: () => void;
 }

package/build/BrowserWindowRenderer.js

@@ -87,13 +87,17 @@ var BrowserWindowRenderer = /** @class */ (function () {
         this.offscreenWindow = new electron_1.BrowserWindow({
             show: false,
             frame: this.opts.frame,
+            fullscreen: this.opts.fullscreen,
             hasShadow: this.opts.hasShadow,
             webPreferences: {
                 preload: path.join(__dirname, 'preload.js'),
+                contextIsolation: false,
             },
         });
         this.proxySettings = null;
-        this.offscreenWindow.setBounds(opts.bounds);
+        if (!opts.fullscreen) {
+            this.offscreenWindow.setBounds(opts.bounds);
+        }
         if (opts.proxySettings) {
             this.proxySettings = opts.proxySettings;
         }
@@ -118,11 +122,13 @@ var BrowserWindowRenderer = /** @class */ (function () {
                                 ? this.createOrGetPooledBrowserView(windowId, {
                                     webPreferences: {
                                         preload: path.join(__dirname, 'preload.js'),
+                                        contextIsolation: false,
                                     },
                                 })
                                 : this.createOrGetPooledBrowserWindow(windowId, {
                                     show: false,
                                     frame: this.opts.frame,
+                                    fullscreen: this.opts.fullscreen,
                                     // NOTE: useWindowPool: true does not work with renderChildWindowsAsBrowserViews: false
                                     // because the parent can't be changed after creating the BrowserWindow.
                                     parent: parentWindowId
@@ -132,6 +138,7 @@ var BrowserWindowRenderer = /** @class */ (function () {
                                     hasShadow: this.opts.hasShadow,
                                     webPreferences: {
                                         preload: path.join(__dirname, 'preload.js'),
+                                        contextIsolation: false,
                                     },
                                 }),
                             // If we are creating a child window and renderChildWindowsAsBrowserViews is false that means
@@ -172,7 +179,9 @@ var BrowserWindowRenderer = /** @class */ (function () {
                             // Electron issue: https://github.com/electron/electron/issues/20357
                             window.view.setBackgroundColor(backgroundColor === 'transparent' ? '#00000000' : backgroundColor);
                         }
-                        window.view.setBounds(window.bounds);
+                        if (!this.opts.fullscreen) {
+                            window.view.setBounds(window.bounds);
+                        }
                         if (!this.proxySettings) return [3 /*break*/, 2];
                         return [4 /*yield*/, window.view.webContents.session.setProxy(this.proxySettings)];
                     case 1:

package/build/PlaylistWindowManager.d.ts

@@ -9,6 +9,7 @@ export interface PlaylistWindowManagerOptions {
     device?: Device;
     readyTimeoutDurationSeconds?: number;
     appRendererUrl?: string;
+    appRendererOfflineSupport?: boolean;
     bounds?: WindowBounds;
     backgroundColor?: string;
     themeOverride?: Theme;

package/build/PlaylistWindowManager.js

@@ -677,7 +677,7 @@ var PlaylistWindowManager = /** @class */ (function (_super) {
         }
     };
     PlaylistWindowManager.prototype.createWindow = function (pr) {
-        var _a = this.options, readyTimeoutDurationSeconds = _a.readyTimeoutDurationSeconds, appRendererUrl = _a.appRendererUrl, backgroundColor = _a.backgroundColor, device = _a.device, logger = _a.logger, windowName = _a.windowName, parentWindowId = _a.parentWindowId, isPreview = _a.isPreview;
+        var _a = this.options, readyTimeoutDurationSeconds = _a.readyTimeoutDurationSeconds, appRendererUrl = _a.appRendererUrl, appRendererOfflineSupport = _a.appRendererOfflineSupport, backgroundColor = _a.backgroundColor, device = _a.device, logger = _a.logger, windowName = _a.windowName, parentWindowId = _a.parentWindowId, isPreview = _a.isPreview;
         if (!this.ruleEngine) {
             throw new Error('Attempted to create window but ruleEngine was not provided');
         }
@@ -712,6 +712,7 @@ var PlaylistWindowManager = /** @class */ (function (_super) {
             forceMute: this.forceMute,
             readyTimeoutDurationSeconds: readyTimeoutDurationSeconds,
             appRendererUrl: appRendererUrl,
+            appRendererOfflineSupport: appRendererOfflineSupport,
             bounds: this.bounds,
             backgroundColor: backgroundColor,
             playlistWindowManagerState: this.state,
@@ -940,6 +941,10 @@ var PlaylistWindowManager = /** @class */ (function (_super) {
                         // Swap windows.
                         this.currentWindow = this.nextWindow;
                         if (this.currentWindow) {
+                            // Restore this.currentPresentation value since if this.removeCurrentWindow()
+                            // was called then this.currentPresentation was set to null.
+                            // This fixes an issue where publishing a playlist with single presentation results
+                            // in two iFrames created. See CX-2602 for more details.
                             this.currentPresentation = nextPresentation;
                             this.currentWindow.onComplete(this.handleCurrentPresentationComplete);
                             this.currentWindow.onError(this.handleCurrentPresentationError);

package/build/PresentationWindow.d.ts

@@ -23,6 +23,7 @@ export interface PresentationWindowOptions {
     renderer: PresentationWindowRenderer;
     readyTimeoutDurationSeconds?: number;
     appRendererUrl?: string;
+    appRendererOfflineSupport?: boolean;
     bounds?: WindowBounds;
     backgroundColor?: string;
     isPreview?: boolean;
@@ -102,7 +103,7 @@ export default class PresentationWindow {
     private isEmbeddedApp;
     private allChildWindowManagersReady;
     private checkIsReadyCallback;
-    private appendWindowIdToHash;
+    private getFullAppRendererUrl;
     private loadEmbeddedApp;
     private loadLegacyApp;
     private createAndLoadWindow;

package/build/PresentationWindow.js

@@ -81,7 +81,7 @@ var PlaylistWindowManager_1 = __importDefault(require("./PlaylistWindowManager")
 var WindowTimeoutError_1 = __importDefault(require("./WindowTimeoutError"));
 var WindowLoadError_1 = __importDefault(require("./WindowLoadError"));
 // TODO: Automatically inject latest version when building in CI.
-var defaultAppRendererUrl = 'https://apps.raydiant.com/3.0.4/index.html';
+var defaultAppRendererUrl = 'https://apps.raydiant.com/3.0.7/index.html';
 var isValidNumber = function (value) {
     return typeof value === 'number' && !isNaN(value);
 };
@@ -690,10 +690,14 @@ var PresentationWindow = /** @class */ (function () {
             }
         }
     };
-    PresentationWindow.prototype.appendWindowIdToHash = function (urlStr, windowId) {
-        var url = new URL(urlStr);
+    PresentationWindow.prototype.getFullAppRendererUrl = function (_a) {
+        var appRendererUrl = _a.appRendererUrl, windowId = _a.windowId, appRendererOfflineSupport = _a.appRendererOfflineSupport;
+        var url = new URL(appRendererUrl);
         var hashParams = new URLSearchParams(url.hash.slice(1));
         hashParams.set('__raydiantWindowId', windowId);
+        if (appRendererOfflineSupport === true) {
+            hashParams.set('__raydiantOfflineSupport', 'true');
+        }
         url.hash = hashParams.toString();
         return url.toString();
     };
@@ -724,13 +728,17 @@ var PresentationWindow = /** @class */ (function () {
     };
     PresentationWindow.prototype.loadLegacyApp = function () {
         return __awaiter(this, void 0, void 0, function () {
-            var _a, windowId, _b, appRendererUrl, backgroundColor;
+            var _a, windowId, _b, appRendererUrl, appRendererOfflineSupport, backgroundColor;
             return __generator(this, function (_c) {
                 switch (_c.label) {
                     case 0:
-                        _a = this.options, windowId = _a.windowId, _b = _a.appRendererUrl, appRendererUrl = _b === void 0 ? defaultAppRendererUrl : _b, backgroundColor = _a.backgroundColor;
+                        _a = this.options, windowId = _a.windowId, _b = _a.appRendererUrl, appRendererUrl = _b === void 0 ? defaultAppRendererUrl : _b, appRendererOfflineSupport = _a.appRendererOfflineSupport, backgroundColor = _a.backgroundColor;
                         this.logInfo("Create window '".concat(windowId, "'"));
-                        return [4 /*yield*/, this.createAndLoadWindow(this.appendWindowIdToHash(appRendererUrl, windowId), backgroundColor || '#000000', // Default to black bg for Raydiant apps
+                        return [4 /*yield*/, this.createAndLoadWindow(this.getFullAppRendererUrl({
+                                appRendererUrl: appRendererUrl,
+                                windowId: windowId,
+                                appRendererOfflineSupport: appRendererOfflineSupport,
+                            }), backgroundColor || '#000000', // Default to black bg for Raydiant apps
                             this.handleLegacyMessage)];
                     case 1:
                         _c.sent();
@@ -1034,12 +1042,16 @@ var PresentationWindow = /** @class */ (function () {
         }
     };
     PresentationWindow.prototype.getEmbeddedAppUrl = function () {
-        var windowId = this.options.windowId;
+        var _a = this.options, windowId = _a.windowId, appRendererOfflineSupport = _a.appRendererOfflineSupport;
         var metadata = {
             renderMode: this.options.isPreview ? 'preview' : 'live',
         };
         var url = (0, embeddedApps_1.default)(this.presentation, this.options.applicationVersion, metadata);
-        return this.appendWindowIdToHash(url, windowId);
+        return this.getFullAppRendererUrl({
+            appRendererUrl: url,
+            windowId: windowId,
+            appRendererOfflineSupport: appRendererOfflineSupport,
+        });
     };
     PresentationWindow.prototype.handleReady = function () {
         this.didReceiveReady = true;

package/build/embeddedApps.js

@@ -24,6 +24,9 @@ function createEmbeddedApp(presentation, applicationVersion, metadata) {
             if (metadataKey === 'renderMode') {
                 value = metadata.renderMode;
             }
+            else if (metadataKey === 'token') {
+                value = presentation.token;
+            }
         }
         else {
             // Don't replace variables that are numbers to allow setting

package/build/embeddedApps.test.js

@@ -121,3 +121,10 @@ test('File input uses url as value', function () {
         presentationProperties: [{ type: 'file', name: 'file' }],
     }), createMetadata())).toBe("https://example.come?image=".concat(encodeURIComponent('https://image.png')));
 });
+test('Replaces $token with presentation token', function () {
+    var presentation = createPresentation({ token: 'abc' });
+    var applicationVersion = createApplicationVersion({
+        embeddedUrlFormat: 'https://example.com?token=:$token',
+    });
+    expect((0, embeddedApps_1.default)(presentation, applicationVersion, createMetadata())).toBe('https://example.com?token=abc');
+});

package/build/types.d.ts

@@ -19,6 +19,7 @@ export interface Presentation {
             playlistId: string;
         }>;
     };
+    token?: string;
 }
 export interface ApplicationVersion {
     id: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@raydiant/playlist-window-manager",
-  "version": "0.0.0-test-32",
+  "version": "0.0.0-test30",
   "description": "Window manager for playlist playback.",
   "main": "build/index.js",
   "scripts": {
@@ -22,7 +22,7 @@
     "@types/jschannel": "^1.0.1",
     "@types/jest": "^24.0.15",
     "@types/uuid": "8.3.0",
-    "electron": "10.1.5",
+    "electron": "28.1.2",
     "jest": "^24.8.0",
     "ts-jest": "^24.0.2",
     "typescript": "^4.1.2"

package/src/BrowserViewRenderer.ts

@@ -37,6 +37,7 @@ export default class BrowserViewRenderer implements PresentationWindowRenderer {
       view: new BrowserView({
         webPreferences: {
           preload: path.join(__dirname, 'preload.js'),
+          contextIsolation: false,
         },
       }),
 

package/src/BrowserWindowRenderer.ts

@@ -5,9 +5,9 @@ import {
   ipcMain,
   IpcMainEvent,
   Event,
-  Details,
   BrowserWindowConstructorOptions,
   BrowserViewConstructorOptions,
+  RenderProcessGoneDetails,
 } from 'electron';
 import {
   PresentationWindowRenderer,
@@ -32,7 +32,10 @@ interface BrowserWindowRendererWindow {
     payload?: any
   ) => void;
   unresponsiveCallback: () => void;
-  renderProcessGoneCallback: (event: Event, details: Details) => void;
+  renderProcessGoneCallback: (
+    event: Event,
+    details: RenderProcessGoneDetails
+  ) => void;
 }
 
 interface BrowserWindowRendererOptions {
@@ -42,6 +45,7 @@ interface BrowserWindowRendererOptions {
   renderChildWindowsAsBrowserViews: boolean;
   useWindowPool: boolean;
   logger: Logger;
+  fullscreen?: boolean;
   proxySettings?: ProxySettings;
   windowCrashHandler?: () => void;
 }
@@ -61,9 +65,11 @@ export default class BrowserWindowRenderer
   private offscreenWindow = new BrowserWindow({
     show: false,
     frame: this.opts.frame,
+    fullscreen: this.opts.fullscreen,
     hasShadow: this.opts.hasShadow,
     webPreferences: {
       preload: path.join(__dirname, 'preload.js'),
+      contextIsolation: false,
     },
   });
 
@@ -72,7 +78,9 @@ export default class BrowserWindowRenderer
   private logger: Logger;
 
   constructor(private opts: BrowserWindowRendererOptions) {
-    this.offscreenWindow.setBounds(opts.bounds);
+    if (!opts.fullscreen) {
+      this.offscreenWindow.setBounds(opts.bounds);
+    }
     if (opts.proxySettings) {
       this.proxySettings = opts.proxySettings;
     }
@@ -101,11 +109,13 @@ export default class BrowserWindowRenderer
           ? this.createOrGetPooledBrowserView(windowId, {
               webPreferences: {
                 preload: path.join(__dirname, 'preload.js'),
+                contextIsolation: false,
               },
             })
           : this.createOrGetPooledBrowserWindow(windowId, {
               show: false,
               frame: this.opts.frame,
+              fullscreen: this.opts.fullscreen,
               // NOTE: useWindowPool: true does not work with renderChildWindowsAsBrowserViews: false
               // because the parent can't be changed after creating the BrowserWindow.
               parent: parentWindowId
@@ -115,6 +125,7 @@ export default class BrowserWindowRenderer
               hasShadow: this.opts.hasShadow,
               webPreferences: {
                 preload: path.join(__dirname, 'preload.js'),
+                contextIsolation: false,
               },
             }),
       // If we are creating a child window and renderChildWindowsAsBrowserViews is false that means
@@ -148,7 +159,10 @@ export default class BrowserWindowRenderer
         );
       },
 
-      renderProcessGoneCallback: (_: Event, details: Details) => {
+      renderProcessGoneCallback: (
+        _: Event,
+        details: RenderProcessGoneDetails
+      ) => {
         this.logger.error(
           `Window received 'render-process-gone' event. Reason: ${details.reason}`,
           { windowId }
@@ -191,7 +205,9 @@ export default class BrowserWindowRenderer
       );
     }
 
-    window.view.setBounds(window.bounds);
+    if (!this.opts.fullscreen) {
+      window.view.setBounds(window.bounds);
+    }
 
     if (this.proxySettings) {
       await window.view.webContents.session.setProxy(this.proxySettings);

package/src/PlaylistWindowManager.ts

@@ -40,6 +40,10 @@ export interface PlaylistWindowManagerOptions {
   // Override the default app renderer url
   appRendererUrl?: string;
 
+  // App renderer offline support.
+  // If true, the app renderer will be using service worker to cache resources for offline support.
+  appRendererOfflineSupport?: boolean;
+
   // The bounds of the window manager, used for child windows
   bounds?: WindowBounds;
 
@@ -488,6 +492,7 @@ export default class PlaylistWindowManager extends EventEmitter {
     const {
       readyTimeoutDurationSeconds,
       appRendererUrl,
+      appRendererOfflineSupport,
       backgroundColor,
       device,
       logger,
@@ -541,6 +546,7 @@ export default class PlaylistWindowManager extends EventEmitter {
       forceMute: this.forceMute,
       readyTimeoutDurationSeconds,
       appRendererUrl,
+      appRendererOfflineSupport,
       bounds: this.bounds,
       backgroundColor,
       playlistWindowManagerState: this.state,
@@ -698,6 +704,8 @@ export default class PlaylistWindowManager extends EventEmitter {
       nextPreviewPresentationId = preview.presentationId;
     }
 
+    // Save reference to next presentation since later call to
+    // this.removeCurrentWindow() will set this.currentPresentation to null.
     const nextPresentation = this.nextPresentation;
     // Set this.currentPresentationId before removing the current window to avoid timing issues with previewCheck
     // triggering during removeCurrentWindow. Current presentation id needs to be set to the next
@@ -735,6 +743,10 @@ export default class PlaylistWindowManager extends EventEmitter {
     // Swap windows.
     this.currentWindow = this.nextWindow;
     if (this.currentWindow) {
+      // Restore this.currentPresentation value since if this.removeCurrentWindow()
+      // was called then this.currentPresentation was set to null.
+      // This fixes an issue where publishing a playlist with single presentation results
+      // in two iFrames created. See CX-2602 for more details.
       this.currentPresentation = nextPresentation;
       this.currentWindow.onComplete(this.handleCurrentPresentationComplete);
       this.currentWindow.onError(this.handleCurrentPresentationError);

package/src/PresentationWindow.ts

@@ -47,6 +47,7 @@ export interface PresentationWindowOptions {
   renderer: PresentationWindowRenderer;
   readyTimeoutDurationSeconds?: number;
   appRendererUrl?: string;
+  appRendererOfflineSupport?: boolean;
   bounds?: WindowBounds;
   backgroundColor?: string;
   isPreview?: boolean;
@@ -60,7 +61,7 @@ export interface PresentationWindowOptions {
 }
 
 // TODO: Automatically inject latest version when building in CI.
-const defaultAppRendererUrl = 'https://apps.raydiant.com/3.0.4/index.html';
+const defaultAppRendererUrl = 'https://apps.raydiant.com/3.0.7/index.html';
 
 const isValidNumber = (value: any) =>
   typeof value === 'number' && !isNaN(value);
@@ -488,10 +489,21 @@ export default class PresentationWindow {
     }
   }
 
-  private appendWindowIdToHash(urlStr: string, windowId: string) {
-    const url = new URL(urlStr);
+  private getFullAppRendererUrl({
+    appRendererUrl,
+    windowId,
+    appRendererOfflineSupport,
+  }: {
+    appRendererUrl: string;
+    windowId: string;
+    appRendererOfflineSupport: boolean | undefined;
+  }) {
+    const url = new URL(appRendererUrl);
     const hashParams = new URLSearchParams(url.hash.slice(1));
     hashParams.set('__raydiantWindowId', windowId);
+    if (appRendererOfflineSupport === true) {
+      hashParams.set('__raydiantOfflineSupport', 'true');
+    }
     url.hash = hashParams.toString();
 
     return url.toString();
@@ -525,13 +537,18 @@ export default class PresentationWindow {
     const {
       windowId,
       appRendererUrl = defaultAppRendererUrl,
+      appRendererOfflineSupport,
       backgroundColor,
     } = this.options;
 
     this.logInfo(`Create window '${windowId}'`);
 
     await this.createAndLoadWindow(
-      this.appendWindowIdToHash(appRendererUrl, windowId),
+      this.getFullAppRendererUrl({
+        appRendererUrl,
+        windowId,
+        appRendererOfflineSupport,
+      }),
       backgroundColor || '#000000', // Default to black bg for Raydiant apps
       this.handleLegacyMessage
     );
@@ -861,7 +878,7 @@ export default class PresentationWindow {
   }
 
   private getEmbeddedAppUrl() {
-    const { windowId } = this.options;
+    const { windowId, appRendererOfflineSupport } = this.options;
 
     const metadata: EmbeddedAppMetadata = {
       renderMode: this.options.isPreview ? 'preview' : 'live',
@@ -873,7 +890,11 @@ export default class PresentationWindow {
       metadata
     );
 
-    return this.appendWindowIdToHash(url, windowId);
+    return this.getFullAppRendererUrl({
+      appRendererUrl: url,
+      windowId,
+      appRendererOfflineSupport,
+    });
   }
 
   private handleEmbeddedMessage = async (type: string, payload?: any) => {

package/src/embeddedApps.test.ts

@@ -229,3 +229,14 @@ test('File input uses url as value', () => {
     `https://example.come?image=${encodeURIComponent('https://image.png')}`
   );
 });
+
+test('Replaces $token with presentation token', () => {
+  const presentation = createPresentation({ token: 'abc' });
+  const applicationVersion = createApplicationVersion({
+    embeddedUrlFormat: 'https://example.com?token=:$token',
+  });
+
+  expect(
+    createEmbeddedApp(presentation, applicationVersion, createMetadata())
+  ).toBe('https://example.com?token=abc');
+});

package/src/embeddedApps.ts

@@ -32,6 +32,8 @@ export default function createEmbeddedApp(
       const metadataKey = variableName.slice(1);
       if (metadataKey === 'renderMode') {
         value = metadata.renderMode;
+      } else if (metadataKey === 'token') {
+        value = presentation.token;
       }
     } else {
       // Don't replace variables that are numbers to allow setting

package/src/types.ts

@@ -16,6 +16,7 @@ export interface Presentation {
     };
     presentationsPlaylists: Array<{ playlistId: string }>;
   };
+  token?: string;
 }
 
 export interface ApplicationVersion {