feat(api): add hasFixableError on OrganizationImportDetail

Author: lionelB

api/src/prescription/learner-management/domain/read-models/OrganizationImportDetail.js

@@ -10,4 +10,7 @@ export class OrganizationImportDetail {
       lastName,
     };
   }
+  get hasFixableErrors() {
+    return this.errors.some((error) => error.code || error.name === 'AggregateImportError');
+  }
 }

api/src/prescription/learner-management/infrastructure/serializers/jsonapi/organization-import-detail-serializer.js

@@ -1,10 +1,15 @@
 import jsonapiSerializer from 'jsonapi-serializer';
+import omit from 'lodash/omit.js';
 
 const { Serializer } = jsonapiSerializer;
 
 const serialize = function (organizationImportDetail, meta) {
   return new Serializer('organization-import-detail', {
-    attributes: ['id', 'status', 'errors', 'createdBy', 'createdAt', 'updatedAt'],
+    attributes: ['id', 'status', 'errors', 'hasFixableErrors', 'createdBy', 'createdAt', 'updatedAt'],
+    transform: function (record) {
+      record.errors = record.errors.map((error) => omit(error, 'stack'));
+      return record;
+    },
     meta,
   }).serialize(organizationImportDetail);
 };

api/tests/prescription/learner-management/unit/domain/read-models/OrganizationImportDetail_test.js

@@ -1,4 +1,8 @@
 import { IMPORT_STATUSES } from '../../../../../../src/prescription/learner-management/domain/constants.js';
+import {
+  AggregateImportError,
+  SiecleXmlImportError,
+} from '../../../../../../src/prescription/learner-management/domain/errors.js';
 import { OrganizationImportDetail } from '../../../../../../src/prescription/learner-management/domain/read-models/OrganizationImportDetail.js';
 import { expect } from '../../../../../test-helper.js';
 
@@ -32,4 +36,46 @@ describe('Unit | Models | OrganizationImportDetail', function () {
 
     expect(organizationImportDetail).to.eql(expected);
   });
+
+  describe('hasFixableErrors', function () {
+    let data;
+
+    beforeEach(function () {
+      data = {
+        id: 1,
+        status: IMPORT_STATUSES.VALIDATION_ERROR,
+        updatedAt: new Date('2023-01-02'),
+        firstName: 'Tomie',
+        lastName: 'Katana',
+        organizationId: 1,
+        createdBy: 12,
+        createdAt: new Date('2023-01-01'),
+      };
+    });
+
+    it('should return true if error is AggregateImportError', function () {
+      const organizationImportDetail = new OrganizationImportDetail({
+        ...data,
+        errors: [new AggregateImportError([new Error('oups')])],
+      });
+      expect(organizationImportDetail.hasFixableErrors).to.be.true;
+    });
+
+    it('should return true if error has a code property', function () {
+      const organizationImportDetail = new OrganizationImportDetail({
+        ...data,
+        errors: [new SiecleXmlImportError('oups')],
+      });
+      expect(organizationImportDetail.hasFixableErrors).to.be.true;
+    });
+
+    it("should return false if errors doesn't contains DomainError", function () {
+      const organizationImportDetail = new OrganizationImportDetail({
+        ...data,
+        errors: [new Error('oups')],
+      });
+
+      expect(organizationImportDetail.hasFixableErrors).to.be.false;
+    });
+  });
 });

api/tests/prescription/learner-management/unit/infrastructure/serializers/jsonapi/organization-import-detail-serializer_test.js

@@ -1,4 +1,5 @@
 import { IMPORT_STATUSES } from '../../../../../../../src/prescription/learner-management/domain/constants.js';
+import { SiecleXmlImportError } from '../../../../../../../src/prescription/learner-management/domain/errors.js';
 import { OrganizationImportDetail } from '../../../../../../../src/prescription/learner-management/domain/read-models/OrganizationImportDetail.js';
 import { serialize } from '../../../../../../../src/prescription/learner-management/infrastructure/serializers/jsonapi/organization-import-detail-serializer.js';
 import { CsvImportError } from '../../../../../../../src/shared/domain/errors.js';
@@ -31,6 +32,39 @@ describe('Unit | Serializer | JSONAPI | organization-import-detail-serializer',
             'created-at': createdAt,
             'created-by': { firstName: 'Richard', lastName: 'Aldana' },
             errors: [{ code: 'header', name: 'CsvImportError', meta: { line: 3 } }],
+            'has-fixable-errors': true,
+          },
+        },
+      });
+    });
+
+    it('should remove stack trace informations from errors', function () {
+      // given
+      const updatedAt = new Date();
+      const createdAt = new Date();
+
+      const organizationImport = new OrganizationImportDetail({
+        id: 1,
+        status: IMPORT_STATUSES.VALIDATION_ERROR,
+        firstName: 'Richard',
+        lastName: 'Aldana',
+        // use object spread to mimic what is saved in db
+        errors: [{ ...new SiecleXmlImportError('plop', 'line 2'), stack: 'Error stack' }],
+        updatedAt,
+        createdAt,
+      });
+      expect(serialize(organizationImport)).to.eql({
+        data: {
+          id: '1',
+          type: 'organization-import-details',
+          attributes: {
+            id: 1,
+            status: IMPORT_STATUSES.VALIDATION_ERROR,
+            'updated-at': updatedAt,
+            'created-at': createdAt,
+            'created-by': { firstName: 'Richard', lastName: 'Aldana' },
+            errors: [{ code: 'plop', meta: 'line 2', name: 'SiecleXmlImportError' }],
+            'has-fixable-errors': true,
           },
         },
       });