fix(error): remove global prototype toJSON (#1642) fixes #1414

Author: roggervalf

docs/gitbook/guide/jobs/removing-job.md

@@ -1,5 +1,3 @@
-# Removing job
-
 Sometimes it is necessary to remove a job. For example, there could be a job that has bad data.
 
 ```typescript

docs/gitbook/guide/jobs/repeatable.md

@@ -1,7 +1,3 @@
-# Repeatable
-
-## Repeatable
-
 There is a special type of _meta_ job called **repeatable**. These jobs are special in the sense that even though you only add one job to the queue, they will keep repeating according to a predefined schedule.
 
 Adding a job with the `repeat` option set will actually do two things immediately: create a Repeatable Job configuration, and schedule a regular delayed job for the job's first run. This first run will be scheduled "on the hour", that is if you create a job that repeats every 15 minutes at 4:07, the job will first run at 4:15, then 4:30, and so on.
@@ -100,7 +96,7 @@ await myQueue.add(
 );
 ```
 
-### Slow repeatable jobs
+## Slow repeatable jobs
 
 It is worth to mention the case where the repeatable frequency is greater than the time it takes to process a job.
 

src/classes/child-processor.ts

@@ -1,6 +1,6 @@
 import { promisify } from 'util';
 import { JobJson, ParentCommand, SandboxedJob } from '../interfaces';
-import { childSend } from '../utils';
+import { childSend, errorToJSON } from '../utils';
 
 enum ChildStatus {
  Idle,
@@ -38,7 +38,7 @@ export class ChildProcessor {
  this.status = ChildStatus.Errored;
  return childSend(process, {
  cmd: ParentCommand.InitFailed,
- err: <Error>err,
+ err: errorToJSON(err),
  });
  }
 
@@ -65,7 +65,7 @@ export class ChildProcessor {
  if (this.status !== ChildStatus.Idle) {
  return childSend(process, {
  cmd: ParentCommand.Error,
- err: new Error('cannot start a not idling child process'),
+ err: errorToJSON(new Error('cannot start a not idling child process')),
  });
  }
  this.status = ChildStatus.Started;
@@ -80,7 +80,7 @@ export class ChildProcessor {
  } catch (err) {
  await childSend(process, {
  cmd: ParentCommand.Failed,
- value: !(<Error>err).message ? new Error(<any>err) : err,
+ value: errorToJSON(!(<Error>err).message ? new Error(<any>err) : err),
  });
  } finally {
  this.status = ChildStatus.Idle;
@@ -101,24 +101,6 @@ export class ChildProcessor {
  }
 }
 
-// https://stackoverflow.com/questions/18391212/is-it-not-possible-to-stringify-an-error-using-json-stringify
-if (!('toJSON' in Error.prototype)) {
- Object.defineProperty(Error.prototype, 'toJSON', {
- value: function toJSONByBull() {
- const alt: any = {};
- const _this = this;
-
- Object.getOwnPropertyNames(_this).forEach(function (key) {
- alt[key] = _this[key];
- }, this);
-
- return alt;
- },
- configurable: true,
- writable: true,
- });
-}
-
 /**
  * Enhance the given job argument with some functions
  * that can be called from the sandboxed job processor.

src/classes/master.ts

@@ -1,7 +1,7 @@
 import { toString } from 'lodash';
 import { ChildProcessor } from './child-processor';
 import { ParentCommand, ChildCommand } from '../interfaces';
-import { childSend } from '../utils';
+import { childSend, errorToJSON } from '../utils';
 
 const childProcessor = new ChildProcessor();
 
@@ -31,7 +31,7 @@ process.on('uncaughtException', async (err: Error) => {
  }
  await childSend(process, {
  cmd: ParentCommand.Failed,
- value: err,
+ value: errorToJSON(err),
  });
 
  // An uncaughException leaves this process in a potentially undetermined state so

src/interfaces/child-message.ts

@@ -3,5 +3,5 @@ import { ParentCommand } from './parent-command';
 export interface ChildMessage {
  cmd: ParentCommand;
  value?: any;
- err?: Error;
+ err?: Record<string, any>;
 }

src/utils.ts

@@ -170,6 +170,16 @@ export const parseObjectValues = (obj: {
  return accumulator;
 };
 
+export const errorToJSON = (value: any): Record<string, any> => {
+ const error: Record<string, any> = {};
+
+ Object.getOwnPropertyNames(value).forEach(function (propName: string) {
+ error[propName] = value[propName];
+ });
+
+ return error;
+};
+
 export const WORKER_SUFFIX = '';
 
 export const QUEUE_EVENT_SUFFIX = ':qe';

tests/fixtures/fixture_processor_fail.js

@@ -6,8 +6,12 @@
 
 const delay = require('./delay');
 
+class TestError extends Error {
+ metadata = 'metadata';
+}
+
 module.exports = function (/*job*/) {
  return delay(500).then(() => {
- throw new Error('Manually failed processor');
+ throw new TestError('Manually failed processor');
  });
 };