add VSCMD_DEBUG=1 logging to vcvars64.bat capture

Author: philwalk

modules/core/src/main/scala/scala/build/internals/NativeWrapper.scala

@@ -33,55 +33,56 @@ object MsvcEnvironment {
       case Some(vcvars) =>
         logger.debug(s"Using vcvars script $vcvars")
 
-        val msvcEnv = captureVcvarsEnv(vcvars, workingDir)
-        val clDir   = os.Path(msvcEnv("VCTOOLSINSTALLDIR")) / "bin" / "Hostx64" / "x64"
-        logger.debug(s"clDir[$clDir]")
-        if (!os.exists(clDir)) {
-          logger.message(s"cl.exe directory missing: $clDir")
-          -1
+        val (debugEcho: Seq[String], msvcEnv: Map[String, String]) =
+          captureVcvarsEnv(vcvars, workingDir)
+        debugEcho.foreach { dbg =>
+          logger.message(s"$dbg")
         }
-        else {
-          val msvcEnv: Map[String, String] = captureVcvarsEnv(vcvars, workingDir)
-          val clExe: os.Path               = clDir / "cl.exe"
-          if !os.exists(clExe) then
-            logger.message(s"warning: file not found: $clExe")
-
-          val msvcEntries: Seq[String] = {
-            val entries = msvcEnv.getOrElse("PATH", "").split(";").toSeq
-            if entries.headOption == Some(clDir.toString) then entries
-            else clDir.toString +: entries
-          }
+        val msvcEntries: Seq[String] = msvcEnv.getOrElse("PATH", "").split(";").toSeq
+
+        // show aliased drive map
+        val substMap: Map[Char, String] = aliasedDriveLetters
+        substMap.foreach((k, v) => logger.message(s"substMap  $k: -> $v"))
 
-          // show aliased drive map
-          val substMap: Map[Char, String] = aliasedDriveLetters
-          substMap.foreach((k, v) => logger.message(s"substMap  $k: -> $v"))
+        val finalPath = msvcEntries.mkString(";")
+        val finalEnv  =
+          msvcEnv +
+            ("PATH"                                 -> finalPath) +
+            ("GRAALVM_ARGUMENT_VECTOR_PROGRAM_NAME" -> "native-image")
 
-          val finalPath = msvcEntries.mkString(";")
-          val finalEnv  =
-            msvcEnv +
-              ("PATH"                                 -> finalPath) +
-              ("GRAALVM_ARGUMENT_VECTOR_PROGRAM_NAME" -> "native-image")
+        logger.message(s"msvc PATH entries:")
+        msvcEntries.foreach { entry =>
+          logger.message(s"$entry;")
+        }
 
-          logger.message(s"msvc PATH entries:")
-          msvcEntries.foreach { entry =>
-            logger.message(s"$entry;")
+        // Replace native-image.cmd with native-image.exe, if applicable
+        val updatedCommand: Seq[String] =
+          command.headOption match {
+            case Some(cmd) if cmd.toLowerCase.endsWith("native-image.cmd") =>
+              val cmdPath   = os.Path(cmd, os.pwd)
+              val graalHome = cmdPath / os.up / os.up
+              resolveNativeImage(graalHome) match {
+                case Some(exe) =>
+                  exe.toString +: command.tail
+                case None =>
+                  command // fall back to the .cmd wrapper
+              }
+            case _ =>
+              command
           }
 
-          logger.message(s"native-image w/args: $command")
+        logger.message(s"native-image w/args: $command")
 
-          // request extra info in case of exceptions
-          val altCommand = insertAfterCp(command, "-H:+ReportExceptionStackTraces")
-          val result     =
-            os.proc(altCommand)
-              .call(
-                cwd = workingDir,
-                env = finalEnv,
-                stdout = os.Inherit,
-                stderr = os.Inherit
-              )
+        val result =
+          os.proc(updatedCommand)
+            .call(
+              cwd = workingDir,
+              env = finalEnv,
+              stdout = os.Inherit,
+              stderr = os.Inherit
+            )
 
-          result.exitCode
-        }
+        result.exitCode
     }
   }
 
@@ -177,19 +178,24 @@ object MsvcEnvironment {
   // =========================
   // Capture MSVC environment
   // =========================
-  private def captureVcvarsEnv(vcvars: os.Path, workingDir: os.Path): Map[String, String] = {
+  private def captureVcvarsEnv(
+    vcvars: os.Path,
+    workingDir: os.Path
+  ): (Seq[String], Map[String, String]) = {
+
     val vcvarsCmd = vcvars.toIO.getAbsolutePath
 
-    val cmd = Seq(
+    val sentinel = "::sentinel"
+    val cmd      = Seq(
       cmdExe,
       "/c",
-      s"""(call \"$vcvarsCmd\") && set"""
+      s"""set "VSCMD_DEBUG=1" & call "$vcvarsCmd" & echo $sentinel & set"""
     )
 
     val out = new StringBuilder
 
     val res = os.proc(cmd).call(
-      cwd = workingDir, // run vcvars from the working directory
+      cwd = workingDir,
       env = sys.env,
       stdout = os.ProcessOutput.Readlines(line => out.append(line).append("\n")),
       stderr = os.Inherit,
@@ -198,17 +204,40 @@ object MsvcEnvironment {
 
     if res.exitCode != 0 then
       System.err.println(s"vcvars call failed with exit code ${res.exitCode}")
-      Map.empty
+      (Seq.empty, Map.empty)
     else
-      out.result().linesIterator
-        .map(_.trim)
-        .filter(_.contains("="))
-        .flatMap {
-          _.split("=", 2) match
-            case Array(k, v) => Some(k.toUpperCase(Locale.ROOT) -> v)
-            case _           => None
-        }
-        .toMap
+      val lines = out.result().linesIterator.map(_.trim).filter(_.nonEmpty).toVector
+
+      // Split at sentinel
+      val (debugLines, afterSentinel) = lines.span(_ != sentinel)
+
+      // Drop the sentinel itself
+      val envLines = afterSentinel.drop(1)
+
+      // Parse KEY=VALUE lines
+      val envMap =
+        envLines
+          .flatMap { line =>
+            if line.contains("=") then
+              line.split("=", 2) match
+                case Array(k, v) =>
+                  Some(k.toUpperCase(Locale.ROOT) -> v)
+                case _ =>
+                  None
+            else None
+          }
+          .toMap
+
+      (debugLines, envMap)
+  }
+
+  private def resolveNativeImage(graalHome: os.Path): Option[os.Path] = {
+    val candidates = Seq(
+      graalHome / "lib" / "svm" / "bin" / "native-image.exe",
+      graalHome / "bin" / "native-image.exe",
+      graalHome / "native-image.exe"
+    )
+    candidates.find(os.exists)
   }
 
   private def vcvarsOpt: Option[os.Path] = {