chore(electron): Move off deprecated remote module

Author: Brendan Mulholland

main.js

@@ -4,6 +4,8 @@ const { autoUpdater } = require('electron-updater');
 const { onFirstRunMaybe } = require('./first-run');
 const path = require('path');
 
+require('@electron/remote/main').initialize()
+
 app.setAppUserModelId('com.electron.gitify');
 
 const iconIdle = path.join(

package.json

@@ -93,6 +93,7 @@
     "afterSign": "scripts/notarize.js"
   },
   "dependencies": {
+    "@electron/remote": "^2.0.11",
     "@primer/octicons-react": "19.8.0",
     "axios": "1.5.1",
     "date-fns": "2.30.0",

pnpm-lock.yaml

@@ -0,0 +1,39 @@
+let instance;
+
+class BrowserWindow {
+  constructor() {
+    if (!instance) {
+      instance = this;
+    }
+    return instance;
+  }
+  loadURL = jest.fn();
+  webContents = {
+    on: () => { },
+    session: {
+      clearStorageData: jest.fn(),
+    },
+  };
+  on() { }
+  close = jest.fn();
+  hide = jest.fn();
+  destroy = jest.fn();
+}
+
+const dialog = {
+  showErrorBox: jest.fn(),
+};
+
+module.exports = {
+  BrowserWindow: BrowserWindow,
+  dialog: dialog,
+  process: {
+    platform: 'darwin',
+  },
+  app: {
+    getVersion: () => '0.0.1',
+    getLoginItemSettings: jest.fn(),
+    setLoginItemSettings: () => { },
+  },
+  getCurrentWindow: jest.fn(() => instance || new BrowserWindow()),
+}

src/__mocks__/@electron/remote.js

@@ -1,4 +1,4 @@
-window.Notification = function (title) {
+window.Notification = function(title) {
   this.title = title;
 
   return {
@@ -11,62 +11,23 @@ window.Audio = class Audio {
     this.path = path;
   }
 
-  play() {}
+  play() { }
 };
 
 window.localStorage = {
   store: {},
-  getItem: function (key) {
+  getItem: function(key) {
     return this.store[key];
   },
-  setItem: function (key, item) {
+  setItem: function(key, item) {
     this.store[key] = item;
   },
   removeItem: jest.fn(),
 };
 
 window.alert = jest.fn();
 
-let instance;
-
-class BrowserWindow {
-  constructor() {
-    if (!instance) {
-      instance = this;
-    }
-    return instance;
-  }
-  loadURL = jest.fn();
-  webContents = {
-    on: () => {},
-    session: {
-      clearStorageData: jest.fn(),
-    },
-  };
-  on() {}
-  close = jest.fn();
-  hide = jest.fn();
-  destroy = jest.fn();
-}
-
-const dialog = {
-  showErrorBox: jest.fn(),
-};
-
 module.exports = {
-  remote: {
-    BrowserWindow: BrowserWindow,
-    dialog: dialog,
-    process: {
-      platform: 'darwin',
-    },
-    app: {
-      getVersion: () => '0.0.1',
-      getLoginItemSettings: jest.fn(),
-      setLoginItemSettings: () => {},
-    },
-    getCurrentWindow: jest.fn(() => instance || new BrowserWindow()),
-  },
   ipcRenderer: {
     send: jest.fn(),
     on: jest.fn(),

src/__mocks__/electron.js

@@ -1,5 +1,6 @@
 import React, { useCallback, useContext } from 'react';
-import { ipcRenderer, remote } from 'electron';
+import { ipcRenderer } from 'electron';
+import remote from '@electron/remote';
 import { useNavigate } from 'react-router-dom';
 import { ArrowLeftIcon } from '@primer/octicons-react';
 

src/routes/Settings.tsx

@@ -1,6 +1,6 @@
 import { AxiosPromise, AxiosResponse } from 'axios';
 
-import { remote } from 'electron';
+import remote from '@electron/remote';
 const browserWindow = new remote.BrowserWindow();
 
 import * as auth from './auth';

src/utils/auth.test.ts

@@ -1,7 +1,6 @@
 import { generateGitHubAPIUrl } from './helpers';
 
-const { remote } = require('electron');
-const BrowserWindow = remote.BrowserWindow;
+const { BrowserWindow } = require('@electron/remote');
 
 import { apiRequest, apiRequestAuth } from '../utils/api-requests';
 import { AuthResponse, AuthState, AuthTokenResponse } from '../types';

src/utils/auth.ts

@@ -6,10 +6,12 @@ import {
   restoreSetting,
 } from './comms';
 
-const { ipcRenderer, remote, shell } = require('electron');
+const { ipcRenderer, shell } = require('electron');
+
+const remote = require('@electron/remote');
 
 describe('utils/comms.ts', () => {
-  beforeEach(function () {
+  beforeEach(function() {
     jest.spyOn(ipcRenderer, 'send');
   });
 

src/utils/comms.test.ts

@@ -1,4 +1,5 @@
-const { ipcRenderer, remote, shell } = require('electron');
+const { ipcRenderer, shell } = require('electron');
+const remote = require('@electron/remote');
 
 export function openExternalLink(url: string): void {
   shell.openExternal(url);

src/utils/comms.ts

@@ -1,4 +1,4 @@
-const { remote } = require('electron');
+const remote = require('@electron/remote');
 
 import { openInBrowser } from '../utils/helpers';
 import { reOpenWindow, updateTrayIcon } from './comms';