@opentermsarchive/engine 0.17.2 → 0.18.0

package/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

package/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

package/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());

package/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)

package/config/default.json

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opentermsarchive/engine",
-  "version": "0.17.2",
+  "version": "0.18.0",
   "description": "Tracks and makes visible changes to the terms of online services",
   "homepage": "https://github.com/ambanum/OpenTermsArchive#readme",
   "bugs": {
@@ -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",

package/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 => {

package/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: {

package/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')));
 

package/src/main.js

@@ -1,18 +0,0 @@
-import fs from 'fs';
-
-import { program } from 'commander';
-
-import track from './index.js';
-
-const { name, description, version } = JSON.parse(fs.readFileSync(new URL('../package.json', import.meta.url)).toString());
-
-program
-  .name(name)
-  .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');
-
-track(program.parse(process.argv).opts());