From e7444b1ebebf3fcadc0589378071ad87e58529ce Mon Sep 17 00:00:00 2001 From: Max Brunsfeld Date: Wed, 24 Aug 2016 13:05:46 -0700 Subject: [PATCH] Add shims for legacy electron APIs Signed-off-by: Nathan Sobo --- exports/ipc.js | 7 +++++++ exports/remote.js | 7 +++++++ exports/web-frame.js | 7 +++++++ src/electron-shims.js | 7 +++++++ src/initialize-application-window.coffee | 1 + src/initialize-test-window.coffee | 1 + 6 files changed, 30 insertions(+) create mode 100644 exports/ipc.js create mode 100644 exports/remote.js create mode 100644 exports/web-frame.js create mode 100644 src/electron-shims.js diff --git a/exports/ipc.js b/exports/ipc.js new file mode 100644 index 000000000..9d1b1e3ee --- /dev/null +++ b/exports/ipc.js @@ -0,0 +1,7 @@ +module.exports = require('electron').ipcRenderer + +const Grim = require('grim') +Grim.deprecate('Use `require("electron").ipcRenderer` instead of `require("ipc")`') + +// Ensure each package that requires this shim causes a deprecation warning +delete require.cache[__filename] diff --git a/exports/remote.js b/exports/remote.js new file mode 100644 index 000000000..379ee43f6 --- /dev/null +++ b/exports/remote.js @@ -0,0 +1,7 @@ +module.exports = require('electron').remote + +const Grim = require('grim') +Grim.deprecate('Use `require("electron").remote` instead of `require("remote")`') + +// Ensure each package that requires this shim causes a deprecation warning +delete require.cache[__filename] diff --git a/exports/web-frame.js b/exports/web-frame.js new file mode 100644 index 000000000..0c97debfd --- /dev/null +++ b/exports/web-frame.js @@ -0,0 +1,7 @@ +module.exports = require('electron').webFrame + +const Grim = require('grim') +Grim.deprecate('Use `require("electron").webFrame` instead of `require("web-frame")`') + +// Ensure each package that requires this shim causes a deprecation warning +delete require.cache[__filename] diff --git a/src/electron-shims.js b/src/electron-shims.js new file mode 100644 index 000000000..ef625e6de --- /dev/null +++ b/src/electron-shims.js @@ -0,0 +1,7 @@ +const electron = require('electron') + +electron.ipcRenderer.sendChannel = function () { + const Grim = require('grim') + Grim.deprecate('Use `ipcRenderer.send` instead of `ipcRenderer.sendChannel`') + return this.send.apply(this, arguments) +} diff --git a/src/initialize-application-window.coffee b/src/initialize-application-window.coffee index 9787977e2..04784efa0 100644 --- a/src/initialize-application-window.coffee +++ b/src/initialize-application-window.coffee @@ -6,6 +6,7 @@ module.exports = ({blobStore}) -> {getWindowLoadSettings} = require './window-load-settings-helpers' {ipcRenderer} = require 'electron' {resourcePath, isSpec, devMode, env} = getWindowLoadSettings() + require '../src/electron-shims' updateProcessEnv(env) diff --git a/src/initialize-test-window.coffee b/src/initialize-test-window.coffee index d5423a5a5..a775ec3fb 100644 --- a/src/initialize-test-window.coffee +++ b/src/initialize-test-window.coffee @@ -19,6 +19,7 @@ module.exports = ({blobStore}) -> {getWindowLoadSettings} = require './window-load-settings-helpers' AtomEnvironment = require '../src/atom-environment' ApplicationDelegate = require '../src/application-delegate' + require '../src/electron-shims' {testRunnerPath, legacyTestRunnerPath, headless, logFile, testPaths} = getWindowLoadSettings()