Fix declarations validation when filters history is modified (#1192)

Author: Ndpnt

CHANGELOG.md

@@ -2,6 +2,14 @@
 
 All changes that impact users of this module are documented in this file, in the [Common Changelog](https://common-changelog.org) format with some additional specifications defined in the CONTRIBUTING file. This codebase adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## Unreleased [patch]
+
+> Development of this release was supported by the [French Ministry for Foreign Affairs](https://www.diplomatie.gouv.fr/fr/politique-etrangere-de-la-france/diplomatie-numerique/) through its ministerial [State Startups incubator](https://beta.gouv.fr/startups/open-terms-archive.html) under the aegis of the Ambassador for Digital Affairs.
+
+### Fixed
+
+- Fix declarations validation when filters history is modified
+
 ## 7.2.2 - 2025-09-16
 
 _Full changeset and discussions: [#1191](https://github.com/OpenTermsArchive/engine/pull/1191)._

scripts/declarations/utils/index.js

@@ -9,7 +9,7 @@ export default class DeclarationUtils {
   }
 
   static getServiceIdFromFilePath(filePath) {
-    return path.parse(filePath.replace(/\.history|\.filters/, '')).name;
+    return path.parse(filePath.replace(/\.history|\.filters/g, '')).name;
   }
 
   async getJSONFromFile(ref, filePath) {
@@ -47,7 +47,7 @@ export default class DeclarationUtils {
         return; // Assuming history modifications imply corresponding changes in the service declaration and that the analysis of which terms types of this service have changed will be done when analysing the related declaration, no further action is required here
       }
 
-      if (modifiedFilePath.endsWith('.filters.js')) {
+      if (modifiedFilePath.endsWith('.filters.js') || modifiedFilePath.endsWith('.filters.history.js')) {
         const declaration = await this.getJSONFromFile(this.defaultBranch, `declarations/${serviceId}.json`);
 
         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

scripts/declarations/utils/index.test.js

@@ -39,6 +39,24 @@ const removeLatestCommit = async () => {
 };
 
 describe('DeclarationUtils', () => {
+  describe('#getServiceIdFromFilePath', () => {
+    it('extracts service ID from regular file path', () => {
+      expect(DeclarationUtils.getServiceIdFromFilePath('declarations/ServiceA.json')).to.equal('ServiceA');
+    });
+
+    it('extracts service ID from history file path', () => {
+      expect(DeclarationUtils.getServiceIdFromFilePath('declarations/ServiceA.history.json')).to.equal('ServiceA');
+    });
+
+    it('extracts service ID from filters file path', () => {
+      expect(DeclarationUtils.getServiceIdFromFilePath('declarations/ServiceA.filters.js')).to.equal('ServiceA');
+    });
+
+    it('extracts service ID from filters history file path', () => {
+      expect(DeclarationUtils.getServiceIdFromFilePath('declarations/ServiceA.filters.history.js')).to.equal('ServiceA');
+    });
+  });
+
   describe('#getModifiedServicesAndTermsTypes', () => {
     before(async () => {
       await loadFixtures();
@@ -137,6 +155,50 @@ describe('DeclarationUtils', () => {
         });
       });
     });
+
+    context('when filters file is modified', () => {
+      before(async () => {
+        await fs.writeFile(path.resolve(SUBJECT_PATH, './declarations/ServiceA.filters.js'), 'module.exports = {};');
+        await declarationUtils.git.add('./declarations/ServiceA.filters.js');
+        await declarationUtils.git.commit('Add filters file', './declarations/ServiceA.filters.js');
+      });
+      after(removeLatestCommit);
+
+      it('returns all terms types from the service declaration', async () => {
+        const result = await declarationUtils.getModifiedServicesAndTermsTypes();
+
+        expect(result.services).to.include('ServiceA');
+        expect(result.servicesTermsTypes.ServiceA).to.have.members([ 'Privacy Policy', 'Terms of Service' ]);
+      });
+    });
+
+    context('when filters history file is modified', () => {
+      before(async () => {
+        await fs.writeFile(path.resolve(SUBJECT_PATH, './declarations/ServiceA.filters.history.js'), 'module.exports = {};');
+        await declarationUtils.git.add('./declarations/ServiceA.filters.history.js');
+        await declarationUtils.git.commit('Add filters history file', './declarations/ServiceA.filters.history.js');
+      });
+      after(removeLatestCommit);
+
+      it('returns all terms types from the service declaration', async () => {
+        const result = await declarationUtils.getModifiedServicesAndTermsTypes();
+
+        expect(result.services).to.include('ServiceA');
+        expect(result.servicesTermsTypes.ServiceA).to.have.members([ 'Privacy Policy', 'Terms of Service' ]);
+      });
+    });
+
+    context('when history file is modified without declaration changes', () => {
+      before(() => commitChanges(COMMIT_PATHS.serviceAHistory, FIXTURES.serviceATermsUpdatedHistory.content));
+      after(removeLatestCommit);
+
+      it('returns no services and no terms types', async () => {
+        expect(await declarationUtils.getModifiedServicesAndTermsTypes()).to.deep.equal({
+          services: [],
+          servicesTermsTypes: {},
+        });
+      });
+    });
   });
 });