@podium/client 4.5.22 → 5.0.0-next.10

package/lib/resource.js

@@ -1,24 +1,22 @@
-/* eslint-disable no-underscore-dangle */
 /* eslint-disable no-param-reassign */
 
-'use strict';
+import Metrics from '@metrics/client';
+import stream from 'stream';
+import abslog from 'abslog';
+import assert from 'assert';
 
-const Metrics = require('@metrics/client');
-const stream = require('readable-stream');
-const abslog = require('abslog');
-const assert = require('assert');
-const util = require('util');
+import HttpOutgoing from './http-outgoing.js';
+import Response from './response.js';
+import Resolver from './resolver.js';
+import * as utils from './utils.js';
 
-const HttpOutgoing = require('./http-outgoing');
-const Response = require('./response');
-const Resolver = require('./resolver');
+const inspect = Symbol.for('nodejs.util.inspect.custom');
 
-const _resolver = Symbol('podium:client:resource:resolver');
-const _options = Symbol('podium:client:resource:options');
-const _metrics = Symbol('podium:client:resource:metrics');
-const _state = Symbol('podium:client:resource:state');
-
-const PodiumClientResource = class PodiumClientResource {
+export default class PodiumClientResource {
+    #resolver;
+    #options;
+    #metrics;
+    #state;
     constructor(registry, state, options = {}) {
         assert(
             registry,
@@ -32,37 +30,38 @@ const PodiumClientResource = class PodiumClientResource {
 
         const log = abslog(options.logger);
 
-        this[_resolver] = new Resolver(registry, options);
-        this[_options] = options;
-        this[_metrics] = new Metrics();
-        this[_state] = state;
+        this.#resolver = new Resolver(registry, options);
+        this.#options = options;
+        this.#metrics = new Metrics();
+        this.#state = state;
 
-        this[_metrics].on('error', error => {
+        this.#metrics.on('error', error => {
             log.error(
                 'Error emitted by metric stream in @podium/client module',
                 error,
             );
         });
 
-        this[_resolver].metrics.pipe(this[_metrics]);
+        this.#resolver.metrics.pipe(this.#metrics);
     }
 
     get metrics() {
-        return this[_metrics];
+        return this.#metrics;
     }
 
     get name() {
-        return this[_options].name;
+        return this.#options.name;
     }
 
     get uri() {
-        return this[_options].uri;
+        return this.#options.uri;
     }
 
     async fetch(incoming = {}, reqOptions = {}) {
-        const outgoing = new HttpOutgoing(this[_options], reqOptions, incoming);
+        if (!utils.validateIncoming(incoming)) throw new TypeError('you must pass an instance of "HttpIncoming" as the first argument to the .fetch() method');
+        const outgoing = new HttpOutgoing(this.#options, reqOptions, incoming);
 
-        this[_state].setInitializingState();
+        this.#state.setInitializingState();
 
         const chunks = [];
         const to = new stream.Writable({
@@ -72,9 +71,11 @@ const PodiumClientResource = class PodiumClientResource {
             },
         });
 
-        stream.pipeline(outgoing, to);
+        stream.pipeline([outgoing, to], () => {
+            // noop
+        });
 
-        const { manifest, headers, redirect } = await this[_resolver].resolve(
+        const { manifest, headers, redirect } = await this.#resolver.resolve(
             outgoing,
         );
 
@@ -92,34 +93,28 @@ const PodiumClientResource = class PodiumClientResource {
     }
 
     stream(incoming = {}, reqOptions = {}) {
-        const outgoing = new HttpOutgoing(this[_options], reqOptions, incoming);
-        this[_state].setInitializingState();
-        this[_resolver].resolve(outgoing).catch((err) => {
-            outgoing.emit('error', err);
-        });
+        if (!utils.validateIncoming(incoming)) throw new TypeError('you must pass an instance of "HttpIncoming" as the first argument to the .stream() method');
+        const outgoing = new HttpOutgoing(this.#options, reqOptions, incoming);
+        this.#state.setInitializingState();
+        this.#resolver.resolve(outgoing);
         return outgoing;
     }
 
     refresh(incoming = {}, reqOptions = {}) {
-        const outgoing = new HttpOutgoing(this[_options], reqOptions, incoming);
-        this[_state].setInitializingState();
-        return this[_resolver].refresh(outgoing).then(obj => obj);
+        const outgoing = new HttpOutgoing(this.#options, reqOptions, incoming);
+        this.#state.setInitializingState();
+        return this.#resolver.refresh(outgoing).then(obj => obj);
     }
 
-    get [Symbol.toStringTag]() {
-        return 'PodiumClientResource';
+    [inspect]() {
+        return {
+            metrics: this.metrics,
+            name: this.name,
+            uri: this.uri,
+        };
     }
 
-    [util.inspect.custom](depth, options) {
-        return util.inspect(
-            {
-                metrics: this.metrics,
-                name: this.name,
-                uri: this.uri,
-            },
-            depth,
-            options,
-        );
+    get [Symbol.toStringTag]() {
+        return 'PodiumClientResource';
     }
 };
-module.exports = PodiumClientResource;

package/lib/response.js

@@ -1,17 +1,11 @@
-/* eslint-disable no-underscore-dangle */
-/* eslint-disable import/order */
+const inspect = Symbol.for('nodejs.util.inspect.custom');
 
-'use strict';
-
-const util = require('util');
-
-const _redirect = Symbol('podium:client:response:redirect');
-const _content = Symbol('podium:client:response:content');
-const _headers = Symbol('podium:client:response:headers');
-const _css = Symbol('podium:client:response:css');
-const _js = Symbol('podium:client:response:js');
-
-const PodiumClientResponse = class PodiumClientResponse {
+export default class PodiumClientResponse {
+    #redirect;
+    #content;
+    #headers;
+    #css;
+    #js;
     constructor({
         content = '',
         headers = {},
@@ -19,57 +13,66 @@ const PodiumClientResponse = class PodiumClientResponse {
         js = [],
         redirect = null,
     } = {}) {
-        this[_redirect] = redirect;
-        this[_content] = content;
-        this[_headers] = headers;
-        this[_css] = css;
-        this[_js] = js;
+        this.#redirect = redirect;
+        this.#content = content;
+        this.#headers = headers;
+        this.#css = css;
+        this.#js = js;
     }
 
     get content() {
-        return this[_content];
+        return this.#content;
     }
 
     get headers() {
-        return this[_headers];
+        return this.#headers;
     }
 
     get css() {
-        return this[_css];
+        return this.#css;
     }
 
     get js() {
-        return this[_js];
+        return this.#js;
     }
 
     get redirect() {
-        return this[_redirect];
-    }
-
-    get [Symbol.toStringTag]() {
-        return 'PodiumClientResponse';
+        return this.#redirect;
     }
 
     toJSON() {
         return {
-            redirect: this[_redirect],
-            content: this[_content],
-            headers: this[_headers],
-            css: this[_css],
-            js: this[_js],
+            redirect: this.redirect,
+            content: this.content,
+            headers: this.headers,
+            css: this.css,
+            js: this.js,
         };
     }
 
     toString() {
-        return this[_content];
+        return this.content;
     }
 
     [Symbol.toPrimitive]() {
-        return this[_content];
+        return this.content;
     }
 
-    [util.inspect.custom](depth, options) {
-        return util.inspect(this.toJSON(), depth, options);
+    [inspect]() {
+        return {
+            referrerpolicy: this.referrerpolicy,
+            crossorigin: this.crossorigin,
+            integrity: this.integrity,
+            nomodule: this.nomodule,
+            value: this.value,
+            async: this.async,
+            defer: this.defer,
+            type: this.type,
+            data: this.data,
+        };
+    }
+
+    get [Symbol.toStringTag]() {
+        return 'PodiumClientResponse';
     }
 };
-module.exports = PodiumClientResponse;

package/lib/state.js

@@ -1,18 +1,13 @@
-/* eslint-disable no-underscore-dangle */
-/* eslint-disable import/order */
+import EventEmitter from 'events';
 
-'use strict';
+const inspect = Symbol.for('nodejs.util.inspect.custom');
 
-const EventEmitter = require('events');
-const util = require('util');
-
-const _thresholdTimer = Symbol('podium:client:state:threshold:timer');
-const _threshold = Symbol('podium:client:state:threshold');
-const _maxTimer = Symbol('podium:client:state:max:timer');
-const _state = Symbol('podium:client:state:state');
-const _max = Symbol('podium:client:state:max');
-
-const PodiumClientState = class PodiumClientState extends EventEmitter {
+export default class PodiumClientState extends EventEmitter {
+    #thresholdTimer;
+    #threshold;
+    #maxTimer;
+    #state;
+    #max;
     constructor({
         resolveThreshold = 10 * 1000,
         resolveMax = 4 * 60 * 1000,
@@ -23,22 +18,22 @@ const PodiumClientState = class PodiumClientState extends EventEmitter {
                 'argument "resolveMax" must be larger than "resolveThreshold" argument',
             );
 
-        this[_thresholdTimer] = undefined;
-        this[_threshold] = resolveThreshold;
-        this[_maxTimer] = undefined;
-        this[_state] = 'instantiated';
-        this[_max] = resolveMax;
+        this.#thresholdTimer = undefined;
+        this.#threshold = resolveThreshold;
+        this.#maxTimer = undefined;
+        this.#state = 'instantiated';
+        this.#max = resolveMax;
     }
 
     get status() {
-        return this[_state];
+        return this.#state;
     }
 
     setInitializingState() {
         const state = 'initializing';
 
-        if (this[_state] === 'instantiated') {
-            this[_state] = state;
+        if (this.#state === 'instantiated') {
+            this.#state = state;
             this.emit('state', state);
         }
     }
@@ -46,10 +41,10 @@ const PodiumClientState = class PodiumClientState extends EventEmitter {
     setStableState() {
         const state = 'stable';
 
-        clearTimeout(this[_maxTimer]);
+        clearTimeout(this.#maxTimer);
 
-        if (this[_state] !== state) {
-            this[_state] = state;
+        if (this.#state !== state) {
+            this.#state = state;
             this.emit('state', state);
         }
     }
@@ -57,8 +52,8 @@ const PodiumClientState = class PodiumClientState extends EventEmitter {
     setUnhealthyState() {
         const state = 'unhealthy';
 
-        if (this[_state] !== state) {
-            this[_state] = state;
+        if (this.#state !== state) {
+            this.#state = state;
             this.emit('state', state);
         }
     }
@@ -68,53 +63,54 @@ const PodiumClientState = class PodiumClientState extends EventEmitter {
         // timeout. This max timeout will be reset if a stable state is reached
         // again before it times out. If this times out, unhealthy state is
         // reached.
-        if (this[_state] === 'stable' || this[_state] === 'initializing') {
-            this[_maxTimer] = setTimeout(
+        if (this.#state === 'stable' || this.#state === 'initializing') {
+            this.#maxTimer = setTimeout(
                 this.setUnhealthyState.bind(this),
-                this[_max],
+                this.#max,
             );
-            this[_maxTimer].unref();
+            this.#maxTimer.unref();
         }
 
         // If state is unhealthy, continue keeping it unhealthy.
-        const state = this[_state] === 'unhealthy' ? 'unhealthy' : 'unstable';
+        const state = this.#state === 'unhealthy' ? 'unhealthy' : 'unstable';
 
         // Clear any possible previous threshold timeouts in case because we are
         // there was a call to this method within the threshold time.
-        clearTimeout(this[_thresholdTimer]);
+        clearTimeout(this.#thresholdTimer);
 
-        if (this[_state] !== state) {
-            this[_state] = state;
+        if (this.#state !== state) {
+            this.#state = state;
             this.emit('state', state);
         }
 
         // Set a threshold timeout. If no further calls is done to this method a
         // the timeout will call method for setting stable state.
-        this[_thresholdTimer] = setTimeout(
+        this.#thresholdTimer = setTimeout(
             this.setStableState.bind(this),
-            this[_threshold],
+            this.#threshold,
         );
-        this[_thresholdTimer].unref();
+        this.#thresholdTimer.unref();
     }
 
     reset() {
-        clearTimeout(this[_thresholdTimer]);
-        clearTimeout(this[_maxTimer]);
-        this[_state] = 'instantiated';
+        clearTimeout(this.#thresholdTimer);
+        clearTimeout(this.#maxTimer);
+        this.#state = 'instantiated';
     }
 
-    get [Symbol.toStringTag]() {
-        return 'PodiumClientState';
+    toJSON() {
+        return {
+            status: this.status,
+        };
     }
 
-    toJSON() {
+    [inspect]() {
         return {
             status: this.status,
         };
     }
 
-    [util.inspect.custom](depth, options) {
-        return util.inspect(this.toJSON(), depth, options);
+    get [Symbol.toStringTag]() {
+        return 'PodiumClientState';
     }
 };
-module.exports = PodiumClientState;

package/lib/utils.js

@@ -1,7 +1,3 @@
-'use strict';
-
-const { HttpIncoming } = require('@podium/utils');
-
 /**
  * Checks if a header Oject has a header.
  * Will return true if the header exist and are not an empty
@@ -13,7 +9,7 @@ const { HttpIncoming } = require('@podium/utils');
  * @returns {Boolean}
  */
 
-module.exports.isHeaderDefined = (headers, header) => {
+export const isHeaderDefined = (headers, header) => {
     if (headers[header] === undefined || headers[header].trim() === '') {
         return false;
     }
@@ -30,44 +26,10 @@ module.exports.isHeaderDefined = (headers, header) => {
  * @returns {Boolean}
  */
 
-module.exports.hasManifestChange = item => {
+export const hasManifestChange = item => {
     const oldVersion = item.oldVal ? item.oldVal.version : '';
     const newVersion = item.newVal ? item.newVal.version : '';
     return oldVersion !== newVersion;
 };
 
-/**
- * Check if a value is a HttpIncoming object or not. If not, it
- * assume the incoming value is a context
- *
- * @param {Object} incoming A object
- *
- * @returns {HttpIncoming}
- */
-
-function incomingDeprecated() {
-    if (!incomingDeprecated.warned) {
-        incomingDeprecated.warned = true;
-        process.emitWarning(
-            'Passing an arbitrary value as the first argument to .fetch() and .stream() is deprecated. In a future version it will be required to pass in a HttpIncoming object as a the first argument to these methods. For further information and how to migrate, please see https://podium-lib.io/blog/2019/06/14/version-4.0.0#httpincoming-replaces-context-argument',
-            'DeprecationWarning',
-        );
-    }
-}
-
-module.exports.validateIncoming = (incoming = {}) => {
-    if (
-        Object.prototype.toString.call(incoming) ===
-        '[object PodiumHttpIncoming]'
-    ) {
-        return incoming;
-    }
-
-    incomingDeprecated();
-
-    const inc = new HttpIncoming({
-        headers: {},
-    });
-    inc.context = incoming;
-    return inc;
-};
+export const validateIncoming = (incoming = {}) => (Object.prototype.toString.call(incoming) === '[object PodiumHttpIncoming]');

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@podium/client",
-  "version": "4.5.22",
-  "main": "lib/client.js",
+  "version": "5.0.0-next.10",
+  "type": "module",
   "license": "MIT",
   "keywords": [
     "micro services",
@@ -24,49 +24,45 @@
     "index.d.ts",
     "README.md",
     "LICENSE",
+    "dist",
     "lib"
   ],
+  "main": "./lib/client.js",
   "types": "index.d.ts",
   "scripts": {
     "lint": "eslint .",
     "lint:fix": "eslint --fix .",
-    "test": "tap --no-cov test/*.js",
-    "lint:format": "eslint --fix .",
-    "precommit": "lint-staged"
+    "test": "tap --no-check-coverage"
   },
   "dependencies": {
-    "@hapi/boom": "^9.0.0",
+    "@hapi/boom": "^10.0.0",
     "@metrics/client": "2.5.0",
-    "@podium/schemas": "4.1.32",
-    "@podium/utils": "4.4.36",
+    "@podium/schemas": "5.0.0-next.4",
+    "@podium/utils": "5.0.0-next.6",
     "abslog": "2.4.0",
     "http-cache-semantics": "^4.0.3",
     "lodash.clonedeep": "^4.5.0",
-    "readable-stream": "^3.4.0",
     "request": "^2.88.0",
     "ttl-mem-cache": "4.1.0"
   },
   "devDependencies": {
-    "@podium/test-utils": "2.4.1",
+    "@podium/test-utils": "2.5.2",
     "@semantic-release/changelog": "6.0.1",
-    "@semantic-release/commit-analyzer": "9.0.2",
     "@semantic-release/git": "10.0.1",
-    "@semantic-release/github": "8.0.2",
-    "@semantic-release/npm": "8.0.3",
-    "@semantic-release/release-notes-generator": "10.0.3",
-    "@sinonjs/fake-timers": "9.1.0",
+    "@sinonjs/fake-timers": "9.1.2",
+    "@babel/eslint-parser": "7.18.9",
     "benchmark": "2.1.4",
-    "eslint": "7.32.0",
-    "eslint-config-airbnb-base": "14.2.1",
-    "eslint-config-prettier": "8.4.0",
-    "eslint-plugin-import": "2.25.4",
-    "eslint-plugin-prettier": "3.4.1",
-    "express": "4.17.3",
+    "eslint": "8.23.0",
+    "eslint-config-airbnb-base": "15.0.0",
+    "eslint-config-prettier": "8.5.0",
+    "eslint-plugin-import": "2.26.0",
+    "eslint-plugin-prettier": "4.2.1",
+    "express": "4.18.1",
     "get-stream": "6.0.1",
     "http-proxy": "1.18.1",
-    "is-stream": "2.0.1",
-    "prettier": "2.5.1",
-    "semantic-release": "18.0.1",
-    "tap": "15.1.6"
+    "is-stream": "3.0.0",
+    "prettier": "2.7.1",
+    "semantic-release": "19.0.5",
+    "tap": "16.3.0"
   }
 }