refactor: extract shared token-tracker budget helpers by lpcox · Pull Request #4780 · github/gh-aw-firewall

lpcox · 2026-06-11T17:59:35Z

Summary

Extracts two duplicated code blocks from token-tracker-http.js and token-tracker-ws.js into a shared token-tracker-shared.js module:

warnCacheReadRollupMismatch() — logs warning + diag when observed cache-read tokens don't match normalized rollup
mergeBudgetFields() — copies effective token/AI credit budget fields from budgetResult onto the usage record

This eliminates ~30 lines of duplicated logic while preserving identical behavior (including the WS-specific transport: 'websocket' field passed via the extra fields parameter).

Fixes #4711

Extract warnCacheReadRollupMismatch() and mergeBudgetFields() into token-tracker-shared.js to eliminate duplicated code between token-tracker-http.js and token-tracker-ws.js. Fixes #4711 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

github-actions · 2026-06-11T18:01:15Z

✅ Coverage Check Passed

Overall Coverage

Metric	Base	PR	Delta
Lines	96.54%	96.58%	📈 +0.04%
Statements	96.46%	96.50%	📈 +0.04%
Functions	98.78%	98.78%	➡️ +0.00%
Branches	91.11%	91.14%	📈 +0.03%

📁 Per-file Coverage Changes (1 files)

File	Lines (Before → After)	Statements (Before → After)
`src/config-writer.ts`	90.2% → 91.4% (+1.23%)	90.2% → 91.4% (+1.23%)

Coverage comparison generated by scripts/ci/compare-coverage.ts

Copilot

Pull request overview

This PR refactors the API proxy token trackers by extracting duplicated “budget field merge” and “cache-read rollup mismatch warning” logic into a new shared helper module, keeping the HTTP and WebSocket trackers behaviorally consistent while reducing duplication.

Changes:

Added containers/api-proxy/token-tracker-shared.js with warnCacheReadRollupMismatch() and mergeBudgetFields() helpers.
Updated HTTP token tracker to call the shared helpers instead of maintaining local duplicated blocks.
Updated WebSocket token tracker to call the shared helpers while preserving WS-specific logging fields (e.g., transport: 'websocket').

Show a summary per file

File	Description
containers/api-proxy/token-tracker-http.js	Replaces inline warning + budget-field merge blocks with shared helper calls.
containers/api-proxy/token-tracker-ws.js	Replaces inline warning + budget-field merge blocks with shared helper calls, preserving WebSocket-specific context fields.
containers/api-proxy/token-tracker-shared.js	New shared module implementing the extracted warning + budget-field merge helpers.

Copilot's findings

Tip

Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Files reviewed: 3/3 changed files
Comments generated: 0

github-actions · 2026-06-11T18:05:20Z

🔥 Smoke Test: Copilot PAT Auth — PASS

Test	Result
GitHub MCP connectivity	✅
GitHub.com HTTP	✅ 200
File write/read	✅

PR: refactor: extract shared token-tracker budget helpers
Author: @lpcox
Auth mode: PAT (COPILOT_GITHUB_TOKEN)

Overall: PASS

🔑 PAT report filed by Smoke Copilot PAT

github-actions · 2026-06-11T18:05:46Z

@lpcox

GitHub MCP Testing: ✅
GitHub.com Connectivity: ✅
File Write/Read Test: ❌
BYOK Inference Test: ✅

Running in direct BYOK mode (AWF_AUTH_TYPE=github-oidc + AWF_AUTH_AZURE_* + COPILOT_PROVIDER_BASE_URL) via api-proxy → Azure OpenAI (Foundry, o4-mini-aw) authenticated via Microsoft Entra

Overall: FAIL

🪪 BYOK (AOAI Entra) report filed by Smoke Copilot BYOK AOAI (Entra)

github-actions · 2026-06-11T18:05:57Z

Smoke Test Results

PR: refactor: extract shared token-tracker budget helpers (by @lpcox)

Test	Result
GitHub MCP connectivity	✅ PR listed: "perf(doc-maintainer): reduce per-run token usage"
GitHub.com HTTP	✅ 200
File write/read	❌ Template vars unresolved (`${{ steps.smoke-data.outputs.* }}`) — pre-step data unavailable

Overall: FAIL — file test could not be verified due to unresolved workflow template variables.

📰 BREAKING: Report filed by Smoke Copilot

github-actions · 2026-06-11T18:06:20Z

🔬 Smoke Test: API Proxy OpenTelemetry Tracing

Scenario	Result	Notes
1. Module Loading	✅	`otel.js` loads cleanly; exports: `startRequestSpan`, `setTokenAttributes`, `setBudgetAttributes`, `endSpan`, `endSpanError`, `shutdown`, `isEnabled` + internal helpers
2. Test Suite	✅	`otel.test.js`: 39/39 passed (3.1s)
3. Env Var Forwarding	✅	`src/services/api-proxy-service-config.ts` forwards `OTEL_EXPORTER_OTLP_ENDPOINT`, `OTEL_EXPORTER_OTLP_HEADERS`, `GITHUB_AW_OTEL_TRACE_ID`, `GITHUB_AW_OTEL_PARENT_SPAN_ID`, `OTEL_SERVICE_NAME` to api-proxy container
4. Token Tracker Integration	✅	`token-tracker-http.js` line 255: `onUsage` callback invoked after normalized usage extraction — OTEL hook point confirmed
5. OTEL Diagnostics	✅	No live spans expected (no OTLP endpoint configured in this run); graceful degradation path in place

All scenarios pass. OTEL tracing integration is correctly wired end-to-end.

📡 OTel tracing validated by Smoke OTel Tracing

github-actions · 2026-06-11T18:06:23Z

Chroot Version Comparison Results

Runtime	Host Version	Chroot Version	Match?
Python	Python 3.12.13	Python 3.12.3	❌
Node.js	v24.16.0	v22.22.3	❌
Go	go1.22.12	go1.22.12	✅

Overall: ❌ Not all tests passed

Go matches between host and chroot environments.
Python and Node.js versions differ — the chroot environment has older versions than the host runner.

Tested by Smoke Chroot

github-actions · 2026-06-11T18:06:48Z

✅ perf(doc-maintainer): reduce per-run token usage
✅ perf(test-coverage-reporter): reduce token usage ~7-10% per run
✅ Page title contains GitHub
✅ Smoke file created and verified
✅ npm ci && npm run build
Overall: PASS

Warning

Firewall blocked 1 domain

The following domain was blocked by the firewall during workflow execution:

registry.npmjs.org

To allow these domains, add them to the network.allowed list in your workflow frontmatter:

network:
  allowed:
    - defaults
    - "registry.npmjs.org"

See Network Configuration for more information.

🔮 The oracle has spoken through Smoke Codex

github-actions · 2026-06-11T18:07:09Z

@lpcox
🔹 refactor: extract makeUnconfiguredHealthResponse helper — ✅
🔹 GitHub.com connectivity (200) — ✅
🔹 File I/O roundtrip — ✅
🔹 BYOK inference via api-proxy — ✅
Running in direct BYOK mode (COPILOT_PROVIDER_API_KEY + COPILOT_PROVIDER_BASE_URL) via api-proxy → Azure OpenAI (Foundry, o4-mini-aw)
PASS

🔑 BYOK (AOAI api-key) report filed by Smoke Copilot BYOK AOAI (api-key)

github-actions · 2026-06-11T18:07:27Z

Smoke Test: Copilot BYOK (Direct Mode) ✅

Test Results:

✅ GitHub.com HTTP (200)
✅ File I/O (read/write)
✅ BYOK Inference (direct COPILOT_PROVIDER_API_KEY via api-proxy → api.githubcopilot.com)
✅ MCP connectivity (GitHub API verified)

Status: PASS — Running in direct BYOK mode with real credentials held in sidecar.

PR Info: Assigned to lpcox, Copilot (@Copilot)

🔑 BYOK report filed by Smoke Copilot BYOK

github-actions · 2026-06-11T18:08:41Z

Smoke Test: GitHub Actions Services Connectivity

Check	Result
Redis PING (`host.docker.internal:6379`)	❌ Connection timed out
PostgreSQL pg_isready (`host.docker.internal:5432`)	❌ No response
PostgreSQL SELECT 1	❌ Connection timed out

host.docker.internal resolves to 172.17.0.1 but no services are listening on ports 6379 or 5432.

Overall: FAIL

🔌 Service connectivity validated by Smoke Services

github-actions · 2026-06-11T18:15:15Z

GitHub API: ✅ PASS
GitHub check: ✅ PASS
File verify: ✅ PASS

Total: PASS

💥 [THE END] — Illustrated by Smoke Claude

…fixes AIC=0) (#5254) * fix(api-proxy): copy token-tracker-shared and otel modules into image PR #4780 (released in v0.27.3) extracted token-tracker-shared.js but did not add it to the Dockerfile COPY list. Because the image copies files individually by name (no bundler), require('./token-tracker-shared') threw MODULE_NOT_FOUND in the container. The graceful-degradation guard in proxy-request.js then silently stubbed trackTokenUsage to a no-op, so the container booted and served traffic normally but never wrote token-usage.jsonl -- causing AI-credit accounting to report 0 for every run since v0.27.3. models.json still appeared because model-discovery.js does not depend on the missing module. otel-exporters.js and otel-serialization.js (required by otel.js) were likewise missing and silently disabled OTEL tracing via its own graceful-degradation guard. Add all three files to the COPY list and add a guard test that computes the require closure from server.js and asserts every local module is present in the Dockerfile, preventing this recurring class of bug. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * fix(test): normalize path.relative() to POSIX separators in dockerfile-copy-coverage test --------- Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>

Copilot AI review requested due to automatic review settings June 11, 2026 17:59

Copilot started reviewing on behalf of lpcox June 11, 2026 18:00 View session

lpcox temporarily deployed to aoai-model June 11, 2026 18:01 — with GitHub Actions Inactive

Copilot AI reviewed Jun 11, 2026

View reviewed changes

github-actions Bot added the smoke-copilot-pat label Jun 11, 2026

lpcox temporarily deployed to aoai-model June 11, 2026 18:05 — with GitHub Actions Inactive

github-actions Bot added the smoke-copilot-byok-aoai-entra label Jun 11, 2026

lpcox temporarily deployed to aoai-model June 11, 2026 18:05 — with GitHub Actions Inactive

github-actions Bot mentioned this pull request Jun 11, 2026

[aw] No-Op Runs #4045

Closed

github-actions Bot mentioned this pull request Jun 11, 2026

[aw] Contribution Check failed #4772

Closed

github-actions Bot added the smoke-codex label Jun 11, 2026

github-actions Bot added smoke-copilot-byok-aoai-apikey smoke-copilot-byok labels Jun 11, 2026

github-actions Bot added the smoke-claude label Jun 11, 2026

lpcox merged commit bffaf07 into main Jun 11, 2026
83 of 85 checks passed

lpcox deleted the refactor/dedup-token-tracker-budget-fields branch June 11, 2026 18:34

github-actions Bot mentioned this pull request Jun 11, 2026

fix: skip symlink assertion for pre-existing path segments #4786

Merged

lpcox mentioned this pull request Jun 18, 2026

fix(api-proxy): copy token-tracker-shared + otel modules into image (fixes AIC=0) #5254

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor: extract shared token-tracker budget helpers#4780

refactor: extract shared token-tracker budget helpers#4780
lpcox merged 1 commit into
mainfrom
refactor/dedup-token-tracker-budget-fields

lpcox commented Jun 11, 2026

Uh oh!

github-actions Bot commented Jun 11, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

github-actions Bot commented Jun 11, 2026

Uh oh!

github-actions Bot commented Jun 11, 2026

Uh oh!

github-actions Bot commented Jun 11, 2026

Uh oh!

github-actions Bot commented Jun 11, 2026

Uh oh!

github-actions Bot commented Jun 11, 2026

Uh oh!

github-actions Bot commented Jun 11, 2026

Uh oh!

github-actions Bot commented Jun 11, 2026

Uh oh!

github-actions Bot commented Jun 11, 2026

Uh oh!

github-actions Bot commented Jun 11, 2026

Uh oh!

github-actions Bot commented Jun 11, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

lpcox commented Jun 11, 2026

Summary

Uh oh!

github-actions Bot commented Jun 11, 2026

✅ Coverage Check Passed

Overall Coverage

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Copilot's findings

Uh oh!

github-actions Bot commented Jun 11, 2026

🔥 Smoke Test: Copilot PAT Auth — PASS

Uh oh!

github-actions Bot commented Jun 11, 2026

Uh oh!

github-actions Bot commented Jun 11, 2026

Smoke Test Results

Uh oh!

github-actions Bot commented Jun 11, 2026

🔬 Smoke Test: API Proxy OpenTelemetry Tracing

Uh oh!

github-actions Bot commented Jun 11, 2026

Chroot Version Comparison Results

Uh oh!

github-actions Bot commented Jun 11, 2026

Uh oh!

github-actions Bot commented Jun 11, 2026

Uh oh!

github-actions Bot commented Jun 11, 2026

Smoke Test: Copilot BYOK (Direct Mode) ✅

Uh oh!

github-actions Bot commented Jun 11, 2026

Smoke Test: GitHub Actions Services Connectivity

Uh oh!

github-actions Bot commented Jun 11, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants