Retire getConfig(), setConfig() and friends

Signed-off-by: Johannes Schindelin <[email protected]>

Author: dscho

lib/ci-helper.ts

@@ -10,7 +10,6 @@ import { ILintError, LintCommit } from "./commit-lint.js";
 import { commitExists, git, emptyTreeName, revParse } from "./git.js";
 import { GitNotes } from "./git-notes.js";
 import { GitGitGadget, IGitGitGadgetOptions } from "./gitgitgadget.js";
-import { getConfig } from "./gitgitgadget-config.js";
 import {
     ConclusionType,
     GitHubGlue,
@@ -25,7 +24,7 @@ import { MailArchiveGitHelper, stateKey as mailArchiveStateKey } from "./mail-ar
 import { MailCommitMapping } from "./mail-commit-mapping.js";
 import { IMailMetadata } from "./mail-metadata.js";
 import { IPatchSeriesMetadata } from "./patch-series-metadata.js";
-import { IConfig, getExternalConfig, setConfig } from "./project-config.js";
+import { IConfig } from "./project-config.js";
 import {
     getPullRequestCommentKeyFromURL,
     getPullRequestKeyFromURL,
@@ -34,6 +33,7 @@ import {
 } from "./pullRequestKey.js";
 import { ISMTPOptions } from "./send-mail.js";
 import { fileURLToPath } from "url";
+import defaultConfig from "./gitgitgadget-config.js";
 
 const readFile = util.promisify(fs.readFile);
 type CommentFunction = (comment: string) => Promise<void>;
@@ -63,10 +63,6 @@ export class CIHelper {
     protected maxCommitsExceptions: string[];
     protected mailingListMirror: string | undefined;
 
-    public static async getConfig(configFile?: string): Promise<IConfig> {
-        return configFile ? await getExternalConfig(configFile) : getConfig();
-    }
-
     public static validateConfig = typia.createValidate<IConfig>();
 
     public static getConfigAsGitHubActionInput(): IConfig | undefined {
@@ -84,7 +80,7 @@ export class CIHelper {
     }
 
     public constructor(workDir: string = "pr-repo.git", config?: IConfig, skipUpdate?: boolean, gggConfigDir = ".") {
-        this.config = config !== undefined ? setConfig(config) : CIHelper.getConfigAsGitHubActionInput() || getConfig();
+        this.config = config || CIHelper.getConfigAsGitHubActionInput() || defaultConfig;
         this.gggConfigDir = gggConfigDir;
         this.workDir = workDir;
         this.notes = new GitNotes(workDir);

lib/gitgitgadget-config.ts

@@ -1,4 +1,4 @@
-import { IConfig, setConfig } from "./project-config.js";
+import { IConfig } from "./project-config.js";
 
 const defaultConfig: IConfig = {
     repo: {
@@ -59,9 +59,3 @@ const defaultConfig: IConfig = {
 };
 
 export default defaultConfig;
-
-setConfig(defaultConfig);
-
-export function getConfig(): IConfig {
-    return setConfig(defaultConfig);
-}

lib/project-config.ts

@@ -1,6 +1,3 @@
-import * as fs from "fs";
-import path from "path";
-
 export type projectInfo = {
     to: string; // email to send patches to
     branch: string; // upstream branch a PR must be based on
@@ -73,76 +70,3 @@ export interface IConfig {
     user: IUserConfig;
     syncUpstreamBranches: ISyncUpstreamBranchesConfig[]; // branches to sync from upstream to our repo
 }
-
-let config: IConfig; // singleton
-
-/**
- * Query to get the current configuration.
- *
- * @returns IConfig interface
- */
-export function getConfig(): IConfig {
-    if (config === undefined) {
-        throw new Error("project-config not set");
-    }
-
-    return config;
-}
-
-export async function getExternalConfig(file: string): Promise<IConfig> {
-    const filePath = path.resolve(file);
-    const newConfig = await loadConfig(filePath);
-
-    if (!Object.prototype.hasOwnProperty.call(newConfig, "project")) {
-        throw new Error(`User configurations must have a 'project:'.  Not found in ${filePath}`);
-    }
-
-    if (!newConfig.repo.owner.match(/^[a-z\d](?:[a-z\d]|-(?=[a-z\d])){0,38}$/i)) {
-        throw new Error(`Invalid 'owner' ${newConfig.repo.owner} in ${filePath}`);
-    }
-
-    if (!newConfig.repo.upstreamOwner.match(/^[a-z\d](?:[a-z\d]|-(?=[a-z\d])){0,38}$/i)) {
-        throw new Error(`Invalid 'baseOwner' ${newConfig.repo.upstreamOwner} in ${filePath}`);
-    }
-
-    return newConfig;
-}
-
-type importedConfig = { default: IConfig };
-
-/**
- * Load a config.  The config may be a javascript file (plain or generated
- * from typescript) or a json file (with a .json extension).
- *
- * @param file fully qualified filename and path
- * @returns IConfig interface
- */
-export async function loadConfig(file: string): Promise<IConfig> {
-    let loadedConfig: IConfig;
-
-    if (path.extname(file) === ".js") {
-        const { default: newConfig } = (await import(file)) as importedConfig;
-        loadedConfig = newConfig;
-    } else {
-        // eslint-disable-next-line security/detect-non-literal-fs-filename
-        const fileText = fs.readFileSync(file, { encoding: "utf-8" });
-        loadedConfig = JSON.parse(fileText) as IConfig;
-    }
-
-    if (loadedConfig === undefined) {
-        throw new Error("project-config not set");
-    }
-
-    return loadedConfig;
-}
-
-/**
- * Set/update the configuration.
- *
- * @param newConfig configuration to be set
- * @returns current IConfig interface
- */
-export function setConfig(newConfig: IConfig): IConfig {
-    config = newConfig;
-    return config;
-}

tests/ci-helper.test.ts

@@ -2,11 +2,11 @@ import { afterAll, beforeAll, expect, jest, test } from "@jest/globals";
 import { fileURLToPath } from "url";
 import { CIHelper } from "../lib/ci-helper.js";
 import { GitNotes } from "../lib/git-notes.js";
-import { getConfig } from "../lib/gitgitgadget-config.js";
 import { GitHubGlue, IGitHubUser, IPRComment, IPRCommit, IPullRequestInfo } from "../lib/github-glue.js";
 import { IMailMetadata } from "../lib/mail-metadata.js";
 import { testSmtpServer } from "test-smtp-server";
 import { testCreateRepo, TestRepo } from "./test-lib.js";
+import defaultConfig from "../lib/gitgitgadget-config.js";
 
 const sourceFileName = fileURLToPath(import.meta.url);
 
@@ -32,7 +32,7 @@ function testQ(label: string, fn: AsyncFn) {
     });
 }
 
-const config = getConfig();
+const config = defaultConfig;
 
 const eMailOptions = {
     smtpserver: new testSmtpServer(),

tests/gitgitgadget.test.ts

@@ -3,7 +3,6 @@ import { fileURLToPath } from "url";
 import { git, gitCommandExists } from "../lib/git.js";
 import { GitNotes } from "../lib/git-notes.js";
 import { GitGitGadget, IGitGitGadgetOptions } from "../lib/gitgitgadget.js";
-import { getConfig } from "../lib/gitgitgadget-config.js";
 import { PatchSeries } from "../lib/patch-series.js";
 import { IPatchSeriesMetadata } from "../lib/patch-series-metadata.js";
 import { testCreateRepo } from "./test-lib.js";
@@ -13,8 +12,6 @@ import defaultConfig from "../lib/gitgitgadget-config.js";
 jest.setTimeout(60000);
 const sourceFileName = fileURLToPath(import.meta.url);
 
-getConfig();
-
 const expectedMails = [
     `From 91fba7811291c1064b2603765a2297c34fc843c0 Mon Sep 17 00:00:00 2001
 Message-Id: <pull.<Message-ID>>

tests/misc-helper.test.ts

@@ -1,17 +1,17 @@
 import { expect, jest, test } from "@jest/globals";
 import { fileURLToPath } from "url";
 import { git } from "../lib/git.js";
-import { getConfig } from "../lib/gitgitgadget-config.js";
 import { testCreateRepo, TestRepo } from "./test-lib.js";
 import { execFile } from "child_process";
 import * as util from "util";
+import defaultConfig from "../lib/gitgitgadget-config.js";
 
 const execChild = util.promisify(execFile);
 
 jest.setTimeout(180000);
 const sourceFileName = fileURLToPath(import.meta.url);
 
-const config = getConfig();
+const config = defaultConfig;
 
 // Create three repos.
 // worktree is a local copy for doing updates and has the config

tests/patch-series.test.ts

@@ -1,6 +1,5 @@
 import { expect, jest, test } from "@jest/globals";
 import { fileURLToPath } from "url";
-import { getConfig } from "../lib/gitgitgadget-config.js";
 import { git } from "../lib/git.js";
 import { GitNotes } from "../lib/git-notes.js";
 import { PatchSeries } from "../lib/patch-series.js";
@@ -11,8 +10,6 @@ import defaultConfig from "../lib/gitgitgadget-config.js";
 jest.setTimeout(60000);
 const sourceFileName = fileURLToPath(import.meta.url);
 
-getConfig();
-
 const mbox1 = `From 38d1082511bb02a709f203481c2787adc6e67c02 Mon Sep 17 00:00:00 2001
 Message-Id: <[email protected]>
 From: A U Thor

tests/project-options.test.ts

@@ -2,7 +2,6 @@ import { expect, jest, test } from "@jest/globals";
 import { fileURLToPath } from "url";
 import { isDirectory } from "../lib/fs-util.js";
 import { GitNotes } from "../lib/git-notes.js";
-import { getConfig } from "../lib/gitgitgadget-config.js";
 import { PatchSeries } from "../lib/patch-series.js";
 import { ProjectOptions } from "../lib/project-options.js";
 import { testCreateRepo } from "./test-lib.js";
@@ -12,8 +11,6 @@ import defaultConfig from "../lib/gitgitgadget-config.js";
 jest.setTimeout(20000);
 const sourceFileName = fileURLToPath(import.meta.url);
 
-getConfig();
-
 test("project options", async () => {
     const repo = await testCreateRepo(sourceFileName);
     expect(await isDirectory(`${repo.workDir}/.git`)).toBeTruthy();