@sudoplatform/sudo-common 7.1.3 → 8.0.2

package/lib/configurationManager/defaultConfigurationManager.js

@@ -1,168 +1,118 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.DefaultConfigurationManager = void 0;
-
-var _Either = require("fp-ts/lib/Either");
-
-var _pipeable = require("fp-ts/lib/pipeable");
-
-var _s = _interopRequireDefault(require("aws-sdk/clients/s3"));
-
-var _PathReporter = require("io-ts/lib/PathReporter");
-
-var _error = require("../errors/error");
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
-
+/* eslint-disable @typescript-eslint/no-explicit-any */
+/* eslint-disable @typescript-eslint/no-unsafe-return */
+/* eslint-disable @typescript-eslint/no-unsafe-call */
+/* eslint-disable @typescript-eslint/no-unsafe-member-access */
+/* eslint-disable @typescript-eslint/no-unsafe-assignment */
+import { fold, left } from 'fp-ts/lib/Either';
+import { pipe } from 'fp-ts/lib/pipeable';
+import { PathReporter } from 'io-ts/lib/PathReporter';
+import { ConfigurationNotSetError, DecodeError, ConfigurationSetNotFoundError, FatalError, } from '../errors/error';
+import { S3Client, ListObjectsCommand, GetObjectCommand, } from '@aws-sdk/client-s3';
+import { bodyToString } from '../utils/stream';
 /**
  * Singleton to manage configuration
  */
-class DefaultConfigurationManager {
-  constructor() {// Do Nothing.
-
-    _defineProperty(this, "_config", void 0);
-  }
-
-  static getInstance() {
-    if (!DefaultConfigurationManager.instance) {
-      DefaultConfigurationManager.instance = new DefaultConfigurationManager();
+export class DefaultConfigurationManager {
+    constructor() {
+        // Do Nothing.
     }
-
-    return DefaultConfigurationManager.instance;
-  }
-
-  setConfig(config) {
-    this._config = config;
-    return DefaultConfigurationManager.instance;
-  }
-
-  getConfigSet(namespace) {
-    if (!this._config) {
-      throw new _error.ConfigurationNotSetError();
+    static getInstance() {
+        if (!DefaultConfigurationManager.instance) {
+            DefaultConfigurationManager.instance = new DefaultConfigurationManager();
+        }
+        return DefaultConfigurationManager.instance;
     }
-
-    const parsed = JSON.parse(this._config);
-    const configSet = namespace ? parsed[namespace] : parsed;
-    return configSet;
-  }
-
-  bind(configSet, codec) {
-    // Decode and validate config
-    return (0, _pipeable.pipe)(codec.decode(configSet), (0, _Either.fold)(errors => {
-      throw new _error.DecodeError(_PathReporter.PathReporter.report((0, _Either.left)(errors)).join('\n'));
-    }, v => v));
-  }
-
-  bindConfigSet(codec, namespace) {
-    const configSet = this.getConfigSet(namespace);
-
-    if (!configSet) {
-      throw new _error.ConfigurationSetNotFoundError(namespace);
+    setConfig(config) {
+        this._config = config;
+        return DefaultConfigurationManager.instance;
     }
-
-    return this.bind(configSet, codec);
-  }
-
-  async validateConfig() {
-    var _config$identityServi, _config$identityServi2, _objects$Contents;
-
-    if (!this._config) {
-      return {
-        incompatible: [],
-        deprecated: []
-      };
+    getConfigSet(namespace) {
+        if (!this._config) {
+            throw new ConfigurationNotSetError();
+        }
+        const parsed = JSON.parse(this._config);
+        const configSet = namespace ? parsed[namespace] : parsed;
+        return configSet;
     }
-
-    const config = JSON.parse(this._config);
-    const region = (_config$identityServi = config.identityService) === null || _config$identityServi === void 0 ? void 0 : _config$identityServi.region;
-    const bucket = (_config$identityServi2 = config.identityService) === null || _config$identityServi2 === void 0 ? void 0 : _config$identityServi2.serviceInfoBucket;
-
-    if (!(region && bucket)) {
-      return {
-        incompatible: [],
-        deprecated: []
-      };
+    bind(configSet, codec) {
+        // Decode and validate config
+        return pipe(codec.decode(configSet), fold((errors) => {
+            throw new DecodeError(PathReporter.report(left(errors)).join('\n'));
+        }, (v) => v));
     }
-
-    const s3Client = new _s.default({
-      region: region
-    });
-    const incompatible = [];
-    const deprecated = [];
-    const objects = await s3Client.makeUnauthenticatedRequest('listObjects', {
-      Bucket: bucket
-    }).promise();
-
-    if (!((_objects$Contents = objects.Contents) !== null && _objects$Contents !== void 0 && _objects$Contents.length)) {
-      return {
-        incompatible: [],
-        deprecated: []
-      };
+    bindConfigSet(codec, namespace) {
+        const configSet = this.getConfigSet(namespace);
+        if (!configSet) {
+            throw new ConfigurationSetNotFoundError(namespace);
+        }
+        return this.bind(configSet, codec);
     }
-
-    const keys = objects.Contents.map(object => object.Key); // Only fetch the service info docs for the services that are present in client config
-    // to minimize the network calls.
-
-    const keysToFetch = keys.filter(key => key.endsWith('.json') && config[key.replace('.json', '')]);
-
-    for (const key of keysToFetch) {
-      const object = await s3Client.makeUnauthenticatedRequest('getObject', {
-        Key: key,
-        Bucket: bucket
-      }).promise();
-      let body;
-
-      if (typeof object.Body === 'string') {
-        body = object.Body;
-      } else if (ArrayBuffer.isView(object.Body)) {
-        // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
-        body = new TextDecoder().decode(object.Body);
-      } else {
-        continue;
-      }
-
-      const json = JSON.parse(body);
-      const serviceName = key.replace('.json', '');
-      const serviceInfo = json[serviceName];
-      const serviceConfig = config[serviceName];
-
-      if (serviceInfo && serviceConfig) {
-        const currentVersion = serviceConfig.version ?? 1;
-        const deprecationGrace = serviceInfo.deprecationGrace ?? -1;
-        const compatibilityInfo = {
-          name: serviceName,
-          configVersion: currentVersion,
-          minSupportedVersion: serviceInfo.minVersion,
-          deprecatedVersion: serviceInfo.deprecated,
-          deprecationGrace: deprecationGrace != -1 ? new Date(deprecationGrace) : undefined
-        }; // If the service config in `sudoplatformconfig.json` is less than the
-        // minimum supported version then the client is incompatible.
-
-        if (currentVersion < (compatibilityInfo.minSupportedVersion ?? 0)) {
-          incompatible.push(compatibilityInfo);
-        } // If the service config is less than or equal to the deprecated version
-        // then it will be made incompatible after the deprecation grace.
-
-
-        if (currentVersion <= (compatibilityInfo.deprecatedVersion ?? 0)) {
-          deprecated.push(compatibilityInfo);
+    async validateConfig() {
+        if (!this._config) {
+            return { incompatible: [], deprecated: [] };
+        }
+        const config = JSON.parse(this._config);
+        const region = config.identityService?.region;
+        const bucket = config.identityService?.serviceInfoBucket;
+        if (!(region && bucket)) {
+            return { incompatible: [], deprecated: [] };
+        }
+        const s3Client = new S3Client({
+            region: region,
+            // We want these request to be unauthenticated
+            // so we provide a no-op signer for the requests
+            signer: { sign: (request) => Promise.resolve(request) },
+        });
+        const incompatible = [];
+        const deprecated = [];
+        const listObjectsCommand = new ListObjectsCommand({
+            Bucket: bucket,
+        });
+        const objects = await s3Client.send(listObjectsCommand);
+        if (!objects.Contents?.length) {
+            return { incompatible: [], deprecated: [] };
+        }
+        const keys = objects.Contents.map((object) => object.Key);
+        // Only fetch the service info docs for the services that are present in client config
+        // to minimize the network calls.
+        const keysToFetch = keys.filter((key) => key.endsWith('.json') && config[key.replace('.json', '')]);
+        for (const key of keysToFetch) {
+            const getObject = new GetObjectCommand({
+                Key: key,
+                Bucket: bucket,
+            });
+            const object = await s3Client.send(getObject);
+            if (!object.Body) {
+                throw new FatalError('No S3 object body');
+            }
+            const body = await bodyToString(object.Body);
+            const json = JSON.parse(body);
+            const serviceName = key.replace('.json', '');
+            const serviceInfo = json[serviceName];
+            const serviceConfig = config[serviceName];
+            if (serviceInfo && serviceConfig) {
+                const currentVersion = serviceConfig.version ?? 1;
+                const deprecationGrace = serviceInfo.deprecationGrace ?? -1;
+                const compatibilityInfo = {
+                    name: serviceName,
+                    configVersion: currentVersion,
+                    minSupportedVersion: serviceInfo.minVersion,
+                    deprecatedVersion: serviceInfo.deprecated,
+                    deprecationGrace: deprecationGrace != -1 ? new Date(deprecationGrace) : undefined,
+                };
+                // If the service config in `sudoplatformconfig.json` is less than the
+                // minimum supported version then the client is incompatible.
+                if (currentVersion < (compatibilityInfo.minSupportedVersion ?? 0)) {
+                    incompatible.push(compatibilityInfo);
+                }
+                // If the service config is less than or equal to the deprecated version
+                // then it will be made incompatible after the deprecation grace.
+                if (currentVersion <= (compatibilityInfo.deprecatedVersion ?? 0)) {
+                    deprecated.push(compatibilityInfo);
+                }
+            }
         }
-      }
+        return { incompatible, deprecated };
     }
-
-    return {
-      incompatible,
-      deprecated
-    };
-  }
-
 }
-
-exports.DefaultConfigurationManager = DefaultConfigurationManager;
-
-_defineProperty(DefaultConfigurationManager, "instance", void 0);
+//# sourceMappingURL=defaultConfigurationManager.js.map

package/lib/configurationManager/defaultConfigurationManager.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"defaultConfigurationManager.js","sourceRoot":"","sources":["../../src/configurationManager/defaultConfigurationManager.ts"],"names":[],"mappings":"AAAA,uDAAuD;AACvD,wDAAwD;AACxD,sDAAsD;AACtD,+DAA+D;AAC/D,4DAA4D;AAC5D,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAA;AAC7C,OAAO,EAAE,IAAI,EAAE,MAAM,oBAAoB,CAAA;AAEzC,OAAO,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAA;AACrD,OAAO,EACL,wBAAwB,EACxB,WAAW,EACX,6BAA6B,EAC7B,UAAU,GACX,MAAM,iBAAiB,CAAA;AACxB,OAAO,EACL,QAAQ,EACR,kBAAkB,EAClB,gBAAgB,GACjB,MAAM,oBAAoB,CAAA;AAC3B,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAA;AAqH9C;;GAEG;AACH,MAAM,OAAO,2BAA2B;IAKtC;QACE,cAAc;IAChB,CAAC;IAEM,MAAM,CAAC,WAAW;QACvB,IAAI,CAAC,2BAA2B,CAAC,QAAQ,EAAE;YACzC,2BAA2B,CAAC,QAAQ,GAAG,IAAI,2BAA2B,EAAE,CAAA;SACzE;QAED,OAAO,2BAA2B,CAAC,QAAQ,CAAA;IAC7C,CAAC;IAEM,SAAS,CAAC,MAAc;QAC7B,IAAI,CAAC,OAAO,GAAG,MAAM,CAAA;QAErB,OAAO,2BAA2B,CAAC,QAAQ,CAAA;IAC7C,CAAC;IAEM,YAAY,CAAC,SAAkB;QACpC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE;YACjB,MAAM,IAAI,wBAAwB,EAAE,CAAA;SACrC;QAED,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;QACvC,MAAM,SAAS,GAAG,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,MAAM,CAAA;QAExD,OAAO,SAAS,CAAA;IAClB,CAAC;IAEM,IAAI,CAAI,SAAkB,EAAE,KAAc;QAC/C,6BAA6B;QAC7B,OAAO,IAAI,CACT,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,EACvB,IAAI,CACF,CAAC,MAAgB,EAAK,EAAE;YACtB,MAAM,IAAI,WAAW,CAAC,YAAY,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAA;QACrE,CAAC,EACD,CAAC,CAAI,EAAK,EAAE,CAAC,CAAC,CACf,CACF,CAAA;IACH,CAAC;IAEM,aAAa,CAAI,KAAc,EAAE,SAAkB;QACxD,MAAM,SAAS,GAAG,IAAI,CAAC,YAAY,CAAC,SAAS,CAAC,CAAA;QAE9C,IAAI,CAAC,SAAS,EAAE;YACd,MAAM,IAAI,6BAA6B,CAAC,SAAS,CAAC,CAAA;SACnD;QAED,OAAO,IAAI,CAAC,IAAI,CAAI,SAAS,EAAE,KAAK,CAAC,CAAA;IACvC,CAAC;IAEM,KAAK,CAAC,cAAc;QACzB,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE;YACjB,OAAO,EAAE,YAAY,EAAE,EAAE,EAAE,UAAU,EAAE,EAAE,EAAE,CAAA;SAC5C;QAED,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;QAEvC,MAAM,MAAM,GAAG,MAAM,CAAC,eAAe,EAAE,MAAM,CAAA;QAC7C,MAAM,MAAM,GAAG,MAAM,CAAC,eAAe,EAAE,iBAAiB,CAAA;QAExD,IAAI,CAAC,CAAC,MAAM,IAAI,MAAM,CAAC,EAAE;YACvB,OAAO,EAAE,YAAY,EAAE,EAAE,EAAE,UAAU,EAAE,EAAE,EAAE,CAAA;SAC5C;QAED,MAAM,QAAQ,GAAG,IAAI,QAAQ,CAAC;YAC5B,MAAM,EAAE,MAAM;YACd,8CAA8C;YAC9C,gDAAgD;YAChD,MAAM,EAAE,EAAE,IAAI,EAAE,CAAC,OAAY,EAAE,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE;SAC7D,CAAC,CAAA;QAEF,MAAM,YAAY,GAA+B,EAAE,CAAA;QACnD,MAAM,UAAU,GAA+B,EAAE,CAAA;QAEjD,MAAM,kBAAkB,GAAG,IAAI,kBAAkB,CAAC;YAChD,MAAM,EAAE,MAAM;SACf,CAAC,CAAA;QAEF,MAAM,OAAO,GAAG,MAAM,QAAQ,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAA;QACvD,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,MAAM,EAAE;YAC7B,OAAO,EAAE,YAAY,EAAE,EAAE,EAAE,UAAU,EAAE,EAAE,EAAE,CAAA;SAC5C;QAED,MAAM,IAAI,GAAG,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,MAAW,EAAE,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;QAE9D,sFAAsF;QACtF,iCAAiC;QACjC,MAAM,WAAW,GAAG,IAAI,CAAC,MAAM,CAC7B,CAAC,GAAW,EAAE,EAAE,CACd,GAAG,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,CAC5D,CAAA;QAED,KAAK,MAAM,GAAG,IAAI,WAAW,EAAE;YAC7B,MAAM,SAAS,GAAG,IAAI,gBAAgB,CAAC;gBACrC,GAAG,EAAE,GAAG;gBACR,MAAM,EAAE,MAAM;aACf,CAAC,CAAA;YACF,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;YAC7C,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE;gBAChB,MAAM,IAAI,UAAU,CAAC,mBAAmB,CAAC,CAAA;aAC1C;YACD,MAAM,IAAI,GAAG,MAAM,YAAY,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;YAC5C,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;YAC7B,MAAM,WAAW,GAAG,GAAG,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC,CAAA;YAC5C,MAAM,WAAW,GAAQ,IAAI,CAAC,WAAW,CAAC,CAAA;YAC1C,MAAM,aAAa,GAAQ,MAAM,CAAC,WAAW,CAAC,CAAA;YAC9C,IAAI,WAAW,IAAI,aAAa,EAAE;gBAChC,MAAM,cAAc,GAAW,aAAa,CAAC,OAAO,IAAI,CAAC,CAAA;gBACzD,MAAM,gBAAgB,GAAW,WAAW,CAAC,gBAAgB,IAAI,CAAC,CAAC,CAAA;gBACnE,MAAM,iBAAiB,GAA6B;oBAClD,IAAI,EAAE,WAAW;oBACjB,aAAa,EAAE,cAAc;oBAC7B,mBAAmB,EAAE,WAAW,CAAC,UAAU;oBAC3C,iBAAiB,EAAE,WAAW,CAAC,UAAU;oBACzC,gBAAgB,EACd,gBAAgB,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,SAAS;iBAClE,CAAA;gBAED,sEAAsE;gBACtE,6DAA6D;gBAC7D,IAAI,cAAc,GAAG,CAAC,iBAAiB,CAAC,mBAAmB,IAAI,CAAC,CAAC,EAAE;oBACjE,YAAY,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAA;iBACrC;gBAED,wEAAwE;gBACxE,iEAAiE;gBACjE,IAAI,cAAc,IAAI,CAAC,iBAAiB,CAAC,iBAAiB,IAAI,CAAC,CAAC,EAAE;oBAChE,UAAU,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAA;iBACnC;aACF;SACF;QAED,OAAO,EAAE,YAAY,EAAE,UAAU,EAAE,CAAA;IACrC,CAAC;CACF"}