Merge branch 'main' into improve-labels

* main:
  Clean changelog
  Add comment to explain why the rule is disabled
  Remove obsolete `async`
  Remove obsolete comment
  Add changelog entry
  Allow `await` inside of loops

Author: Ndpnt

.eslintrc.yaml

@@ -113,6 +113,7 @@ rules:
     - properties: false
   require-await: 1
   no-only-tests/no-only-tests: error
+  no-await-in-loop: 0 # allows intentional sequential processing of async operations
 
 overrides:
   - files:

scripts/history/migrate-services.js

@@ -140,7 +140,7 @@ async function rewriteSnapshots(repository, records, idsMapping, logger) {
   let i = 1;
 
   for (const record of records) {
-    const { id: recordId } = await repository.save(record); // eslint-disable-line no-await-in-loop
+    const { id: recordId } = await repository.save(record);
 
     idsMapping[record.id] = recordId; // Saves the mapping between the old ID and the new one.
 
@@ -166,7 +166,7 @@ async function rewriteVersions(repository, records, idsMapping, logger) {
 
     record.snapshotId = newSnapshotId;
 
-    const { id: recordId } = await repository.save(record); // eslint-disable-line no-await-in-loop
+    const { id: recordId } = await repository.save(record);
 
     if (recordId) {
       logger.info({ message: `Migrated version with new ID: ${recordId}`, serviceId: record.serviceId, type: record.termsType, id: record.id, current: i++, total: records.length });

scripts/import/loadCommits.js

@@ -42,7 +42,7 @@ let client;
   let counter = 1;
 
   for (const commit of filteredCommits.reverse()) { // reverse array to insert most recent commits first
-    await collection.updateOne({ hash: commit.hash }, { $set: { ...commit } }, { upsert: true }); // eslint-disable-line no-await-in-loop
+    await collection.updateOne({ hash: commit.hash }, { $set: { ...commit } }, { upsert: true });
 
     if (counter % 1000 == 0) {
       logger.info({ message: ' ', current: counter, total: totalCommitToLoad });

scripts/reporter/duplicate/index.js

@@ -48,14 +48,14 @@ async function removeDuplicateIssues() {
         continue;
       }
 
-      await octokit.request('PATCH /repos/{owner}/{repo}/issues/{issue_number}', { /* eslint-disable-line no-await-in-loop */
+      await octokit.request('PATCH /repos/{owner}/{repo}/issues/{issue_number}', {
         owner,
         repo,
         issue_number: issue.number,
         state: 'closed',
       });
 
-      await octokit.request('POST /repos/{owner}/{repo}/issues/{issue_number}/comments', { /* eslint-disable-line no-await-in-loop */
+      await octokit.request('POST /repos/{owner}/{repo}/issues/{issue_number}/comments', {
         owner,
         repo,
         issue_number: issue.number,

scripts/rewrite/rewrite-snapshots.js

@@ -64,7 +64,6 @@ let recorder;
   const filteredCommits = commits.filter(({ message }) =>
     message.match(/^(Start tracking|Update)/));
 
-  /* eslint-disable no-await-in-loop */
   /* eslint-disable no-continue */
   for (const commit of filteredCommits) {
     console.log(Date.now(), commit.hash, commit.date, commit.message);

scripts/rewrite/rewrite-versions.js

@@ -74,7 +74,6 @@ let recorder;
   const filteredCommits = commits.filter(({ message }) =>
     message.match(/^(Start tracking|Update)/));
 
-  /* eslint-disable no-await-in-loop */
   /* eslint-disable no-continue */
   for (const commit of filteredCommits) {
     console.log(Date.now(), commit.hash, commit.date, commit.message);

src/archivist/extract/index.js

@@ -59,15 +59,12 @@ export async function extractFromHTML(sourceDocument) {
 
   for (const filterFunction of serviceSpecificFilters) {
     try {
-      /* eslint-disable no-await-in-loop */
-      // We want this to be made in series
       await filterFunction(webPageDOM, {
         fetch: location,
         select: contentSelectors,
         remove: insignificantContentSelectors,
         filter: serviceSpecificFilters.map(filter => filter.name),
       });
-      /* eslint-enable no-await-in-loop */
     } catch (error) {
       throw new Error(`The filter function "${filterFunction.name}" failed: ${error}`);
     }

src/archivist/fetcher/index.js

@@ -27,7 +27,7 @@ export const FETCHER_TYPES = {
  * @throws {FetchDocumentError} When the fetch operation fails
  * @async
  */
-export default async function fetch({
+export default function fetch({
   url,
   executeClientScripts,
   cssSelectors,

src/archivist/index.js

@@ -187,7 +187,7 @@ export default class Archivist extends events.EventEmitter {
       const { location: url, executeClientScripts, cssSelectors } = sourceDocument;
 
       try {
-        const { mimeType, content, fetcher } = await this.fetch({ url, executeClientScripts, cssSelectors }); // eslint-disable-line no-await-in-loop
+        const { mimeType, content, fetcher } = await this.fetch({ url, executeClientScripts, cssSelectors });
 
         sourceDocument.content = content;
         sourceDocument.mimeType = mimeType;

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

@@ -1382,7 +1382,6 @@ describe('GitRepository', () => {
 
       await subject.initialize();
 
-      /* eslint-disable no-await-in-loop */
       for (const commit of Object.values(commits)) {
         const { path: relativeFilePath, date, content, message } = commit;
         const filePath = path.join(RECORDER_PATH, relativeFilePath);
@@ -1396,7 +1395,6 @@ describe('GitRepository', () => {
         expectedIds.push(sha);
         expectedDates.push(date);
       }
-      /* eslint-enable no-await-in-loop */
     });
 
     after(() => subject.removeAll());