feat: update usage file paths to /tmp/gh-aw/usage/{agent,detection}/token_usage.jsonl

- Update JavaScript constants to use new aggregated paths
- Remove obsolete Go constants for old usage file names
- Update notify_comment.go to remove references to old paths
- Add existsSync logging in parseAICreditsFromUsageJsonl
- Update test expectations to match new paths
- All tests passing

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>

Author: Copilot

actions/setup/js/send_otlp_span.cjs

@@ -1438,18 +1438,18 @@ const OTLP_EXPORT_ERROR_DETAILS_PATH = "/tmp/gh-aw/otlp-export-errors.jsonl";
 const FAILURE_CATEGORIES_PATH = "/tmp/gh-aw/failure_categories.json";
 
 /**
- * Path to the per-agent AI usage JSONL file written to the temp folder.
+ * Path to the aggregated agent job AI usage JSONL file in the usage artifact directory.
  * Read by the conclusion job post-step before /tmp/gh-aw/ is deleted.
  * @type {string}
  */
-const AGENTS_USAGE_JSONL_PATH = "/tmp/gh-aw/agent_usage.jsonl";
+const AGENTS_USAGE_JSONL_PATH = "/tmp/gh-aw/usage/agent/token_usage.jsonl";
 
 /**
- * Path to the detection job AI usage JSONL file written to the temp folder.
+ * Path to the aggregated detection job AI usage JSONL file in the usage artifact directory.
  * Read by the conclusion job post-step before /tmp/gh-aw/ is deleted.
  * @type {string}
  */
-const DETECTION_USAGE_JSONL_PATH = "/tmp/gh-aw/detection_usage.jsonl";
+const DETECTION_USAGE_JSONL_PATH = "/tmp/gh-aw/usage/detection/token_usage.jsonl";
 
 /**
  * Path to the agent stdio log file.
@@ -1768,15 +1768,23 @@ function normalizeRuntimeTokenUsage(rawUsage) {
  * non-negative numeric AI-credits field are silently skipped.
  *
  * Used by the conclusion job post-step to read AI usage data from
- * `/tmp/gh-aw/agent_usage.jsonl` and `/tmp/gh-aw/detection_usage.jsonl`
- * before the temp folder is deleted.
+ * `/tmp/gh-aw/usage/agent/token_usage.jsonl` and
+ * `/tmp/gh-aw/usage/detection/token_usage.jsonl` before the temp folder is deleted.
  *
  * @param {string} filePath - Absolute path to the JSONL usage file
  * @returns {number} Total AI credits summed across all valid entries (0 when the
  *   file is absent, empty, or contains no entries with a valid AI-credits field)
  */
 function parseAICreditsFromUsageJsonl(filePath) {
   try {
+    // Check if file exists and log it
+    if (fs.existsSync(filePath)) {
+      core.info(`[otlp] parseAICreditsFromUsageJsonl: file exists at ${filePath}`);
+    } else {
+      core.info(`[otlp] parseAICreditsFromUsageJsonl: file not found at ${filePath}`);
+      return 0;
+    }
+
     const content = fs.readFileSync(filePath, "utf8");
     if (!content.trim()) return 0;
     let total = 0;
@@ -1787,7 +1795,8 @@ function parseAICreditsFromUsageJsonl(filePath) {
       if (typeof parsed === "number") total += parsed;
     }
     return total;
-  } catch {
+  } catch (error) {
+    core.info(`[otlp] parseAICreditsFromUsageJsonl: error reading ${filePath}: ${error.message}`);
     return 0;
   }
 }

actions/setup/js/send_otlp_span.test.cjs

@@ -6783,92 +6783,107 @@ describe("sendJobConclusionSpan does not emit OTLP metrics", () => {
 
 describe("parseAICreditsFromUsageJsonl", () => {
   let readFileSpy;
+  let existsSyncSpy;
 
   beforeEach(() => {
     readFileSpy = vi.spyOn(fs, "readFileSync").mockImplementation(() => {
       throw Object.assign(new Error("ENOENT"), { code: "ENOENT" });
     });
+    existsSyncSpy = vi.spyOn(fs, "existsSync").mockReturnValue(false);
   });
 
   afterEach(() => {
     readFileSpy.mockRestore();
+    existsSyncSpy.mockRestore();
   });
 
   it("returns 0 when the file does not exist", () => {
     expect(parseAICreditsFromUsageJsonl("/tmp/gh-aw/agent_usage.jsonl")).toBe(0);
   });
 
   it("returns 0 for an empty file", () => {
+    existsSyncSpy.mockReturnValue(true);
     readFileSpy.mockImplementation(() => "");
     expect(parseAICreditsFromUsageJsonl("/tmp/gh-aw/agent_usage.jsonl")).toBe(0);
   });
 
   it("returns 0 for a file with only whitespace", () => {
+    existsSyncSpy.mockReturnValue(true);
     readFileSpy.mockImplementation(() => "   \n  \n");
     expect(parseAICreditsFromUsageJsonl("/tmp/gh-aw/agent_usage.jsonl")).toBe(0);
   });
 
   it("sums ai_credits from a single-entry file", () => {
+    existsSyncSpy.mockReturnValue(true);
     readFileSpy.mockImplementation(() => JSON.stringify({ ai_credits: 1.5, model: "gpt-4o" }) + "\n");
     expect(parseAICreditsFromUsageJsonl("/tmp/gh-aw/agent_usage.jsonl")).toBe(1.5);
   });
 
   it("sums ai_credits across multiple entries", () => {
+    existsSyncSpy.mockReturnValue(true);
     const lines = [JSON.stringify({ ai_credits: 1.0, model: "gpt-4o" }), JSON.stringify({ ai_credits: 0.5, model: "claude-3-5-sonnet" }), JSON.stringify({ ai_credits: 0.25 })].join("\n");
     readFileSpy.mockImplementation(() => lines);
     expect(parseAICreditsFromUsageJsonl("/tmp/gh-aw/agent_usage.jsonl")).toBe(1.75);
   });
 
   it("supports camelCase aiCredits field", () => {
+    existsSyncSpy.mockReturnValue(true);
     readFileSpy.mockImplementation(() => JSON.stringify({ aiCredits: 2.0 }) + "\n");
     expect(parseAICreditsFromUsageJsonl("/tmp/gh-aw/agent_usage.jsonl")).toBe(2.0);
   });
 
   it("prefers snake_case ai_credits over camelCase aiCredits when both are present", () => {
+    existsSyncSpy.mockReturnValue(true);
     readFileSpy.mockImplementation(() => JSON.stringify({ ai_credits: 1.0, aiCredits: 9.0 }) + "\n");
     expect(parseAICreditsFromUsageJsonl("/tmp/gh-aw/agent_usage.jsonl")).toBe(1.0);
   });
 
   it("skips entries without an ai_credits or aiCredits field", () => {
+    existsSyncSpy.mockReturnValue(true);
     const lines = [JSON.stringify({ model: "gpt-4o", input_tokens: 100 }), JSON.stringify({ ai_credits: 0.75 })].join("\n");
     readFileSpy.mockImplementation(() => lines);
     expect(parseAICreditsFromUsageJsonl("/tmp/gh-aw/agent_usage.jsonl")).toBe(0.75);
   });
 
   it("skips malformed JSON lines without throwing", () => {
+    existsSyncSpy.mockReturnValue(true);
     const lines = ["{not valid json}", JSON.stringify({ ai_credits: 1.0 }), "also bad"].join("\n");
     readFileSpy.mockImplementation(() => lines);
     expect(parseAICreditsFromUsageJsonl("/tmp/gh-aw/agent_usage.jsonl")).toBe(1.0);
   });
 
   it("skips entries with negative ai_credits", () => {
+    existsSyncSpy.mockReturnValue(true);
     const lines = [JSON.stringify({ ai_credits: -0.5 }), JSON.stringify({ ai_credits: 1.0 })].join("\n");
     readFileSpy.mockImplementation(() => lines);
     expect(parseAICreditsFromUsageJsonl("/tmp/gh-aw/agent_usage.jsonl")).toBe(1.0);
   });
 
   it("skips entries where ai_credits is a non-numeric string", () => {
+    existsSyncSpy.mockReturnValue(true);
     const lines = [JSON.stringify({ ai_credits: "invalid" }), JSON.stringify({ ai_credits: 0.5 })].join("\n");
     readFileSpy.mockImplementation(() => lines);
     expect(parseAICreditsFromUsageJsonl("/tmp/gh-aw/agent_usage.jsonl")).toBe(0.5);
   });
 
   it("accepts ai_credits expressed as a numeric string", () => {
+    existsSyncSpy.mockReturnValue(true);
     readFileSpy.mockImplementation(() => JSON.stringify({ ai_credits: "1.234" }) + "\n");
     expect(parseAICreditsFromUsageJsonl("/tmp/gh-aw/agent_usage.jsonl")).toBeCloseTo(1.234);
   });
 
   it("accepts ai_credits of zero", () => {
+    existsSyncSpy.mockReturnValue(true);
     readFileSpy.mockImplementation(() => JSON.stringify({ ai_credits: 0 }) + "\n");
     expect(parseAICreditsFromUsageJsonl("/tmp/gh-aw/agent_usage.jsonl")).toBe(0);
   });
 
   it("uses the AGENTS_USAGE_JSONL_PATH constant for the agents file", () => {
-    expect(AGENTS_USAGE_JSONL_PATH).toBe("/tmp/gh-aw/agent_usage.jsonl");
+    expect(AGENTS_USAGE_JSONL_PATH).toBe("/tmp/gh-aw/usage/agent/token_usage.jsonl");
   });
 
   it("uses the DETECTION_USAGE_JSONL_PATH constant for the detection file", () => {
-    expect(DETECTION_USAGE_JSONL_PATH).toBe("/tmp/gh-aw/detection_usage.jsonl");
+    expect(DETECTION_USAGE_JSONL_PATH).toBe("/tmp/gh-aw/usage/detection/token_usage.jsonl");
   });
 });
 
@@ -6880,7 +6895,7 @@ describe("sendJobConclusionSpan conclusion job AI credits from usage files", ()
   /** @type {Record<string, string | undefined>} */
   const savedEnv = {};
   const envKeys = ["GH_AW_OTLP_ENDPOINTS", "INPUT_JOB_NAME", "GH_AW_AIC", "GH_AW_AGENT_CONCLUSION", "GITHUB_RUN_ID", "GITHUB_ACTOR", "GITHUB_REPOSITORY"];
-  let mkdirSpy, appendSpy, readFileSpy;
+  let mkdirSpy, appendSpy, readFileSpy, existsSyncSpy;
 
   beforeEach(() => {
     vi.stubGlobal("fetch", vi.fn().mockResolvedValue({ ok: true, status: 200, statusText: "OK" }));
@@ -6890,6 +6905,10 @@ describe("sendJobConclusionSpan conclusion job AI credits from usage files", ()
     }
     mkdirSpy = vi.spyOn(fs, "mkdirSync").mockImplementation(() => {});
     appendSpy = vi.spyOn(fs, "appendFileSync").mockImplementation(() => {});
+    existsSyncSpy = vi.spyOn(fs, "existsSync").mockImplementation(filePath => {
+      // Return true for paths that will be read by readFileSpy
+      return filePath === AGENTS_USAGE_JSONL_PATH || filePath === DETECTION_USAGE_JSONL_PATH;
+    });
     readFileSpy = vi.spyOn(fs, "readFileSync").mockImplementation(() => {
       throw Object.assign(new Error("ENOENT"), { code: "ENOENT" });
     });
@@ -6909,6 +6928,7 @@ describe("sendJobConclusionSpan conclusion job AI credits from usage files", ()
     mkdirSpy.mockRestore();
     appendSpy.mockRestore();
     readFileSpy.mockRestore();
+    existsSyncSpy.mockRestore();
   });
 
   /**
@@ -7004,7 +7024,7 @@ describe("sendJobConclusionSpan conclusion job AI credits from usage files", ()
   it("reads usage files from the fixed /tmp/gh-aw/ paths regardless of GH_AW_AGENT_OUTPUT", async () => {
     process.env.GH_AW_AGENT_OUTPUT = "/custom/path/output.json";
     readFileSpy.mockImplementation(filePath => {
-      if (filePath === "/tmp/gh-aw/agent_usage.jsonl") return JSON.stringify({ ai_credits: 2.0 }) + "\n";
+      if (filePath === AGENTS_USAGE_JSONL_PATH) return JSON.stringify({ ai_credits: 2.0 }) + "\n";
       throw Object.assign(new Error("ENOENT"), { code: "ENOENT" });
     });
 

pkg/constants/job_constants.go

@@ -112,16 +112,6 @@ const SafeOutputsFilename = "safeoutputs.jsonl"
 // consume structured token data without parsing the step summary or GITHUB_OUTPUT.
 const TokenUsageFilename = "agent_usage.json"
 
-// AgentUsageJsonlFilename is the filename of the per-run agent AI credit usage JSONL file written to /tmp/gh-aw/.
-// Each line is a JSON object with an ai_credits (or aiCredits) field tracking credit consumption.
-// This file is read by the conclusion job post-step to aggregate AIC before the temp folder is removed.
-const AgentUsageJsonlFilename = "agent_usage.jsonl"
-
-// DetectionUsageJsonlFilename is the filename of the per-run detection job AI credit usage JSONL file written to /tmp/gh-aw/.
-// Each line is a JSON object with an ai_credits (or aiCredits) field tracking credit consumption.
-// This file is read by the conclusion job post-step to aggregate AIC before the temp folder is removed.
-const DetectionUsageJsonlFilename = "detection_usage.jsonl"
-
 // GithubRateLimitsFilename is the filename of the GitHub API rate-limit log written to /tmp/gh-aw/.
 // Each line is a JSON object recording the x-ratelimit-* headers (or rate-limit API snapshot)
 // captured during github.rest API calls, enabling post-run analysis of rate-limit consumption.

pkg/workflow/notify_comment.go

@@ -650,7 +650,7 @@ func (c *Compiler) buildConclusionJob(data *WorkflowData, mainJobName string, sa
 }
 
 // buildUsageArtifactUploadSteps creates steps that collect and upload a compact usage artifact.
-// The artifact includes aw-info.jsonl, agent_usage.jsonl, detection_usage.jsonl, and agent/detection token usage JSONL files (when present).
+// The artifact includes aw-info.jsonl and aggregated token usage JSONL files from agent/detection sandbox locations.
 func buildUsageArtifactUploadSteps(prefix string, pinAction func(string) string) []string {
 	usageArtifactName := prefix + "usage"
 	return []string{
@@ -660,12 +660,10 @@ func buildUsageArtifactUploadSteps(prefix string, pinAction func(string) string)
 		"        run: |\n",
 		"          mkdir -p /tmp/gh-aw/usage/agent /tmp/gh-aw/usage/detection\n",
 		"          echo \"Usage artifact source file status:\"\n",
-		fmt.Sprintf("          for file in /tmp/gh-aw/aw-info.jsonl /tmp/gh-aw/%s /tmp/gh-aw/%s /tmp/gh-aw/sandbox/firewall-audit-logs/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/sandbox/firewall/logs/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/sandbox/firewall/audit/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/threat-detection/sandbox/firewall-audit-logs/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/threat-detection/sandbox/firewall/logs/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/threat-detection/sandbox/firewall/audit/api-proxy-logs/token-usage.jsonl; do\n", constants.AgentUsageJsonlFilename, constants.DetectionUsageJsonlFilename),
+		"          for file in /tmp/gh-aw/aw-info.jsonl /tmp/gh-aw/sandbox/firewall-audit-logs/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/sandbox/firewall/logs/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/sandbox/firewall/audit/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/threat-detection/sandbox/firewall-audit-logs/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/threat-detection/sandbox/firewall/logs/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/threat-detection/sandbox/firewall/audit/api-proxy-logs/token-usage.jsonl; do\n",
 		"            [ -f \"$file\" ] && echo \"FOUND: $file\" || echo \"MISSING: $file\"\n",
 		"          done\n",
 		"          [ -f /tmp/gh-aw/aw-info.jsonl ] && cp /tmp/gh-aw/aw-info.jsonl /tmp/gh-aw/usage/aw-info.jsonl || true\n",
-		fmt.Sprintf("          [ -f /tmp/gh-aw/%[1]s ] && cp /tmp/gh-aw/%[1]s /tmp/gh-aw/usage/%[1]s || true\n", constants.AgentUsageJsonlFilename),
-		fmt.Sprintf("          [ -f /tmp/gh-aw/%[1]s ] && cp /tmp/gh-aw/%[1]s /tmp/gh-aw/usage/%[1]s || true\n", constants.DetectionUsageJsonlFilename),
 		"          [ -f /tmp/gh-aw/sandbox/firewall-audit-logs/api-proxy-logs/token-usage.jsonl ] && cp /tmp/gh-aw/sandbox/firewall-audit-logs/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/usage/agent/token_usage.jsonl || true\n",
 		"          [ -f /tmp/gh-aw/sandbox/firewall/logs/api-proxy-logs/token-usage.jsonl ] && cp /tmp/gh-aw/sandbox/firewall/logs/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/usage/agent/token_usage.jsonl || true\n",
 		"          [ -f /tmp/gh-aw/sandbox/firewall/audit/api-proxy-logs/token-usage.jsonl ] && cp /tmp/gh-aw/sandbox/firewall/audit/api-proxy-logs/token-usage.jsonl /tmp/gh-aw/usage/agent/token_usage.jsonl || true\n",
@@ -683,8 +681,6 @@ func buildUsageArtifactUploadSteps(prefix string, pinAction func(string) string)
 		fmt.Sprintf("          name: %s\n", usageArtifactName),
 		"          path: |\n",
 		"            /tmp/gh-aw/usage/aw-info.jsonl\n",
-		"            /tmp/gh-aw/usage/" + constants.AgentUsageJsonlFilename + "\n",
-		"            /tmp/gh-aw/usage/" + constants.DetectionUsageJsonlFilename + "\n",
 		"            /tmp/gh-aw/usage/agent/token_usage.jsonl\n",
 		"            /tmp/gh-aw/usage/detection/token_usage.jsonl\n",
 		"          if-no-files-found: ignore\n",

pkg/workflow/notify_comment_test.go

@@ -1186,15 +1186,12 @@ func TestConclusionJobIncludesUsageArtifactSteps(t *testing.T) {
 	if !strings.Contains(allSteps, "/tmp/gh-aw/usage/aw-info.jsonl") {
 		t.Errorf("Expected usage artifact to include aw-info.jsonl path.\nGenerated steps:\n%s", allSteps)
 	}
-	if !strings.Contains(allSteps, "/tmp/gh-aw/usage/agent_usage.jsonl") {
-		t.Errorf("Expected usage artifact to include agent_usage.jsonl path.\nGenerated steps:\n%s", allSteps)
-	}
-	if !strings.Contains(allSteps, "/tmp/gh-aw/usage/detection_usage.jsonl") {
-		t.Errorf("Expected usage artifact to include detection_usage.jsonl path.\nGenerated steps:\n%s", allSteps)
-	}
 	if !strings.Contains(allSteps, "/tmp/gh-aw/usage/agent/token_usage.jsonl") {
 		t.Errorf("Expected usage artifact to include agent token usage path.\nGenerated steps:\n%s", allSteps)
 	}
+	if !strings.Contains(allSteps, "/tmp/gh-aw/usage/detection/token_usage.jsonl") {
+		t.Errorf("Expected usage artifact to include detection token usage path.\nGenerated steps:\n%s", allSteps)
+	}
 	if !strings.Contains(allSteps, "/tmp/gh-aw/sandbox/firewall/audit/api-proxy-logs/token-usage.jsonl") {
 		t.Errorf("Expected usage artifact collection to include firewall audit token usage path for agent.\nGenerated steps:\n%s", allSteps)
 	}