@sudoplatform/sudo-common 6.0.2 → 6.2.1

package/github/package.json

@@ -14,7 +14,9 @@
     "lint": "yarn lint:eslint && yarn lint:prettier",
     "lint:eslint": "eslint \"{bin,integration-tests,src,test}/**/*.{ts,tsx}\"",
     "lint:prettier": "prettier -l \"{bin,integration-tests,src,test}/**/*.{js,json,jsx,ts,tsx}\"",
-    "test": "jest",
+    "unit-test": "jest test/unit",
+    "integration-test": "jest test/integration",
+    "test": "yarn unit-test && yarn integration-test",
     "build": "yarn clean && yarn build:transpile && yarn build:verify && yarn build:declarations && yarn build:doc",
     "build:verify": "yarn audit-with-suppressions && yarn lint && yarn test --coverage",
     "build:transpile": "babel src --out-dir lib --extensions '.ts'",
@@ -37,42 +39,45 @@
     "**/apollo-cache-inmemory": "^1.6.6",
     "**/apollo-client": "^2.6.10",
     "ansi-regex": "^5.0.1",
-    "tmpl": "^1.0.5"
+    "tmpl": "^1.0.5",
+    "minimist": "^1.2.6"
   },
   "dependencies": {
     "apollo-client": "^2.6.10",
-    "browser-bunyan": "^1.6.3",
-    "fflate": "^0.7.1",
-    "graphql": "^15.6.1"
+    "aws-sdk": "^2.973.0",
+    "browser-bunyan": "^1.8.0",
+    "fflate": "^0.7.3",
+    "graphql": "^15.8.0"
   },
   "peerDependencies": {
     "io-ts": "^2.2.10"
   },
   "devDependencies": {
-    "@babel/cli": "^7.15.7",
-    "@babel/core": "^7.15.8",
-    "@babel/plugin-proposal-class-properties": "^7.14.5",
-    "@babel/plugin-proposal-private-methods": "^7.14.5",
-    "@babel/preset-env": "^7.15.8",
-    "@babel/preset-typescript": "^7.15.0",
-    "@types/jest": "^27.0.2",
-    "@typescript-eslint/eslint-plugin": "^5.1.0",
-    "@typescript-eslint/parser": "^5.1.0",
-    "eslint": "^8.0.1",
-    "eslint-config-prettier": "^8.3.0",
-    "eslint-plugin-import": "^2.25.2",
+    "@babel/cli": "^7.17.10",
+    "@babel/core": "^7.17.10",
+    "@babel/plugin-proposal-class-properties": "^7.16.7",
+    "@babel/plugin-proposal-private-methods": "^7.16.11",
+    "@babel/preset-env": "^7.17.10",
+    "@babel/preset-typescript": "^7.16.7",
+    "@types/jest": "^27.5.0",
+    "@typescript-eslint/eslint-plugin": "^5.22.0",
+    "@typescript-eslint/parser": "^5.22.0",
+    "aws-sdk-mock": "^5.7.0",
+    "eslint": "^8.14.0",
+    "eslint-config-prettier": "^8.5.0",
+    "eslint-plugin-import": "^2.26.0",
     "eslint-plugin-prettier": "^4.0.0",
-    "fp-ts": "^2.11.5",
+    "fp-ts": "^2.11.8",
     "io-ts": "^2.2.16",
     "io-ts-types": "^0.5.16",
     "isomorphic-webcrypto": "^2.3.8",
-    "jest": "^27.3.1",
-    "monocle-ts": "^2.3.11",
-    "newtype-ts": "^0.3.2",
-    "prettier": "^2.4.1",
+    "jest": "^27.5.1",
+    "monocle-ts": "^2.3.13",
+    "newtype-ts": "^0.3.5",
+    "prettier": "^2.6.2",
     "rimraf": "^3.0.2",
     "ts-mockito": "^2.6.1",
-    "typedoc": "^0.22.6",
-    "typescript": "^4.4.4"
+    "typedoc": "^0.22.15",
+    "typescript": "^4.6.4"
   }
-}
+}

package/github/src/configurationManager/defaultConfigurationManager.ts

@@ -1,6 +1,12 @@
+/* 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 * as t from 'io-ts'
+import * as AWS from 'aws-sdk'
 import { PathReporter } from 'io-ts/lib/PathReporter'
 import {
   ConfigurationNotSetError,
@@ -8,6 +14,54 @@ import {
   ConfigurationSetNotFoundError,
 } from '../errors/error'
 
+/**
+ * Service compatibility information.
+ */
+export interface ServiceCompatibilityInfo {
+  /**
+   * The name of the service associated with the compatibility info. This matches one of the
+   * service name present in sudoplatformconfig.json.
+   */
+  name: string
+  /**
+   * The version of the service config present in sudoplatformconfig.json. It defaults
+   * to 1 if not present.
+   */
+  configVersion: number
+  /**
+   * The minimum supported service config version currently supported by the backend.
+   */
+  minSupportedVersion?: number
+  /**
+   * Any service config version less than or equal to this version is considered deprecated
+   * and the backend may remove the support for those versions after a grace period.
+   */
+  deprecatedVersion?: number
+  /**
+   * After this time any deprecated service config versions will no longer be compatible
+   * with the backend. It is recommended to warn the user prior to the deprecation grace.
+   */
+  deprecationGrace?: Date
+}
+
+/**
+ * Result returned by `validateConfig` API if an incompatible client config is found when compared
+ * to the deployed backend services.
+ */
+export interface ValidationResult {
+  /**
+   * The list of incompatible services. The client must be upgraded to the latest
+   * version in order to use these services.
+   */
+  incompatible: ServiceCompatibilityInfo[]
+  /**
+   * The list of services that will be made incompatible with the current version of the
+   * client. The users should be warned that after the specified grace period these services will be
+   * made incompatible.
+   */
+  deprecated: ServiceCompatibilityInfo[]
+}
+
 /**
  * Interface that encapsulates the APIs common to all configuration manager implementations.
  * A configuration manager should be a singleton that holds reference to a parsed config
@@ -62,6 +116,17 @@ export interface ConfigurationManager {
    * @throws {@link DecodeError}
    */
   bindConfigSet<T>(codec: t.Mixed, namespace?: string): T
+
+  /**
+   * Validates the client configuration (sudoplatformconfig.json) against the currently deployed set of
+   * backend services. If the client configuration is valid, i.e. the client is compatible will all deployed
+   * backend services, then the call will complete with `success` result. If any part of the client
+   * configuration is incompatible then a detailed information on the incompatible service will be
+   * returned in `failure` result. See `SudoConfigManagerError.compatibilityIssueFound` for more details.
+   *
+   * @return validation result with the details of incompatible or deprecated service configurations.
+   */
+  validateConfig(): Promise<ValidationResult>
 }
 
 /**
@@ -95,15 +160,9 @@ export class DefaultConfigurationManager implements ConfigurationManager {
       throw new ConfigurationNotSetError()
     }
 
-    // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
     const parsed = JSON.parse(this._config)
-    // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
-    const configSet = namespace
-      ? // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
-        parsed[namespace]
-      : parsed
+    const configSet = namespace ? parsed[namespace] : parsed
 
-    // eslint-disable-next-line @typescript-eslint/no-unsafe-return
     return configSet
   }
 
@@ -129,4 +188,94 @@ export class DefaultConfigurationManager implements ConfigurationManager {
 
     return this.bind<T>(configSet, codec)
   }
+
+  public async validateConfig(): Promise<ValidationResult> {
+    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 AWS.S3({ region: region })
+
+    const incompatible: ServiceCompatibilityInfo[] = []
+    const deprecated: ServiceCompatibilityInfo[] = []
+
+    const objects = await s3Client
+      .makeUnauthenticatedRequest('listObjects', {
+        Bucket: bucket,
+      })
+      .promise()
+
+    if (!objects.Contents?.length) {
+      return { incompatible: [], deprecated: [] }
+    }
+
+    const keys = objects.Contents.map((object: any) => 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: string) =>
+        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: string
+
+      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: any = json[serviceName]
+      const serviceConfig: any = config[serviceName]
+      if (serviceInfo && serviceConfig) {
+        const currentVersion: number = serviceConfig.version ?? 1
+        const deprecationGrace: number = serviceInfo.deprecationGrace ?? -1
+        const compatibilityInfo: ServiceCompatibilityInfo = {
+          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 }
+  }
 }

package/github/src/errors/error.ts

@@ -425,7 +425,9 @@ export class UnrecognizedAlgorithmError extends Error {
  * @param error The App Sync error to map
  * @returns The mapped error
  */
-export function mapGraphQLToClientError(error: AppSyncError): Error {
+export function mapGraphQLToClientError(
+  error: Pick<AppSyncError, 'errorType' | 'message'>,
+): Error {
   switch (error.errorType) {
     case 'sudoplatform.AccountLockedError':
       return new AccountLockedError()
@@ -435,6 +437,8 @@ export function mapGraphQLToClientError(error: AppSyncError): Error {
       return new InvalidTokenError()
     case 'sudoplatform.InvalidArgumentError':
       return new IllegalArgumentError()
+    case 'sudoplatform.LimitExceededError':
+      return new LimitExceededError()
     case 'sudoplatform.NoEntitlementsError':
       return new NoEntitlementsError()
     case 'sudoplatform.ServiceError':

package/github/test/integration/defaultConfigurationManager.spec.ts

@@ -0,0 +1,85 @@
+import { DefaultConfigurationManager } from '../../src/configurationManager/defaultConfigurationManager'
+import { readFileSync, existsSync } from 'fs'
+import { TextEncoder, TextDecoder } from 'util'
+
+global.TextEncoder = TextEncoder
+global.TextDecoder = TextDecoder
+
+describe('configuration manager', () => {
+  const configFilePath = 'config/sudoplatformconfig.json'
+  if (existsSync(configFilePath)) {
+    const config = readFileSync(configFilePath, 'utf-8')
+    const json = JSON.parse(config)
+
+    describe('validateConfig', () => {
+      it('should return deprecated service info if equal to deprecated version', async () => {
+        const config = {
+          identityService: {
+            region: json.identityService.region,
+            serviceInfoBucket: json.identityService.serviceInfoBucket,
+          },
+          vcService: {
+            version: 3,
+          },
+        }
+
+        const manager = DefaultConfigurationManager.getInstance().setConfig(
+          JSON.stringify(config),
+        )
+
+        await expect(manager.validateConfig()).resolves.toEqual({
+          deprecated: [
+            {
+              configVersion: 3,
+              minSupportedVersion: 2,
+              deprecatedVersion: 3,
+              name: 'vcService',
+            },
+          ],
+          incompatible: [],
+        })
+      })
+
+      it('should return incompatible service info if less than min version', async () => {
+        const config = {
+          identityService: {
+            region: json.identityService.region,
+            serviceInfoBucket: json.identityService.serviceInfoBucket,
+          },
+          vcService: {
+            version: 1,
+          },
+        }
+
+        const manager = DefaultConfigurationManager.getInstance().setConfig(
+          JSON.stringify(config),
+        )
+
+        await expect(manager.validateConfig()).resolves.toEqual({
+          deprecated: [
+            {
+              configVersion: 1,
+              minSupportedVersion: 2,
+              deprecatedVersion: 3,
+              name: 'vcService',
+            },
+          ],
+          incompatible: [
+            {
+              configVersion: 1,
+              minSupportedVersion: 2,
+              deprecatedVersion: 3,
+              name: 'vcService',
+            },
+          ],
+        })
+      })
+    })
+  } else {
+    it('Skip all tests.', () => {
+      console.log(
+        'No sudoplatformconfig.json, test key and test key ID file found. Skipping all integration tests.',
+      )
+    })
+  }
+})