MailArchiveGitHelper: do not allow the config to be passed implicitly

Implicit configuration is a recipe for confusion when trying to allow
for overriding said configuration. Let's require the config to be passed
down explicitly.

Signed-off-by: Johannes Schindelin <johannes.schindelin@gmx.de>

Author: dscho

lib/ci-helper.ts

@@ -1110,6 +1110,7 @@ export class CIHelper {
               };
         await this.maybeUpdateGGGNotes();
         const mailArchiveGit = await MailArchiveGitHelper.get(
+            this.config,
             this.notes,
             mailArchiveGitDir,
             this.github,

lib/mail-archive-helper.ts

@@ -5,7 +5,7 @@ import { IGitGitGadgetOptions } from "./gitgitgadget.js";
 import { GitHubGlue } from "./github-glue.js";
 import { IMailMetadata } from "./mail-metadata.js";
 import { IPatchSeriesMetadata } from "./patch-series-metadata.js";
-import { IConfig, getConfig } from "./project-config.js";
+import { IConfig } from "./project-config.js";
 import { getPullRequestKey } from "./pullRequestKey.js";
 import { IParsedMBox, parseMBox, parseMBoxMessageIDAndReferences } from "./send-mail.js";
 import { SousChef } from "./sous-chef.js";
@@ -19,13 +19,14 @@ export interface IGitMailingListMirrorState {
 
 export class MailArchiveGitHelper {
     public static async get(
+        config: IConfig,
         gggNotes: GitNotes,
         mailArchiveGitDir: string,
         githubGlue: GitHubGlue,
         branch: string,
     ): Promise<MailArchiveGitHelper> {
         const state: IGitMailingListMirrorState = (await gggNotes.get<IGitMailingListMirrorState>(stateKey)) || {};
-        return new MailArchiveGitHelper(gggNotes, mailArchiveGitDir, githubGlue, state, branch);
+        return new MailArchiveGitHelper(config, gggNotes, mailArchiveGitDir, githubGlue, state, branch);
     }
 
     /**
@@ -56,19 +57,21 @@ export class MailArchiveGitHelper {
     }
 
     protected readonly branch: string;
-    protected readonly config: IConfig = getConfig();
+    protected readonly config: IConfig;
     protected readonly state: IGitMailingListMirrorState;
     protected readonly gggNotes: GitNotes;
     protected readonly mailArchiveGitDir: string;
     protected readonly githubGlue: GitHubGlue;
 
     protected constructor(
+        config: IConfig,
         gggNotes: GitNotes,
         mailArchiveGitDir: string,
         githubGlue: GitHubGlue,
         state: IGitMailingListMirrorState,
         branch: string,
     ) {
+        this.config = config;
         this.branch = branch;
         this.gggNotes = gggNotes;
         this.mailArchiveGitDir = mailArchiveGitDir;

tests/mail-archive-helper.test.ts

@@ -3,24 +3,25 @@ import { OctokitResponse } from "@octokit/types";
 import { expect, jest, test } from "@jest/globals";
 import { fileURLToPath } from "url";
 import { GitNotes } from "../lib/git-notes.js";
-import { getConfig } from "../lib/gitgitgadget-config.js";
 import { GitHubGlue } from "../lib/github-glue.js";
 import { MailArchiveGitHelper, IGitMailingListMirrorState } from "../lib/mail-archive-helper.js";
 import { IMailMetadata } from "../lib/mail-metadata.js";
-import { setConfig } from "../lib/project-config.js";
 import { testCreateRepo } from "./test-lib.js";
+import defaultConfig from "../lib/gitgitgadget-config.js";
+import { IConfig } from "../lib/project-config.js";
 
 /* eslint max-classes-per-file: ["error", 2] */
 
 class MailArchiveGitHelperProxy extends MailArchiveGitHelper {
     public constructor(
+        config: IConfig,
         gggNotes: GitNotes,
         mailArchiveGitDir: string,
         githubGlue: GitHubGlue,
         state: IGitMailingListMirrorState,
         branch: string,
     ) {
-        super(gggNotes, mailArchiveGitDir, githubGlue, state, branch);
+        super(config, gggNotes, mailArchiveGitDir, githubGlue, state, branch);
     }
 }
 class GitHubProxy extends GitHubGlue {
@@ -96,10 +97,9 @@ interface ICommit {
     parents: [{ sha: string; url: string; html_url?: string }];
 }
 
-const config = getConfig();
+const config = { ...defaultConfig }; // make a copy
 config.repo.owner = "test";
 config.repo.name = "test";
-setConfig(config);
 
 const fromEmail = "I Replied <ireplied@gmail.com>";
 
@@ -205,7 +205,14 @@ This Pull Request contains some ipsum lorem.
     const notes = new GitNotes(repo.workDir);
     await notes.set(mailMeta.messageID, mailMeta, true);
 
-    const mail = new MailArchiveGitHelperProxy(notes, repo.workDir, github, { latestRevision: "HEAD~" }, "master");
+    const mail = new MailArchiveGitHelperProxy(
+        config,
+        notes,
+        repo.workDir,
+        github,
+        { latestRevision: "HEAD~" },
+        "master",
+    );
 
     const logSpy = jest.spyOn(console, "log").mockImplementation(() => {});
     await mail.processMails();
@@ -240,7 +247,14 @@ This Pull Request contains some ipsum lorem.
     const notes = new GitNotes(repo.workDir);
     await notes.set(mailMeta.messageID, mailMeta, true);
 
-    const mail = new MailArchiveGitHelperProxy(notes, repo.workDir, github, { latestRevision: "HEAD~" }, "master");
+    const mail = new MailArchiveGitHelperProxy(
+        config,
+        notes,
+        repo.workDir,
+        github,
+        { latestRevision: "HEAD~" },
+        "master",
+    );
 
     const logSpy = jest.spyOn(console, "log").mockImplementation(() => {});
     await mail.processMails();
@@ -279,7 +293,14 @@ This Pull Request contains some ipsum lorem.
     const notes = new GitNotes(repo.workDir);
     await notes.set(mailMeta.messageID, mailMeta, true);
 
-    const mail = new MailArchiveGitHelperProxy(notes, repo.workDir, github, { latestRevision: "HEAD~" }, "master");
+    const mail = new MailArchiveGitHelperProxy(
+        config,
+        notes,
+        repo.workDir,
+        github,
+        { latestRevision: "HEAD~" },
+        "master",
+    );
 
     const commitsResponse = getCommitsResponse;
     const fail = false;
@@ -365,7 +386,14 @@ This Pull Request contains some ipsum lorem.
     const notes = new GitNotes(repo.workDir);
     await notes.set(mailMeta.messageID, mailMeta, true);
 
-    const mail = new MailArchiveGitHelperProxy(notes, repo.workDir, github, { latestRevision: "HEAD~~" }, "master");
+    const mail = new MailArchiveGitHelperProxy(
+        config,
+        notes,
+        repo.workDir,
+        github,
+        { latestRevision: "HEAD~~" },
+        "master",
+    );
 
     const commitsResponse = getCommitsResponse;
     const fail = false;
@@ -453,7 +481,14 @@ This Pull Request contains some ipsum lorem.
     const notes = new GitNotes(repo.workDir);
     await notes.set(mailMeta.messageID, mailMeta, true);
 
-    const mail = new MailArchiveGitHelperProxy(notes, repo.workDir, github, { latestRevision: "HEAD~" }, "master");
+    const mail = new MailArchiveGitHelperProxy(
+        config,
+        notes,
+        repo.workDir,
+        github,
+        { latestRevision: "HEAD~" },
+        "master",
+    );
 
     const commitsResponse = getCommitsResponse;
     const fail = true;
@@ -530,7 +565,14 @@ This Pull Request contains some ipsum lorem.
     const notes = new GitNotes(repo.workDir);
     await notes.set(mailMeta.messageID, mailMeta, true);
 
-    const mail = new MailArchiveGitHelperProxy(notes, repo.workDir, github, { latestRevision: "HEAD~" }, "master");
+    const mail = new MailArchiveGitHelperProxy(
+        config,
+        notes,
+        repo.workDir,
+        github,
+        { latestRevision: "HEAD~" },
+        "master",
+    );
 
     const commitsResponse = getCommitsResponse;
     commitsResponse.data[0].sha = mailMeta.originalCommit;