Add backward compatibility for legacy config

Author: Ndpnt

src/index.js

@@ -56,17 +56,13 @@ export default async function track({ services, types, extractOnly, schedule })
   }
 
   if (process.env.OTA_ENGINE_GITHUB_TOKEN || process.env.OTA_ENGINE_GITLAB_TOKEN) {
-    if (config.has('@opentermsarchive/engine.reporter.repositories.declarations')) {
-      try {
-        const reporter = new Reporter(config.get('@opentermsarchive/engine.reporter'));
-
-        await reporter.initialize();
-        archivist.attach(reporter);
-      } catch (error) {
-        logger.error('Cannot instantiate the Reporter module; it will be ignored:', error);
-      }
-    } else {
-      logger.warn('Configuration key "reporter.repositories.declarations" was not found; issues on the declarations repository cannot be created');
+    try {
+      const reporter = new Reporter(config.get('@opentermsarchive/engine.reporter'));
+
+      await reporter.initialize();
+      archivist.attach(reporter);
+    } catch (error) {
+      logger.error('Cannot instantiate the Reporter module; it will be ignored:', error);
     }
   } else {
     logger.warn('Environment variable with token for GitHub or GitLab was not found; the Reporter module will be ignored');

src/reporter/index.js

@@ -1,6 +1,7 @@
 import mime from 'mime';
 
 import { toISODateWithoutMilliseconds } from '../archivist/utils/date.js';
+import logger from '../logger/index.js';
 
 import { createReporter } from './factory.js';
 
@@ -33,16 +34,53 @@ function getLabelNameFromError(error) {
 // In the following class, it is assumed that each issue is managed using its title as a unique identifier
 export default class Reporter {
   constructor(config) {
-    const { repositories } = config;
+    const normalizedConfig = Reporter.normalizeConfig(config);
 
-    for (const repositoryType of Object.keys(repositories)) {
-      if (!repositories[repositoryType].includes('/') || repositories[repositoryType].includes('https://')) {
-        throw new Error(`Configuration entry "reporter.repositories.${repositoryType}" is expected to be a string in the format <owner>/<repo>, but received: "${repositories[repositoryType]}"`);
-      }
+    Reporter.validateConfiguration(normalizedConfig.repositories);
+
+    this.reporter = createReporter(normalizedConfig);
+    this.repositories = normalizedConfig.repositories;
+  }
+
+  /**
+   * Support for legacy config format where reporter configuration was nested under "githubIssues"
+   * Example:
+   *
+   * ```json
+   * {
+   *   "githubIssues": {
+   *     "repositories": {
+   *       "declarations": "OpenTermsArchive/sandbox-declarations"
+   *     }
+   *   }
+   * }
+   * ```
+   *
+   * @deprecated
+   */
+  static normalizeConfig(config) {
+    if (config.githubIssues) {
+      logger.warn('The "reporter.githubIssues" key is deprecated; please see configuration documentation for the new format: https://docs.opentermsarchive.org/#configuring');
+
+      return {
+        type: 'github',
+        repositories: config.githubIssues.repositories,
+      };
+    }
+
+    return config;
+  }
+
+  static validateConfiguration(repositories) {
+    if (!repositories?.declarations) {
+      throw new Error('Required configuration key "reporter.repositories.declarations" was not found; issues on the declarations repository cannot be created');
     }
 
-    this.reporter = createReporter(config);
-    this.repositories = repositories;
+    for (const [ type, repo ] of Object.entries(repositories)) {
+      if (!repo.includes('/') || repo.includes('https://')) {
+        throw new Error(`Configuration entry "reporter.repositories.${type}" is expected to be a string in the format <owner>/<repo>, but received: "${repo}"`);
+      }
+    }
   }
 
   initialize() {

src/reporter/index.test.js

@@ -0,0 +1,63 @@
+import { expect } from 'chai';
+
+import Reporter from './index.js';
+
+describe('Reporter', () => {
+  describe('#normalizeConfig', () => {
+    context('with current config format', () => {
+      it('returns the config as is', () => {
+        const config = { repositories: { declarations: 'owner/repo' } };
+        const normalizedConfig = Reporter.normalizeConfig(config);
+
+        expect(normalizedConfig).to.deep.equal(config);
+      });
+    });
+
+    context('with old config format where githubIssues is nested under reporter', () => {
+      it('returns a normalized config', () => {
+        const config = { githubIssues: { repositories: { declarations: 'owner/repo' } } };
+        const expectedConfig = {
+          type: 'github',
+          repositories: { declarations: 'owner/repo' },
+        };
+        const normalizedConfig = Reporter.normalizeConfig(config);
+
+        expect(normalizedConfig).to.deep.equal(expectedConfig);
+      });
+    });
+  });
+
+  describe('#validateConfiguration', () => {
+    context('with valid configuration', () => {
+      it('does not throw an error', () => {
+        const repositories = { declarations: 'owner/repo' };
+
+        expect(() => {
+          Reporter.validateConfiguration(repositories);
+        }).not.to.throw();
+      });
+    });
+
+    context('with invalid configuration', () => {
+      context('when declarations key is missing', () => {
+        it('throws an error', () => {
+          const repositories = {};
+
+          expect(() => {
+            Reporter.validateConfiguration(repositories);
+          }).to.throw('Required configuration key "reporter.repositories.declarations" was not found; issues on the declarations repository cannot be created');
+        });
+      });
+
+      context('when repository format is incorrect', () => {
+        it('throws an error', () => {
+          const repositories = { declarations: 'invalidFormat' };
+
+          expect(() => {
+            Reporter.validateConfiguration(repositories);
+          }).to.throw('Configuration entry "reporter.repositories.declarations" is expected to be a string in the format <owner>/<repo>, but received: "invalidFormat"');
+        });
+      });
+    });
+  });
+});