Fix config loading (#976)

Author: Ndpnt

CHANGELOG.md

@@ -5,7 +5,9 @@ All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html) and the format is based on [Common Changelog](https://common-changelog.org).\
 Unlike Common Changelog, the `unreleased` section of [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) is preserved with the addition of a tag to specify which type of release should be published and to foster discussions about it inside pull requests. This tag should be one of the names mandated by SemVer, within brackets: `[patch]`, `[minor]` or `[major]`. For example: `## Unreleased [minor]`.
 
-## Unreleased
+## Unreleased [minor]
+### Added
+- Load both the configurations defined in this module and the configurations defined in the module which use it as dependency.
 
 ## 0.17.2 - 2022-12-12
 ### Fixed

bin/.env.js

@@ -1 +1,10 @@
-process.env.SUPPRESS_NO_CONFIG_WARNING = 'y';
+import path from 'path';
+import { fileURLToPath } from 'url';
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
+
+process.env.SUPPRESS_NO_CONFIG_WARNING = 'y'; // Caller don't get "no config files" warnings if it does define configuration files
+
+const OTA_CONFIG_DIR = path.resolve(__dirname + "./../config/");
+const PROCESS_CONFIG_DIR = path.resolve(process.cwd() + "/config/");
+
+process.env["NODE_CONFIG_DIR"] = OTA_CONFIG_DIR + path.delimiter + PROCESS_CONFIG_DIR; // Ensure OTA config is loaded and loaded before caller config

bin/lint-declarations.js

@@ -9,14 +9,9 @@ import path from 'path';
 import { fileURLToPath, pathToFileURL } from 'url';
 
 import { program } from 'commander';
-import config from 'config';
 
 const __dirname = path.dirname(fileURLToPath(import.meta.url));
 
-// Initialise configs to allow clients of this module to use it without requiring node-config in their own application.
-// see https://github.com/lorenwest/node-config/wiki/Sub-Module-Configuration
-
-config.util.setModuleDefaults('services', { declarationsPath: path.resolve(process.cwd(), './declarations') });
 const { version } = JSON.parse(fs.readFileSync(new URL('../package.json', import.meta.url)).toString());
 
 program

bin/track.js

@@ -5,22 +5,21 @@ import fs from 'fs';
 import path from 'path';
 import { fileURLToPath, pathToFileURL } from 'url';
 
-import config from 'config';
+import { program } from 'commander';
 
 const __dirname = path.dirname(fileURLToPath(import.meta.url));
 
-const defaultConfigs = JSON.parse(fs.readFileSync(path.resolve(__dirname, '../config/default.json')));
+const { description, version } = JSON.parse(fs.readFileSync(new URL('../package.json', import.meta.url)).toString());
 
-// Initialise configs to allow clients of this module to use it without requiring node-config in their own application.
-// see https://github.com/lorenwest/node-config/wiki/Sub-Module-Configuration
-config.util.setModuleDefaults('services', { declarationsPath: path.resolve(process.cwd(), './declarations') });
-config.util.setModuleDefaults('fetcher', defaultConfigs.fetcher);
-config.util.setModuleDefaults('recorder', config.util.extendDeep({}, defaultConfigs.recorder, {
-  versions: { storage: { git: { path: path.resolve(process.cwd(), './data/versions') } } },
-  snapshots: { storage: { git: { path: path.resolve(process.cwd(), './data/snapshots') } } },
-}));
-config.util.setModuleDefaults('logger', defaultConfigs.logger);
-// we do not want any tracker when launching through this command line
-config.util.setModuleDefaults('tracker', {});
+program
+  .name('ota-track')
+  .description(description)
+  .version(version)
+  .option('-s, --services [serviceId...]', 'service IDs of services to handle')
+  .option('-d, --documentTypes [documentType...]', 'terms types to handle')
+  .option('-r, --refilter-only', 'only refilter exisiting snapshots with last declarations and engine\'s updates')
+  .option('--schedule', 'schedule automatic document tracking');
 
-import(pathToFileURL(path.resolve(__dirname, '../src/main.js')));
+const track = (await import(pathToFileURL(path.resolve(__dirname, '../src/index.js')))).default;
+
+track(program.parse(process.argv).opts());

bin/validate-declarations.js

@@ -6,20 +6,12 @@ import path from 'path';
 import { fileURLToPath } from 'url';
 
 import { program } from 'commander';
-import config from 'config';
 import Mocha from 'mocha';
 
 const { version } = JSON.parse(fs.readFileSync(new URL('../package.json', import.meta.url)).toString());
 
 const __dirname = path.dirname(fileURLToPath(import.meta.url));
 
-const defaultConfigs = JSON.parse(fs.readFileSync(path.resolve(__dirname, '../config/default.json')));
-
-// Initialise configs to allow clients of this module to use it without requiring node-config in their own application.
-// see https://github.com/lorenwest/node-config/wiki/Sub-Module-Configuration
-config.util.setModuleDefaults('services', { declarationsPath: path.resolve(process.cwd(), './declarations') });
-config.util.setModuleDefaults('fetcher', defaultConfigs.fetcher);
-
 const VALIDATE_PATH = path.resolve(__dirname, '../scripts/declarations/validate/index.mocha.js');
 
 // Mocha catches unhandled rejection from the user code and re-emits them to the process (see https://github.com/mochajs/mocha/blob/master/lib/runner.js#L198)

config/default.json

@@ -1,6 +1,6 @@
 {
   "services": {
-    "declarationsPath": "../declarations/declarations"
+    "declarationsPath": "./declarations"
   },
   "recorder": {
     "versions": {

package.json

@@ -41,7 +41,7 @@
     "lint": "eslint src test scripts bin",
     "lint:fix": "npm run lint -- --fix",
     "refilter": "npm start -- --refilter-only",
-    "start": "node --max-http-header-size=32768 src/main.js",
+    "start": "node --max-http-header-size=32768 bin/track.js",
     "start:scheduler": "npm start -- --schedule",
     "test": "cross-env NODE_ENV=test mocha --recursive \"./src/**/*.test.js\" \"./scripts/**/*.test.js\" --exit",
     "posttest": "npm run lint",

scripts/declarations/validate/index.mocha.js

@@ -28,7 +28,7 @@ const SLOW_DOCUMENT_THRESHOLD = 10 * 1000; // number of milliseconds after which
 const eslint = new ESLint({ overrideConfigFile: ESLINT_CONFIG_PATH, fix: false });
 const eslintWithFix = new ESLint({ overrideConfigFile: ESLINT_CONFIG_PATH, fix: true });
 
-const declarationsPath = path.resolve(ROOT_PATH, config.get('services.declarationsPath'));
+const declarationsPath = path.resolve(process.cwd(), config.get('services.declarationsPath'));
 const instancePath = path.resolve(declarationsPath, '../');
 
 export default async options => {

src/archivist/recorder/repositories/git/index.test.js

@@ -38,7 +38,8 @@ let git;
 describe('GitRepository', () => {
   let subject;
 
-  before(async () => {
+  before(async function () {
+    this.timeout(5000);
     git = new Git({
       path: RECORDER_PATH,
       author: {

src/archivist/services/index.js

@@ -10,7 +10,7 @@ import Service from './service.js';
 
 const fs = fsApi.promises;
 const __dirname = path.dirname(fileURLToPath(import.meta.url));
-const declarationsPath = path.resolve(__dirname, '../../..', config.get('services.declarationsPath'));
+const declarationsPath = path.resolve(process.cwd(), config.get('services.declarationsPath'));
 
 export const DOCUMENT_TYPES = JSON.parse(fsApi.readFileSync(path.resolve(__dirname, './documentTypes.json')));