Merge pull request #9095 from seanchas116/better-path-resolve

Search for module from app path when URL is not file protocol

atom/browser/api/atom_api_app.cc

@@ -655,6 +655,14 @@ void App::OnGpuProcessCrashed(base::TerminationStatus status) {
     status == base::TERMINATION_STATUS_PROCESS_WAS_KILLED);
 }
 
+base::FilePath App::GetAppPath() const {
+  return app_path_;
+}
+
+void App::SetAppPath(const base::FilePath& app_path) {
+  app_path_ = app_path;
+}
+
 base::FilePath App::GetPath(mate::Arguments* args, const std::string& name) {
   bool succeed = false;
   base::FilePath path;
@@ -959,6 +967,8 @@ void App::BuildPrototype(
       .SetMethod("isUnityRunning",
                  base::Bind(&Browser::IsUnityRunning, browser))
 #endif
+      .SetMethod("setAppPath", &App::SetAppPath)
+      .SetMethod("getAppPath", &App::GetAppPath)
       .SetMethod("setPath", &App::SetPath)
       .SetMethod("getPath", &App::GetPath)
       .SetMethod("setDesktopName", &App::SetDesktopName)

atom/browser/api/atom_api_app.h

@@ -70,6 +70,8 @@ class App : public AtomBrowserClient::Delegate,
       std::unique_ptr<CertificateManagerModel> model);
 #endif
 
+  base::FilePath GetAppPath() const;
+
  protected:
   explicit App(v8::Isolate* isolate);
   ~App() override;
@@ -115,6 +117,8 @@ class App : public AtomBrowserClient::Delegate,
   void OnGpuProcessCrashed(base::TerminationStatus status) override;
 
  private:
+  void SetAppPath(const base::FilePath& app_path);
+
   // Get/Set the pre-defined path in PathService.
   base::FilePath GetPath(mate::Arguments* args, const std::string& name);
   void SetPath(mate::Arguments* args,
@@ -154,6 +158,8 @@ class App : public AtomBrowserClient::Delegate,
   // Tracks tasks requesting file icons.
   base::CancelableTaskTracker cancelable_task_tracker_;
 
+  base::FilePath app_path_;
+
   DISALLOW_COPY_AND_ASSIGN(App);
 };
 

atom/browser/atom_browser_client.cc

@@ -235,6 +235,11 @@ void AtomBrowserClient::AppendExtraCommandLineSwitches(
   }
 #endif
 
+  if (delegate_) {
+    auto app_path = static_cast<api::App*>(delegate_)->GetAppPath();
+    command_line->AppendSwitchPath(switches::kAppPath, app_path);
+  }
+
   content::WebContents* web_contents = GetWebContentsFromProcessID(process_id);
   if (!web_contents)
     return;

atom/common/options_switches.cc

@@ -159,6 +159,9 @@ const char kSecureSchemes[] = "secure-schemes";
 // The browser process app model ID
 const char kAppUserModelId[] = "app-user-model-id";
 
+// The application path
+const char kAppPath[] = "app-path";
+
 // The command line switch versions of the options.
 const char kBackgroundColor[]  = "background-color";
 const char kPreloadScript[]    = "preload";

atom/common/options_switches.h

@@ -81,6 +81,7 @@ extern const char kStandardSchemes[];
 extern const char kRegisterServiceWorkerSchemes[];
 extern const char kSecureSchemes[];
 extern const char kAppUserModelId[];
+extern const char kAppPath[];
 
 extern const char kBackgroundColor[];
 extern const char kPreloadScript[];

lib/browser/api/app.js

@@ -12,11 +12,7 @@ const {EventEmitter} = require('events')
 
 Object.setPrototypeOf(App.prototype, EventEmitter.prototype)
 
-let appPath = null
-
 Object.assign(app, {
-  getAppPath () { return appPath },
-  setAppPath (path) { appPath = path },
   setApplicationMenu (menu) {
     return Menu.setApplicationMenu(menu)
   },

lib/renderer/init.js

@@ -56,6 +56,7 @@ electron.ipcRenderer.on('ELECTRON_INTERNAL_RENDERER_ASYNC_WEB_FRAME_METHOD', (ev
 let nodeIntegration = 'false'
 let preloadScript = null
 let isBackgroundPage = false
+let appPath = null
 for (let arg of process.argv) {
   if (arg.indexOf('--guest-instance-id=') === 0) {
     // This is a guest web view.
@@ -69,6 +70,8 @@ for (let arg of process.argv) {
     preloadScript = arg.substr(arg.indexOf('=') + 1)
   } else if (arg === '--background-page') {
     isBackgroundPage = true
+  } else if (arg.indexOf('--app-path=') === 0) {
+    appPath = arg.substr(arg.indexOf('=') + 1)
   }
 }
 
@@ -116,6 +119,11 @@ if (nodeIntegration === 'true') {
   } else {
     global.__filename = __filename
     global.__dirname = __dirname
+
+    if (appPath) {
+      // Search for module under the app directory
+      module.paths = module.paths.concat(Module._nodeModulePaths(appPath))
+    }
   }
 
   // Redirect window.onerror to uncaughtException.

spec/modules-spec.js

@@ -2,6 +2,9 @@ const assert = require('assert')
 const Module = require('module')
 const path = require('path')
 const temp = require('temp')
+const {remote} = require('electron')
+const {BrowserWindow} = remote
+const {closeWindow} = require('./window-helpers')
 
 describe('third-party module', function () {
   var fixtures = path.join(__dirname, 'fixtures')
@@ -129,3 +132,26 @@ describe('Module._nodeModulePaths', function () {
     })
   })
 })
+
+describe('require', () => {
+  describe('when loaded URL is not file: protocol', () => {
+    let w
+
+    beforeEach(() => {
+      w = new BrowserWindow({
+        show: false
+      })
+    })
+
+    afterEach(async () => {
+      await closeWindow(w)
+      w = null
+    })
+
+    it('searches for module under app directory', async () => {
+      w.loadURL('about:blank')
+      const result = await w.webContents.executeJavaScript('typeof require("q").when')
+      assert.equal(result, 'function')
+    })
+  })
+})