@k03mad/request 2.0.0 → 2.2.0

package/app/lib/curl.js

@@ -4,7 +4,6 @@ import prettyBytes from 'pretty-bytes';
 const {bgWhite, black, blue, dim, green, magenta, red, white, yellow} = chalk;
 
 /**
- * Сформировать curl-строку из опций got
  * @param {string} url
  * @param {object} [opts]
  * @param {string} [opts.method]
@@ -25,12 +24,10 @@ export default (url, {
 }, res) => {
     const msg = [];
 
-    // если третий параметр — объект ошибки, то все необходимое на уровень ниже, в ключе response
     if (res?.response) {
         res = res.response;
     }
 
-    // 200 [800 ms] [3.15 kB]
     if (res?.statusCode) {
         msg.push(bgWhite(black(res.statusCode)));
     }

package/app/lib/queue.js

@@ -6,9 +6,9 @@ const debug = _debug('mad:queue');
 // const rps = num => ({intervalCap: num, interval: 1000});
 const concurrency = num => ({concurrency: num});
 
-// первый уровень — хост (* — любой, кроме уже перечисленных)
-// второй уровень — метод (* — любой, кроме уже перечисленных)
-// третий уровень — настройки очереди из p-queue
+// first level — host
+// second level — method
+// third level — p-queue options
 const requestQueue = {
     '*': {
         '*': concurrency(3),
@@ -16,7 +16,6 @@ const requestQueue = {
 };
 
 /**
- * Поставить логирование и вернуть очередь
  * @param {string} host
  * @param {string} method
  * @param {object} opts
@@ -44,20 +43,16 @@ const getLoggedQueue = (host, method, opts) => {
 };
 
 /**
- * Получить очередь по хосту и методу
  * @param {string} host
  * @param {string} method
  * @returns {object}
  */
 export default (host, method = 'GET') => {
-    // проверка на предустановленные настройки очереди для хоста и метода
     for (const elem of [method, '*']) {
-        // очередь уже проинициализирована
         if (requestQueue[host]?.[elem]?._events) {
             return requestQueue[host][elem];
         }
 
-        // очередь нужно проинициализировать
         if (requestQueue[host]?.[elem]) {
             const opts = requestQueue[host][elem];
             requestQueue[host][elem] = new PQueue(opts);
@@ -65,21 +60,18 @@ export default (host, method = 'GET') => {
         }
     }
 
-    // инициализация очереди для хоста без текущего метода в предустановках
     if (requestQueue[host]) {
         const opts = requestQueue['*']['*'];
         requestQueue[host]['*'] = new PQueue(opts);
         return getLoggedQueue(host, '*', opts);
     }
 
-    // инициализация очереди для хоста с методом из предустановок для всех очередей
     if (requestQueue['*'][method]) {
         const opts = requestQueue['*'][method];
         requestQueue[host] = {[method]: new PQueue(opts)};
         return getLoggedQueue(host, method, opts);
     }
 
-    // нет ни хоста не метода в предустановках
     const opts = requestQueue['*']['*'];
     requestQueue[host] = {'*': new PQueue(opts)};
     return getLoggedQueue(host, '*', opts);

package/app/lib/request.js

@@ -8,38 +8,37 @@ import getQueue from './queue.js';
 const {blue, cyan, dim, green, red, yellow} = chalk;
 const debug = _debug('mad:request');
 
-/**
- * @param {object} opts
- */
-const prepareRequestOpts = (opts = {}) => {
-    const UA = 'curl/8.1.2';
-
-    if (opts.dnsCache === undefined) {
-        opts.dnsCache = true;
-    }
-
-    if (!opts.timeout) {
-        opts.timeout = {request: 15_000};
-    }
-
-    if (!opts.headers) {
-        opts.headers = {'user-agent': UA};
-    } else if (!opts.headers['user-agent']) {
-        opts.headers['user-agent'] = UA;
+const gotCache = new Map();
+
+const cacheGotResponseKeys = [
+    'body',
+    'headers',
+    'method',
+    'statusCode',
+    'statusMessage',
+    'timings',
+];
+
+const gotDefaultOpts = got.extend({
+    dnsCache: true,
+    timeout: {request: 15_000},
+    headers: {'user-agent': 'curl/7.81.0'},
+});
+
+const cacheDebug = msgArr => {
+    if (process.env.DEBUG) {
+        debug(msgArr.join(' :: '));
     }
 };
 
 /**
- * Отправить запрос
  * @param {string} url
  * @param {object} opts
  * @returns {object}
  */
 const sendRequest = async (url, opts) => {
-    prepareRequestOpts(opts);
-
     try {
-        const response = await got(url, opts);
+        const response = await gotDefaultOpts(url, opts);
 
         if (!opts.responseType) {
             try {
@@ -52,22 +51,25 @@ const sendRequest = async (url, opts) => {
     } catch (err) {
         debug(getCurl(url, opts, err));
 
-        err.__pretty = {};
-
-        err.__pretty.req = [
-            err?.response?.statusCode,
+        err.__req = [
+            err?.response?.statusCode || err?.code,
             err?.options?.method,
             url,
-            err?.response?.ip ? `(${err.response.ip})` : '',
-        ].join(' ');
+        ].join(' ').trim();
 
-        err.__pretty.opts = opts;
+        if (err?.response?.ip) {
+            err.__ip = err.response.ip;
+        }
+
+        if (Object.keys(opts).length > 0) {
+            err.__opts = opts;
+        }
 
         if (err?.response?.body) {
             try {
-                err.__pretty.body = JSON.parse(err.response.body);
+                err.__res = JSON.parse(err.response.body);
             } catch {
-                err.__pretty.body = err.response.body;
+                err.__res = err.response.body;
             }
         }
 
@@ -79,21 +81,12 @@ const sendRequest = async (url, opts) => {
     }
 };
 
-export const cache = new Map();
-
 /**
- * Отправить запрос c выбором использования очереди
  * @param {string} url
  * @param {object} [opts]
- * @param {object} [params]
- * @param {boolean} [params.skipQueue]
  * @returns {Promise<object>}
  */
-export const request = (url, opts = {}, {skipQueue} = {}) => {
-    if (skipQueue) {
-        return sendRequest(url, opts);
-    }
-
+export const request = (url, opts = {}) => {
     const queue = getQueue(new URL(url).host, opts.method);
     return queue.add(() => sendRequest(url, opts));
 };
@@ -110,41 +103,31 @@ export const requestCache = (url, opts = {}, {cacheBy, expire = 43_200} = {}) =>
     const queue = getQueue(new URL(url).host, opts.method);
 
     return queue.add(async () => {
-        prepareRequestOpts(opts);
-
-        const cacheGotResponseKeys = [
-            'body',
-            'headers',
-            'method',
-            'statusCode',
-            'statusMessage',
-            'timings',
-        ];
-
         const cacheKey = `${url}::${JSON.stringify(cacheBy || opts)}`;
-        const log = `${blue(url)}\n${dim(cacheKey)}`;
+        const urlLog = `${blue(url)}\n${dim(cacheKey)}`;
 
         try {
-            if (cache.has(cacheKey)) {
-                const {cachedResponse, date} = cache.get(cacheKey);
+            if (gotCache.has(cacheKey)) {
+                const {cachedResponse, date} = gotCache.get(cacheKey);
 
                 const measurement = 'seconds';
                 const currentDiff = Math.round((Date.now() - date) / 1000);
+                const diffLog = `${currentDiff}/${expire} ${measurement} left`;
 
                 if (currentDiff < expire) {
-                    debug(`${green('FROM CACHE')} :: ${currentDiff}/${expire} ${measurement} left :: ${log}`);
+                    cacheDebug([green('FROM CACHE'), diffLog, urlLog]);
                     return {cacheKey, ...cachedResponse};
                 }
 
-                debug(`${red('CACHE EXPIRED')} :: ${currentDiff}/${expire} ${measurement} left :: ${log}`);
+                cacheDebug([yellow('CACHE EXPIRED'), diffLog, urlLog]);
             } else {
-                debug(`${yellow('CACHE NOT FOUND')} :: ${log}`);
+                cacheDebug([blue('CACHE NOT FOUND'), urlLog]);
             }
         } catch (err) {
-            debug(`${red('CACHE ERROR')} :: ${dim(err)} :: ${log}`);
+            cacheDebug([red('CACHE ERROR'), dim(err), urlLog]);
         }
 
-        const res = await request(url, opts, {skipQueue: true});
+        const res = await sendRequest(url, opts);
 
         const cachedResponse = {};
 
@@ -152,8 +135,8 @@ export const requestCache = (url, opts = {}, {cacheBy, expire = 43_200} = {}) =>
             cachedResponse[key] = res[key];
         });
 
-        cache.set(cacheKey, {date: Date.now(), cachedResponse});
-        debug(`${cyan('CACHE SAVED')} :: ${log}`);
+        gotCache.set(cacheKey, {date: Date.now(), cachedResponse});
+        cacheDebug([cyan('CACHE SAVED'), urlLog]);
 
         return res;
     });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@k03mad/request",
-  "version": "2.0.0",
+  "version": "2.2.0",
   "description": "Request library",
   "maintainers": [
     "Kirill Molchanov <k03.mad@gmail.com"
@@ -20,7 +20,7 @@
     "pretty-bytes": "6.1.1"
   },
   "devDependencies": {
-    "@k03mad/eslint-config": "12.0.5",
+    "@k03mad/eslint-config": "12.0.6",
     "@microsoft/eslint-formatter-sarif": "3.0.0",
     "eslint": "8.46.0",
     "eslint-plugin-import": "2.28.0",