test(errors): refactor error object and move toJson method to helpers

For whatever reason, this has not worked correctly for awhile

Author: danbucholtz

src/util/errors.spec.ts

@@ -5,39 +5,27 @@ describe('Errors', () => {
 
   describe('BuildError', () => {
 
-    /*it('should create BuildError from err object in constructor', () => {
-      const buildError = new BuildError();
-      buildError.hasBeenLogged = false;
-      buildError.message = 'message1';
+    it('should create BuildError from err object in constructor', () => {
+      const buildError = new BuildError('message1');
       buildError.name = 'name1';
       buildError.stack = 'stack1';
+      buildError.isFatal = true;
+      buildError.hasBeenLogged = true;
 
       const buildErrorCopy = new BuildError(buildError);
-
-      const json = buildErrorCopy.toJson();
-      expect(json.hasBeenLogged).toEqual(buildError.hasBeenLogged);
-      expect(json.message).toEqual(buildError.message);
-      expect(json.name).toEqual(buildError.name);
-      expect(json.stack).toEqual(buildError.stack);
+      expect(buildErrorCopy.message).toEqual(buildError.message);
+      expect(buildErrorCopy.message).toEqual('message1');
+      expect(buildErrorCopy.name).toEqual(buildError.name);
+      expect(buildErrorCopy.stack).toEqual(buildError.stack);
+      expect(buildErrorCopy.isFatal).toEqual(buildError.isFatal);
+      expect(buildErrorCopy.hasBeenLogged).toEqual(buildError.hasBeenLogged);
     });
 
-    it('should create json object', () => {
-      const buildError = new BuildError();
-      buildError.hasBeenLogged = false;
-      buildError.message = 'message';
-      buildError.name = 'name';
-      buildError.stack = 'stack';
-      const json = buildError.toJson();
-      expect(json.hasBeenLogged).toEqual(buildError.hasBeenLogged);
-      expect(json.message).toEqual(buildError.message);
-      expect(json.name).toEqual(buildError.name);
-      expect(json.stack).toEqual(buildError.stack);
-    });*/
-
-    it('should stop npm run test from cancelling', () => {
-
+    it('should create a default object', () => {
+      const buildError = new BuildError('message1');
+      expect(buildError.isFatal).toBeFalsy();
+      expect(buildError.hasBeenLogged).toBeFalsy();
     });
-
   });
 
 });

src/util/errors.ts

@@ -3,38 +3,16 @@ export class BuildError extends Error {
   hasBeenLogged = false;
   isFatal: boolean = false;
 
-  constructor(err?: any) {
-    super();
-
-    if (err) {
-      if (err.message) {
-        this.message = err.message;
-      } else if (err) {
-        this.message = err;
-      }
-      if (err.stack) {
-        this.stack = err.stack;
-      }
-      if (err.name) {
-        this.name = err.name;
-      }
-      if (typeof err.hasBeenLogged === 'boolean') {
-        this.hasBeenLogged = err.hasBeenLogged;
-      }
-      if (err.hasOwnProperty('isFatal')) {
-        this.isFatal = err.isFatal;
-      }
+  constructor(error: Error | string) {
+    super(error instanceof Error ? error.message : error);
+    if (error instanceof Error) {
+      this.message = error.message;
+      this.stack = error.stack;
+      this.name = error.name;
+      this.hasBeenLogged = (error as BuildError).hasBeenLogged;
+      this.isFatal = (error as BuildError).isFatal;
     }
   }
-
-  toJson() {
-    return {
-      message: this.message,
-      name: this.name,
-      stack: this.stack,
-      hasBeenLogged: this.hasBeenLogged
-    };
-  }
 }
 
 

src/util/helpers.spec.ts

@@ -1,3 +1,4 @@
+import { BuildError } from './errors';
 import * as helpers from './helpers';
 
 let originalEnv: any = null;
@@ -190,4 +191,21 @@ describe('helpers', () => {
       expect(helpers.replaceAll('hello $VAR world', '$VAR', undefined)).toEqual('hello  world');
     });
   });
+
+  describe('buildErrorToJson', () => {
+    it('should return a pojo', () => {
+      const buildError = new BuildError('message1');
+      buildError.name = 'name1';
+      buildError.stack = 'stack1';
+      buildError.isFatal = true;
+      buildError.hasBeenLogged = false;
+
+      const object = helpers.buildErrorToJson(buildError);
+      expect(object.message).toEqual('message1');
+      expect(object.name).toEqual(buildError.name);
+      expect(object.stack).toEqual(buildError.stack);
+      expect(object.isFatal).toEqual(buildError.isFatal);
+      expect(object.hasBeenLogged).toEqual(buildError.hasBeenLogged);
+    });
+  });
 });

src/util/helpers.ts

@@ -4,6 +4,7 @@ import { createReadStream, createWriteStream, ensureDir, readdir, readFile, read
 import * as osName from 'os-name';
 
 import * as Constants from './constants';
+import { BuildError } from './errors';
 import { BuildContext, DeepLinkConfigEntry, File, WebpackStats } from './interfaces';
 import { Logger } from '../logger/logger';
 
@@ -365,3 +366,13 @@ export function removeSuffix(input: string, suffix: string) {
 
   return input;
 }
+
+export function buildErrorToJson(buildError: BuildError) {
+  return {
+    message: buildError.message,
+    name: buildError.name,
+    stack: buildError.stack,
+    hasBeenLogged: buildError.hasBeenLogged,
+    isFatal: buildError.isFatal
+  };
+}