GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

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

Conversation

@mbg

@mbg mbg commented Oct 13, 2026

Copy link
Copy Markdown
Member

Extends start-proxy's success telemetry with the version of the release that the proxy binary came from.

Risk assessment

For internal use only. Please select the risk level of this change:

  • Low risk: Changes are fully under feature flags, or have been fully tested and validated in pre-production environments and are highly observable, or are documentation or test only.

Which use cases does this change impact?

Workflow types:

  • Advanced setup - Impacts users who have custom CodeQL workflows.
  • Managed - Impacts users with dynamic workflows (Default Setup, Code Quality, ...).

Products:

  • Code Scanning - The changes impact analyses when analysis-kinds: code-scanning.
  • Code Quality - The changes impact analyses when analysis-kinds: code-quality.
  • Other first-party - The changes impact other first-party analyses.

Environments:

  • Dotcom - Impacts CodeQL workflows on github.com and/or GitHub Enterprise Cloud with Data Residency.

How did/will you validate this change?

  • Unit tests - I am depending on unit test coverage (i.e. tests in .test.ts files).
  • End-to-end tests - I am depending on PR checks (i.e. tests in pr-checks).

If something goes wrong after this change is released, what are the mitigation and rollback strategies?

  • Rollback - Change can only be disabled by rolling back the release or releasing a new version with a fix.

How will you know if something goes wrong after this change is released?

  • Telemetry - I rely on existing telemetry or have made changes to the telemetry.
    • Dashboards - I will watch relevant dashboards for issues after the release. Consider whether this requires this change to be released at a particular time rather than as part of a regular release.
    • Alerts - New or existing monitors will trip if something goes wrong with this change.

Are there any special considerations for merging or releasing this change?

  • No special considerations - This change can be merged at any time.

Merge / deployment checklist

  • Confirm this change is backwards compatible with existing workflows.
  • Consider adding a changelog entry for this change.
  • Confirm the readme and docs have been updated if necessary.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
mbg added 3 commits October 13, 2026 18:59
@mbg
Move start-proxy status report handling into its own file
aa80ca0
@mbg
Return release version from getProxyBinaryPath
6308e36
@mbg
Include proxy version in telemetry
43db2c0
@mbg
mbg requested a review from a team as a code owner October 13, 2026 18:14
Copilot AI balanced review requested due to automatic review settings October 13, 2026 18:14
@github-actions github-actions Bot added the size/L May be hard to review label Oct 13, 2026
Copilot started reviewing on behalf of mbg October 13, 2026 18:14
View session
Copilot AI reviewed Oct 13, 2026
View reviewed changes

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

There was a problem hiding this comment.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Warning

  • Copilot's review of this pull request may be incomplete because some of the changed files are excluded by your Copilot content exclusion settings. See Excluding content from Copilot for details.

🟡 Changes recommended

The primary telemetry payload lacks direct unit-test coverage for its field name and nesting.

1 open finding
  • Medium severity Add unit test verifying proxy version telemetry payload · New
What changed in this PR

Adds the originating proxy release version to successful start-proxy telemetry.

Changes:

  • Returns both the proxy path and version.
  • Adds start_proxy.proxy_version to telemetry.
  • Extracts proxy status reporting and updates tests.
File Description
src/​start-proxy/​status-report.ts Defines proxy telemetry and reporting.
src/​start-proxy/​status-report.test.ts Relocates failure-report tests.
src/​start-proxy.ts Returns proxy path and version.
src/​start-proxy.test.ts Verifies resolved proxy versions.
src/​start-proxy-action.ts Sends the version in success telemetry.
lib/​entry-points.js Generated bundle; content excluded from review.
Files excluded by content exclusion policy (1)
  • lib/entry-points.js

🧠 Review effort: Balanced

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
Comment thread src/start-proxy/status-report.ts Resolved

Uh oh!

There was an error while loading. Please reload this page.
mbg added 3 commits October 14, 2026 10:30
@mbg
Sort registry_types in status report
6aee1f8
@mbg
Add unit test for sendSuccessStatusReport
1580058
@mbg
Merge remote-tracking branch 'origin/main' into mbg/start-proxy/repor…
4eabea6 
…t-version
henrymercer
henrymercer previously approved these changes Oct 15, 2026
View reviewed changes
Comment thread src/start-proxy/status-report.test.ts
Comment on lines +48 to +56
t.is(sendStatusReport.callCount, 1);
t.is(sendStatusReport.args[0].length, 1);

const arg = sendStatusReport.args[0][0];
t.like(arg, {
action_name: statusReport.ActionName.StartProxy,
registry_types: "docker_registry,git_source",
start_proxy: { proxy_version },
});

@henrymercer henrymercer Oct 15, 2026

Copy link
Copy Markdown
Contributor

There was a problem hiding this comment.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would calledOnceWithExactly work here?

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions

@mbg mbg Oct 15, 2026

Copy link
Copy Markdown
Member Author

There was a problem hiding this comment.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, but I don't like the sinon assertions because they only return true/false and so if the assertion fails we don't know why. The t.like will print a nice diff if the assertion fails.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions

@henrymercer henrymercer Oct 15, 2026

Copy link
Copy Markdown
Contributor

There was a problem hiding this comment.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think if we use sinon.assert.calledOnceWithExactly instead of sendStatusReport.calledOnceWithExactly we'll get a good error message if the assertion fails. It's non-blocking, though.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
Comment thread src/start-proxy.test.ts Resolved

Uh oh!

There was an error while loading. Please reload this page.
@mbg
Rename path to result in tests
8dec0b9
@mbg
mbg dismissed henrymercer’s stale review via 8dec0b9 October 15, 2026 10:03
@mbg
mbg requested a review from henrymercer October 15, 2026 10:05
henrymercer
henrymercer approved these changes Oct 15, 2026
View reviewed changes
@mbg
mbg enabled auto-merge October 15, 2026 10:06
@mbg
mbg added this pull request to the merge queue Oct 15, 2026
Merged via the queue into main with commit d63383a Oct 15, 2026
234 checks passed

Uh oh!

There was an error while loading. Please reload this page.
@mbg
mbg deleted the mbg/start-proxy/report-version branch October 15, 2026 10:29
This was referenced Oct 15, 2026
Merge main into releases/v4 #4239
Merged
Merge releases/v4 into releases/v3 #4241
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot
Copilot review effort
Applies to this pull request for everyone.Learn more about Copilot code review.
Copilot left review comments
@henrymercer henrymercer henrymercer approved these changes

Uh oh!

There was an error while loading. Please reload this page.

Assignees

No one assigned

Labels

size/L May be hard to review

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Uh oh!

There was an error while loading. Please reload this page.

3 participants

@mbg @henrymercer
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
You are visitor 01402520 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.