Merge pull request #2537 from github/henrymercer/no-zstd-windows

Don't use Zstandard bundles on Windows

.github/workflows/__zstd-bundle-fallback.yml

@@ -29,8 +29,6 @@ jobs:
         include:
           - os: macos-latest
             version: linked
-          - os: windows-latest
-            version: linked
           - os: ubuntu-latest
             version: linked
     name: Zstandard bundle fallback

.github/workflows/__zstd-bundle.yml

@@ -29,10 +29,10 @@ jobs:
         include:
           - os: macos-latest
             version: linked
-          - os: windows-latest
-            version: linked
           - os: ubuntu-latest
             version: linked
+          - os: windows-latest
+            version: linked
     name: Zstandard bundle
     permissions:
       contents: read
@@ -109,9 +109,11 @@ jobs:
             const toolsUrl = downloadTelemetryNotifications[0].properties.attributes.toolsUrl;
             console.log(`Found tools URL: ${toolsUrl}`);
 
-            if (!toolsUrl.endsWith('.tar.zst')) {
+            const expectedExtension = process.env['RUNNER_OS'] === 'Windows' ? '.tar.gz' : '.tar.zst';
+
+            if (!toolsUrl.endsWith(expectedExtension)) {
               core.setFailed(
-                `Expected the tools URL to be a .tar.zst file, but found ${toolsUrl}.`
+                `Expected the tools URL to be a ${expectedExtension} file, but found ${toolsUrl}.`
               );
             }
     env:

lib/setup-codeql.js

@@ -553,7 +553,10 @@ function sanitizeUrlForStatusReport(url) {
         : "sanitized-value";
 }
 async function useZstdBundle(cliVersion, features, tarSupportsZstd) {
-    return (tarSupportsZstd &&
+    return (
+    // In testing, gzip performs better than zstd on Windows.
+    process.platform !== "win32" &&
+        tarSupportsZstd &&
         semver.gte(cliVersion, feature_flags_1.CODEQL_VERSION_ZSTD_BUNDLE) &&
         !!(await features.getValue(feature_flags_1.Feature.ZstdBundle)));
 }

pr-checks/checks/zstd-bundle-fallback.yml

@@ -4,7 +4,6 @@ versions:
   - linked
 operatingSystems:
   - macos
-  - windows
   - ubuntu
 env:
   CODEQL_ACTION_ZSTD_BUNDLE: true

pr-checks/checks/zstd-bundle.yml

@@ -4,8 +4,8 @@ versions:
   - linked
 operatingSystems:
   - macos
-  - windows
   - ubuntu
+  - windows
 env:
   CODEQL_ACTION_ZSTD_BUNDLE: true
 steps:
@@ -59,8 +59,10 @@ steps:
         const toolsUrl = downloadTelemetryNotifications[0].properties.attributes.toolsUrl;
         console.log(`Found tools URL: ${toolsUrl}`);
 
-        if (!toolsUrl.endsWith('.tar.zst')) {
+        const expectedExtension = process.env['RUNNER_OS'] === 'Windows' ? '.tar.gz' : '.tar.zst';
+
+        if (!toolsUrl.endsWith(expectedExtension)) {
           core.setFailed(
-            `Expected the tools URL to be a .tar.zst file, but found ${toolsUrl}.`
+            `Expected the tools URL to be a ${expectedExtension} file, but found ${toolsUrl}.`
           );
         }

src/setup-codeql.ts

@@ -823,6 +823,8 @@ async function useZstdBundle(
   tarSupportsZstd: boolean,
 ): Promise<boolean> {
   return (
+    // In testing, gzip performs better than zstd on Windows.
+    process.platform !== "win32" &&
     tarSupportsZstd &&
     semver.gte(cliVersion, CODEQL_VERSION_ZSTD_BUNDLE) &&
     !!(await features.getValue(Feature.ZstdBundle))