Fix issue with using zstd long range mode on ubuntu-16.04

Author: Aiqiao Yan

packages/cache/package-lock.json

@@ -41,10 +41,12 @@
     "@actions/glob": "^0.1.0",
     "@actions/http-client": "^1.0.8",
     "@actions/io": "^1.0.1",
+    "semver": "^6.1.0",
     "uuid": "^3.3.3"
   },
   "devDependencies": {
     "typescript": "^3.8.3",
+    "@types/semver": "^6.0.0",
     "@types/uuid": "^3.4.5"
   }
 }

packages/cache/package.json

@@ -96,7 +96,9 @@ export function getCacheVersion(
   compressionMethod?: CompressionMethod
 ): string {
   const components = paths.concat(
-    compressionMethod === CompressionMethod.Zstd ? [compressionMethod] : []
+    !compressionMethod || compressionMethod === CompressionMethod.Gzip
+      ? []
+      : [compressionMethod]
   )
 
   // Add salt to cache version to support breaking changes in cache entry

packages/cache/src/internal/cacheHttpClient.ts

@@ -4,6 +4,7 @@ import * as glob from '@actions/glob'
 import * as io from '@actions/io'
 import * as fs from 'fs'
 import * as path from 'path'
+import * as semver from 'semver'
 import * as util from 'util'
 import {v4 as uuidV4} from 'uuid'
 import {CacheFilename, CompressionMethod} from './constants'
@@ -82,16 +83,24 @@ async function getVersion(app: string): Promise<string> {
 
 // Use zstandard if possible to maximize cache performance
 export async function getCompressionMethod(): Promise<CompressionMethod> {
-  const versionOutput = await getVersion('zstd')
-  return versionOutput.toLowerCase().includes('zstd command line interface')
-    ? CompressionMethod.Zstd
-    : CompressionMethod.Gzip
+  if (process.platform === 'win32') {
+    // Disable zstd on windows due to bug https://github.com/actions/cache/issues/301
+    return CompressionMethod.Gzip
+  } else {
+    const versionOutput = await getVersion('zstd')
+    const version = semver.clean(versionOutput)
+    return !versionOutput.toLowerCase().includes('zstd command line interface')
+      ? CompressionMethod.Gzip
+      : !version || semver.lt(version, 'v1.3.2')
+      ? CompressionMethod.ZstdOld
+      : CompressionMethod.Zstd
+  }
 }
 
 export function getCacheFileName(compressionMethod: CompressionMethod): string {
-  return compressionMethod === CompressionMethod.Zstd
-    ? CacheFilename.Zstd
-    : CacheFilename.Gzip
+  return compressionMethod === CompressionMethod.Gzip
+    ? CacheFilename.Gzip
+    : CacheFilename.Zstd
 }
 
 export async function useGnuTar(): Promise<boolean> {

packages/cache/src/internal/cacheUtils.ts

@@ -5,6 +5,7 @@ export enum CacheFilename {
 
 export enum CompressionMethod {
   Gzip = 'gzip',
+  ZstdOld = 'zstd-old',
   Zstd = 'zstd'
 }
 

packages/cache/src/internal/constants.ts

@@ -41,10 +41,18 @@ export async function extractTar(
   // --d: Decompress.
   // --long=#: Enables long distance matching with # bits. Maximum is 30 (1GB) on 32-bit OS and 31 (2GB) on 64-bit.
   // Using 30 here because we also support 32-bit self-hosted runners.
+  function getProg(): string[] {
+    switch (compressionMethod) {
+      case CompressionMethod.Zstd:
+        return ['--use-compress-program', 'zstd -d --long=30']
+      case CompressionMethod.ZstdOld:
+        return ['--use-compress-program', 'zstd -d']
+      default:
+        return ['-z']
+    }
+  }
   const args = [
-    ...(compressionMethod === CompressionMethod.Zstd
-      ? ['--use-compress-program', 'zstd -d --long=30']
-      : ['-z']),
+    ...getProg(),
     '-xf',
     archivePath.replace(new RegExp(`\\${path.sep}`, 'g'), '/'),
     '-P',
@@ -66,14 +74,24 @@ export async function createTar(
     path.join(archiveFolder, manifestFilename),
     sourceDirectories.join('\n')
   )
+  const workingDirectory = getWorkingDirectory()
+
   // -T#: Compress using # working thread. If # is 0, attempt to detect and use the number of physical CPU cores.
   // --long=#: Enables long distance matching with # bits. Maximum is 30 (1GB) on 32-bit OS and 31 (2GB) on 64-bit.
   // Using 30 here because we also support 32-bit self-hosted runners.
-  const workingDirectory = getWorkingDirectory()
+  // Long range mode is added to zstd in v1.3.2 release, so we will not use --long in older version of zstd.
+  function getProg(): string[] {
+    switch (compressionMethod) {
+      case CompressionMethod.Zstd:
+        return ['--use-compress-program', 'zstd -T0 --long=30']
+      case CompressionMethod.ZstdOld:
+        return ['--use-compress-program', 'zstd -T0']
+      default:
+        return ['-z']
+    }
+  }
   const args = [
-    ...(compressionMethod === CompressionMethod.Zstd
-      ? ['--use-compress-program', 'zstd -T0 --long=30']
-      : ['-z']),
+    ...getProg(),
     '-cf',
     cacheFileName.replace(new RegExp(`\\${path.sep}`, 'g'), '/'),
     '-P',