Output environment file for Windows

.github/workflows/pr-checks.yml

@@ -465,8 +465,10 @@ jobs:
 
     - name: Build code
       shell: powershell
+      # Note we want to make sure that the .win32env file is read correctly, so we unset the CODEQL_EXTRACTOR_CSHARP_ROOT from the .sh file.
       run: |
         cat ./codeql-runner/codeql-env.sh | Invoke-Expression
+        $Env:CODEQL_EXTRACTOR_CSHARP_ROOT = ""
         & $Env:CODEQL_RUNNER dotnet build
 
     - name: Run analyze

lib/tracer-config.js

@@ -45,7 +45,7 @@ async function getTracerConfigForLanguage(codeql, config, language) {
     return info;
 }
 exports.getTracerConfigForLanguage = getTracerConfigForLanguage;
-function concatTracerConfigs(tracerConfigs, config) {
+function concatTracerConfigs(tracerConfigs, config, writeBothEnvironments = false) {
     // A tracer config is a map containing additional environment variables and a tracer 'spec' file.
     // A tracer 'spec' file has the following format [log_file, number_of_blocks, blocks_text]
     // Merge the environments
@@ -103,20 +103,42 @@ function concatTracerConfigs(tracerConfigs, config) {
         envSize += 1;
     }
     fs.writeFileSync(spec, newSpecContent.join("\n"));
-    // Prepare the content of the compound environment file
-    let buffer = Buffer.alloc(4);
-    buffer.writeInt32LE(envSize, 0);
-    for (const e of Object.entries(env)) {
-        const key = e[0];
-        const value = e[1];
-        const lineBuffer = Buffer.from(`${key}=${value}\0`, "utf8");
-        const sizeBuffer = Buffer.alloc(4);
-        sizeBuffer.writeInt32LE(lineBuffer.length, 0);
-        buffer = Buffer.concat([buffer, sizeBuffer, lineBuffer]);
+    if (writeBothEnvironments || process.platform !== "win32") {
+        // Prepare the content of the compound environment file on Unix
+        let buffer = Buffer.alloc(4);
+        buffer.writeInt32LE(envSize, 0);
+        for (const e of Object.entries(env)) {
+            const key = e[0];
+            const value = e[1];
+            const lineBuffer = Buffer.from(`${key}=${value}\0`, "utf8");
+            const sizeBuffer = Buffer.alloc(4);
+            sizeBuffer.writeInt32LE(lineBuffer.length, 0);
+            buffer = Buffer.concat([buffer, sizeBuffer, lineBuffer]);
+        }
+        // Write the compound environment for Unix
+        const envPath = `${spec}.environment`;
+        fs.writeFileSync(envPath, buffer);
+    }
+    if (writeBothEnvironments || process.platform === "win32") {
+        // Prepare the content of the compound environment file on Windows
+        let bufferWindows = Buffer.alloc(0);
+        let length = 0;
+        for (const e of Object.entries(env)) {
+            const key = e[0];
+            const value = e[1];
+            const string = `${key}=${value}\0`;
+            length += string.length;
+            const lineBuffer = Buffer.from(string, "utf16le");
+            bufferWindows = Buffer.concat([bufferWindows, lineBuffer]);
+        }
+        const sizeBuffer = Buffer.alloc(4);
+        sizeBuffer.writeInt32LE(length + 1, 0); // Add one for trailing null character marking end
+        const trailingNull = Buffer.from(`\0`, "utf16le");
+        bufferWindows = Buffer.concat([sizeBuffer, bufferWindows, trailingNull]);
+        // Write the compound environment for Windows
+        const envPathWindows = `${spec}.win32env`;
+        fs.writeFileSync(envPathWindows, bufferWindows);
     }
-    // Write the compound environment
-    const envPath = `${spec}.environment`;
-    fs.writeFileSync(envPath, buffer);
     return { env, spec };
 }
 exports.concatTracerConfigs = concatTracerConfigs;

lib/tracer-config.test.js

@@ -216,17 +216,26 @@ ava_1.default("concatTracerConfigs - compound environment file is created correc
                 foo: "bar_baz",
             },
         };
-        const result = tracer_config_1.concatTracerConfigs({ javascript: tc1, python: tc2 }, config);
+        const result = tracer_config_1.concatTracerConfigs({ javascript: tc1, python: tc2 }, config, true);
+        // Check binary contents for the Unix file
         const envPath = `${result.spec}.environment`;
         t.true(fs.existsSync(envPath));
         const buffer = fs.readFileSync(envPath);
-        // Contents is binary data
         t.deepEqual(buffer.length, 28);
         t.deepEqual(buffer.readInt32LE(0), 2); // number of env vars
         t.deepEqual(buffer.readInt32LE(4), 4); // length of env var definition
         t.deepEqual(buffer.toString("utf8", 8, 12), "a=a\0"); // [key]=[value]\0
         t.deepEqual(buffer.readInt32LE(12), 12); // length of env var definition
         t.deepEqual(buffer.toString("utf8", 16, 28), "foo=bar_baz\0"); // [key]=[value]\0
+        // Check binary contents for the Windows file
+        const envPathWindows = `${result.spec}.win32env`;
+        t.true(fs.existsSync(envPathWindows));
+        const bufferWindows = fs.readFileSync(envPathWindows);
+        t.deepEqual(bufferWindows.length, 38);
+        t.deepEqual(bufferWindows.readInt32LE(0), 4 + 12 + 1); // number of tchars to represent the environment
+        t.deepEqual(bufferWindows.toString("utf16le", 4, 12), "a=a\0"); // [key]=[value]\0
+        t.deepEqual(bufferWindows.toString("utf16le", 12, 36), "foo=bar_baz\0"); // [key]=[value]\0
+        t.deepEqual(bufferWindows.toString("utf16le", 36, 38), "\0"); // trailing null character
     });
 });
 ava_1.default("getCombinedTracerConfig - return undefined when no languages are traced languages", async (t) => {

package.json

@@ -6,6 +6,7 @@
   "scripts": {
     "build": "tsc",
     "test": "ava src/** --serial --verbose",
+    "test-debug": "ava src/** --serial --verbose --timeout=20m",
     "lint": "eslint --report-unused-disable-directives --max-warnings=0 . --ext .js,.ts",
     "lint-fix": "eslint --report-unused-disable-directives --max-warnings=0 . --ext .js,.ts --fix",
     "removeNPMAbsolutePaths": "removeNPMAbsolutePaths . --force"

src/tracer-config.test.ts

@@ -276,19 +276,30 @@ test("concatTracerConfigs - compound environment file is created correctly", asy
 
     const result = concatTracerConfigs(
       { javascript: tc1, python: tc2 },
-      config
+      config,
+      true
     );
+
+    // Check binary contents for the Unix file
     const envPath = `${result.spec}.environment`;
     t.true(fs.existsSync(envPath));
-
     const buffer: Buffer = fs.readFileSync(envPath);
-    // Contents is binary data
     t.deepEqual(buffer.length, 28);
     t.deepEqual(buffer.readInt32LE(0), 2); // number of env vars
     t.deepEqual(buffer.readInt32LE(4), 4); // length of env var definition
     t.deepEqual(buffer.toString("utf8", 8, 12), "a=a\0"); // [key]=[value]\0
     t.deepEqual(buffer.readInt32LE(12), 12); // length of env var definition
     t.deepEqual(buffer.toString("utf8", 16, 28), "foo=bar_baz\0"); // [key]=[value]\0
+
+    // Check binary contents for the Windows file
+    const envPathWindows = `${result.spec}.win32env`;
+    t.true(fs.existsSync(envPathWindows));
+    const bufferWindows: Buffer = fs.readFileSync(envPathWindows);
+    t.deepEqual(bufferWindows.length, 38);
+    t.deepEqual(bufferWindows.readInt32LE(0), 4 + 12 + 1); // number of tchars to represent the environment
+    t.deepEqual(bufferWindows.toString("utf16le", 4, 12), "a=a\0"); // [key]=[value]\0
+    t.deepEqual(bufferWindows.toString("utf16le", 12, 36), "foo=bar_baz\0"); // [key]=[value]\0
+    t.deepEqual(bufferWindows.toString("utf16le", 36, 38), "\0"); // trailing null character
   });
 });
 

src/tracer-config.ts

@@ -58,7 +58,8 @@ export async function getTracerConfigForLanguage(
 
 export function concatTracerConfigs(
   tracerConfigs: { [lang: string]: TracerConfig },
-  config: configUtils.Config
+  config: configUtils.Config,
+  writeBothEnvironments = false
 ): TracerConfig {
   // A tracer config is a map containing additional environment variables and a tracer 'spec' file.
   // A tracer 'spec' file has the following format [log_file, number_of_blocks, blocks_text]
@@ -127,20 +128,43 @@ export function concatTracerConfigs(
 
   fs.writeFileSync(spec, newSpecContent.join("\n"));
 
-  // Prepare the content of the compound environment file
-  let buffer = Buffer.alloc(4);
-  buffer.writeInt32LE(envSize, 0);
-  for (const e of Object.entries(env)) {
-    const key = e[0];
-    const value = e[1];
-    const lineBuffer = Buffer.from(`${key}=${value}\0`, "utf8");
-    const sizeBuffer = Buffer.alloc(4);
-    sizeBuffer.writeInt32LE(lineBuffer.length, 0);
-    buffer = Buffer.concat([buffer, sizeBuffer, lineBuffer]);
+  if (writeBothEnvironments || process.platform !== "win32") {
+    // Prepare the content of the compound environment file on Unix
+    let buffer = Buffer.alloc(4);
+    buffer.writeInt32LE(envSize, 0);
+    for (const e of Object.entries(env)) {
+      const key = e[0];
+      const value = e[1];
+      const lineBuffer = Buffer.from(`${key}=${value}\0`, "utf8");
+      const sizeBuffer = Buffer.alloc(4);
+      sizeBuffer.writeInt32LE(lineBuffer.length, 0);
+      buffer = Buffer.concat([buffer, sizeBuffer, lineBuffer]);
+    }
+    // Write the compound environment for Unix
+    const envPath = `${spec}.environment`;
+    fs.writeFileSync(envPath, buffer);
+  }
+
+  if (writeBothEnvironments || process.platform === "win32") {
+    // Prepare the content of the compound environment file on Windows
+    let bufferWindows = Buffer.alloc(0);
+    let length = 0;
+    for (const e of Object.entries(env)) {
+      const key = e[0];
+      const value = e[1];
+      const string = `${key}=${value}\0`;
+      length += string.length;
+      const lineBuffer = Buffer.from(string, "utf16le");
+      bufferWindows = Buffer.concat([bufferWindows, lineBuffer]);
+    }
+    const sizeBuffer = Buffer.alloc(4);
+    sizeBuffer.writeInt32LE(length + 1, 0); // Add one for trailing null character marking end
+    const trailingNull = Buffer.from(`\0`, "utf16le");
+    bufferWindows = Buffer.concat([sizeBuffer, bufferWindows, trailingNull]);
+    // Write the compound environment for Windows
+    const envPathWindows = `${spec}.win32env`;
+    fs.writeFileSync(envPathWindows, bufferWindows);
   }
-  // Write the compound environment
-  const envPath = `${spec}.environment`;
-  fs.writeFileSync(envPath, buffer);
 
   return { env, spec };
 }