@opentermsarchive/engine 1.0.0 → 1.1.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opentermsarchive/engine",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "Tracks and makes visible changes to the terms of online services",
   "homepage": "https://github.com/OpenTermsArchive/engine#readme",
   "bugs": {

package/src/archivist/index.js

@@ -29,6 +29,7 @@ export const EVENTS = [
   'trackingCompleted',
   'inaccessibleContent',
   'error',
+  'pluginError',
 ];
 
 export default class Archivist extends events.EventEmitter {
@@ -72,10 +73,6 @@ export default class Archivist extends events.EventEmitter {
   initQueue() {
     this.trackingQueue = async.queue(this.trackTermsChanges.bind(this), MAX_PARALLEL_TRACKING);
     this.trackingQueue.error(async (error, { terms }) => {
-      if (error.toString().includes('HttpError: API rate limit exceeded for user ID')) {
-        return; // This is an error due to SendInBlue quota, bypass
-      }
-
       if (error instanceof InaccessibleContentError) {
         this.emit('inaccessibleContent', error, terms);
 
@@ -91,7 +88,13 @@ export default class Archivist extends events.EventEmitter {
       const handlerName = `on${event[0].toUpperCase()}${event.substring(1)}`;
 
       if (listener[handlerName]) {
-        this.on(event, listener[handlerName].bind(listener));
+        this.on(event, async (...params) => {
+          try {
+            await listener[handlerName](...params); // Prefer try...catch over .catch() for handling errors to account for both synchronous and asynchronous functions, as .catch() cannot be applied to synchronous functions
+          } catch (error) {
+            this.emit('pluginError', error, listener.constructor.name);
+          }
+        });
       }
     });
   }

package/src/archivist/index.test.js

@@ -245,6 +245,80 @@ describe('Archivist', function () {
     });
   });
 
+  describe('Plugin system', () => {
+    const plugin = {};
+
+    describe('#attach', () => {
+      before(async () => {
+        app = new Archivist({
+          recorderConfig: config.get('recorder'),
+          fetcherConfig: config.get('fetcher'),
+        });
+        await app.initialize();
+
+        EVENTS.forEach(event => {
+          const handlerName = `on${event[0].toUpperCase()}${event.substring(1)}`;
+
+          plugin[handlerName] = sinon.spy();
+        });
+
+        app.removeAllListeners('error');
+        expect(app.eventNames()).to.be.empty;
+        app.attach(plugin);
+      });
+
+      EVENTS.forEach(event => {
+        const handlerName = `on${event[0].toUpperCase()}${event.substring(1)}`;
+
+        it(`attaches plugin "${event}" handler`, () => {
+          app.emit(event);
+          expect(plugin[handlerName].calledOnce).to.be.true;
+        });
+      });
+    });
+
+    context('when errors occur within a plugin', () => {
+      let error;
+      let listeners;
+      let plugin;
+
+      before(async () => {
+        nock.cleanAll();
+        nock('https://www.servicea.example').get('/tos').reply(200, serviceASnapshotExpectedContent, { 'Content-Type': 'text/html' });
+
+        app = new Archivist({
+          recorderConfig: config.get('recorder'),
+          fetcherConfig: config.get('fetcher'),
+        });
+        await app.initialize();
+
+        plugin = { onFirstVersionRecorded: () => { throw new Error('Plugin error'); } };
+
+        listeners = process.listeners('unhandledRejection'); // back up listeners
+        process.removeAllListeners('unhandledRejection'); // remove all listeners to avoid exit the process
+
+        process.on('unhandledRejection', reason => { error = reason; });
+
+        app.attach(plugin);
+      });
+
+      after(async () => {
+        process.removeAllListeners('unhandledRejection');
+        listeners.forEach(listener => process.on('unhandledRejection', listener));
+        await resetGitRepositories();
+      });
+
+      it('does not crash the tracking process', done => {
+        app.track({ services: [services[0]] }).then(() => {
+          if (error) {
+            return done(error);
+          }
+          done();
+        });
+      });
+    });
+  });
+
   describe('events', () => {
     const spies = {};
 

package/src/index.js

@@ -39,17 +39,25 @@ export default async function track({ services, types, extractOnly, schedule })
   }
 
   if (process.env.SENDINBLUE_API_KEY) {
-    archivist.attach(new Notifier(archivist.services));
+    try {
+      archivist.attach(new Notifier(archivist.services));
+    } catch (error) {
+      logger.error('Cannot instantiate the Notifier module; it will be ignored:', error);
+    }
   } else {
     logger.warn('Environment variable "SENDINBLUE_API_KEY" was not found; the Notifier module will be ignored');
   }
 
   if (process.env.GITHUB_TOKEN) {
     if (config.has('reporter.githubIssues.repositories.declarations')) {
-      const reporter = new Reporter(config.get('reporter'));
+      try {
+        const reporter = new Reporter(config.get('reporter'));
 
-      await reporter.initialize();
-      archivist.attach(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.githubIssues.repositories.declarations" was not found; issues on the declarations repository cannot be created');
     }

package/src/logger/index.js

@@ -136,4 +136,8 @@ logger.onError = (error, terms) => {
   logger.error({ message: error.stack, serviceId: terms.serviceId, termsType: terms.type });
 };
 
+logger.onPluginError = (error, pluginName) => {
+  logger.error({ message: `Error in "${pluginName}" plugin: ${error.stack}` });
+};
+
 export default logger;