fix(exceptions): provide AggregateError polyfill

- prevent Exception#errors from always equaling undefined
- https://github.com/es-shims/AggregateError

Author: unicornware

package.json

@@ -22,7 +22,7 @@
     "bootstrap": ". ./.env && yarn prepack",
     "postinstall": "is-ci || chmod +x .husky/* && husky install",
     "prepack": "yarn workspaces foreach -iv --topological-dev run prepack",
-    "check:ci": "yarn check:types && yarn check:format && yarn check:style && yarn build --tarball && rimraf packages/*/*.tgz",
+    "check:ci": "yarn check:types && yarn check:format && yarn check:style && yarn test && yarn build --tarball && rimraf packages/*/*.tgz",
     "check:dedupe": "yarn dedupe --check",
     "check:format": "prettier --check .",
     "check:install": "yarn dlx @yarnpkg/doctor .",

packages/exceptions/.eslintrc.cjs

@@ -25,6 +25,7 @@ module.exports = {
           'firebase',
           'oauth',
           'parallelization',
+          'readonly',
           'resform',
           'saml',
           'satisfiable',

packages/exceptions/package.json

@@ -96,6 +96,8 @@
   },
   "dependencies": {
     "@flex-development/tutils": "4.2.3",
+    "@types/es-aggregate-error": "1.0.2",
+    "es-aggregate-error": "1.0.7",
     "lodash.isplainobject": "4.0.6",
     "lodash.omit": "4.5.0",
     "lodash.pick": "4.4.0"

packages/exceptions/src/exceptions/__tests__/base.exception.spec.ts

@@ -126,6 +126,12 @@ describe('unit:exceptions/Exception', () => {
         expect(Subject.message).toBe(expected)
       })
     })
+
+    describe('#name', () => {
+      it('should set #name to "Exception"', () => {
+        expect(new TestSubject().name).toBe('Exception')
+      })
+    })
   })
 
   describe('.findIdByCode', () => {

packages/exceptions/src/exceptions/__tests__/validation.exception.spec.ts

@@ -53,11 +53,12 @@ describe('unit:exceptions/ValidationException', () => {
     const { dto, expected } = testcase
 
     // Act
-    const result = new TestSubject('Model', { ...dto, errors: ERRORS }).toJSON()
+    const result = new TestSubject('Model', { ...dto, errors: ERRORS })
 
     // Expect
     expect(result.code).toBe(expected.code)
-    expect(result.data).toStrictEqual(expected.data)
+    expect(result.toJSON().data).toStrictEqual(expected.data)
     expect(result.message).toBe(expected.message)
+    expect(result.name).toBe('ValidationException')
   })
 })

packages/exceptions/src/exceptions/base.exception.ts

@@ -16,6 +16,7 @@ import {
   NextError
 } from '@packages/exceptions/interfaces'
 import { ExceptionData, ExceptionErrors } from '@packages/exceptions/types'
+import AggregateError from 'es-aggregate-error'
 import omit from 'lodash.omit'
 import pick from 'lodash.pick'
 import { DEM } from './constants.exceptions'
@@ -35,29 +36,41 @@ import { DEM } from './constants.exceptions'
 // eslint-disable-next-line unicorn/custom-error-definition
 export default class Exception<T = any> extends AggregateError {
   /**
+   * @readonly
    * @property {ExceptionErrors<T>} errors - Aggregated errors
    */
-  override errors: ExceptionErrors<T>
+  declare readonly errors: ExceptionErrors<T>
 
   /**
+   * @readonly
+   * @property {'Exception'} name - Constructor name
+   */
+  // @ts-expect-error '"Exception"' is not assignable to type '"AggregateError"
+  override readonly name: 'Exception' = 'Exception'
+
+  /**
+   * @readonly
    * @property {ExceptionClassName} className - Associated CSS class name
    */
-  className: ExceptionClassName
+  readonly className: ExceptionClassName
 
   /**
+   * @readonly
    * @property {ExceptionCode} code - HTTP error response status code
    */
-  code: ExceptionCode
+  readonly code: ExceptionCode
 
   /**
+   * @readonly
    * @property {ExceptionData} data - Custom error data
    */
-  data: ExceptionData
+  readonly data: ExceptionData
 
   /**
+   * @readonly
    * @property {ExceptionId} id - HTTP error response status code name
    */
-  id: ExceptionId
+  readonly id: ExceptionId
 
   /**
    * Instantiates a new Exception.
@@ -77,7 +90,6 @@ export default class Exception<T = any> extends AggregateError {
   ) {
     super([data.errors || []].flat(), data.message || message || DEM)
 
-    this.name = 'Exception'
     this.code = Exception.formatCode(code)
     this.data = omit(data, ['errors', 'message'])
     this.id = Exception.findIdByCode(this.code)

packages/exceptions/src/exceptions/validation.exception.ts

@@ -19,9 +19,17 @@ import Exception from './base.exception'
  */
 export default class ValidationException extends Exception<ValidationError> {
   /**
+   * @readonly
    * @property {ValidationExceptionErrors} errors - Aggregated validation errors
    */
-  declare errors: ValidationExceptionErrors
+  declare readonly errors: ValidationExceptionErrors
+
+  /**
+   * @readonly
+   * @property {'ValidationException'} name - Constructor name
+   */
+  // @ts-expect-error '"ValidationException"' !== '"Exception"
+  override readonly name: 'ValidationException' = 'ValidationException'
 
   /**
    * Instantiates a new `ValidationException`.
@@ -50,11 +58,13 @@ export default class ValidationException extends Exception<ValidationError> {
 
     // Set message if custom message wasn't provided
     if (!dto.message) {
-      this.message = `${model} validation failure`
+      let message = `${model} validation failure`
 
       if (this.errors.length > 0) {
-        this.message += `: [${this.errors.map(e => e.property)}]`
+        message += `: [${this.errors.map(error => error.property)}]`
       }
+
+      Object.assign(this, { message })
     }
   }
 }

packages/exceptions/src/types/exception-errors.type.ts

@@ -8,4 +8,4 @@
  *
  * @template T - Error type
  */
-export type ExceptionErrors<T = any> = Array<T>
+export type ExceptionErrors<T = any> = ReadonlyArray<T>

yarn.lock

@@ -839,6 +839,7 @@ __metadata:
     "@jest/types": 27.2.5
     "@packages/exceptions": "link:src"
     "@tests/utils": "link:../../__tests__/utils"
+    "@types/es-aggregate-error": 1.0.2
     "@types/faker": 5.5.9
     "@types/jest": 27.0.2
     "@types/lodash.isplainobject": 4.0.6
@@ -848,6 +849,7 @@ __metadata:
     "@vates/toggle-scripts": 1.0.0
     axios: 0.24.0
     class-validator: 0.13.1
+    es-aggregate-error: 1.0.7
     faker: 5.5.3
     firebase-admin: 10.0.0
     jest: 27.3.1
@@ -1940,6 +1942,15 @@ __metadata:
   languageName: node
   linkType: hard
 
+"@types/es-aggregate-error@npm:1.0.2":
+  version: 1.0.2
+  resolution: "@types/es-aggregate-error@npm:1.0.2"
+  dependencies:
+    "@types/node": "*"
+  checksum: 076fd59b595f33c8c7e7eb68ec55bd43cf8b2cf7bbc6778e25d7ae1a5fa0538a0a56f149015f403d7bbcefe59f1d8182351685b59c1fe719fd46d0dd8a9737fa
+  languageName: node
+  linkType: hard
+
 "@types/express-jwt@npm:0.0.42":
   version: 0.0.42
   resolution: "@types/express-jwt@npm:0.0.42"
@@ -4120,6 +4131,20 @@ __metadata:
   languageName: node
   linkType: hard
 
+"es-aggregate-error@npm:1.0.7":
+  version: 1.0.7
+  resolution: "es-aggregate-error@npm:1.0.7"
+  dependencies:
+    define-properties: ^1.1.3
+    es-abstract: ^1.19.0
+    function-bind: ^1.1.1
+    functions-have-names: ^1.2.2
+    get-intrinsic: ^1.1.1
+    globalthis: ^1.0.2
+  checksum: 16b89fefdf56c0478cd21577249156cf83e44c2220c057cbfddd99c01e15e03d6d90a85ce73dece4728a5bfcb022dc160e04a66b1f83a620f140842c6f8325f9
+  languageName: node
+  linkType: hard
+
 "es-to-primitive@npm:^1.2.1":
   version: 1.2.1
   resolution: "es-to-primitive@npm:1.2.1"
@@ -4975,6 +5000,13 @@ fsevents@^2.3.2:
   languageName: node
   linkType: hard
 
+"functions-have-names@npm:^1.2.2":
+  version: 1.2.2
+  resolution: "functions-have-names@npm:1.2.2"
+  checksum: 25f44b6d1c41ac86ffdf41f25d1de81c0a5b4a3fcf4307a33cdfb23b9d4bd5d0d8bf312eaef5ad368c6500c8a9e19f692b8ce9f96aaab99db9dd936554165558
+  languageName: node
+  linkType: hard
+
 "gauge@npm:~2.7.3":
   version: 2.7.4
   resolution: "gauge@npm:2.7.4"
@@ -5222,6 +5254,15 @@ fsevents@^2.3.2:
   languageName: node
   linkType: hard
 
+"globalthis@npm:^1.0.2":
+  version: 1.0.2
+  resolution: "globalthis@npm:1.0.2"
+  dependencies:
+    define-properties: ^1.1.3
+  checksum: 5a5f3c7ab94708260a98106b35946b74bb57f6b2013e39668dc9e8770b80a3418103b63a2b4aa01c31af15fdf6a2940398ffc0a408573c34c2304f928895adff
+  languageName: node
+  linkType: hard
+
 "globby@npm:^11.0.4":
   version: 11.0.4
   resolution: "globby@npm:11.0.4"