feat: reverse stacktraces in extended errors

namecheap · Oct 2, 2024 · 5560fb8 · 5560fb8
1 parent e0582a4
commit 5560fb8
Show file tree

Hide file tree

Showing 18 changed files with 38 additions and 29 deletions.
diff --git a/ilc/client/registry/errors.js b/ilc/client/registry/errors.js
@@ -1,4 +1,4 @@
-import extendError from '@namecheap/error-extender';
+import { extendError } from '../../common/utils';
 
 const errors = {};
 errors.RegistryError = extendError('RegistryError');

diff --git a/ilc/common/CacheWrapper.js b/ilc/common/CacheWrapper.js
@@ -1,5 +1,4 @@
-const extendError = require('@namecheap/error-extender');
-const { withTimeout } = require('./utils');
+const { withTimeout, extendError } = require('./utils');
 
 const errors = {};
 errors.CacheWrapperError = extendError('CacheWrapperError', { defaultData: {} });

diff --git a/ilc/common/guard/errors.js b/ilc/common/guard/errors.js
@@ -1,4 +1,4 @@
-const extendError = require('@namecheap/error-extender');
+const { extendError } = require('../utils');
 
 const errors = {};
 

diff --git a/ilc/common/router/errors.js b/ilc/common/router/errors.js
@@ -1,4 +1,4 @@
-const extendError = require('@namecheap/error-extender');
+const { extendError } = require('../utils');
 
 const errors = {};
 errors.RouterError = extendError('RouterError', { defaultData: {} });

diff --git a/ilc/common/utils.js b/ilc/common/utils.js
@@ -1,3 +1,4 @@
+const errorExtender = require('@namecheap/error-extender');
 const deepmerge = require('deepmerge');
 
 function appIdToNameAndSlot(appId) {
@@ -76,6 +77,10 @@ async function withTimeout(promise, ms, message = 'Promise timeout') {
     return Promise.race([decoratedPromise, timeoutPromise]);
 }
 
+function extendError(name, options = {}) {
+    return errorExtender(name, { ...options, inverse: true });
+}
+
 module.exports = {
     appIdToNameAndSlot,
     makeAppId,
@@ -88,4 +93,5 @@ module.exports = {
     addTrailingSlashToPath,
     withTimeout,
     TimeoutError,
+    extendError,
 };
diff --git a/ilc/package-lock.json b/ilc/package-lock.json
diff --git a/ilc/package.json b/ilc/package.json
@@ -20,7 +20,7 @@
   "author": "",
   "license": "Apache-2.0",
   "dependencies": {
-    "@namecheap/error-extender": "^2.2.0",
+    "@namecheap/error-extender": "^2.2.1",
     "@namecheap/tailorx": "^8.1.0",
     "@newrelic/native-metrics": "^11.0.0",
     "agentkeepalive": "^4.5.0",

diff --git a/ilc/server/errorHandler/ErrorHandler.js b/ilc/server/errorHandler/ErrorHandler.js
@@ -3,7 +3,7 @@ const path = require('path');
 const { StatusCodes, getReasonPhrase } = require('http-status-codes');
 const safeJsonStringify = require('safe-json-stringify');
 const uuidv4 = require('uuid/v4');
-const extendError = require('@namecheap/error-extender');
+const { extendError } = require('../../common/utils');
 const config = require('config');
 const { readFileSync } = require('fs');
 const { setErrorData } = require('../utils/helpers');

diff --git a/ilc/server/registry/errors.ts b/ilc/server/registry/errors.ts
@@ -1,4 +1,4 @@
-import extendError from '@namecheap/error-extender';
+import { extendError } from '../../common/utils';
 
 export const RegistryError = extendError('RegistryError', { defaultData: {} });
 export const ValidationRegistryError = extendError('ValidationRegistryError', {

diff --git a/ilc/server/tailor/errors.js b/ilc/server/tailor/errors.js
@@ -1,4 +1,4 @@
-const extendError = require('@namecheap/error-extender');
+const { extendError } = require('../../common/utils');
 
 const errors = {};
 errors.TailorError = extendError('TailorError', { defaultData: {} });

diff --git a/registry/package-lock.json b/registry/package-lock.json
diff --git a/registry/package.json b/registry/package.json
@@ -65,7 +65,7 @@
         "typescript": "^5.6.2"
     },
     "dependencies": {
-        "@namecheap/error-extender": "^2.2.0",
+        "@namecheap/error-extender": "^2.2.1",
         "@newrelic/native-metrics": "^11.0.0",
         "axios": "^1.7.7",
         "bcrypt": "^5.1.1",

diff --git a/registry/server/errorHandler/httpErrors.ts b/registry/server/errorHandler/httpErrors.ts
@@ -1,4 +1,4 @@
-import extendError from '@namecheap/error-extender';
+import { extendError } from '../util/extendError';
 
 export const HttpError = extendError('HttpError', { defaultData: {} });
 export const NotFoundError = extendError('NotFoundError', {

diff --git a/registry/server/templates/errors.ts b/registry/server/templates/errors.ts
@@ -1,6 +1,6 @@
-import errorExtender from '@namecheap/error-extender';
+import { extendError } from '../util/extendError';
 
 export default {
-    FetchIncludeError: errorExtender('FetchIncludeError', { defaultData: {} }),
-    InvalidTemplateError: errorExtender('InvalidTemplateError', { defaultData: {} }),
+    FetchIncludeError: extendError('FetchIncludeError', { defaultData: {} }),
+    InvalidTemplateError: extendError('InvalidTemplateError', { defaultData: {} }),
 };
diff --git a/registry/server/util/axiosErrorTransformer.ts b/registry/server/util/axiosErrorTransformer.ts
@@ -1,7 +1,7 @@
-import errorExtender from '@namecheap/error-extender';
-import type { AxiosError } from 'axios';
+import { type AxiosError } from 'axios';
+import { extendError } from './extendError';
 
-const IlcAxiosError = errorExtender('AxiosError');
+const IlcAxiosError = extendError('AxiosError');
 
 export function isAxiosError(err: unknown): err is AxiosError {
     return Boolean((err as AxiosError)?.isAxiosError);

diff --git a/registry/server/util/extendError.ts b/registry/server/util/extendError.ts
@@ -0,0 +1,5 @@
+import errorExtender, { type ExtendConfig } from '@namecheap/error-extender';
+
+export function extendError<T = any>(name: string, options: ExtendConfig<T> = {}) {
+    return errorExtender(name, { ...options, inverse: true });
+}
diff --git a/registry/server/versioning/errors.ts b/registry/server/versioning/errors.ts
@@ -1,4 +1,4 @@
-import extendError from '@namecheap/error-extender';
+import { extendError } from '../util/extendError';
 
 export const VersioningError = extendError('VersioningError', { defaultData: {} });
 export const NonRevertableError = extendError<{ reason: string }>('NonRevertableError', { parent: VersioningError });

diff --git a/registry/tests/logging.spec.ts b/registry/tests/logging.spec.ts
@@ -1,13 +1,12 @@
 import sinon, { SinonSpy } from 'sinon';
 import supertest from 'supertest';
 
-import errorExtender from '@namecheap/error-extender';
-
 import createApplication from '../server/app';
 import { getLogger } from '../server/util/logger';
 import { getPluginManagerInstance, loadPlugins } from '../server/util/pluginManager';
 
 import type { Handler } from 'express';
+import { extendError } from '../server/util/extendError';
 
 async function runScenario(handler: Handler) {
     const app = await createApplication(true);
@@ -96,7 +95,7 @@ describe('Logging', () => {
 
     it('should log extended error json format', async () => {
         const logObjectHandler: Handler = (req, res, next) => {
-            const CustomError = errorExtender('Custom');
+            const CustomError = extendError('Custom');
             try {
                 getLogger().error(new CustomError({ message: 'desc', data: { a: 1 }, cause: new Error('cause') }));
             } catch (e) {