VSCode plugin: fix predeploy call (#6238)

Author: hsubox76

firebase-vscode/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Change Log
 
+## 0.0.25 (unreleased)
+
+- Replace predeploy hack with something more robust.
+
 ## 0.0.24
 
 - Remove proxy-agent stub #6172

firebase-vscode/webpack.common.js

@@ -84,18 +84,6 @@ const extensionConfig = {
               search: /Configstore\(pkg\.name\)/g,
               replace: "Configstore('firebase-tools')",
             },
-            // TODO(hsubox76): replace with something more robust
-            // This is an issue with a local call to cross-env-shell.js
-            // and a dependency on calling the Node executable using an env
-            // variable which returns a string with a lot of unusual characters
-            // if called inside VSCode.
-            // We may be able to copy cross-env-shell.js into dist?
-            // For the node executable we can probably just call Node, still
-            // need to search/replace though
-            {
-              search: "childProcess.spawn(translatedCommand",
-              replace: "childProcess.spawn(escapedCommand"
-            },
             // Some CLI code uses module.exports for test stubbing.
             // We are using ES2020 and it doesn't recognize functions called
             // as exports.functionName() or module.exports.functionName().
@@ -142,7 +130,13 @@ const extensionConfig = {
           from: "*.js",
           to: './',
           context: "../src/deploy/functions/runtimes/node",
-        }
+        },
+        // Copy cross-env-shell.js used to run predeploy scripts
+        // to ensure they work in Windows
+        {
+          from: "../node_modules/cross-env/dist",
+          to: './cross-env/dist',
+        },
       ],
     })
   ],

src/deploy/lifecycleHooks.ts

@@ -9,14 +9,13 @@ import { Options } from "../options";
 
 function runCommand(command: string, childOptions: childProcess.SpawnOptions) {
   const escapedCommand = command.replace(/\"/g, '\\"');
+  const isVSCode = utils.isVSCodeExtension();
+  const nodeExecutable = isVSCode ? "node" : process.execPath;
+  const crossEnvShellPath = isVSCode
+    ? path.resolve(__dirname, "./cross-env/dist/bin/cross-env-shell.js")
+    : path.resolve(require.resolve("cross-env"), "..", "bin", "cross-env-shell.js");
   const translatedCommand =
-    '"' +
-    process.execPath +
-    '" "' +
-    path.resolve(require.resolve("cross-env"), "..", "bin", "cross-env-shell.js") +
-    '" "' +
-    escapedCommand +
-    '"';
+    '"' + nodeExecutable + '" "' + crossEnvShellPath + '" "' + escapedCommand + '"';
 
   return new Promise<void>((resolve, reject) => {
     logger.info("Running command: " + command);

src/utils.ts

@@ -581,6 +581,13 @@ export function isCloudEnvironment() {
   return !!process.env.CODESPACES || !!process.env.GOOGLE_CLOUD_WORKSTATIONS;
 }
 
+/**
+ * Detect if code is running in a VSCode Extension
+ */
+export function isVSCodeExtension(): boolean {
+  return !!process.env.VSCODE_CWD;
+}
+
 /**
  * Indicates whether or not this process is likely to be running in WSL.
  * @return true if we're likely in WSL, false otherwise