FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

Report release version the proxy is taken from in `start-proxy` telemetry by mbg · Pull Request #4233 · github/codeql-action · GitHub

  1. github
  2. codeql-action

Repository navigation

Report release version the proxy is taken from in start-proxy telemetry #4233

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

Merged
mbg merged 7 commits into from
Oct 15, 2026
+395 −297
Conversation 6 Commits 7 Checks 233 Files changed 6
Merged

Report release version the proxy is taken from in start-proxy telemetry #4233

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
aa80ca0
Move `start-proxy` status report handling into its own file
mbg Oct 13, 2026
6308e36
Return release version from `getProxyBinaryPath`
mbg Oct 13, 2026
43db2c0
Include proxy version in telemetry
mbg Oct 13, 2026
6aee1f8
Sort `registry_types` in status report
mbg Oct 14, 2026
1580058
Add unit test for `sendSuccessStatusReport`
mbg Oct 14, 2026
4eabea6
Merge remote-tracking branch 'origin/main' into mbg/start-proxy/repor…
mbg Oct 15, 2026
8dec0b9
Rename `path` to `result` in tests
mbg Oct 15, 2026
File filter

Filter by extension

Filter by extension .js  (1) .ts  (5) All 2 file types selected
Viewed files
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Unified
Split
Hide whitespace
Diff view
Unified
Split
Hide whitespace
123 changes: 65 additions & 58 deletions lib/entry-points.js
Show comments
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 2 additions & 1 deletion src/start-proxy-action.ts
Show comments
View file
Open in desktop
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ async function run(action: ActionState<["Base", "Logger", "Env", "Actions"]>) {
getApiDetails(action.env),
);
const proxyInfo = await startProxy(
proxyBin,
proxyBin.path,
proxyConfig,
proxyLogFilePath,
logger,
Expand All @@ -125,6 +125,7 @@ async function run(action: ActionState<["Base", "Logger", "Env", "Actions"]>) {
languages: language === undefined ? undefined : [language],
},
proxyConfig.all_credentials.map((c) => c.type),
{ proxy_version: proxyBin.version },
logger,
);
} catch (unwrappedError) {
Expand Down
116 changes: 18 additions & 98 deletions src/start-proxy.test.ts
Show comments
View file
Open in desktop
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
import * as filepath from "path";

import * as core from "@actions/core";
import * as toolcache from "@actions/tool-cache";
import test, { ExecutionContext } from "ava";
import sinon from "sinon";
Expand All @@ -18,7 +17,6 @@ import { getRunnerLogger, Logger } from "./logging";
import { BundlePlatform, getBundlePlatform } from "./platform";
import * as repository from "./setup/repository";
import * as startProxyExports from "./start-proxy";
import * as statusReport from "./status-report";
import {
addSinonAssertions,
assertNotLogged,
Expand All @@ -32,94 +30,10 @@ import {
setupTests,
withRecordingLoggerAsync,
} from "./testing-utils";
import {
ConfigurationError,
GitHubVariant,
GitHubVersion,
withTmpDir,
} from "./util";
import { GitHubVariant, GitHubVersion, withTmpDir } from "./util";

setupTests(test);

const sendFailedStatusReportTest = makeMacro({
exec: async (
t: ExecutionContext<unknown>,
err: Error,
expectedMessage: string,
expectedStatus: statusReport.ActionStatus = "failure",
) => {
const now = new Date();

// Override core.setFailed to avoid it setting the program's exit code
sinon.stub(core, "setFailed").returns();

const createStatusReportBase = sinon.stub(
statusReport,
"createStatusReportBase",
);
createStatusReportBase.resolves(undefined);

await withRecordingLoggerAsync(async (logger) => {
await startProxyExports.sendFailedStatusReport(
logger,
now,
undefined,
err,
);

// Check that the stub has been called exactly once, with the expected arguments,
// but not with the message from the error.
sinon.assert.calledOnceWithExactly(
createStatusReportBase,
statusReport.ActionName.StartProxy,
expectedStatus,
now,
sinon.match.any,
sinon.match.any,
sinon.match.any,
expectedMessage,
);
t.false(
createStatusReportBase.calledWith(
statusReport.ActionName.StartProxy,
expectedStatus,
now,
sinon.match.any,
sinon.match.any,
sinon.match.any,
sinon.match((msg: string) => msg.includes(err.message)),
),
"createStatusReportBase was called with the error message",
);
});
},

title: (providedTitle = "") => `sendFailedStatusReport - ${providedTitle}`,
});

sendFailedStatusReportTest.serial(
"reports generic error message for non-StartProxyError error",
new Error("Something went wrong today"),
"Error from start-proxy Action omitted (Error).",
);

sendFailedStatusReportTest.serial(
"reports generic error message for non-StartProxyError error with safe error message",
new Error(
startProxyExports.getStartProxyErrorMessage(
startProxyExports.StartProxyErrorType.DownloadFailed,
),
),
"Error from start-proxy Action omitted (Error).",
);

sendFailedStatusReportTest.serial(
"reports generic error message for ConfigurationError error",
new ConfigurationError("Something went wrong today"),
"Error from start-proxy Action omitted (ConfigurationError).",
"user-error",
);

const toEncodedJSON = (data: any) =>
Buffer.from(JSON.stringify(data)).toString("base64");

Expand Down Expand Up @@ -1021,16 +935,17 @@ test.serial(
sinon.stub(actionsUtil, "isRunningLocalAction").returns(true);

const features = mockOfflineFeatures(tempDir, logger);
const path = await startProxyExports.getProxyBinaryPath(
const result = await startProxyExports.getProxyBinaryPath(
initAllState({ logger, features }),
SAMPLE_DOTCOM_API_DETAILS,
);

t.assert(path);
t.assert(result);
t.is(
path,
result.path,
filepath.join(toolcachePath, startProxyExports.getProxyFilename()),
);
t.is(result.version, defaults.cliVersion);
});
},
);
Expand Down Expand Up @@ -1067,7 +982,7 @@ test.serial(
sinon.stub(actionsUtil, "isRunningLocalAction").returns(false);
state.env.set(ActionsEnvVars.GITHUB_ACTION_REPOSITORY, "test/repo");

const path = await startProxyExports.getProxyBinaryPath(
const result = await startProxyExports.getProxyBinaryPath(
{
...state,
features: createFeatures([]),
Expand All @@ -1084,11 +999,12 @@ test.serial(
st.onceWith(extractTar, archivePath);
st.onceWith(cacheDir, extractedPath);

t.assert(path);
t.assert(result);
t.is(
path,
result.path,
filepath.join(toolcachePath, startProxyExports.getProxyFilename()),
);
t.is(result.version, defaults.cliVersion);

checkExpectedLogMessages(t, logger.messages, [
`Found private registry proxy ${startProxyExports.getProxyPackage(getTestPlatform(state))} in test/repo on https://github.com with URL ${downloadUrl}`,
Expand All @@ -1101,7 +1017,8 @@ test.serial(
async (t) => {
const logger = new RecordingLogger();
const state = initAllState({ logger });
const expectedTag = "codeql-bundle-v2.20.1";
const expectedVersion = "2.20.1";
const expectedTag = `codeql-bundle-v${expectedVersion}`;
const expectedParams = {
owner: "test",
repo: "repo",
Expand Down Expand Up @@ -1154,14 +1071,16 @@ test.serial(
const getDefaultCliVersion = sinon
.stub(features, "getEnabledDefaultCliVersions")
.resolves({
enabledVersions: [{ cliVersion: "2.20.1", tagName: expectedTag }],
enabledVersions: [
{ cliVersion: expectedVersion, tagName: expectedTag },
],
});

// Stub this to always return `false` so we force `getCodeQLAssetDownloadURL` to use the (mocked) API.
sinon.stub(actionsUtil, "isRunningLocalAction").returns(false);
state.env.set(ActionsEnvVars.GITHUB_ACTION_REPOSITORY, "test/repo");

const path = await startProxyExports.getProxyBinaryPath(
const result = await startProxyExports.getProxyBinaryPath(
{
...state,
features,
Expand All @@ -1179,11 +1098,12 @@ test.serial(
st.onceWith(extractTar, archivePath);
st.onceWith(cacheDir, extractedPath);

t.assert(path);
t.assert(result);
t.is(
path,
result.path,
filepath.join(toolcachePath, startProxyExports.getProxyFilename()),
);
t.is(result.version, expectedVersion);
});

checkExpectedLogMessages(t, logger.messages, [
Expand Down
Loading
Loading
Back | FazBrowse Home | New Git URL