Add chromium path arguments (#465)

* Add chromium path arguments * Update simulate API * Argument correction and exception logs * Lowercase correction * Lowercase correction 1.0 * Fix chromium path argument validation * Fix chromium path argument validation 1.0 * Chromium target validation * Fix Chromium target validation * Target validation update * getBrowser chromiumPath argument location change --------- Co-authored-by: Rodolfo Liberado (BEYONDSOFT CONSULTING INC) <[email protected]>
microsoft · Mar 11, 2024 · d052b51 · d052b51
1 parent e84a1e3
commit d052b51
Show file tree

Hide file tree

Showing 4 changed files with 24 additions and 47 deletions.
diff --git a/bin/simulate b/bin/simulate
@@ -35,7 +35,7 @@ function unknownOptHandler(optName) {
 function processArgs() {
     try {
         var parserOptions = {
-            string: ['dir', 'simhostui', 'target', 'simulationpath', 'device', 'lang', 'theme', 'middleware'],
+            string: ['dir', 'simhostui', 'target', 'simulationpath', 'device', 'lang', 'theme', 'middleware', 'chromiumpath'],
             boolean: ['livereload', 'forceprepare', 'corsproxy', 'generateids', 'spaurlrewrites', 'showbrowser'],
             default: {
                 dir: null,
@@ -77,7 +77,8 @@ function processArgs() {
             middleware: parsed.middleware,
             generateids: parsed.generateids,
             spaurlrewrites: parsed.spaurlrewrites,
-            showbrowser: parsed.showbrowser
+            showbrowser: parsed.showbrowser,
+            chromiumpath: parsed.chromiumpath
         };
     } catch (err) {
         throw new Error('Error parsing arguments: ' + (err.message || err) + os.EOL + os.EOL + getUsageString());
@@ -102,7 +103,8 @@ function getUsageString() {
         '[--middleware MIDDLEWARE_PATH]',
         '[--generateids (GENERATEIDS)]',
         '[--spaurlrewrites (SPA_URL_REWRITES)]',
-        '[--showbrowser (SHOWBROWSER)]'
+        '[--showbrowser (SHOWBROWSER)]',
+        '[--chromiumpath CHROMIUM_PATH]'
     ];
 
     return message + options.join(' ') + os.EOL;

diff --git a/package-lock.json b/package-lock.json
diff --git a/src/browsers/browser.js b/src/browsers/browser.js
@@ -17,6 +17,7 @@ function launchBrowser(opts) {
     let target = opts.target || 'default';
     const url = opts.url || '';
     let showBrowser = opts.showBrowser;
+    const chromiumPath = opts.chromiumPath;
 
     // Handle showbrowser argument sent from cordova-tools and other unknown scenarios
     // Only showbrowser = false will return method
@@ -29,7 +30,7 @@ function launchBrowser(opts) {
         open(url);
         return Promise.resolve();
     } else {
-        return getBrowser(target, opts.dataDir, url).then(browser => {
+        return getBrowser(target, opts.dataDir, url, chromiumPath).then(browser => {
             let args;
 
             switch (process.platform) {
@@ -62,7 +63,7 @@ function launchBrowser(opts) {
     }
 }
 
-function getBrowser(target, dataDir, url) {
+function getBrowser(target, dataDir, url, chromiumPath) {
     if (target == 'chrome') {
         dataDir = dataDir || 'cordova_simulate_temp_chrome_user_data_dir';
     } else if (target == 'edge') {
@@ -73,6 +74,7 @@ function getBrowser(target, dataDir, url) {
     const browsers = {
         win32: {
             chrome: `chrome --user-data-dir=%TEMP%\\${dataDir}`,
+            chromium: chromiumPath,
             opera: 'opera',
             firefox: 'firefox',
             edge: `msedge ${url} --user-data-dir=%TEMP%\\${dataDir}`

diff --git a/src/simulate.js b/src/simulate.js
@@ -6,8 +6,8 @@ var Simulator = require('./server/simulator');
 var BrowserHelper = require('./browsers/browser');
 const log = require('./server/utils/log');
 
-var launchBrowser = function (target, url, showBrowser) {
-    return BrowserHelper.launchBrowser({ target: target, url: url, showBrowser: showBrowser });
+var launchBrowser = function (target, url, showBrowser, chromiumPath) {
+    return BrowserHelper.launchBrowser({ target: target, url: url, showBrowser: showBrowser, chromiumPath: chromiumPath });
 };
 
 var simulate = function (opts) {
@@ -17,18 +17,27 @@ var simulate = function (opts) {
     var target = opts.target || 'default';
     var simulator = new Simulator(opts);
     var showBrowser = opts.showbrowser;
+    var chromiumPath = opts.chromiumpath;
 
     if (!showBrowser) {
         var noBrowserMessage = 'The argument `showbrowser` is set to false. Please load simulated application in browser manually if needed.';
         log.warning(noBrowserMessage);
     }
 
+    if(process.platform === 'win32' && target.toLowerCase() === 'chromium' && !chromiumPath){
+        var win32NoPathMessage = 'Chromium path is required on Windows (win32).';
+        throw new Error(win32NoPathMessage);
+    }else if(process.platform !== 'win32' && chromiumPath){
+        var nonWin32PathMessage = 'Chromium path is not supported on this platform.';
+        log.warning(nonWin32PathMessage);
+    }
+
     return simulator.startSimulation()
         .then(function () {
-            return launchBrowser(target, simulator.appUrl(), showBrowser);
+            return launchBrowser(target, simulator.appUrl(), showBrowser, chromiumPath);
         })
         .then(function () {
-            return launchBrowser(target, simulator.simHostUrl(), showBrowser);
+            return launchBrowser(target, simulator.simHostUrl(), showBrowser, chromiumPath);
         })
         .then(function () {
             return simulator;