Merge branch 'debug-update-mail-to-commit-notes'

dscho · dscho · commit e85806d1c637 · 2025-08-22T14:40:47.000+02:00
diff --git a/.vscode/launch.json b/.vscode/launch.json
@@ -4,6 +4,32 @@
     // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
     "version": "0.2.0",
     "configurations": [
+        {
+            "name": "Launch GitHub Action",
+            "type": "node",
+            "request": "launch",
+            "runtimeArgs": [
+                "--inspect-brk",
+                // "--nolazy",
+            ],
+            "args": [
+                "${workspaceFolder}/update-mail-to-commit-notes/index.js"
+            ],
+            "stopOnEntry": false,
+            "cwd": "${workspaceFolder}",
+            "runtimeExecutable": null,
+            "env": {
+                "NODE_ENV": "development",
+                "GITGITGADGET_DRY_RUN": "1",
+            },
+            "console": "integratedTerminal",
+            "sourceMaps": true,
+            "outFiles": [
+                "${workspaceFolder}/build/**/*.js",
+                "${workspaceFolder}/dist/**/*.js",
+                "${workspaceFolder}/lib/**/*.js"
+            ]
+        },
         {
             "name": "Tests",
             "type": "node",
@@ -18,7 +44,6 @@
             ],
             "stopOnEntry": false,
             "cwd": "${workspaceFolder}",
-            "preLaunchTask": null,
             "runtimeExecutable": null,
             "env": {
                 "NODE_ENV": "development"
diff --git a/lib/ci-helper.ts b/lib/ci-helper.ts
@@ -54,6 +54,23 @@ export class CIHelper {
     }
 
     public constructor(workDir: string = "git.git", config?: IConfig, skipUpdate?: boolean, gggConfigDir = ".") {
+        if (process.env.GITGITGADGET_DRY_RUN) {
+            // Avoid letting VS Code's `GIT_ASKPASS` any push succeed
+            Object.keys(process.env).forEach((key) => {
+                if (key.startsWith("GIT_") || key.startsWith("VSCODE_")) {
+                    console.warn(`Deleting environment variable ${key}`);
+                    delete process.env[key];
+                }
+            });
+            process.env.GIT_CONFIG_NOSYSTEM = "1";
+            process.env.GIT_CONFIG_GLOBAL = "does-not-exist";
+
+            // Disable any credential helper
+            process.env.GIT_CONFIG_PARAMETERS = [process.env.GIT_CONFIG_PARAMETERS, "'credential.helper='"]
+                .filter((e) => e)
+                .join(" ");
+        }
+
         this.config = config !== undefined ? setConfig(config) : getConfig();
         this.gggConfigDir = gggConfigDir;
         this.workDir = workDir;
@@ -129,6 +146,15 @@ export class CIHelper {
             // Ignore, for now
         }
 
+        if (!this.smtpOptions && process.env.GITGITGADGET_DRY_RUN) {
+            this.smtpOptions = {
+                smtpUser: "user@example.com",
+                smtpHost: "smtp.example.com",
+                smtpPass: "password",
+            };
+            console.log("Using debug SMTP options:", this.smtpOptions);
+        }
+
         // eslint-disable-next-line security/detect-non-literal-fs-filename
         if (!fs.existsSync(this.workDir)) await git(["init", "--bare", "--initial-branch", "unused", this.workDir]);
         for (const [key, value] of [
@@ -162,6 +188,23 @@ export class CIHelper {
             },
         );
         console.timeEnd("fetch Git notes");
+        console.time("forcing `gitgitgadget` notes refs back in time");
+        await git(["update-ref", "refs/notes/gitgitgadget", "07cbd089352a850817060742d649adb4c4c99445"], {
+            workDir: this.workDir,
+        });
+        console.timeEnd("forcing `gitgitgadget` notes refs back in time");
+        if (setupOptions?.needsMailToCommitNotes) {
+            console.time("forcing `commit-to-mail` notes refs back in time");
+            await git(["update-ref", "refs/notes/commit-to-mail", "de5f0ffd77eabc913e560acb4f3303b6e3df4163"], {
+                workDir: this.workDir,
+            });
+            console.timeEnd("forcing `commit-to-mail` notes refs back in time");
+            console.time("forcing `mail-to-commit` notes refs back in time");
+            await git(["update-ref", "refs/notes/mail-to-commit", "92b87ef409b0858d188a371a6af30aa477bc549f"], {
+                workDir: this.workDir,
+            });
+            console.timeEnd("forcing `mail-to-commit` notes refs back in time");
+        }
         this.gggNotesUpdated = true;
         if (setupOptions?.needsUpstreamBranches) {
             console.time("fetch upstream branches");
diff --git a/lib/git-notes.ts b/lib/git-notes.ts
@@ -20,6 +20,10 @@ type TemporaryNoteIndex = {
 
 export class GitNotes {
     public async push(url: string, token: string | undefined = undefined): Promise<void> {
+        if (process.env.GITGITGADGET_DRY_RUN) {
+            console.log(`Would push '${this.notesRef}' to ${url}`);
+            return; // debug mode does not actually do anything
+        }
         const auth = !token
             ? []
             : [
diff --git a/lib/github-glue.ts b/lib/github-glue.ts
@@ -79,6 +79,10 @@ export class GitHubGlue {
         const [, short, completedAt] = match;
         const url = `https://github.com/${baseOwner}/${this.repo}/commit/${gitGitCommit}`;
 
+        if (process.env.GITGITGADGET_DRY_RUN) {
+            console.log(`Would annotate ${originalCommit}:\n${gitGitCommit} as ${short} at ${completedAt}\n${url}`);
+            return -1; // debug mode does not actually do anything
+        }
         await this.ensureAuthenticated(repositoryOwner);
         const checks = await this.client.rest.checks.create({
             completed_at: completedAt,
@@ -177,6 +181,10 @@ export class GitHubGlue {
      * @returns the comment ID and the URL to the comment
      */
     public async addPRComment(pullRequest: pullRequestKeyInfo, comment: string): Promise<{ id: number; url: string }> {
+        if (process.env.GITGITGADGET_DRY_RUN) {
+            console.log(`Would add comment to ${JSON.stringify(pullRequest)}:\n${comment}`);
+            return { id: -1, url: "" }; // debug mode does not actually do anything
+        }
         const prKey = getPullRequestKey(pullRequest);
 
         await this.ensureAuthenticated(prKey.owner);
@@ -208,6 +216,10 @@ export class GitHubGlue {
         comment: string,
         line?: number,
     ): Promise<{ id: number; url: string }> {
+        if (process.env.GITGITGADGET_DRY_RUN) {
+            console.log(`Would add comment to ${JSON.stringify(pullRequest)}, commit ${commit}:\n${comment}`);
+            return { id: -1, url: "" }; // debug mode does not actually do anything
+        }
         const prKey = getPullRequestKey(pullRequest);
 
         await this.ensureAuthenticated(prKey.owner);
@@ -241,6 +253,10 @@ export class GitHubGlue {
         id: number,
         comment: string,
     ): Promise<{ id: number; url: string }> {
+        if (process.env.GITGITGADGET_DRY_RUN) {
+            console.log(`Would add reply to ${JSON.stringify(pullRequest)}, id ${id}:\n${comment}`);
+            return { id: -1, url: "" }; // debug mode does not actually do anything
+        }
         const prKey = getPullRequestKey(pullRequest);
 
         await this.ensureAuthenticated(prKey.owner);
@@ -265,6 +281,10 @@ export class GitHubGlue {
      * @returns the PR number
      */
     public async updatePR(prKey: pullRequestKey, body?: string, title?: string): Promise<number> {
+        if (process.env.GITGITGADGET_DRY_RUN) {
+            console.log(`Would add update ${JSON.stringify(prKey)}:\ntitle: ${title}\nbody: ${body}`);
+            return prKey.pull_number; // debug mode does not actually do anything
+        }
         await this.ensureAuthenticated(prKey.owner);
 
         const result = await this.client.rest.pulls.update({
@@ -277,6 +297,10 @@ export class GitHubGlue {
     }
 
     public async addPRLabels(pullRequest: pullRequestKeyInfo, labels: string[]): Promise<string[]> {
+        if (process.env.GITGITGADGET_DRY_RUN) {
+            console.log(`Would add labels to ${JSON.stringify(pullRequest)}:\n${labels.join(", ")}`);
+            return labels; // debug mode does not actually do anything
+        }
         const prKey = getPullRequestKey(pullRequest);
 
         await this.ensureAuthenticated(prKey.owner);
@@ -290,6 +314,10 @@ export class GitHubGlue {
     }
 
     public async closePR(pullRequest: pullRequestKeyInfo, viaMergeCommit: string): Promise<number> {
+        if (process.env.GITGITGADGET_DRY_RUN) {
+            console.log(`Would add close ${JSON.stringify(pullRequest)}:\n${viaMergeCommit}`);
+            return -1; // debug mode does not actually do anything
+        }
         const prKey = getPullRequestKey(pullRequest);
 
         await this.ensureAuthenticated(prKey.owner);
@@ -454,6 +482,16 @@ export class GitHubGlue {
      * @param login the GitHub login
      */
     public async getGitHubUserInfo(login: string): Promise<IGitHubUser> {
+        if (process.env.GITGITGADGET_DRY_RUN) {
+            if (login === "dscho")
+                return {
+                    email: "dscho@me.com",
+                    login,
+                    name: "Ohai!",
+                    type: "user",
+                };
+            throw new Error(`Cannot mock getByUsername: ${login}`);
+        }
         // required to get email
         await this.ensureAuthenticated(this.authenticated || this.owner);
 
diff --git a/lib/patch-series.ts b/lib/patch-series.ts
@@ -144,6 +144,11 @@ export class PatchSeries {
             options.rangeDiff = rangeDiff;
         }
 
+        if (process.env.GITGITGADGET_DRY_RUN) {
+            console.log(`Forcing Patch Series to use dry-run mode`);
+            options = { ...(options || {}), dryRun: true }; // debug mode does not actually do anything
+        }
+
         return new PatchSeries(notes, options, project, metadata, rangeDiffRanges, patchCount, coverLetter, senderName);
     }
 
diff --git a/lib/send-mail.ts b/lib/send-mail.ts
@@ -157,6 +157,10 @@ export function parseMBoxMessageIDAndReferences(parsed: IParsedMBox): { messageI
 }
 
 export async function sendMail(mail: IParsedMBox, smtpOptions: ISMTPOptions): Promise<string> {
+    if (process.env.GITGITGADGET_DRY_RUN) {
+        console.log(`Would send the email:\n${JSON.stringify(mail, null, 2)}`);
+        return "<Message-ID>"; // debug mode does not actually do anything
+    }
     const transportOpts: SMTPTransport.Options = {
         auth: {
             pass: smtpOptions.smtpPass,
diff --git a/script/lookup-commit.sh b/script/lookup-commit.sh
@@ -68,6 +68,9 @@ update_gitgit_dir () {
 	git -C "$GITGIT_DIR" fetch $git_remote refs/notes/commit-to-mail:refs/notes/commit-to-mail ||
 	die "Could not update refs/notes/commit-to-mail"
 
+	git -C "$GITGIT_DIR" update-ref refs/notes/commit-to-mail de5f0ffd77eabc913e560acb4f3303b6e3df4163
+	git -C "$GITGIT_DIR" update-ref refs/notes/mail-to-commit 92b87ef409b0858d188a371a6af30aa477bc549f
+
 	if git -C "$GITGIT_DIR" rev-parse --verify refs/remotes/upstream/seen >/dev/null 2>&1
 	then
 		# Let's take 'seen' from the official source at git.git.
diff --git a/script/update-mail-to-commit-notes.sh b/script/update-mail-to-commit-notes.sh
@@ -23,7 +23,7 @@ update_gitgit_dir () {
 	git clone $git_remote "$GITGIT_DIR" ||
 	die "Could not clone $git_remote to $GITGIT_DIR"
 
-	git -C "$GITGIT_DIR" fetch $git_remote \
+echo	git -C "$GITGIT_DIR" fetch $git_remote \
 		refs/notes/mail-to-commit:refs/notes/mail-to-commit ||
 	die "Could not update notes"
 }

Original file line number	Diff line number	Diff line change
`@@ -144,6 +144,11 @@ export class PatchSeries {`
`144`	`144`	`options.rangeDiff = rangeDiff;`
`145`	`145`	`}`
`146`	`146`
	`147`	`+ if (process.env.GITGITGADGET_DRY_RUN) {`
	`148`	+ console.log(`Forcing Patch Series to use dry-run mode`);
	`149`	`+ options = { ...(options \|\| {}), dryRun: true }; // debug mode does not actually do anything`
	`150`	`+ }`
	`151`	`+`
`147`	`152`	`return new PatchSeries(notes, options, project, metadata, rangeDiffRanges, patchCount, coverLetter, senderName);`
`148`	`153`	`}`
`149`	`154`
Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,7 @@ update_gitgit_dir () {`
`23`	`23`	`git clone $git_remote "$GITGIT_DIR" \|\|`
`24`	`24`	`die "Could not clone $git_remote to $GITGIT_DIR"`
`25`	`25`
`26`		`- git -C "$GITGIT_DIR" fetch $git_remote \`
	`26`	`+echo git -C "$GITGIT_DIR" fetch $git_remote \`
`27`	`27`	`refs/notes/mail-to-commit:refs/notes/mail-to-commit \|\|`
`28`	`28`	`die "Could not update notes"`
`29`	`29`	`}`