✨ Implement support for custom logger with loglevel as default one

Author: cermakjiri

packages/@ackee/antonio-core/src/index.ts

@@ -1,2 +1,2 @@
 export { create as default } from './modules/core';
-export type { DefaultRequestConfig } from './modules/core/types';
+export type { DefaultRequestConfig } from './types';

packages/@ackee/antonio-core/src/modules/core/config/index.ts

@@ -1,7 +1,13 @@
 import Headers from 'fetch-headers';
-import { DefaultRequestConfig } from '../types';
+import loglevel from 'loglevel';
+
+import { DefaultRequestConfig, GeneralConfig } from '../../../types';
 
 export const defaultRequestConfig: DefaultRequestConfig = {
     responseType: 'json',
     headers: new Headers(),
 };
+
+export const defaultGeneralConfig: GeneralConfig = {
+    logger: loglevel,
+};

packages/@ackee/antonio-core/src/modules/core/create.ts

@@ -1,7 +1,7 @@
-import { RequestConfig } from './types';
+import { RequestConfig, GeneralConfig } from '../../types';
 
 import HttpClient from './models/HttpClient';
 
-export function create(requestConfig?: RequestConfig) {
-    return new HttpClient(requestConfig);
+export default function create(requestConfig?: RequestConfig, generalConfig?: Partial<GeneralConfig>) {
+    return new HttpClient(requestConfig, generalConfig);
 }

packages/@ackee/antonio-core/src/modules/core/destroy.ts

@@ -0,0 +1,5 @@
+import HttpClient, { generalConfigs } from './models/HttpClient';
+
+export default function destroy(httpClient: HttpClient) {
+    return generalConfigs.delete(httpClient);
+}

packages/@ackee/antonio-core/src/modules/core/index.ts

@@ -1,2 +1,3 @@
 export { default } from './models/HttpClient';
-export * from './create';
+export { default as create } from './create';
+export { default as destroy } from './destroy';

packages/@ackee/antonio-core/src/modules/core/models/HttpClient.ts

@@ -1,42 +1,50 @@
-import { RequestConfig, RequestBody } from '../types';
-import { defaultRequestConfig } from '../config';
-import { mergeConfig } from '../utils';
+import { RequestConfig, RequestBody, GeneralConfig } from '../../../types';
+import { defaultRequestConfig, defaultGeneralConfig } from '../config';
+import { mergeRequestConfigs } from '../utils';
 
 import request from '../request';
 
+export const generalConfigs = new WeakMap();
 class HttpClient {
     readonly defaults: RequestConfig;
+    readonly config: GeneralConfig;
 
-    constructor(customRequestConfig?: RequestConfig) {
-        this.defaults = Object.freeze<RequestConfig>(mergeConfig(defaultRequestConfig, customRequestConfig));
+    constructor(requestConfig?: RequestConfig, generalConfig?: Partial<GeneralConfig>) {
+        this.defaults = Object.freeze<RequestConfig>(mergeRequestConfigs(defaultRequestConfig, requestConfig));
+
+        const config = Object.freeze<GeneralConfig>({
+            ...defaultGeneralConfig,
+            ...generalConfig,
+        });
+        generalConfigs.set(this, config);
     }
 
     post(url: string, body: RequestBody, requestConfig?: RequestConfig) {
-        return request('post', url, body, requestConfig, this.defaults);
+        return request('post', url, body, requestConfig, this.defaults, generalConfigs.get(this));
     }
 
     put(url: string, body: RequestBody, requestConfig?: RequestConfig) {
-        return request('put', url, body, requestConfig, this.defaults);
+        return request('put', url, body, requestConfig, this.defaults, generalConfigs.get(this));
     }
 
     patch(url: string, body: RequestBody, requestConfig?: RequestConfig) {
-        return request('patch', url, body, requestConfig, this.defaults);
+        return request('patch', url, body, requestConfig, this.defaults, generalConfigs.get(this));
     }
 
     get(url: string, requestConfig?: RequestConfig) {
-        return request('get', url, undefined, requestConfig, this.defaults);
+        return request('get', url, undefined, requestConfig, this.defaults, generalConfigs.get(this));
     }
 
     delete(url: string, requestConfig?: RequestConfig) {
-        return request('delete', url, undefined, requestConfig, this.defaults);
+        return request('delete', url, undefined, requestConfig, this.defaults, generalConfigs.get(this));
     }
 
     head(url: string, requestConfig?: RequestConfig) {
-        return request('head', url, undefined, requestConfig, this.defaults);
+        return request('head', url, undefined, requestConfig, this.defaults, generalConfigs.get(this));
     }
 
     options(url: string, requestConfig?: RequestConfig) {
-        return request('options', url, undefined, requestConfig, this.defaults);
+        return request('options', url, undefined, requestConfig, this.defaults, generalConfigs.get(this));
     }
 }
 

packages/@ackee/antonio-core/src/modules/core/request.ts

@@ -1,17 +1,18 @@
-import { RequestMethod, RequestConfig, RequestResult } from './types';
+import { RequestMethod, RequestConfig, RequestResult, GeneralConfig } from '../../types';
 import { HTTPError } from './errors';
-import { createRequestUrl, formatRequestBody, setRequestHeaders, parseResponse, mergeConfig } from './utils';
+import { createRequestUrl, formatRequestBody, setRequestHeaders, parseResponse, mergeRequestConfigs } from './utils';
 
 export default async function request(
     method: RequestMethod,
     requestUrl: string,
     body: BodyInit | undefined,
     requestConfig: RequestConfig | undefined,
     defaultRequestConfig: RequestConfig,
+    generalConfig: GeneralConfig,
 ): Promise<RequestResult> {
-    const config = mergeConfig(defaultRequestConfig, requestConfig);
+    const config = mergeRequestConfigs(defaultRequestConfig, requestConfig);
 
-    const url = createRequestUrl(requestUrl, config);
+    const url = createRequestUrl(requestUrl, config, generalConfig);
 
     const { mode, credentials, cache, redirect, referrer, referrerPolicy, integrity, keepalive, signal } = config;
 

packages/@ackee/antonio-core/src/modules/core/utils/index.ts

@@ -1,3 +1,3 @@
 export * from './request';
 export * from './response';
-export * from './config';
+export * from './mergeRequestConfigs';

packages/@ackee/antonio-core/src/modules/core/utils/config.ts renamed to packages/@ackee/antonio-core/src/modules/core/utils/mergeRequestConfigs.ts

@@ -1,5 +1,5 @@
 import Headers from 'fetch-headers';
-import { RequestConfig, RequestHeaders, RequestSearchParams } from '../types';
+import { RequestConfig, RequestHeaders, RequestSearchParams } from '../../../types';
 
 const getSearchParamsEntries = (value?: RequestSearchParams) =>
     value instanceof URLSearchParams ? value.entries() : Object.entries(value ?? {});
@@ -35,7 +35,7 @@ function mergeHeaders(headersA?: RequestHeaders, headersB?: RequestHeaders): Hea
     return result;
 }
 
-export function mergeConfig(configA: RequestConfig = {}, configB: RequestConfig = {}): RequestConfig {
+export function mergeRequestConfigs(configA: RequestConfig = {}, configB: RequestConfig = {}): RequestConfig {
     const result: RequestConfig = {
         ...configA,
         ...configB,

packages/@ackee/antonio-core/src/modules/core/utils/request.ts

@@ -7,8 +7,9 @@ import {
     RequestHeaders,
     RequestUriParams,
     RequestBody,
-} from '../types';
-import { mergeUrlSearchParams } from './config';
+    GeneralConfig,
+} from '../../../types';
+import { mergeUrlSearchParams } from './mergeRequestConfigs';
 
 export function formatRequestBody(body: RequestBody, config: RequestConfig): RequestBody {
     if (config.responseType === 'json') {
@@ -46,7 +47,11 @@ function setUriParams(templateUrl: string, uriParams: RequestUriParams): string
     return templateUrl.split('/').map(templateToValue).join('/');
 }
 
-export function createRequestUrl(requestUrl: string, requestConfig: RequestConfig): string {
+export function createRequestUrl(
+    requestUrl: string,
+    requestConfig: RequestConfig,
+    generalConfig: GeneralConfig,
+): string {
     try {
         if (requestConfig.uriParams) {
             requestUrl = setUriParams(requestUrl, requestConfig.uriParams);
@@ -61,9 +66,7 @@ export function createRequestUrl(requestUrl: string, requestConfig: RequestConfi
 
         return url.toString();
     } catch (e) {
-        // TODO: use log-level
-        // eslint-disable-next-line no-console
-        console.error(e, {
+        generalConfig.logger.error(e, {
             requestUrl,
             requestConfig,
         });

packages/@ackee/antonio-core/src/modules/core/utils/response.ts

@@ -1,4 +1,4 @@
-import { ResponseType, Header, ResponseTypes } from '../types';
+import { ResponseType, Header, ResponseTypes } from '../../../types';
 
 function parseHeaderValue(headerValue: string | null): string[] {
     if (!headerValue) {

packages/@ackee/antonio-core/src/modules/core/types.ts renamed to packages/@ackee/antonio-core/src/types.ts

@@ -1,3 +1,5 @@
+import type { Logger } from 'loglevel';
+
 export type RequestMethod = 'get' | 'post' | 'put' | 'patch' | 'delete' | 'options' | 'head';
 
 export type ResponseType = 'json' | 'blob' | 'formData' | 'text';
@@ -40,6 +42,10 @@ export interface RequestConfig extends Omit<RequestInit, 'body' | 'headers' | 'm
     searchParams?: RequestSearchParams;
 }
 
+export interface GeneralConfig {
+    logger: Logger;
+}
+
 export interface DefaultRequestConfig extends RequestConfig {
     headers: RequestHeaders;
     responseType: ResponseType;

tsconfig.types.json

@@ -15,5 +15,10 @@
         "strictNullChecks": true,
         "noImplicitAny": false
     },
-    "include": ["packages/@ackee/*/src"]
+    "include": ["packages/@ackee/*/src"],
+    "references": [
+        {
+            "path": "./packages/@ackee/antonio-core"
+        }
+    ]
 }