feat(api): check image production readiness

Author: yannbertrand

api/src/devcomp/domain/models/element/Image.js

@@ -1,7 +1,10 @@
+import { DomainError } from '../../../../shared/domain/errors.js';
 import { assertNotNullOrUndefined } from '../../../../shared/domain/models/asserts.js';
 import { Element } from './Element.js';
 
 class Image extends Element {
+  static #VALID_PRODUCTION_HOSTNAME = 'assets.pix.org';
+
   /**
    * @param{object} params
    * @param{string} params.id
@@ -10,11 +13,16 @@ class Image extends Element {
    * @param{string} params.alternativeText
    * @param{string} params.legend
    * @param{string} params.licence
+   * @param{boolean} params.isBeta
    */
-  constructor({ id, url, alt, alternativeText, legend, licence }) {
+  constructor({ id, url, alt, alternativeText, legend, licence, isBeta = true }) {
     super({ id, type: 'image' });
 
     assertNotNullOrUndefined(url, 'The URL is required for an image');
+    if (!URL.canParse(url)) {
+      throw new DomainError('The URL must be a valid URL for an image');
+    }
+
     assertNotNullOrUndefined(alt, 'The alt text is required for an image');
     assertNotNullOrUndefined(alternativeText, 'The alternative text is required for an image');
 
@@ -23,6 +31,12 @@ class Image extends Element {
     this.alternativeText = alternativeText;
     this.legend = legend;
     this.licence = licence;
+
+    if (!isBeta) {
+      if (URL.parse(url).hostname !== Image.#VALID_PRODUCTION_HOSTNAME) {
+        throw new DomainError('The image URL must be from "assets.pix.org" when module is production ready');
+      }
+    }
   }
 }
 

api/tests/devcomp/unit/domain/models/element/Element_test.js

@@ -31,7 +31,12 @@ describe('Unit | Devcomp | Domain | Models | Element', function () {
     it('should instanciate non answerable elements', function () {
       // Given
       const text = new Text({ id: 'id', content: 'content' });
-      const image = new Image({ id: 'id', url: 'url', alt: 'alt', alternativeText: 'alternativeText' });
+      const image = new Image({
+        id: 'id',
+        url: 'https://assets.pix.org/modules/placeholder-details.svg',
+        alt: 'alt',
+        alternativeText: 'alternativeText',
+      });
 
       const nonAnswerableElements = [text, image];
 

api/tests/devcomp/unit/domain/models/element/Image_test.js

@@ -8,16 +8,17 @@ describe('Unit | Devcomp | Domain | Models | Element | Image', function () {
       // when
       const image = new Image({
         id: 'id',
-        url: 'url',
+        url: 'https://assets.pix.org/modules/placeholder-details.svg',
         alt: 'alt',
         alternativeText: 'alternativeText',
         legend: 'legend',
         licence: 'licence',
+        isBeta: false,
       });
 
       // then
       expect(image.id).to.equal('id');
-      expect(image.url).to.equal('url');
+      expect(image.url).to.equal('https://assets.pix.org/modules/placeholder-details.svg');
       expect(image.alt).to.equal('alt');
       expect(image.alternativeText).to.equal('alternativeText');
       expect(image.legend).to.equal('legend');
@@ -48,11 +49,22 @@ describe('Unit | Devcomp | Domain | Models | Element | Image', function () {
     });
   });
 
-  describe('An image without alt', function () {
+  describe('An image with invalid url', function () {
     it('should throw an error', function () {
       // when
       const error = catchErrSync(() => new Image({ id: 'id', url: 'url' }))();
 
+      // then
+      expect(error).to.be.instanceOf(DomainError);
+      expect(error.message).to.equal('The URL must be a valid URL for an image');
+    });
+  });
+
+  describe('An image without alt', function () {
+    it('should throw an error', function () {
+      // when
+      const error = catchErrSync(() => new Image({ id: 'id', url: 'https://images.pix.fr/coolcat.jpg' }))();
+
       // then
       expect(error).to.be.instanceOf(DomainError);
       expect(error.message).to.equal('The alt text is required for an image');
@@ -62,11 +74,35 @@ describe('Unit | Devcomp | Domain | Models | Element | Image', function () {
   describe('An image without an alternative text', function () {
     it('should throw an error', function () {
       // when
-      const error = catchErrSync(() => new Image({ id: 'id', url: 'url', alt: 'alt' }))();
+      const error = catchErrSync(() => new Image({ id: 'id', url: 'https://images.pix.fr/coolcat.jpg', alt: 'alt' }))();
 
       // then
       expect(error).to.be.instanceOf(DomainError);
       expect(error.message).to.equal('The alternative text is required for an image');
     });
   });
+
+  describe('When isBeta is false', function () {
+    describe('and image URL is not from assets.pix.org', function () {
+      it('should throw an error', function () {
+        // given & when
+        const error = catchErrSync(
+          () =>
+            new Image({
+              id: 'id',
+              url: 'https://images.pix.fr/coolcat.jpg',
+              alt: 'alt',
+              alternativeText: 'alternativeText',
+              legend: 'legend',
+              licence: 'licence',
+              isBeta: false,
+            }),
+        )();
+
+        // then
+        expect(error).to.be.instanceOf(DomainError);
+        expect(error.message).to.equal('The image URL must be from "assets.pix.org" when module is production ready');
+      });
+    });
+  });
 });

api/tests/devcomp/unit/infrastructure/serializers/jsonapi/module-serializer_test.js

@@ -222,7 +222,7 @@ function getComponents() {
     new ComponentElement({
       element: new Image({
         id: '3',
-        url: 'url',
+        url: 'https://assets.pix.org/modules/placeholder-details.svg',
         alt: 'alt',
         alternativeText: 'alternativeText',
         licence: 'mon copyright',
@@ -399,7 +399,7 @@ function getAttributesComponents() {
         id: '3',
         isAnswerable: false,
         type: 'image',
-        url: 'url',
+        url: 'https://assets.pix.org/modules/placeholder-details.svg',
         legend: 'ma légende',
         licence: 'mon copyright',
       },