CIHelper: make the config an explicit constructor parameter

It was a bit hard for me to follow the code, getting confused by two
separate `getConfig()` functions that do different things (the one from
`gitgitgadget-config` initializes the default config, the one from
`project-config` gets a singleton that might still be uninitialized).

Let's unconfuse things by making the config a parameter of the
constructor. It can still be omitted, in which case the default config
is used.

Note: This commit is only concerned with the CIHelper class, because we
will use it from light-weight GitHub Actions in the future. The rest of
the code really needs to use the singleton up until the time when we'll
get around to The Big Refactor.

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

Author: dscho

lib/ci-helper.ts

@@ -5,13 +5,14 @@ import { ILintError, LintCommit } from "./commit-lint.js";
 import { commitExists, git, emptyTreeName } from "./git.js";
 import { GitNotes } from "./git-notes.js";
 import { GitGitGadget, IGitGitGadgetOptions } from "./gitgitgadget.js";
+import { getConfig } from "./gitgitgadget-config.js";
 import { GitHubGlue, IGitHubUser, IPRComment, IPRCommit, IPullRequestInfo, RequestError } from "./github-glue.js";
 import { toPrettyJSON } from "./json-util.js";
 import { MailArchiveGitHelper } from "./mail-archive-helper.js";
 import { MailCommitMapping } from "./mail-commit-mapping.js";
 import { IMailMetadata } from "./mail-metadata.js";
 import { IPatchSeriesMetadata } from "./patch-series-metadata.js";
-import { IConfig, getConfig } from "./project-config.js";
+import { IConfig, getExternalConfig, setConfig } from "./project-config.js";
 import { getPullRequestKeyFromURL, pullRequestKey } from "./pullRequestKey.js";
 
 const readFile = util.promisify(fs.readFile);
@@ -25,7 +26,7 @@ type CommentFunction = (comment: string) => Promise<void>;
  * commit.
  */
 export class CIHelper {
-    public readonly config: IConfig = getConfig();
+    public readonly config: IConfig;
     public readonly workDir: string;
     public readonly notes: GitNotes;
     public readonly urlBase: string;
@@ -40,7 +41,12 @@ export class CIHelper {
     private notesPushToken: string | undefined;
     protected maxCommitsExceptions: string[];
 
-    public constructor(workDir: string, skipUpdate?: boolean, gggConfigDir = ".") {
+    public static async getConfig(configFile?: string): Promise<IConfig> {
+        return configFile ? await getExternalConfig(configFile) : getConfig();
+    }
+
+    public constructor(workDir: string, config?: IConfig, skipUpdate?: boolean, gggConfigDir = ".") {
+        this.config = config !== undefined ? setConfig(config) : getConfig();
         this.gggConfigDir = gggConfigDir;
         this.workDir = workDir;
         this.notes = new GitNotes(workDir);

lib/misc-action.ts

@@ -35,7 +35,7 @@ export async function handleAction(parms: actionInterface): Promise<void> {
         throw new Error(`git WorkDir '${parms.repositoryDir}' not found.`);
     }
 
-    const ci = new CIHelper(parms.repositoryDir, parms.skipUpdate ? true : false, parms.configRepositoryDir);
+    const ci = new CIHelper(parms.repositoryDir, config, parms.skipUpdate ? true : false, parms.configRepositoryDir);
 
     if (parms.action === "update-open-prs") {
         const result = await ci.updateOpenPrs();

lib/pull-action.ts

@@ -38,7 +38,7 @@ export async function handlePRUpdate(parms: PRUpdateInterface): Promise<void> {
         throw new Error(`git WorkDir '${parms.repositoryDir}' not found.`);
     }
 
-    const ci = new CIHelper(parms.repositoryDir, parms.skipUpdate ? true : false, parms.configRepositoryDir);
+    const ci = new CIHelper(parms.repositoryDir, config, parms.skipUpdate ? true : false, parms.configRepositoryDir);
 
     if (parms.action === "comment") {
         if (parms.commentId) {

script/misc-helper.ts

@@ -5,12 +5,11 @@ import { CIHelper } from "../lib/ci-helper.js";
 import { isDirectory } from "../lib/fs-util.js";
 import { git, gitConfig } from "../lib/git.js";
 import { IGitGitGadgetOptions, getVar } from "../lib/gitgitgadget.js";
-import { getConfig } from "../lib/gitgitgadget-config.js";
 import { GitHubGlue } from "../lib/github-glue.js";
 import { toPrettyJSON } from "../lib/json-util.js";
 import { IGitMailingListMirrorState, stateKey } from "../lib/mail-archive-helper.js";
 import { IPatchSeriesMetadata } from "../lib/patch-series-metadata.js";
-import { IConfig, getExternalConfig, setConfig } from "../lib/project-config.js";
+import { IConfig } from "../lib/project-config.js";
 
 let commander = new Command();
 const publishRemoteKey = "publishRemote";
@@ -46,9 +45,7 @@ interface ICommanderOptions {
 const commandOptions = commander.opts<ICommanderOptions>();
 
 (async (): Promise<void> => {
-    const config: IConfig = commandOptions.config
-        ? setConfig(await getExternalConfig(commandOptions.config))
-        : getConfig();
+    const config: IConfig = await CIHelper.getConfig(commandOptions.config);
 
     const getGitGitWorkDir = async (): Promise<string> => {
         if (!commandOptions.gitWorkDir) {
@@ -69,7 +66,12 @@ const commandOptions = commander.opts<ICommanderOptions>();
         return commandOptions.gitWorkDir;
     };
 
-    const ci = new CIHelper(await getGitGitWorkDir(), commandOptions.skipUpdate, commandOptions.gitgitgadgetWorkDir);
+    const ci = new CIHelper(
+        await getGitGitWorkDir(),
+        config,
+        commandOptions.skipUpdate,
+        commandOptions.gitgitgadgetWorkDir,
+    );
 
     const configureNotesPushToken = async (): Promise<void> => {
         const token = await gitConfig("gitgitgadget.githubToken");

tests-config/ci-helper.test.ts

@@ -94,7 +94,7 @@ class TestCIHelper extends CIHelper {
     public addPRLabelsCalls: Array<[_: string, labels: string[]]>;
 
     public constructor(workDir: string, debug = false, gggDir = ".") {
-        super(workDir, debug, gggDir);
+        super(workDir, config, debug, gggDir);
         this.testing = true;
         this.ghGlue = this.github;
 
@@ -240,7 +240,7 @@ test("identify merge that integrated some commit", async () => {
     const commitD = await repo.merge("d", commitF);
     await repo.git(["update-ref", `refs/remotes/upstream/${config.repo.trackingBranches[2]}`, commitD]);
 
-    const ci = new CIHelper(repo.workDir, true);
+    const ci = new CIHelper(repo.workDir, config, true);
     expect(commitB).not.toBeUndefined();
     expect(await ci.identifyMergeCommit(config.repo.trackingBranches[2], commitG)).toEqual(commitD);
     expect(await ci.identifyMergeCommit(config.repo.trackingBranches[2], commitE)).toEqual(commitC);

tests/ci-helper.test.ts

@@ -32,7 +32,7 @@ function testQ(label: string, fn: AsyncFn) {
     });
 }
 
-getConfig();
+const config = getConfig();
 
 const eMailOptions = {
     smtpserver: new testSmtpServer(),
@@ -61,7 +61,7 @@ class TestCIHelper extends CIHelper {
     public addPRLabelsCalls: Array<[_: string, labels: string[]]>;
 
     public constructor(workDir: string, debug = false, gggDir = ".") {
-        super(workDir, debug, gggDir);
+        super(workDir, config, debug, gggDir);
         this.testing = true;
         this.ghGlue = this.github;
 
@@ -203,7 +203,7 @@ testQ("identify merge that integrated some commit", async () => {
     const commitD = await repo.merge("d", commitF);
     await repo.git(["update-ref", "refs/remotes/upstream/seen", commitD]);
 
-    const ci = new CIHelper(repo.workDir, true);
+    const ci = new CIHelper(repo.workDir, config, true);
     expect(commitB).not.toBeUndefined();
     expect(await ci.identifyMergeCommit("seen", commitG)).toEqual(commitD);
     expect(await ci.identifyMergeCommit("seen", commitE)).toEqual(commitC);