@opentermsarchive/engine 1.2.1 → 1.3.0

package/src/archivist/recorder/repositories/git/git.js

@@ -30,7 +30,7 @@ export default class Git {
       .addConfig('core.quotePath', false); // disable Git's encoding of special characters in pathnames. For example, `service·A` will be encoded as `service\302\267A` without this setting, leading to issues. See https://git-scm.com/docs/git-config#Documentation/git-config.txt-corequotePath
   }
 
-  async add(filePath) {
+  add(filePath) {
     return this.git.add(this.relativePath(filePath));
   }
 
@@ -55,11 +55,11 @@ export default class Git {
     return summary.commit;
   }
 
-  async pushChanges() {
+  pushChanges() {
     return this.git.push();
   }
 
-  async listCommits(options = []) {
+  listCommits(options = []) {
     return this.log([ '--reverse', '--no-merges', '--name-only', ...options ]);
   }
 
@@ -89,11 +89,11 @@ export default class Git {
     return Boolean(result);
   }
 
-  async checkout(options) {
+  checkout(options) {
     return this.git.checkout(options);
   }
 
-  async show(options) {
+  show(options) {
     return this.git.show(options);
   }
 
@@ -107,7 +107,7 @@ export default class Git {
     return (await this.git.show([ shortHash, '--pretty=%H', '-s' ])).trim();
   }
 
-  async restore(path, commit) {
+  restore(path, commit) {
     return this.git.raw([ 'restore', '-s', commit, '--', path ]);
   }
 

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

@@ -100,7 +100,7 @@ export default class GitRepository extends RepositoryInterface {
     }
   }
 
-  async removeAll() {
+  removeAll() {
     return this.git.destroyHistory();
   }
 
@@ -129,7 +129,9 @@ export default class GitRepository extends RepositoryInterface {
 
   async #getCommits() {
     return (await this.git.listCommits())
-      .filter(({ message }) => message.match(DataMapper.COMMIT_MESSAGE_PREFIXES_REGEXP)) // Skip commits which are not a record (README, LICENSE…)
+      .filter(commit => // Skip non-record commits (e.g., README or LICENSE updates)
+        DataMapper.COMMIT_MESSAGE_PREFIXES_REGEXP.test(commit.message) // Commits generated by the engine have messages that match predefined prefixes
+        && path.dirname(commit.diff.files[0].file) !== '.') // Assumes one record per commit; records must be in a serviceId folder, not root
       .sort((commitA, commitB) => new Date(commitA.date) - new Date(commitB.date)); // Make sure that the commits are sorted in ascending chronological order
   }
 

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

@@ -91,7 +91,7 @@ describe('GitRepository', () => {
           ([commit] = await git.log());
         });
 
-        after(async () => subject.removeAll());
+        after(() => subject.removeAll());
 
         it('saves the record', () => {
           expect(numberOfRecordsAfter).to.equal(numberOfRecordsBefore + 1);
@@ -158,7 +158,7 @@ describe('GitRepository', () => {
           ([commit] = await git.log());
         });
 
-        after(async () => subject.removeAll());
+        after(() => subject.removeAll());
 
         it('saves the record', () => {
           expect(numberOfRecordsAfter).to.equal(numberOfRecordsBefore + 1);
@@ -194,7 +194,7 @@ describe('GitRepository', () => {
           numberOfRecordsAfter = (await git.log()).length;
         });
 
-        after(async () => subject.removeAll());
+        after(() => subject.removeAll());
 
         it('does not save the record', () => {
           expect(numberOfRecordsAfter).to.equal(numberOfRecordsBefore);
@@ -232,7 +232,7 @@ describe('GitRepository', () => {
           ([commit] = await git.log());
         });
 
-        after(async () => subject.removeAll());
+        after(() => subject.removeAll());
 
         it('saves the record', () => {
           expect(numberOfRecordsAfter).to.equal(numberOfRecordsBefore + 1);
@@ -263,7 +263,7 @@ describe('GitRepository', () => {
           ([commit] = await git.log());
         });
 
-        after(async () => subject.removeAll());
+        after(() => subject.removeAll());
 
         it('stores snapshot ID', () => {
           expect(commit.body).to.include(config.get('recorder.versions.storage.git.snapshotIdentiferTemplate').replace(SNAPSHOT_ID_MARKER, SNAPSHOT_ID));
@@ -295,7 +295,7 @@ describe('GitRepository', () => {
           ([commit] = await git.log());
         });
 
-        after(async () => subject.removeAll());
+        after(() => subject.removeAll());
 
         it('stores snapshots IDs', () => {
           expect(commit.body).to.include(config.get('recorder.versions.storage.git.snapshotIdentiferTemplate').replace(SNAPSHOT_ID_MARKER, SNAPSHOT_ID_1));
@@ -333,7 +333,7 @@ describe('GitRepository', () => {
         (record = await subject.findById(id));
       });
 
-      after(async () => subject.removeAll());
+      after(() => subject.removeAll());
 
       it('returns a Version object', () => {
         expect(record).to.be.an.instanceof(Version);
@@ -355,7 +355,7 @@ describe('GitRepository', () => {
         expect(record.termsType).to.equal(TERMS_TYPE);
       });
 
-      it('returns the content', async () => {
+      it('returns the content', () => {
         expect(record.content).to.equal(CONTENT);
       });
 
@@ -412,7 +412,7 @@ describe('GitRepository', () => {
             recordFound = await subject.findByDate(SERVICE_PROVIDER_ID, TERMS_TYPE, oneHourBeforeFetchDateLater);
           });
 
-          after(async () => subject.removeAll());
+          after(() => subject.removeAll());
 
           it('returns a Version object', () => {
             expect(recordFound).to.be.an.instanceof(Version);
@@ -431,7 +431,7 @@ describe('GitRepository', () => {
           recordFound = await subject.findByDate(SERVICE_PROVIDER_ID, TERMS_TYPE);
         });
 
-        it('returns null', async () => {
+        it('returns null', () => {
           expect(recordFound).to.equal(null);
         });
       });
@@ -478,7 +478,7 @@ describe('GitRepository', () => {
         (records = await subject.findAll());
       });
 
-      after(async () => subject.removeAll());
+      after(() => subject.removeAll());
 
       it('returns all records', () => {
         expect(records.length).to.equal(3);
@@ -490,7 +490,7 @@ describe('GitRepository', () => {
         }
       });
 
-      it('returns records in ascending order', async () => {
+      it('returns records in ascending order', () => {
         expect(records.map(record => record.fetchDate)).to.deep.equal([ FETCH_DATE_EARLIER, FETCH_DATE, FETCH_DATE_LATER ]);
       });
     });
@@ -527,9 +527,9 @@ describe('GitRepository', () => {
         (count = await subject.count());
       });
 
-      after(async () => subject.removeAll());
+      after(() => subject.removeAll());
 
-      it('returns the proper count', async () => {
+      it('returns the proper count', () => {
         expect(count).to.equal(3);
       });
     });
@@ -562,7 +562,7 @@ describe('GitRepository', () => {
             latestRecord = await subject.findLatest(SERVICE_PROVIDER_ID, TERMS_TYPE);
           });
 
-          after(async () => subject.removeAll());
+          after(() => subject.removeAll());
 
           it('returns a Version object', () => {
             expect(latestRecord).to.be.an.instanceof(Version);
@@ -572,7 +572,7 @@ describe('GitRepository', () => {
             expect(latestRecord.id).to.include(lastSnapshotId);
           });
 
-          it('returns the latest record content', async () => {
+          it('returns the latest record content', () => {
             expect(latestRecord.content.toString('utf8')).to.equal(UPDATED_FILE_CONTENT);
           });
         });
@@ -585,7 +585,7 @@ describe('GitRepository', () => {
           latestRecord = await subject.findLatest(SERVICE_PROVIDER_ID, TERMS_TYPE);
         });
 
-        it('returns null', async () => {
+        it('returns null', () => {
           expect(latestRecord).to.equal(null);
         });
       });
@@ -637,15 +637,36 @@ describe('GitRepository', () => {
         }
       });
 
-      after(async () => subject.removeAll());
+      after(() => subject.removeAll());
 
-      it('iterates through all records', async () => {
+      it('iterates through all records', () => {
         expect(ids).to.have.members(expectedIds);
       });
 
-      it('iterates in ascending order', async () => {
+      it('iterates in ascending order', () => {
         expect(fetchDates).to.deep.equal([ FETCH_DATE_EARLIER, FETCH_DATE, FETCH_DATE_LATER ]);
       });
+
+      context('when the repository contains non-record commits (e.g., README or LICENSE updates)', () => {
+        const iteratedIds = [];
+        let extraCommitId;
+
+        before(async () => {
+          await fs.writeFileSync(path.resolve(subject.path, 'README.md'), '# README');
+          await subject.git.add(path.resolve(subject.path, 'README.md'));
+          extraCommitId = await subject.git.commit({ message: 'Update README', filePath: path.resolve(subject.path, 'README.md') });
+
+          for await (const record of subject.iterate()) {
+            iteratedIds.push(record.id);
+          }
+        });
+
+        after(() => subject.removeAll());
+
+        it('iterates through records only', () => {
+          expect(iteratedIds).to.not.contains(extraCommitId);
+        });
+      });
     });
   });
 
@@ -695,7 +716,7 @@ describe('GitRepository', () => {
           ([commit] = await git.log());
         });
 
-        after(async () => subject.removeAll());
+        after(() => subject.removeAll());
 
         it('saves the record', () => {
           expect(numberOfRecordsAfter).to.equal(numberOfRecordsBefore + 1);
@@ -765,7 +786,7 @@ describe('GitRepository', () => {
           ([commit] = await git.log());
         });
 
-        after(async () => subject.removeAll());
+        after(() => subject.removeAll());
 
         it('saves the record', () => {
           expect(numberOfRecordsAfter).to.equal(numberOfRecordsBefore + 1);
@@ -803,7 +824,7 @@ describe('GitRepository', () => {
           numberOfRecordsAfter = (await git.log()).length;
         });
 
-        after(async () => subject.removeAll());
+        after(() => subject.removeAll());
 
         it('does not save the record', () => {
           expect(numberOfRecordsAfter).to.equal(numberOfRecordsBefore);
@@ -831,7 +852,7 @@ describe('GitRepository', () => {
           ([commit] = await git.log());
         });
 
-        after(async () => subject.removeAll());
+        after(() => subject.removeAll());
 
         it('saves the record', () => {
           expect(numberOfRecordsAfter).to.equal(numberOfRecordsBefore + 1);
@@ -863,7 +884,7 @@ describe('GitRepository', () => {
           ([commit] = await git.log());
         });
 
-        after(async () => subject.removeAll());
+        after(() => subject.removeAll());
 
         it('saves the record', () => {
           expect(numberOfRecordsAfter).to.equal(numberOfRecordsBefore + 1);
@@ -899,7 +920,7 @@ describe('GitRepository', () => {
         (record = await subject.findById(id));
       });
 
-      after(async () => subject.removeAll());
+      after(() => subject.removeAll());
 
       it('returns a Snapshot object', () => {
         expect(record).to.be.an.instanceof(Snapshot);
@@ -921,7 +942,7 @@ describe('GitRepository', () => {
         expect(record.termsType).to.equal(TERMS_TYPE);
       });
 
-      it('returns the content', async () => {
+      it('returns the content', () => {
         expect(record.content).to.equal(CONTENT);
       });
 
@@ -986,7 +1007,7 @@ describe('GitRepository', () => {
         (records = await subject.findAll());
       });
 
-      after(async () => subject.removeAll());
+      after(() => subject.removeAll());
 
       it('returns all records', () => {
         expect(records.length).to.equal(3);
@@ -998,7 +1019,7 @@ describe('GitRepository', () => {
         }
       });
 
-      it('returns records in ascending order', async () => {
+      it('returns records in ascending order', () => {
         expect(records.map(record => record.fetchDate)).to.deep.equal([ FETCH_DATE_EARLIER, FETCH_DATE, FETCH_DATE_LATER ]);
       });
     });
@@ -1035,9 +1056,9 @@ describe('GitRepository', () => {
         (count = await subject.count());
       });
 
-      after(async () => subject.removeAll());
+      after(() => subject.removeAll());
 
-      it('returns the proper count', async () => {
+      it('returns the proper count', () => {
         expect(count).to.equal(3);
       });
     });
@@ -1070,7 +1091,7 @@ describe('GitRepository', () => {
             latestRecord = await subject.findLatest(SERVICE_PROVIDER_ID, TERMS_TYPE);
           });
 
-          after(async () => subject.removeAll());
+          after(() => subject.removeAll());
 
           it('returns a Snapshot object', () => {
             expect(latestRecord).to.be.an.instanceof(Snapshot);
@@ -1080,7 +1101,7 @@ describe('GitRepository', () => {
             expect(latestRecord.id).to.include(lastSnapshotId);
           });
 
-          it('returns the latest record content', async () => {
+          it('returns the latest record content', () => {
             expect(latestRecord.content.toString('utf8')).to.equal(UPDATED_FILE_CONTENT);
           });
 
@@ -1102,13 +1123,13 @@ describe('GitRepository', () => {
             latestRecord = await subject.findLatest(SERVICE_PROVIDER_ID, TERMS_TYPE);
           });
 
-          after(async () => subject.removeAll());
+          after(() => subject.removeAll());
 
           it('returns the latest record id', () => {
             expect(latestRecord.id).to.include(lastSnapshotId);
           });
 
-          it('returns the latest record content', async () => {
+          it('returns the latest record content', () => {
             expect(latestRecord.content.toString('utf8')).to.equal(PDF_CONTENT);
           });
 
@@ -1125,7 +1146,7 @@ describe('GitRepository', () => {
           latestRecord = await subject.findLatest(SERVICE_PROVIDER_ID, TERMS_TYPE);
         });
 
-        it('returns null', async () => {
+        it('returns null', () => {
           expect(latestRecord).to.equal(null);
         });
       });
@@ -1174,13 +1195,13 @@ describe('GitRepository', () => {
         }
       });
 
-      after(async () => subject.removeAll());
+      after(() => subject.removeAll());
 
-      it('iterates through all records', async () => {
+      it('iterates through all records', () => {
         expect(ids).to.have.members(expectedIds);
       });
 
-      it('iterates in ascending order', async () => {
+      it('iterates in ascending order', () => {
         expect(fetchDates).to.deep.equal([ FETCH_DATE_EARLIER, FETCH_DATE, FETCH_DATE_LATER ]);
       });
     });
@@ -1266,7 +1287,7 @@ describe('GitRepository', () => {
       /* eslint-enable no-await-in-loop */
     });
 
-    after(async () => subject.removeAll());
+    after(() => subject.removeAll());
 
     describe('Records attributes', () => {
       describe('#isExtractOnly', () => {
@@ -1333,7 +1354,7 @@ describe('GitRepository', () => {
         }
       });
 
-      it('returns records in ascending order', async () => {
+      it('returns records in ascending order', () => {
         expect(records.map(record => record.fetchDate)).to.deep.equal(expectedDates);
       });
     });
@@ -1345,7 +1366,7 @@ describe('GitRepository', () => {
         (count = await subject.count());
       });
 
-      it('returns the proper count', async () => {
+      it('returns the proper count', () => {
         expect(count).to.equal(expectedIds.length);
       });
     });
@@ -1361,11 +1382,11 @@ describe('GitRepository', () => {
         }
       });
 
-      it('iterates through all records', async () => {
+      it('iterates through all records', () => {
         expect(ids).to.have.members(expectedIds);
       });
 
-      it('iterates in ascending order', async () => {
+      it('iterates in ascending order', () => {
         expect(fetchDates).to.deep.equal(expectedDates);
       });
     });

package/src/archivist/recorder/repositories/interface.js

@@ -3,6 +3,8 @@
  * @see {@link https://martinfowler.com/eaaCatalog/repository.html|Repository}
  * @interface
  */
+
+/* eslint-disable require-await */
 class RepositoryInterface {
   /**
   * [Optional] Initialize repository
@@ -122,3 +124,4 @@ class RepositoryInterface {
 }
 
 export default RepositoryInterface;
+/* eslint-enable require-await */

package/src/archivist/recorder/repositories/mongo/index.js

@@ -29,7 +29,7 @@ export default class MongoRepository extends RepositoryInterface {
     return this;
   }
 
-  async finalize() {
+  finalize() {
     return this.client.close();
   }
 
@@ -77,7 +77,7 @@ export default class MongoRepository extends RepositoryInterface {
       .map(mongoDocument => this.#toDomain(mongoDocument, { deferContentLoading: true })));
   }
 
-  async count() {
+  count() {
     return this.collection.find().count();
   }
 
@@ -93,7 +93,7 @@ export default class MongoRepository extends RepositoryInterface {
     /* eslint-enable no-await-in-loop */
   }
 
-  async removeAll() {
+  removeAll() {
     return this.collection.deleteMany();
   }