removing undefined from headers refactoring

Author: MrRefactoring

CHANGELOG.md

@@ -1,5 +1,13 @@
 # Jira.js changelog
 
+### 1.7.2
+
+- FIX: console.log removed
+
+### 1.7.1
+
+- FIX: Headers fixes
+
 ### 1.7.0
 
 - IMPROVEMENT: Readme examples updated

package.json

@@ -28,16 +28,16 @@
   "devDependencies": {
     "@types/jest": "^26.0.14",
     "@types/node": "^14.11.2",
-    "@types/sinon": "^9.0.6",
+    "@types/sinon": "^9.0.7",
     "@typescript-eslint/eslint-plugin": "^4.3.0",
     "@typescript-eslint/parser": "^4.3.0",
     "eslint": "^7.10.0",
     "eslint-config-airbnb-typescript": "^11.0.0",
     "eslint-import-resolver-typescript": "^2.3.0",
     "eslint-plugin-import": "^2.22.1",
     "jest": "^26.4.2",
-    "sinon": "^9.0.3",
-    "ts-jest": "^26.4.0",
+    "sinon": "^9.1.0",
+    "ts-jest": "^26.4.1",
     "typedoc": "^0.19.2",
     "typescript": "^4.0.3"
   },

src/helpers/index.ts

@@ -3,17 +3,6 @@ import * as jwt from 'atlassian-jwt';
 import * as url from 'url';
 import { Config } from '../config';
 
-export const removeEmptyValues = (obj: { [key: string]: unknown }) => Object.entries(obj)
-  .forEach(([key, val]) => {
-    if (val && typeof val === 'object') {
-      // @ts-ignore
-      removeEmptyValues(val);
-    } else if (val == null) {
-      // eslint-disable-next-line no-param-reassign
-      delete obj[key];
-    }
-  });
-
 export const getAuthentication = (
   config: Config,
   request: AxiosRequestConfig,

src/index.ts

@@ -3,7 +3,8 @@
 import axios, { AxiosInstance, AxiosRequestConfig } from 'axios';
 import { Callback } from './callback';
 import { Config } from './config';
-import { getAuthentication, removeEmptyValues } from './helpers';
+import { getAuthentication } from './helpers';
+import * as Utils from './utils';
 import {
   ApplicationRoles,
   AppProperties,
@@ -188,12 +189,10 @@ export class Client {
   private requestInstance: AxiosInstance;
 
   constructor(private readonly config: Config) {
-    const headers = {
+    const headers = Utils.removeUndefinedElements({
       ...config.baseRequestConfig?.headers,
       'x-atlassian-force-account-id': config.strictGDPR,
-    };
-
-    removeEmptyValues(headers);
+    });
 
     this.requestInstance = axios.create({
       timeout: config.timeout,
@@ -293,12 +292,10 @@ export class Client {
 
   public async sendRequest(request: AxiosRequestConfig, callback?: Callback): Promise<any> {
     try {
-      request.headers = {
+      request.headers = Utils.removeUndefinedElements({
         Authorization: getAuthentication(this.config, request),
         ...request.headers,
-      };
-
-      removeEmptyValues(request.headers);
+      });
 
       const response = await this.requestInstance.request(request);
 

src/utils/index.ts

@@ -0,0 +1 @@
+export * from './removeUndefinedElements';

src/utils/removeUndefinedElements.ts

@@ -0,0 +1,52 @@
+function removeUndefinedFromArray<T>(array: Array<T>): Array<T> {
+  return array.filter((element) => element !== undefined);
+}
+
+function removeUndefinedFromObject<T>(object: Record<string, T>): Record<string, T> {
+  return Object.entries(object).reduce((accumulator, current) => {
+    const [key, value] = current;
+
+    if (value === undefined) {
+      return accumulator;
+    }
+
+    const isObject = typeof value === 'object';
+    const isNull = value === null;
+    const isSet = value instanceof Set;
+    const isMap = value instanceof Map;
+
+    if (
+      !isNull
+      && isObject
+      && !isSet
+      && !isMap
+    ) {
+      return {
+        ...accumulator,
+        [key]: Array.isArray(value)
+          ? removeUndefinedFromArray(value)
+          : removeUndefinedFromObject(value as Record<string, unknown>),
+      };
+    }
+
+    return {
+      ...accumulator,
+      [key]: value,
+    };
+  }, {});
+}
+
+export function removeUndefinedElements<T>(o: Array<T>): Array<T>;
+export function removeUndefinedElements<T>(o: Record<string, T>): Record<string, T>;
+export function removeUndefinedElements(o: any): any {
+  switch (typeof o) {
+    case 'object':
+      if (Array.isArray(o)) {
+        return removeUndefinedFromArray(o);
+      }
+
+      return removeUndefinedFromObject(o);
+    default:
+      return o;
+  }
+}

tests/utils/removeUndefinedElements.test.ts

@@ -0,0 +1,66 @@
+import { removeUndefinedElements } from '../../src/utils';
+
+describe('Utils: removeUndefinedElements', () => {
+  it('should return empty object for empty object', () => {
+    const originalObject: {} = {};
+    const expectedObject: {} = {};
+
+    const actualObject = removeUndefinedElements(originalObject);
+
+    expect(actualObject).toEqual(expectedObject);
+  });
+
+  it('should return empty array for empty array', () => {
+    const originalArray: [] = [];
+    const expectedArray: [] = [];
+
+    const actualArray = removeUndefinedElements(originalArray);
+
+    expect(actualArray).toEqual(expectedArray);
+  });
+
+  it('shouldn\'t remove any element', () => {
+    const originalObject = {
+      key1: 'stringValue',
+      emptyString: '',
+      nullValue: null,
+      falseBooleanValue: false,
+      trueBooleanValue: true,
+      map: new Map(),
+      set: new Set(),
+      emptyArray: [],
+      number: 0,
+      arrayWithNullElements: [null, null],
+      arrayWithEmptyString: [''],
+      arrayWithStrings: ['string1', 'string2'],
+    };
+
+    const expectedObject = {
+      key1: 'stringValue',
+      emptyString: '',
+      nullValue: null,
+      falseBooleanValue: false,
+      trueBooleanValue: true,
+      map: new Map(),
+      set: new Set(),
+      emptyArray: [],
+      number: 0,
+      arrayWithNullElements: [null, null],
+      arrayWithEmptyString: [''],
+      arrayWithStrings: ['string1', 'string2'],
+    };
+
+    const actualObject = removeUndefinedElements(originalObject);
+
+    expect(actualObject).toEqual(expectedObject);
+  });
+
+  it('should remove undefined elements from array', () => {
+    const originalArray = [undefined, 'someString', 3, undefined, '', null, undefined, undefined];
+    const expectedArray = ['someString', 3, '', null];
+
+    const actualArray = removeUndefinedElements(originalArray);
+
+    expect(actualArray).toEqual(expectedArray);
+  });
+});

yarn.lock

@@ -703,10 +703,10 @@
     "@types/express-serve-static-core" "*"
     "@types/mime" "*"
 
-"@types/sinon@^9.0.6":
-  version "9.0.6"
-  resolved "https://registry.yarnpkg.com/@types/sinon/-/sinon-9.0.6.tgz#fb4b6883fe0417e6a1ac5d9753bdcb7016dd4dd0"
-  integrity sha512-j3GK0fiHgn8fe7sqOpInMjm0A2Tary1NBZ8gbI/sZ0C0JxYeO+nh8H0/pW/0l94vNWcH1FnZOZu/cOvIfNZTrg==
+"@types/sinon@^9.0.7":
+  version "9.0.7"
+  resolved "https://registry.yarnpkg.com/@types/sinon/-/sinon-9.0.7.tgz#c277e19cf9eb0c71106e785650f1e5c299262302"
+  integrity sha512-uyFiy2gp4P/FK9pmU3WIbT5ZzH54hCswwRkQFhxX7xl8jzhW3g+xOkVqk5YP4cIO//Few8UDAX0MtzFpqBEqwA==
   dependencies:
     "@types/sinonjs__fake-timers" "*"
 
@@ -4137,10 +4137,10 @@ signal-exit@^3.0.0, signal-exit@^3.0.2:
   resolved "https://registry.yarnpkg.com/signal-exit/-/signal-exit-3.0.3.tgz#a1410c2edd8f077b08b4e253c8eacfcaf057461c"
   integrity sha512-VUJ49FC8U1OxwZLxIbTTrDvLnf/6TDgxZcK8wxR8zs13xpx7xbG60ndBlhNrFi2EMuFRoeDoJO7wthSLq42EjA==
 
-sinon@^9.0.3:
-  version "9.0.3"
-  resolved "https://registry.yarnpkg.com/sinon/-/sinon-9.0.3.tgz#bffc3ec28c936332cd2a41833547b9eed201ecff"
-  integrity sha512-IKo9MIM111+smz9JGwLmw5U1075n1YXeAq8YeSFlndCLhAL5KGn6bLgu7b/4AYHTV/LcEMcRm2wU2YiL55/6Pg==
+sinon@^9.1.0:
+  version "9.1.0"
+  resolved "https://registry.yarnpkg.com/sinon/-/sinon-9.1.0.tgz#4afc90707c8e360fe051398eed2d3b197980ffc3"
+  integrity sha512-9zQShgaeylYH6qtsnNXlTvv0FGTTckuDfHBi+qhgj5PvW2r2WslHZpgc3uy3e/ZAoPkqaOASPi+juU6EdYRYxA==
   dependencies:
     "@sinonjs/commons" "^1.7.2"
     "@sinonjs/fake-timers" "^6.0.1"
@@ -4522,10 +4522,10 @@ tr46@^2.0.2:
   dependencies:
     punycode "^2.1.1"
 
-ts-jest@^26.4.0:
-  version "26.4.0"
-  resolved "https://registry.yarnpkg.com/ts-jest/-/ts-jest-26.4.0.tgz#903c7827f3d3bc33efc2f91be294b164400c32e3"
-  integrity sha512-ofBzoCqf6Nv/PoWb/ByV3VNKy2KJSikamOBxvR3E6eVdIw10GwAXoyvMWXXjZJK2s6S27ZE8fI+JBTnGaovl6Q==
+ts-jest@^26.4.1:
+  version "26.4.1"
+  resolved "https://registry.yarnpkg.com/ts-jest/-/ts-jest-26.4.1.tgz#08ec0d3fc2c3a39e4a46eae5610b69fafa6babd0"
+  integrity sha512-F4aFq01aS6mnAAa0DljNmKr/Kk9y4HVZ1m6/rtJ0ED56cuxINGq3Q9eVAh+z5vcYKe5qnTMvv90vE8vUMFxomg==
   dependencies:
     "@types/jest" "26.x"
     bs-logger "0.x"