@opentermsarchive/engine 10.6.0 → 11.0.0

package/config/default.json

@@ -42,20 +42,9 @@
       "language": "en"
     },
     "logger": {
-      "smtp": {
-        "host": "smtp-relay.brevo.com",
-        "port": 587,
-        "username": "admin@opentermsarchive.org"
-      },
       "sendMailOnError": false,
       "timestampPrefix": true
     },
-    "notifier": {
-      "sendInBlue": {
-        "updatesListId": 850,
-        "updateTemplateId": 7
-      }
-    },
     "dataset": {
       "publishingSchedule": "30 8 * * MON"
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opentermsarchive/engine",
-  "version": "10.6.0",
+  "version": "11.0.0",
   "description": "Tracks and makes visible changes to the terms of online services",
   "homepage": "https://opentermsarchive.org",
   "bugs": {
@@ -95,7 +95,6 @@
     "puppeteer": "^24.22.0",
     "puppeteer-extra": "^3.3.6",
     "puppeteer-extra-plugin-stealth": "^2.11.2",
-    "sib-api-v3-sdk": "^8.5.0",
     "simple-git": "^3.28.0",
     "swagger-jsdoc": "^6.2.8",
     "swagger-ui-express": "^5.0.1",

package/scripts/declarations/utils/index.js

@@ -50,6 +50,10 @@ export default class DeclarationUtils {
       if (modifiedFilePath.endsWith('.filters.js') || modifiedFilePath.endsWith('.filters.history.js')) {
         const declaration = await this.getJSONFromFile(this.defaultBranch, `declarations/${serviceId}.json`);
 
+        if (!declaration) { // Happens when the file declaration exists in the branch but not in the default branch
+          return;
+        }
+
         servicesTermsTypes[serviceId] = Object.keys(declaration.terms); // Considering how rarely filters are used, simply return all term types that could potentially be impacted to spare implementing a function change check
 
         return;

package/scripts/declarations/utils/index.test.js

@@ -188,6 +188,23 @@ describe('DeclarationUtils', () => {
       });
     });
 
+    context('when a new declaration has been added along with a filters file', () => {
+      before(async () => {
+        await fs.writeFile(path.resolve(SUBJECT_PATH, COMMIT_PATHS.serviceB), JSON.stringify(FIXTURES.serviceB.content, null, 2));
+        await fs.writeFile(path.resolve(SUBJECT_PATH, './declarations/ServiceB.filters.js'), 'module.exports = {};');
+        await declarationUtils.git.add([ COMMIT_PATHS.serviceB, './declarations/ServiceB.filters.js' ]);
+        await declarationUtils.git.commit('Add declaration with filters for new service');
+      });
+      after(removeLatestCommit);
+
+      it('returns the added service ID along with all its terms types', async () => {
+        expect(await declarationUtils.getModifiedServicesAndTermsTypes()).to.deep.equal({
+          services: ['ServiceB'],
+          servicesTermsTypes: { ServiceB: ['Terms of Service'] },
+        });
+      });
+    });
+
     context('when history file is modified without declaration changes', () => {
       before(() => commitChanges(COMMIT_PATHS.serviceAHistory, FIXTURES.serviceATermsUpdatedHistory.content));
       after(removeLatestCommit);

package/src/index.js

@@ -7,7 +7,6 @@ import cronstrue from 'cronstrue';
 import { getCollection } from './archivist/collection/index.js';
 import Archivist from './archivist/index.js';
 import logger from './logger/index.js';
-import Notifier from './notifier/index.js';
 import Reporter from './reporter/index.js';
 
 const require = createRequire(import.meta.url);
@@ -52,16 +51,6 @@ export default async function track({ services, types, schedule }) {
   // All versions from this pass are labeled as technical upgrades to avoid false notifications about content changes.
   await archivist.applyTechnicalUpgrades({ services: filteredServices, types });
 
-  if (process.env.OTA_ENGINE_SENDINBLUE_API_KEY) {
-    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 "OTA_ENGINE_SENDINBLUE_API_KEY" was not found; the Notifier module will be ignored');
-  }
-
   if (process.env.OTA_ENGINE_GITHUB_TOKEN || process.env.OTA_ENGINE_GITLAB_TOKEN) {
     try {
       const reporter = new Reporter(config.get('@opentermsarchive/engine.reporter'));

package/src/notifier/README.md

@@ -1 +0,0 @@
-This module is intended to be considered as a simple consumer of the Archivist application's events API and therefore to be extracted from this repository. It is still in this repository to facilitate quick iterations but is expected to be extracted as soon as the Open Terms Archive app is stabilized.

package/src/notifier/index.js

@@ -1,148 +0,0 @@
-import config from 'config';
-import sendInBlue from 'sib-api-v3-sdk';
-
-export default class Notifier {
-  constructor(passedServiceProviders) {
-    const defaultClient = sendInBlue.ApiClient.instance;
-    const authentication = defaultClient.authentications['api-key'];
-
-    authentication.apiKey = process.env.OTA_ENGINE_SENDINBLUE_API_KEY;
-
-    this.apiInstance = new sendInBlue.TransactionalEmailsApi();
-    this.contactsInstance = new sendInBlue.ContactsApi();
-
-    this.serviceProviders = passedServiceProviders;
-    this.delayedVersionNotificationsParams = [];
-  }
-
-  onVersionRecorded(record) {
-    this.delayedVersionNotificationsParams.push(record);
-  }
-
-  onTrackingCompleted() {
-    this.delayedVersionNotificationsParams.forEach(async ({ serviceId, termsType, id }) => {
-      try {
-        await this.notifyVersionRecorded(serviceId, termsType, id);
-      } catch (error) {
-        console.error(`The notification for version ${id} of ${serviceId} — ${termsType} can not be sent:`, error);
-      }
-    });
-
-    this.delayedVersionNotificationsParams = [];
-  }
-
-  async notifyVersionRecorded(serviceProviderId, termsType, versionId) {
-    const sendParams = {
-      templateId: config.get('@opentermsarchive/engine.notifier.sendInBlue.updateTemplateId'),
-      params: {
-        SERVICE_PROVIDER_NAME: this.serviceProviders[serviceProviderId].name,
-        DOCUMENT_TYPE: termsType,
-        SHA: versionId,
-      },
-    };
-
-    const lists = [
-      config.get('@opentermsarchive/engine.notifier.sendInBlue.updatesListId'),
-    ];
-
-    const notificationListName = `${this.serviceProviders[serviceProviderId].name} - ${termsType} - Update`;
-    const notificationList = await this.searchContactList(notificationListName);
-
-    if (notificationList?.id) {
-      lists.push(notificationList.id);
-    }
-
-    return this.send(lists, sendParams);
-  }
-
-  async send(lists, sendParams) {
-    const promises = lists.map(listId => this.getListContacts(listId));
-
-    let contacts = await Promise.all(promises);
-
-    contacts = contacts.flat();
-
-    const uniqueContacts = [...new Map(contacts.map(item => [ item.id, item ])).values()];
-
-    const sendPromises = uniqueContacts.map(contact =>
-      this.apiInstance.sendTransacEmail({ ...sendParams, to: [{ email: contact.email }] }));
-
-    return Promise.all(sendPromises);
-  }
-
-  async getAllContactLists() {
-    const limit = 50;
-    const offset = 0;
-    const { count, lists } = await this.contactsInstance.getLists({
-      limit,
-      offset,
-    });
-
-    return {
-      count,
-      lists: await this.getAllPaginatedEntries(
-        'getLists',
-        undefined,
-        'lists',
-        lists,
-        count,
-        offset + limit,
-      ),
-    };
-  }
-
-  async searchContactList(name) {
-    const { lists } = await this.getAllContactLists();
-
-    const list = lists.find(list => list.name === name);
-
-    return list;
-  }
-
-  async getListContacts(listId) {
-    const list = await this.contactsInstance.getList(listId);
-
-    return this.getAllPaginatedEntries(
-      'getContactsFromList',
-      listId,
-      'contacts',
-      [],
-      list.totalSubscribers,
-    );
-  }
-
-  async getAllPaginatedEntries(
-    functionName,
-    resourceIdParameter,
-    resultKey,
-    accumulator,
-    count,
-    offset = 0,
-    paginationSize = 50,
-  ) {
-    if (accumulator.length >= count) {
-      return accumulator;
-    }
-
-    const promise = resourceIdParameter
-      ? this.contactsInstance[functionName](resourceIdParameter, {
-        limit: paginationSize,
-        offset,
-      })
-      : this.contactsInstance[functionName](paginationSize, offset);
-
-    const result = await promise;
-
-    accumulator = accumulator.concat(result[resultKey]);
-
-    return this.getAllPaginatedEntries(
-      functionName,
-      resourceIdParameter,
-      resultKey,
-      accumulator,
-      count,
-      offset + paginationSize,
-      paginationSize,
-    );
-  }
-}