robojerk/codeql-action

Fall back to gzip if zstd fails

Browse source
This commit is contained in:
Henry Mercer 2024-09-23 21:59:03 +01:00
parent 662c71aa9e
commit 4d015b8cba
6 changed files with 82 additions and 33 deletions
Download patch file Download diff file Expand all files Collapse all files

13
src/setup-codeql.test.ts
View file

@ -6,7 +6,6 @@ import * as sinon from "sinon";
import * as actionsUtil from "./actions-util";
import { getRunnerLogger } from "./logging";
import * as setupCodeql from "./setup-codeql";
import { ZstdAvailability } from "./tar";
import {
LINKED_CLI_VERSION,
LoggedMessage,
@ -91,7 +90,7 @@ test("getCodeQLSource sets CLI version for a semver tagged bundle", async (t) =>
SAMPLE_DEFAULT_CLI_VERSION,
SAMPLE_DOTCOM_API_DETAILS,
GitHubVariant.DOTCOM,
getStubZstdAvailability(),
false,
createFeatures([]),
getRunnerLogger(true),
);
@ -109,7 +108,7 @@ test("getCodeQLSource correctly returns bundled CLI version when tools == linked
SAMPLE_DEFAULT_CLI_VERSION,
SAMPLE_DOTCOM_API_DETAILS,
GitHubVariant.DOTCOM,
getStubZstdAvailability(),
false,
createFeatures([]),
getRunnerLogger(true),
);
@ -130,7 +129,7 @@ test("getCodeQLSource correctly returns bundled CLI version when tools == latest
SAMPLE_DEFAULT_CLI_VERSION,
SAMPLE_DOTCOM_API_DETAILS,
GitHubVariant.DOTCOM,
getStubZstdAvailability(),
false,
createFeatures([]),
logger,
);
@ -246,9 +245,3 @@ test("setupCodeQLBundle logs the CodeQL CLI version being used when asked to dow
);
});
});
function getStubZstdAvailability(): ZstdAvailability {
return {
available: false,
};
}

60
src/setup-codeql.ts
View file

@ -242,7 +242,7 @@ export async function getCodeQLSource(
defaultCliVersion: CodeQLDefaultVersionInfo,
apiDetails: api.GitHubApiDetails,
variant: util.GitHubVariant,
zstdAvailability: tar.ZstdAvailability,
tarSupportsZstd: boolean,
features: FeatureEnablement,
logger: Logger,
): Promise<CodeQLToolsSource> {
@ -441,7 +441,7 @@ export async function getCodeQLSource(
tagName!,
apiDetails,
cliVersion !== undefined &&
(await useZstdBundle(cliVersion, features, zstdAvailability)),
(await useZstdBundle(cliVersion, features, tarSupportsZstd)),
logger,
);
}
@ -673,12 +673,60 @@ export async function setupCodeQLBundle(
): Promise<SetupCodeQLResult> {
const zstdAvailability = await tar.isZstdAvailable(logger);
// If we think the installed version of tar supports zstd, try to use zstd,
// but be prepared to fall back to gzip in case we were wrong.
if (zstdAvailability.available) {
try {
return await setupCodeQLBundleWithCompressionMethod(
toolsInput,
apiDetails,
tempDir,
variant,
defaultCliVersion,
features,
logger,
zstdAvailability,
true,
);
} catch (e) {
logger.warning(
`Failed to set up CodeQL tools with zstd. Falling back to gzipped version. Error: ${util.getErrorMessage(
e,
)}`,
);
}
}
return await setupCodeQLBundleWithCompressionMethod(
toolsInput,
apiDetails,
tempDir,
variant,
defaultCliVersion,
features,
logger,
zstdAvailability,
false,
);
}
async function setupCodeQLBundleWithCompressionMethod(
toolsInput: string | undefined,
apiDetails: api.GitHubApiDetails,
tempDir: string,
variant: util.GitHubVariant,
defaultCliVersion: CodeQLDefaultVersionInfo,
features: FeatureEnablement,
logger: Logger,
zstdAvailability: tar.ZstdAvailability,
useTarIfAvailable: boolean,
) {
const source = await getCodeQLSource(
toolsInput,
defaultCliVersion,
apiDetails,
variant,
zstdAvailability,
useTarIfAvailable,
features,
logger,
);
@ -757,11 +805,11 @@ function sanitizeUrlForStatusReport(url: string): string {
async function useZstdBundle(
cliVersion: string,
features: FeatureEnablement,
zstdAvailability: tar.ZstdAvailability,
tarSupportsZstd: boolean,
): Promise<boolean> {
return (
tarSupportsZstd &&
semver.gte(cliVersion, "2.19.0") &&
!!(await features.getValue(Feature.ZstdBundle)) &&
zstdAvailability.available
!!(await features.getValue(Feature.ZstdBundle))
);
}