Define an API to query records history

.eslintrc.yaml

@@ -1,7 +1,7 @@
 extends:
   - airbnb-base
 parserOptions:
-  ecmaVersion: 2020
+  ecmaVersion: 2022
 env:
   node: true
   mocha: true
@@ -106,3 +106,10 @@ overrides:
     rules:
       func-names: 0
       import/no-extraneous-dependencies: 0
+  - files:
+      - src/**/*[iI]nterface.js
+    rules:
+      no-unused-vars: 0
+      require-yield: 0
+      class-methods-use-this: 0
+      no-empty-function: 0

README.md

@@ -19,11 +19,11 @@
     - [Core](#core)
   - [Configuring](#configuring)
     - [Configuration file](#configuration-file)
-      - [Storage adapters](#storage-adapters)
+      - [Storage repositories](#storage-repositories)
     - [Environment variables](#environment-variables)
   - [Running](#running)
 - [Deploying](#deploying)
-- [Publishing](#publishing) 
+- [Publishing](#publishing)
 - [Contributing](#contributing)
   - [Adding or updating a service](#adding-a-new-service-or-updating-an-existing-service)
   - [Core engine](#core-engine)
@@ -144,7 +144,7 @@ When refering to the base folder, it means the folder where you will be `git pul
 5. If you are using a special repo instance (e.g., `dating-declarations`), create a new [config file](#configuring), `config/development.json`, and add:
     ```json
     {
-   
+
       "services": {
         "declarationsPath": "../<name of the repo>/declarations"
       }
@@ -185,12 +185,12 @@ The default configuration can be found in `config/default.json`. The full refere
   "recorder": {
     "versions": {
       "storage": {
-        "<storage-adapter>": "Storage adapter configuration object; see below"
+        "<storage-repository>": "Storage repository configuration object; see below"
       }
     },
     "snapshots": {
       "storage": {
-        "<storage-adapter>": "Storage adapter configuration object; see below"
+        "<storage-repository>": "Storage repository configuration object; see below"
       }
     }
   },
@@ -235,9 +235,9 @@ The default configuration is merged with (and overridden by) environment-specifi
 
 If you want to change your local configuration, we suggest you create a `config/development.json` file with overridden values. An example of a production configuration file can be found in `config/production.json`.
 
-##### Storage adapters
+##### Storage repositories
 
-Two storage adapters are currently supported: Git and MongoDB. Each one can be used independently for versions and snapshots.
+Two storage repositories are currently supported: Git and MongoDB. Each one can be used independently for versions and snapshots.
 
 ###### Git
 

ops/README.md

@@ -168,7 +168,7 @@ In order to automatically set up a virtual machine:
 2. Install [VirtualBox](https://www.virtualbox.org/wiki/Downloads) to manage virtual machines. If you prefer Docker, or have an Apple Silicon machine, install [Docker](https://docs.docker.com/get-docker/) instead.
 3. Create a dedicated SSH key with no password: `ssh-keygen -f ~/.ssh/ota-vagrant -q -N ""`. This key will be automatically used by Vagrant.
 
-> VirtualBox is not compatible with Apple Silicon (M1…) processors. If you have such a machine, you will need to use the Docker provider. Since MongoDB cannot be installed on ARM, it is skipped in the infrastructure installation process. This means you cannot test the MongoDB storage adapter with Vagrant with an Apple Silicon processor.
+> VirtualBox is not compatible with Apple Silicon (M1…) processors. If you have such a machine, you will need to use the Docker provider. Since MongoDB cannot be installed on ARM, it is skipped in the infrastructure installation process. This means you cannot test the MongoDB storage repository with Vagrant with an Apple Silicon processor.
 
 ### Launch
 

package.json

@@ -13,7 +13,7 @@
   "license": "EUPL-1.2",
   "author": "ambanum",
   "type": "module",
-  "main": "index.js",
+  "main": "src/main.js",
   "bin": {
     "ota-lint-declarations": "./bin/lint-declarations.js",
     "ota-validate-declarations": "./bin/validate-declarations.js"
@@ -37,6 +37,7 @@
   "dependencies": {
     "@accordproject/markdown-cicero": "^0.15.2",
     "@accordproject/markdown-pdf": "^0.15.2",
+    "@opentermsarchive/simple-git": "^3.7.2",
     "abort-controller": "^3.0.0",
     "ajv": "^6.12.6",
     "archiver": "^5.3.0",
@@ -72,7 +73,6 @@
     "puppeteer-extra": "^3.2.3",
     "puppeteer-extra-plugin-stealth": "^2.9.0",
     "sib-api-v3-sdk": "^8.2.1",
-    "simple-git": "^2.47.0",
     "turndown": "^7.0.0",
     "winston": "^3.3.3",
     "winston-mail": "^2.0.0"

scripts/dataset/export/index.js

@@ -3,8 +3,9 @@ import path from 'path';
 import { fileURLToPath } from 'url';
 
 import archiver from 'archiver';
+import config from 'config';
 
-import { instantiateVersionsStorageAdapter } from '../../../src/index.js';
+import RepositoryFactory from '../../../src/archivist/recorder/repositories/factory.js';
 import * as renamer from '../../utils/renamer/index.js';
 import readme from '../assets/README.template.js';
 import logger from '../logger/index.js';
@@ -16,7 +17,7 @@ const fs = fsApi.promises;
 const ARCHIVE_FORMAT = 'zip'; // for supported formats, see https://www.archiverjs.com/docs/archive-formats
 
 export default async function generate({ archivePath, releaseDate }) {
-  const versionsStorageAdapter = await (instantiateVersionsStorageAdapter()).initialize();
+  const versionsRepository = await RepositoryFactory.create(config.get('recorder.versions.storage')).initialize();
 
   const archive = await initializeArchive(archivePath);
 
@@ -28,7 +29,7 @@ export default async function generate({ archivePath, releaseDate }) {
 
   let index = 1;
 
-  for await (const version of versionsStorageAdapter.iterate()) {
+  for await (const version of versionsRepository.iterate()) {
     const { content, fetchDate } = version;
     const { serviceId, documentType } = renamer.applyRules(version.serviceId, version.documentType);
 
@@ -70,7 +71,7 @@ export default async function generate({ archivePath, releaseDate }) {
   archive.stream.finalize();
 
   await archive.done;
-  await versionsStorageAdapter.finalize();
+  await versionsRepository.finalize();
 
   return {
     servicesCount: services.size,

scripts/dataset/export/index.test.js

@@ -8,7 +8,8 @@ import dircompare from 'dir-compare';
 import mime from 'mime';
 import StreamZip from 'node-stream-zip';
 
-import GitAdapter from '../../../src/storage-adapters/git/index.js';
+import Record from '../../../src/archivist/recorder/record.js';
+import GitRepository from '../../../src/archivist/recorder/repositories/git/index.js';
 
 import generateArchive from './index.js';
 
@@ -30,6 +31,8 @@ const FOURTH_FETCH_DATE = '2022-01-01T12:12:24.000Z';
 const FIRST_CONTENT = 'First Content';
 const SECOND_CONTENT = 'Second Content';
 
+const MIME_TYPE = 'text/markdown';
+
 const SNAPSHOT_ID = '721ce4a63ad399ecbdb548a66d6d327e7bc97876';
 
 const RELEASE_DATE = '2022-01-01T18:21:00.000Z';
@@ -41,49 +44,53 @@ describe('Export', () => {
     const TMP_PATH = path.resolve(__dirname, './tmp');
     const EXPECTED_DATASET_PATH = path.resolve(__dirname, './test/fixtures/dataset');
 
-    let storageAdapter;
+    let repository;
     let zip;
 
     before(async function () {
       this.timeout(10000);
-      storageAdapter = new GitAdapter({
+      repository = new GitRepository({
         ...config.get('recorder.versions.storage.git'),
         path: path.resolve(__dirname, '../../../', config.get('recorder.versions.storage.git.path')),
       });
 
-      await storageAdapter.initialize();
+      await repository.initialize();
 
-      await storageAdapter.record({
+      await repository.save(new Record({
         serviceId: FIRST_SERVICE_PROVIDER_ID,
         documentType: FIRST_DOCUMENT_TYPE,
         content: FIRST_CONTENT,
+        mimeType: MIME_TYPE,
         fetchDate: FIRST_FETCH_DATE,
         snapshotId: SNAPSHOT_ID,
-      });
+      }));
 
-      await storageAdapter.record({
+      await repository.save(new Record({
         serviceId: FIRST_SERVICE_PROVIDER_ID,
         documentType: FIRST_DOCUMENT_TYPE,
         content: SECOND_CONTENT,
+        mimeType: MIME_TYPE,
         fetchDate: SECOND_FETCH_DATE,
         snapshotId: SNAPSHOT_ID,
-      });
+      }));
 
-      await storageAdapter.record({
+      await repository.save(new Record({
         serviceId: SECOND_SERVICE_PROVIDER_ID,
         documentType: FIRST_DOCUMENT_TYPE,
         content: FIRST_CONTENT,
+        mimeType: MIME_TYPE,
         fetchDate: THIRD_FETCH_DATE,
         snapshotId: SNAPSHOT_ID,
-      });
+      }));
 
-      await storageAdapter.record({
+      await repository.save(new Record({
         serviceId: SECOND_SERVICE_PROVIDER_ID,
         documentType: SECOND_DOCUMENT_TYPE,
         content: FIRST_CONTENT,
+        mimeType: MIME_TYPE,
         fetchDate: FOURTH_FETCH_DATE,
         snapshotId: SNAPSHOT_ID,
-      });
+      }));
 
       await generateArchive({
         archivePath: ARCHIVE_PATH,
@@ -97,7 +104,7 @@ describe('Export', () => {
 
     after(async () => {
       await fs.rm(TMP_PATH, { recursive: true });
-      await storageAdapter._removeAllRecords();
+      await repository.removeAll();
     });
 
     it('is an archive', () => {