From fcc82ebd353d1704e111d4d84a8a1e5675840dff Mon Sep 17 00:00:00 2001
From: Alexey Kuzmin <alexeykuzmin@users.noreply.github.com>
Date: Fri, 20 Apr 2018 09:09:23 +0200
Subject: [PATCH] Add "app.whenReady()" (#12652)

* Make "chai-as-promised" avaialble in tests

* Add "app.whenReady()"

Closes #9561.
---
 docs/api/app.md        |  6 ++++++
 lib/browser/api/app.js | 18 ++++++++++++++++++
 spec/api-app-spec.js   | 16 ++++++++++++++++
 spec/package.json      |  1 +
 4 files changed, 41 insertions(+)

diff --git a/docs/api/app.md b/docs/api/app.md
index 21b013f9070..e840018dd5a 100644
--- a/docs/api/app.md
+++ b/docs/api/app.md
@@ -432,6 +432,12 @@ app.exit(0)
 
 Returns `Boolean` - `true` if Electron has finished initializing, `false` otherwise.
 
+### `app.whenReady()`
+
+Returns `Promise` - fulfilled when Electron is initialized.
+May be used as a convenient alternative to checking `app.isReady()`
+and subscribing to the `ready` event if the app is not ready yet.
+
 ### `app.focus()`
 
 On Linux, focuses on the first visible window. On macOS, makes the application
diff --git a/lib/browser/api/app.js b/lib/browser/api/app.js
index 1ea1daddca8..6aaeadbe8f8 100644
--- a/lib/browser/api/app.js
+++ b/lib/browser/api/app.js
@@ -11,12 +11,30 @@ const {deprecate, Menu} = electron
 const {EventEmitter} = require('events')
 
 let dockMenu = null
+let readyPromise = null
 
 // App is an EventEmitter.
 Object.setPrototypeOf(App.prototype, EventEmitter.prototype)
 EventEmitter.call(app)
 
 Object.assign(app, {
+  whenReady () {
+    if (readyPromise !== null) {
+      return readyPromise
+    }
+
+    if (app.isReady()) {
+      readyPromise = Promise.resolve()
+    } else {
+      readyPromise = new Promise(resolve => {
+        // XXX(alexeykuzmin): Explicitly ignore any data
+        // passed to the event handler to avoid memory leaks.
+        app.once('ready', () => resolve())
+      })
+    }
+
+    return readyPromise
+  },
   setApplicationMenu (menu) {
     return Menu.setApplicationMenu(menu)
   },
diff --git a/spec/api-app-spec.js b/spec/api-app-spec.js
index b4be1f337f6..1de8a99e195 100644
--- a/spec/api-app-spec.js
+++ b/spec/api-app-spec.js
@@ -1,4 +1,6 @@
 const assert = require('assert')
+const chai = require('chai')
+const chaiAsPromised = require('chai-as-promised')
 const ChildProcess = require('child_process')
 const https = require('https')
 const net = require('net')
@@ -7,10 +9,13 @@ const path = require('path')
 const {ipcRenderer, remote} = require('electron')
 const {closeWindow} = require('./window-helpers')
 
+const {expect} = chai
 const {app, BrowserWindow, Menu, ipcMain} = remote
 
 const isCI = remote.getGlobal('isCi')
 
+chai.use(chaiAsPromised)
+
 describe('electron module', () => {
   it('does not expose internal modules to require', () => {
     assert.throws(() => {
@@ -903,4 +908,15 @@ describe('app module', () => {
       v8Util.requestGarbageCollectionForTesting()
     })
   })
+
+  describe('whenReady', () => {
+    it('returns a Promise', () => {
+      expect(app.whenReady()).to.be.an.instanceOf(Promise)
+    })
+
+    it('becomes fulfilled if the app is already ready', () => {
+      assert(app.isReady())
+      return expect(app.whenReady()).to.be.eventually.fulfilled
+    })
+  })
 })
diff --git a/spec/package.json b/spec/package.json
index b34558416fb..30fa0480992 100644
--- a/spec/package.json
+++ b/spec/package.json
@@ -7,6 +7,7 @@
     "basic-auth": "^1.0.4",
     "bluebird": "^3.5.1",
     "chai": "^4.1.2",
+    "chai-as-promised": "^7.1.1",
     "coffee-script": "1.12.7",
     "dbus-native": "^0.2.3",
     "graceful-fs": "^4.1.9",