Skip to content

feat: allow user configuration of zstd compression level #2051

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat: allow user configuration of zstd compression level #2051

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
284 changes: 280 additions & 4 deletions packages/cache/__tests__/tar.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ test('zstd extract tar', async () => {
.concat(IS_MAC ? ['--delay-directory-restore'] : [])
.concat([
'--use-compress-program',
IS_WINDOWS ? '"zstd -d --long=30"' : 'unzstd --long=30'
IS_WINDOWS ? '"zstd -d -3 --long=30"' : 'unzstd --long=30'
])
.join(' '),
undefined,
Expand Down Expand Up @@ -104,7 +104,7 @@ test('zstd extract tar with windows BSDtar', async () => {
expect(execMock).toHaveBeenNthCalledWith(
1,
[
'zstd -d --long=30 --force -o',
'zstd -d -3 --long=30 --force -o',
TarFilename.replace(new RegExp(`\\${path.sep}`, 'g'), '/'),
archivePath.replace(new RegExp(`\\${path.sep}`, 'g'), '/')
].join(' '),
Expand Down Expand Up @@ -233,7 +233,7 @@ test('zstd create tar', async () => {
.concat(IS_MAC ? ['--delay-directory-restore'] : [])
.concat([
'--use-compress-program',
IS_WINDOWS ? '"zstd -T0 --long=30"' : 'zstdmt --long=30'
IS_WINDOWS ? '"zstd -T0 -3 --long=30"' : 'zstdmt -3 --long=30'
])
.join(' '),
undefined, // args
Expand Down Expand Up @@ -292,7 +292,7 @@ test('zstd create tar with windows BSDtar', async () => {
expect(execMock).toHaveBeenNthCalledWith(
2,
[
'zstd -T0 --long=30 --force -o',
'zstd -T0 -3 --long=30 --force -o',
CacheFilename.Zstd.replace(/\\/g, '/'),
TarFilename.replace(/\\/g, '/')
].join(' '),
Expand Down Expand Up @@ -480,3 +480,279 @@ test('gzip list tar', async () => {
}
)
})

test('zstd create tar with custom compression level', async () => {
const execMock = jest.spyOn(exec, 'exec')

// Save the original environment variable value
const originalCompressionLevel = process.env['CACHE_ZSTD_COMPRESSION_LEVEL']

try {
// Set the custom compression level
process.env['CACHE_ZSTD_COMPRESSION_LEVEL'] = '10'

const archiveFolder = getTempDir()
const workspace = process.env['GITHUB_WORKSPACE']
const sourceDirectories = ['~/.npm/cache', `${workspace}/dist`]

await fs.promises.mkdir(archiveFolder, {recursive: true})

await tar.createTar(
archiveFolder,
sourceDirectories,
CompressionMethod.Zstd
)

const tarPath = IS_WINDOWS ? GnuTarPathOnWindows : defaultTarPath

expect(execMock).toHaveBeenCalledTimes(1)
expect(execMock).toHaveBeenCalledWith(
[
`"${tarPath}"`,
'--posix',
'-cf',
IS_WINDOWS
? CacheFilename.Zstd.replace(/\\/g, '/')
: CacheFilename.Zstd,
'--exclude',
IS_WINDOWS
? CacheFilename.Zstd.replace(/\\/g, '/')
: CacheFilename.Zstd,
'-P',
'-C',
IS_WINDOWS ? workspace?.replace(/\\/g, '/') : workspace,
'--files-from',
ManifestFilename
]
.concat(IS_WINDOWS ? ['--force-local'] : [])
.concat(IS_MAC ? ['--delay-directory-restore'] : [])
.concat([
'--use-compress-program',
IS_WINDOWS ? '"zstd -T0 -10 --long=30"' : 'zstdmt -10 --long=30'
])
.join(' '),
undefined, // args
{
cwd: archiveFolder,
env: expect.objectContaining(defaultEnv)
}
)
} finally {
// Restore the original environment variable
if (originalCompressionLevel === undefined) {
delete process.env['CACHE_ZSTD_COMPRESSION_LEVEL']
} else {
process.env['CACHE_ZSTD_COMPRESSION_LEVEL'] = originalCompressionLevel
}
}
})

test('zstd create tar with invalid compression level', async () => {
const execMock = jest.spyOn(exec, 'exec')

// Save the original environment variable value
const originalCompressionLevel = process.env['CACHE_ZSTD_COMPRESSION_LEVEL']

try {
// Set an invalid compression level
process.env['CACHE_ZSTD_COMPRESSION_LEVEL'] = 'invalid'

const archiveFolder = getTempDir()
const workspace = process.env['GITHUB_WORKSPACE']
const sourceDirectories = ['~/.npm/cache', `${workspace}/dist`]

await fs.promises.mkdir(archiveFolder, {recursive: true})

await tar.createTar(
archiveFolder,
sourceDirectories,
CompressionMethod.Zstd
)

const tarPath = IS_WINDOWS ? GnuTarPathOnWindows : defaultTarPath

// Should fall back to the default compression level (-3)
expect(execMock).toHaveBeenCalledTimes(1)
expect(execMock).toHaveBeenCalledWith(
[
`"${tarPath}"`,
'--posix',
'-cf',
IS_WINDOWS
? CacheFilename.Zstd.replace(/\\/g, '/')
: CacheFilename.Zstd,
'--exclude',
IS_WINDOWS
? CacheFilename.Zstd.replace(/\\/g, '/')
: CacheFilename.Zstd,
'-P',
'-C',
IS_WINDOWS ? workspace?.replace(/\\/g, '/') : workspace,
'--files-from',
ManifestFilename
]
.concat(IS_WINDOWS ? ['--force-local'] : [])
.concat(IS_MAC ? ['--delay-directory-restore'] : [])
.concat([
'--use-compress-program',
IS_WINDOWS ? '"zstd -T0 -3 --long=30"' : 'zstdmt -3 --long=30'
])
.join(' '),
undefined, // args
{
cwd: archiveFolder,
env: expect.objectContaining(defaultEnv)
}
)
} finally {
// Restore the original environment variable
if (originalCompressionLevel === undefined) {
delete process.env['CACHE_ZSTD_COMPRESSION_LEVEL']
} else {
process.env['CACHE_ZSTD_COMPRESSION_LEVEL'] = originalCompressionLevel
}
}
})

test('zstd create tar with out-of-range compression level', async () => {
const execMock = jest.spyOn(exec, 'exec')

// Save the original environment variable value
const originalCompressionLevel = process.env['CACHE_ZSTD_COMPRESSION_LEVEL']

try {
// Set an out-of-range compression level
process.env['CACHE_ZSTD_COMPRESSION_LEVEL'] = '25'

const archiveFolder = getTempDir()
const workspace = process.env['GITHUB_WORKSPACE']
const sourceDirectories = ['~/.npm/cache', `${workspace}/dist`]

await fs.promises.mkdir(archiveFolder, {recursive: true})

await tar.createTar(
archiveFolder,
sourceDirectories,
CompressionMethod.Zstd
)

const tarPath = IS_WINDOWS ? GnuTarPathOnWindows : defaultTarPath

// Should fall back to the default compression level (-3)
expect(execMock).toHaveBeenCalledTimes(1)
expect(execMock).toHaveBeenCalledWith(
[
`"${tarPath}"`,
'--posix',
'-cf',
IS_WINDOWS
? CacheFilename.Zstd.replace(/\\/g, '/')
: CacheFilename.Zstd,
'--exclude',
IS_WINDOWS
? CacheFilename.Zstd.replace(/\\/g, '/')
: CacheFilename.Zstd,
'-P',
'-C',
IS_WINDOWS ? workspace?.replace(/\\/g, '/') : workspace,
'--files-from',
ManifestFilename
]
.concat(IS_WINDOWS ? ['--force-local'] : [])
.concat(IS_MAC ? ['--delay-directory-restore'] : [])
.concat([
'--use-compress-program',
IS_WINDOWS ? '"zstd -T0 -3 --long=30"' : 'zstdmt -3 --long=30'
])
.join(' '),
undefined, // args
{
cwd: archiveFolder,
env: expect.objectContaining(defaultEnv)
}
)
} finally {
// Restore the original environment variable
if (originalCompressionLevel === undefined) {
delete process.env['CACHE_ZSTD_COMPRESSION_LEVEL']
} else {
process.env['CACHE_ZSTD_COMPRESSION_LEVEL'] = originalCompressionLevel
}
}
})

test('zstd create tar with windows BSDtar and custom compression level', async () => {
if (IS_WINDOWS) {
const execMock = jest.spyOn(exec, 'exec')
jest
.spyOn(utils, 'getGnuTarPathOnWindows')
.mockReturnValue(Promise.resolve(''))

// Save the original environment variable value
const originalCompressionLevel = process.env['CACHE_ZSTD_COMPRESSION_LEVEL']

try {
// Set a custom compression level
process.env['CACHE_ZSTD_COMPRESSION_LEVEL'] = '19'

const archiveFolder = getTempDir()
const workspace = process.env['GITHUB_WORKSPACE']
const sourceDirectories = ['~/.npm/cache', `${workspace}/dist`]

await fs.promises.mkdir(archiveFolder, {recursive: true})

await tar.createTar(
archiveFolder,
sourceDirectories,
CompressionMethod.Zstd
)

const tarPath = SystemTarPathOnWindows

expect(execMock).toHaveBeenCalledTimes(2)

expect(execMock).toHaveBeenNthCalledWith(
1,
[
`"${tarPath}"`,
'--posix',
'-cf',
TarFilename.replace(/\\/g, '/'),
'--exclude',
TarFilename.replace(/\\/g, '/'),
'-P',
'-C',
workspace?.replace(/\\/g, '/'),
'--files-from',
ManifestFilename
].join(' '),
undefined, // args
{
cwd: archiveFolder,
env: expect.objectContaining(defaultEnv)
}
)

expect(execMock).toHaveBeenNthCalledWith(
2,
[
'zstd -T0 -19 --long=30 --force -o',
CacheFilename.Zstd.replace(/\\/g, '/'),
TarFilename.replace(/\\/g, '/')
].join(' '),
undefined, // args
{
cwd: archiveFolder,
env: expect.objectContaining(defaultEnv)
}
)
} finally {
// Restore the original environment variable
if (originalCompressionLevel === undefined) {
delete process.env['CACHE_ZSTD_COMPRESSION_LEVEL']
} else {
process.env['CACHE_ZSTD_COMPRESSION_LEVEL'] = originalCompressionLevel
}
}
}
})
36 changes: 32 additions & 4 deletions packages/cache/src/internal/tar.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -204,6 +204,20 @@ async function getDecompressionProgram(
}
}

// Get zstd compression level from env var (1-22), defaulting to 3 if invalid
function getZstdCompressionLevel(): string {
const defaultLevel = 3
const levelEnv = process.env['CACHE_ZSTD_COMPRESSION_LEVEL']

// Check if it's a valid positive integer
if (!levelEnv || !/^\d+$/.test(levelEnv)) {
return `-${defaultLevel}`
}

const level = parseInt(levelEnv, 10)
return level >= 1 && level <= 22 ? `-${level}` : `-${defaultLevel}`
}

// Used for creating the archive
// -T#: Compress using # working thread. If # is 0, attempt to detect and use the number of physical CPU cores.
// zstdmt is equivalent to 'zstd -T0'
Expand All @@ -219,26 +233,40 @@ async function getCompressionProgram(
tarPath.type === ArchiveToolType.BSD &&
compressionMethod !== CompressionMethod.Gzip &&
IS_WINDOWS

// Get the compression level for zstd
const compressionLevel =
compressionMethod === CompressionMethod.Gzip
? ''
: getZstdCompressionLevel()

switch (compressionMethod) {
case CompressionMethod.Zstd:
return BSD_TAR_ZSTD
? [
'zstd -T0 --long=30 --force -o',
`zstd -T0 ${compressionLevel} --long=30 --force -o`,
cacheFileName.replace(new RegExp(`\\${path.sep}`, 'g'), '/'),
TarFilename
]
: [
'--use-compress-program',
IS_WINDOWS ? '"zstd -T0 --long=30"' : 'zstdmt --long=30'
IS_WINDOWS
? `"zstd -T0 ${compressionLevel} --long=30"`
: `zstdmt ${compressionLevel} --long=30`
]
case CompressionMethod.ZstdWithoutLong:
return BSD_TAR_ZSTD
? [
'zstd -T0 --force -o',
`zstd -T0 ${compressionLevel} --force -o`,
cacheFileName.replace(new RegExp(`\\${path.sep}`, 'g'), '/'),
TarFilename
]
: ['--use-compress-program', IS_WINDOWS ? '"zstd -T0"' : 'zstdmt']
: [
'--use-compress-program',
IS_WINDOWS
? `"zstd -T0 ${compressionLevel}"`
: `zstdmt ${compressionLevel}`
]
default:
return ['-z']
}
Expand Down