fix: use merge commit timestamp for PR benchmark entries

src/extract.ts

@@ -1,6 +1,7 @@
 /* eslint-disable @typescript-eslint/naming-convention */
 import { promises as fs } from 'fs';
 import * as github from '@actions/github';
+import { cmd } from './git';
 import { Config, ToolType } from './config';
 import { z } from 'zod';
 
@@ -34,7 +35,7 @@
 }
 
 interface PullRequest {
     [key: string]: any;
     number: number;
     html_url?: string;
     body?: string;
@@ -239,21 +240,24 @@
     }
 }
 
-function getCommitFromPullRequestPayload(pr: PullRequest): Commit {
-    // On pull_request hook, head_commit is not available
+async function getCommitFromPullRequestPayload(pr: PullRequest): Promise<Commit> {
+    // On pull_request hook, head_commit is not available.
+    // HEAD is the merge commit GitHub creates for the PR, always accessible even with shallow clones.
+    // Its timestamp is within seconds of the actual commit time.
     const id: string = pr.head.sha;
     const username: string = pr.head.user.login;
     const user = {
         name: username, // XXX: Fallback, not correct
         username,
     };
+    const timestamp = (await cmd([], 'log', '-1', '--format=%aI', 'HEAD')).trim();
 
     return {
         author: user,
         committer: user,
         id,
         message: pr.title,
-        timestamp: pr.head.repo.updated_at,
+        timestamp,
         url: `${pr.html_url}/commits/${id}`,
     };
 }
@@ -299,7 +303,7 @@
     const pr = github.context.payload.pull_request;
 
     if (pr) {
-        return getCommitFromPullRequestPayload(pr);
+        return await getCommitFromPullRequestPayload(pr);
     }
 
     if (!githubToken) {
@@ -465,7 +469,7 @@
             const extra = `mean: ${mean} ${meanUnit}\nrounds: ${stats.rounds}`;
             return { name, value, unit, range, extra };
         });
     } catch (err: any) {
         throw new Error(
             `Output file for 'pytest' must be JSON file generated by --benchmark-json option: ${err.message}`,
         );
@@ -476,7 +480,7 @@
     let json: GoogleCppBenchmarkJson;
     try {
         json = JSON.parse(output);
     } catch (err: any) {
         throw new Error(
             `Output file for 'googlecpp' must be JSON file generated by --benchmark_format=json option: ${err.message}`,
         );
@@ -604,7 +608,7 @@
     return ret;
 }
 
 function extractJuliaBenchmarkHelper([_, bench]: JuliaBenchmarkGroup, labels: string[] = []): BenchmarkResult[] {
     const res: BenchmarkResult[] = [];
     for (const key in bench.data) {
         const value = bench.data[key];
@@ -635,7 +639,7 @@
     let json: JuliaBenchmarkJson;
     try {
         json = JSON.parse(output);
     } catch (err: any) {
         throw new Error(
             `Output file for 'julia' must be JSON file generated by BenchmarkTools.save("output.json", suit::BenchmarkGroup) :  ${err.message}`,
         );
@@ -653,7 +657,7 @@
     let json: JmhBenchmarkJson[];
     try {
         json = JSON.parse(output);
     } catch (err: any) {
         throw new Error(`Output file for 'jmh' must be JSON file generated by -rf json option: ${err.message}`);
     }
     return json.map((b) => {
@@ -670,7 +674,7 @@
     let json: BenchmarkDotNetBenchmarkJson;
     try {
         json = JSON.parse(output);
     } catch (err: any) {
         throw new Error(
             `Output file for 'benchmarkdotnet' must be JSON file generated by '--exporters json' option or by adding the JsonExporter to your run config: ${err.message}`,
         );

test/extract.spec.ts

@@ -37,6 +37,10 @@ const dummyGitHubContext = {
     ref: 'abcd1234',
 };
 
+jest.mock('../src/git', () => ({
+    cmd: jest.fn().mockResolvedValue('2024-01-15T10:30:00+00:00\n'),
+}));
+
 jest.mock('@actions/github', () => ({
     get context() {
         return dummyGitHubContext;
@@ -218,9 +222,7 @@ describe('extractResult()', function () {
                     user: {
                         login: 'user',
                     },
-                    repo: {
-                        updated_at: 'repo updated at timestamp',
-                    },
+                    repo: {},
                 },
             },
         };
@@ -238,7 +240,7 @@ describe('extractResult()', function () {
         A.deepEqual(commit.committer, expectedUser);
         A.equal(commit.id, 'abcdef0123456789');
         A.equal(commit.message, 'this is title');
-        A.equal(commit.timestamp, 'repo updated at timestamp');
+        A.equal(commit.timestamp, '2024-01-15T10:30:00+00:00');
         A.equal(commit.url, 'https://github.com/dummy/repo/pull/1/commits/abcdef0123456789');
     });