@podium/client 4.5.22 → 5.0.0-next.10

package/lib/http-outgoing.js

@@ -1,36 +1,28 @@
 /* eslint-disable no-underscore-dangle */
 
-'use strict';
-
-const { PassThrough } = require('readable-stream');
-const assert = require('assert');
-const utils = require('./utils');
-
-const _rejectUnauthorized = Symbol('podium:httpoutgoing:rejectUnauthorized');
-const _killRecursions = Symbol('podium:httpoutgoing:killrecursions');
-const _killThreshold = Symbol('podium:httpoutgoing:killthreshold');
-const _redirectable = Symbol('podium:httpoutgoing:redirectable');
-const _reqOptions = Symbol('podium:httpoutgoing:reqoptions');
-const _resolveCss = Symbol('podium:httpoutgoing:resolvecss');
-const _resolveJs = Symbol('podium:httpoutgoing:resolvejs');
-const _throwable = Symbol('podium:httpoutgoing:throwable');
-const _manifest = Symbol('podium:httpoutgoing:manifest');
-const _incoming = Symbol('podium:httpoutgoing:incoming');
-const _redirect = Symbol('podium:httpoutgoing:redirect');
-const _timeout = Symbol('podium:httpoutgoing:timeout');
-const _success = Symbol('podium:httpoutgoing:success');
-const _headers = Symbol('podium:httpoutgoing:headers');
-const _maxAge = Symbol('podium:httpoutgoing:maxage');
-const _status = Symbol('podium:httpoutgoing:status');
-const _name = Symbol('podium:httpoutgoing:name');
-const _uri = Symbol('podium:httpoutgoing:uri');
-
-const PodletClientHttpOutgoing = class PodletClientHttpOutgoing extends PassThrough {
+import { PassThrough } from 'stream';
+import assert from 'assert';
+
+export default class PodletClientHttpOutgoing extends PassThrough {
+    #rejectUnauthorized;
+    #killRecursions;
+    #killThreshold;
+    #redirectable;
+    #reqOptions;
+    #throwable;
+    #manifest;
+    #incoming;
+    #redirect;
+    #timeout;
+    #success;
+    #headers;
+    #maxAge;
+    #status;
+    #name;
+    #uri;    
     constructor(
         {
             rejectUnauthorized = true,
-            resolveCss = false,
-            resolveJs = false,
             throwable = false,
             redirectable = false,
             retries = 4,
@@ -50,47 +42,44 @@ const PodletClientHttpOutgoing = class PodletClientHttpOutgoing extends PassThro
         );
 
         // If requests to https sites should reject on unsigned sertificates
-        this[_rejectUnauthorized] = rejectUnauthorized;
+        this.#rejectUnauthorized = rejectUnauthorized;
 
         // A HttpIncoming object
-        this[_incoming] = utils.validateIncoming(incoming);
+        this.#incoming = incoming;
 
         // Kill switch for breaking the recursive promise chain
         // in case it is never able to completely resolve
-        this[_killRecursions] = 0;
-        this[_killThreshold] = retries;
+        this.#killRecursions = 0;
+        this.#killThreshold = retries;
 
         // Options to be appended to the content request
-        this[_reqOptions] = {
+        this.#reqOptions = {
             pathname: '',
             query: {},
             headers: {},
             ...reqOptions,
         };
 
-        // If relative CSS/JS paths should be resolved into an absolute
-        // path based on the URI to the podlets manifest
-        this[_resolveCss] = resolveCss;
-        this[_resolveJs] = resolveJs;
-
         // In the case of failure, should the resource throw or not
-        this[_throwable] = throwable;
+        this.#throwable = throwable;
 
         // Manifest which is either retrieved from the registry or
         // remote podlet (in other words its not saved in registry yet)
-        this[_manifest] = {
+        this.#manifest = {
             _fallback: '',
         };
 
         // How long before a request should time out
-        this[_timeout] = timeout;
+        this.#timeout = timeout;
 
         // Done indicator to break the promise chain
         // Set to true when content is served
-        this[_success] = false;
+        this.#success = false;
+
+        this.#headers = {};
 
         // How long the manifest should be cached before refetched
-        this[_maxAge] = maxAge;
+        this.#maxAge = maxAge;
 
         // What status the manifest is in. This is used to tell what actions need to
         // be performed throughout the resolving process to complete a request.
@@ -100,149 +89,140 @@ const PodletClientHttpOutgoing = class PodletClientHttpOutgoing extends PassThro
         // "fresh" - the manifest has been fetched but is not stored in cache yet
         // "cached" - the manifest was retrieved from cache
         // "stale" - the manifest is outdated, a new manifest needs to be fetched
-        this[_status] = 'empty';
+        this.#status = 'empty';
 
         // Name of the resource (name given to client)
-        this[_name] = name;
+        this.#name = name;
 
         // URI to manifest
-        this[_uri] = uri;
+        this.#uri = uri;
 
         // Whether the user can handle redirects manually.
-        this[_redirectable] = redirectable;
+        this.#redirectable = redirectable;
 
         // When redirectable is true, this object should be populated with redirect information
         // such that a user can perform manual redirection
-        this[_redirect] = null;
-    }
-
-    get [Symbol.toStringTag]() {
-        return 'PodletClientHttpOutgoing';
+        this.#redirect = null;
     }
 
     get rejectUnauthorized() {
-        return this[_rejectUnauthorized];
+        return this.#rejectUnauthorized;
     }
 
     get reqOptions() {
-        return this[_reqOptions];
-    }
-
-    get resolveCss() {
-        return this[_resolveCss];
-    }
-
-    get resolveJs() {
-        return this[_resolveJs];
+        return this.#reqOptions;
     }
 
     get throwable() {
-        return this[_throwable];
+        return this.#throwable;
     }
 
     get manifest() {
-        return this[_manifest];
+        return this.#manifest;
     }
 
     set manifest(obj) {
-        this[_manifest] = obj;
+        this.#manifest = obj;
     }
 
     get fallback() {
-        return this[_manifest]._fallback;
+        return this.#manifest._fallback;
     }
 
     set fallback(value) {
-        this[_manifest]._fallback = value;
+        this.#manifest._fallback = value;
     }
 
     get timeout() {
-        return this[_timeout];
+        return this.#timeout;
     }
 
     get success() {
-        return this[_success];
+        return this.#success;
     }
 
     set success(value) {
-        this[_success] = value;
+        this.#success = value;
     }
 
     get context() {
-        return this[_incoming].context;
+        return this.#incoming.context;
     }
 
     get headers() {
-        return this[_headers];
+        return this.#headers;
     }
 
     set headers(value) {
-        this[_headers] = value;
+        this.#headers = value;
     }
 
     get maxAge() {
-        return this[_maxAge];
+        return this.#maxAge;
     }
 
     set maxAge(value) {
-        this[_maxAge] = value;
+        this.#maxAge = value;
     }
 
     get status() {
-        return this[_status];
+        return this.#status;
     }
 
     set status(value) {
-        this[_status] = value;
+        this.#status = value;
     }
 
     get name() {
-        return this[_name];
+        return this.#name;
     }
 
     get manifestUri() {
-        return this[_uri];
+        return this.#uri;
     }
 
     get fallbackUri() {
-        return this[_manifest].fallback;
+        return this.#manifest.fallback;
     }
 
     get contentUri() {
-        return this[_manifest].content;
+        return this.#manifest.content;
     }
 
     get kill() {
-        return this[_killRecursions] === this[_killThreshold];
+        return this.#killRecursions === this.#killThreshold;
     }
 
     get recursions() {
-        return this[_killRecursions];
+        return this.#killRecursions;
     }
 
     set recursions(value) {
-        this[_killRecursions] = value;
+        this.#killRecursions = value;
     }
 
     get redirect() {
-        return this[_redirect];
+        return this.#redirect;
     }
 
     set redirect(value) {
-        this[_redirect] = value;
+        this.#redirect = value;
     }
 
     get redirectable() {
-        return this[_redirectable];
+        return this.#redirectable;
     }
 
     set redirectable(value) {
-        this[_redirectable] = value;
+        this.#redirectable = value;
     }
 
     pushFallback() {
-        this.push(this[_manifest]._fallback);
+        this.push(this.#manifest._fallback);
         this.push(null);
     }
+
+    get [Symbol.toStringTag]() {
+        return 'PodletClientHttpOutgoing';
+    }
 };
-module.exports = PodletClientHttpOutgoing;

package/lib/resolver.cache.js

@@ -1,40 +1,30 @@
 /* eslint-disable no-plusplus */
 /* eslint-disable no-param-reassign */
 
-'use strict';
+import clonedeep from 'lodash.clonedeep';
+import abslog from 'abslog';
+import assert from 'assert';
 
-const clonedeep = require('lodash.clonedeep');
-const abslog = require('abslog');
-const assert = require('assert');
-
-module.exports = class PodletClientCacheResolver {
+export default class PodletClientCacheResolver {
+    #registry;
+    #log;
     constructor(registry, options = {}) {
         assert(
             registry,
             'you must pass a "registry" object to the PodletClientCacheResolver constructor',
         );
-
-        Object.defineProperty(this, 'registry', {
-            value: registry,
-        });
-
-        Object.defineProperty(this, 'log', {
-            value: abslog(options.logger),
-        });
-    }
-
-    get [Symbol.toStringTag]() {
-        return 'PodletClientCacheResolver';
+        this.#registry = registry;
+        this.#log = abslog(options.logger);
     }
 
     load(outgoing) {
         return new Promise(resolve => {
             if (outgoing.status !== 'stale') {
-                const cached = this.registry.get(outgoing.name);
+                const cached = this.#registry.get(outgoing.name);
                 if (cached) {
                     outgoing.manifest = clonedeep(cached);
                     outgoing.status = 'cached';
-                    this.log.debug(
+                    this.#log.debug(
                         `loaded manifest from cache - resource: ${outgoing.name}`,
                     );
                 }
@@ -46,12 +36,12 @@ module.exports = class PodletClientCacheResolver {
     save(outgoing) {
         return new Promise(resolve => {
             if (outgoing.status === 'fresh') {
-                this.registry.set(
+                this.#registry.set(
                     outgoing.name,
                     outgoing.manifest,
                     outgoing.maxAge,
                 );
-                this.log.debug(
+                this.#log.debug(
                     `saved manifest to cache - resource: ${outgoing.name}`,
                 );
             }
@@ -61,4 +51,8 @@ module.exports = class PodletClientCacheResolver {
             resolve(outgoing);
         });
     }
+
+    get [Symbol.toStringTag]() {
+        return 'PodletClientCacheResolver';
+    }
 };

package/lib/resolver.content.js

@@ -1,70 +1,64 @@
 /* eslint-disable no-param-reassign */
 
-'use strict';
-
-const { pipeline } = require('readable-stream');
-const Metrics = require('@metrics/client');
-const request = require('request');
-const abslog = require('abslog');
-const putils = require('@podium/utils');
-const { Boom, badGateway } = require('@hapi/boom');
-const Response = require('./response');
-const utils = require('./utils');
-const pkg = require('../package.json');
+import { pipeline } from 'stream';
+import Metrics from '@metrics/client';
+import request from 'request';
+import abslog from 'abslog';
+import * as putils from '@podium/utils';
+import { Boom, badGateway } from '@hapi/boom';
 
-const UA_STRING = `${pkg.name} ${pkg.version}`;
-
-module.exports = class PodletClientContentResolver {
-    constructor(options = {}) {
-        Object.defineProperty(this, 'log', {
-            value: abslog(options.logger),
-        });
-
-        Object.defineProperty(this, 'clientName', {
-            enumerable: false,
-            value: options.clientName,
-        });
-
-        Object.defineProperty(this, 'metrics', {
-            enumerable: true,
-            value: new Metrics(),
-        });
+import { join, dirname } from 'path';
+import { fileURLToPath } from 'url';
+import fs from 'fs';
+import * as utils from './utils.js';
+import Response from './response.js';
 
-        Object.defineProperty(this, 'httpsAgent', {
-            value: options.httpsAgent,
-        });
+const currentDirectory = dirname(fileURLToPath(import.meta.url));
 
-        Object.defineProperty(this, 'httpAgent', {
-            value: options.httpAgent,
-        });
+const pkgJson = fs.readFileSync(join(currentDirectory, '../package.json'), 'utf-8');
+const pkg = JSON.parse(pkgJson);
 
-        this.metrics.on('error', error => {
-            this.log.error(
-                'Error emitted by metric stream in @podium/client module',
-                error,
-            );
-        });
+const UA_STRING = `${pkg.name} ${pkg.version}`;
 
-        this.histogram = this.metrics.histogram({
+export default class PodletClientContentResolver {
+    #log;
+    #metrics;
+    #histogram;
+    #httpAgent;
+    #httpsAgent;
+    constructor(options = {}) {
+        const name = options.clientName;
+        this.#log = abslog(options.logger);
+        this.#httpAgent = options.httpAgent;
+        this.#httpsAgent = options.httpsAgent;
+        this.#metrics = new Metrics();
+        this.#histogram = this.#metrics.histogram({
             name: 'podium_client_resolver_content_resolve',
             description: 'Time taken for success/failure of content request',
             labels: {
-                name: this.clientName,
+                name,
                 status: null,
                 podlet: null,
             },
             buckets: [0.001, 0.01, 0.1, 0.5, 1, 2, 10],
         });
+
+        this.#metrics.on('error', error => {
+            this.#log.error(
+                'Error emitted by metric stream in @podium/client module',
+                error,
+            );
+        });
     }
 
-    get [Symbol.toStringTag]() {
-        return 'PodletClientContentResolver';
+    get metrics() {
+        return this.#metrics;
     }
 
     resolve(outgoing) {
         return new Promise((resolve, reject) => {
             if (outgoing.kill && outgoing.throwable) {
-                this.log.warn(
+                this.#log.warn(
                     `recursion detected - failed to resolve fetching of podlet ${outgoing.recursions} times - throwing - resource: ${outgoing.name} - url: ${outgoing.manifestUri}`,
                 );
                 reject(
@@ -76,7 +70,7 @@ module.exports = class PodletClientContentResolver {
             }
 
             if (outgoing.kill) {
-                this.log.warn(
+                this.#log.warn(
                     `recursion detected - failed to resolve fetching of podlet ${outgoing.recursions} times - serving fallback - resource: ${outgoing.name} - url: ${outgoing.manifestUri}`,
                 );
                 outgoing.success = true;
@@ -86,7 +80,7 @@ module.exports = class PodletClientContentResolver {
             }
 
             if (outgoing.status === 'empty' && outgoing.throwable) {
-                this.log.warn(
+                this.#log.warn(
                     `no manifest available - cannot read content - throwing - resource: ${outgoing.name} - url: ${outgoing.manifestUri}`,
                 );
                 reject(
@@ -96,7 +90,7 @@ module.exports = class PodletClientContentResolver {
             }
 
             if (outgoing.status === 'empty') {
-                this.log.warn(
+                this.#log.warn(
                     `no manifest available - cannot read content - serving fallback - resource: ${outgoing.name} - url: ${outgoing.manifestUri}`,
                 );
                 outgoing.success = true;
@@ -117,8 +111,8 @@ module.exports = class PodletClientContentResolver {
                 timeout: outgoing.timeout,
                 method: 'GET',
                 agent: outgoing.contentUri.startsWith('https://')
-                ? this.httpsAgent
-                : this.httpAgent,
+                ? this.#httpsAgent
+                : this.#httpAgent,
                 uri: putils.uriBuilder(
                     outgoing.reqOptions.pathname,
                     outgoing.contentUri,
@@ -131,13 +125,13 @@ module.exports = class PodletClientContentResolver {
                 reqOptions.followRedirect = false;
             }
 
-            const timer = this.histogram.timer({
+            const timer = this.#histogram.timer({
                 labels: {
                     podlet: outgoing.name,
                 },
             });
 
-            this.log.debug(
+            this.#log.debug(
                 `start reading content from remote resource - manifest version is ${outgoing.manifest.version} - resource: ${outgoing.name} - url: ${outgoing.contentUri}`,
             );
 
@@ -153,7 +147,7 @@ module.exports = class PodletClientContentResolver {
                         },
                     });
 
-                    this.log.warn(
+                    this.#log.debug(
                         `remote resource responded with non 200 http status code for content - code: ${response.statusCode} - resource: ${outgoing.name} - url: ${outgoing.contentUri}`,
                     );
 
@@ -176,7 +170,7 @@ module.exports = class PodletClientContentResolver {
                         },
                     });
 
-                    this.log.warn(
+                    this.#log.warn(
                         `remote resource responded with non 200 http status code for content - code: ${response.statusCode} - resource: ${outgoing.name} - url: ${outgoing.contentUri}`,
                     );
                     outgoing.success = true;
@@ -192,7 +186,7 @@ module.exports = class PodletClientContentResolver {
                     ? response.headers['podlet-version']
                     : undefined;
 
-                this.log.debug(
+                this.#log.debug(
                     `got head response from remote resource for content - header version is ${response.headers['podlet-version']} - resource: ${outgoing.name} - url: ${outgoing.contentUri}`,
                 );
 
@@ -206,7 +200,7 @@ module.exports = class PodletClientContentResolver {
                         },
                     });
 
-                    this.log.info(
+                    this.#log.info(
                         `podlet version number in header differs from cached version number - aborting request to remote resource for content - resource: ${outgoing.name} - url: ${outgoing.contentUri}`,
                     );
                     r.abort();
@@ -234,9 +228,9 @@ module.exports = class PodletClientContentResolver {
                     }),
                 );
 
-                pipeline(r, outgoing, err => {
+                pipeline([r, outgoing], (err) => {
                     if (err) {
-                        this.log.warn('error while piping content stream', err);
+                        this.#log.warn('error while piping content stream', err);
                     }
                 });
             });
@@ -250,7 +244,7 @@ module.exports = class PodletClientContentResolver {
                         },
                     });
 
-                    this.log.warn(
+                    this.#log.warn(
                         `could not create network connection to remote resource when trying to request content - resource: ${outgoing.name} - url: ${outgoing.contentUri}`,
                     );
                     reject(
@@ -268,7 +262,7 @@ module.exports = class PodletClientContentResolver {
                     },
                 });
 
-                this.log.warn(
+                this.#log.warn(
                     `could not create network connection to remote resource when trying to request content - resource: ${outgoing.name} - url: ${outgoing.contentUri}`,
                 );
 
@@ -285,7 +279,7 @@ module.exports = class PodletClientContentResolver {
                     },
                 });
 
-                this.log.debug(
+                this.#log.debug(
                     `successfully read content from remote resource - resource: ${outgoing.name} - url: ${outgoing.contentUri}`,
                 );
 
@@ -293,4 +287,8 @@ module.exports = class PodletClientContentResolver {
             });
         });
     }
+
+    get [Symbol.toStringTag]() {
+        return 'PodletClientContentResolver';
+    }
 };