feat(api): compute module version

in module repository

Author: er-lim

api/src/devcomp/infrastructure/repositories/module-repository.js

@@ -1,12 +1,15 @@
+import crypto from 'node:crypto';
+
 import { NotFoundError } from '../../../shared/domain/errors.js';
 import { LearningContentResourceNotFound } from '../../../shared/domain/errors.js';
 import { ModuleFactory } from '../factories/module-factory.js';
 
 async function getBySlug({ slug, moduleDatasource }) {
   try {
     const moduleData = await moduleDatasource.getBySlug(slug);
+    const version = _computeModuleVersion(moduleData);
 
-    return ModuleFactory.build(moduleData);
+    return ModuleFactory.build({ ...moduleData, version });
   } catch (e) {
     if (e instanceof LearningContentResourceNotFound) {
       throw new NotFoundError();
@@ -15,4 +18,10 @@ async function getBySlug({ slug, moduleDatasource }) {
   }
 }
 
+function _computeModuleVersion(moduleData) {
+  const hash = crypto.createHash('sha256');
+  hash.update(JSON.stringify(moduleData));
+  return hash.copy().digest('hex');
+}
+
 export { getBySlug };

api/tests/devcomp/integration/repositories/module-repository_test.js

@@ -1,3 +1,5 @@
+import crypto from 'node:crypto';
+
 import { Module } from '../../../../src/devcomp/domain/models/module/Module.js';
 import moduleDatasource from '../../../../src/devcomp/infrastructure/datasources/learning-content/module-datasource.js';
 import { ModuleFactory } from '../../../../src/devcomp/infrastructure/factories/module-factory.js';
@@ -42,7 +44,7 @@ describe('Integration | DevComp | Repositories | ModuleRepository', function ()
       });
     });
 
-    it('should return a Module instance', async function () {
+    it('should return a Module instance with its version', async function () {
       const existingModuleSlug = 'bien-ecrire-son-adresse-mail';
       const expectedFoundModule = {
         id: 'f7b3a2e1-0d5c-4c6c-9c4d-1a3d8f7e9f5d',
@@ -87,15 +89,30 @@ describe('Integration | DevComp | Repositories | ModuleRepository', function ()
       moduleDatasourceStub.getBySlug.withArgs(existingModuleSlug).resolves(expectedFoundModule);
       sinon.spy(ModuleFactory, 'build');
 
+      const version = 'AZERTY123456';
+      const digestStub = sinon.stub().returns(version);
+      const updateStub = sinon.stub();
+      const createHashStub = sinon.stub(crypto, 'createHash').returns({
+        copy: () => {
+          return {
+            digest: digestStub,
+          };
+        },
+        update: updateStub,
+      });
+
       // when
       const module = await moduleRepository.getBySlug({
         slug: existingModuleSlug,
         moduleDatasource: moduleDatasourceStub,
       });
 
       // then
-      expect(ModuleFactory.build).to.have.been.calledWith(expectedFoundModule);
+      expect(ModuleFactory.build).to.have.been.calledWith({ ...expectedFoundModule, version });
       expect(module).to.be.instanceof(Module);
+      expect(createHashStub).to.have.been.calledOnceWith('sha256');
+      expect(updateStub).to.have.been.calledOnceWith(JSON.stringify(expectedFoundModule));
+      expect(digestStub).to.have.been.calledOnceWith('hex');
     });
   });
 });