@skillswaveca/nova-shared-libraries 4.18.1 → 4.19.0

package/docs-base/package-info.js

@@ -1,31 +1,31 @@
 export const packageInfo = [
   {
     "name": "@skillswaveca/nova-utils",
-    "version": "4.18.0",
+    "version": "4.18.2",
     "description": "A collection of random utils used in nova repos",
     "docsPath": "./nova-utils/index.html"
   },
   {
     "name": "@skillswaveca/nova-router",
-    "version": "4.18.0",
+    "version": "4.18.2",
     "description": "An extended Koa router that enables better validation",
     "docsPath": "./nova-router/index.html"
   },
   {
     "name": "@skillswaveca/nova-model",
-    "version": "4.18.0",
+    "version": "4.18.2",
     "description": "Nova model stuff",
     "docsPath": "./nova-model/index.html"
   },
   {
     "name": "@skillswaveca/nova-middleware",
-    "version": "4.18.0",
+    "version": "4.18.2",
     "description": "A collection of middleware used by nova projects",
     "docsPath": "./nova-middleware/index.html"
   },
   {
     "name": "@skillswaveca/nova-drivers",
-    "version": "4.18.0",
+    "version": "4.18.2",
     "description": "Some helper drivers for AWS services",
     "docsPath": "./drivers/index.html"
   }

package/index.js

@@ -10,6 +10,7 @@ export * from './packages/drivers/src/nova-driver.js';
 export * from './packages/drivers/src/kraken-driver.js';
 export * from './packages/drivers/src/http.js';
 export * from './packages/drivers/src/config.js';
+export * from './packages/drivers/src/base-driver.js';
 export * from './packages/nova-model/src/stream/nova-stream-task-router.js';
 export * from './packages/nova-model/src/repo/nova-model-repo.js';
 export * from './packages/nova-model/src/repo/api-token.js';

package/package.json

@@ -3,7 +3,7 @@
   "name": "@skillswaveca/nova-shared-libraries",
   "description": "A monorepo of shared libraries for Nova projects.",
   "repository": "https://github.com/SkillsWave/nova-shared-libraries",
-  "version": "4.18.1",
+  "version": "4.19.0",
   "main": "index.js",
   "license": "MIT",
   "keywords": [],

package/packages/drivers/index.js

@@ -4,6 +4,7 @@ export * from './src/nova-driver.js';
 export * from './src/kraken-driver.js';
 export * from './src/http.js';
 export * from './src/config.js';
+export * from './src/base-driver.js';
 export * from './src/aws/sqs.js';
 export * from './src/aws/secrets-manager.js';
 export * from './src/aws/parameter-store.js';

package/packages/drivers/package.json

@@ -3,7 +3,7 @@
   "name": "@skillswaveca/nova-drivers",
   "description": "Some helper drivers for AWS services",
   "repository": "https://github.com/SkillsWave/nova-shared-libraries",
-  "version": "4.18.1",
+  "version": "4.19.0",
   "main": "index.js",
   "scripts": {
     "pre-release": "pnpm run create-index",

package/packages/drivers/src/aws/aws-base-driver.js

@@ -1,5 +1,5 @@
 import xray from 'aws-xray-sdk-core';
-import { NovaDriver } from '../nova-driver.js';
+import { BaseDriver } from '../base-driver.js';
 
 /**
  * Base driver for AWS services. You can extend this driver with any AWS service to set the client and automatically capture AWS X-Ray traces.
@@ -13,7 +13,7 @@ import { NovaDriver } from '../nova-driver.js';
  *  }
 *  }
  */
-export class AwsBaseDriver extends NovaDriver {
+export class AwsBaseDriver extends BaseDriver {
 
   /**
    * Constructor for the AWS base driver.

package/packages/drivers/src/base-driver.js

@@ -0,0 +1,27 @@
+import { DEFAULT_CONFIG } from './config.js';
+
+export class BaseDriver {
+
+  constructor(configOverrides = {}) {
+    this.config = { ...DEFAULT_CONFIG, ...configOverrides };
+    this.log = this.config.logger;
+    this.enabled = this.config.enabled;
+    this.novaRequestId = null;
+    this.region = this.config.aws.region;
+    this.rootEnvironmentAwsAccountId = this.config.rootEnvironmentAwsAccountId;
+  }
+
+  /**
+   * Provides a way to override the context of the driver. Specifically useful for logging
+   * and sending requests making use of the `distributedLoggingMiddleware` and it's reliance
+   * on the http header `x-nova-request-id`
+   *
+   * @param novaRequestId - The unique id of the request to send to external services
+   * @param log - The provided logger to use
+   */
+  useContext({ novaRequestId, log }) {
+    this.novaRequestId = novaRequestId;
+    this.log = log || this.log;
+  }
+
+}

package/packages/drivers/src/nova-driver.js

@@ -1,32 +1,27 @@
-import { DEFAULT_CONFIG } from './config.js';
+import { BaseDriver } from './base-driver.js';
+
+import { secretsManager } from './aws/secrets-manager.js';
 
 /**
  * NovaDriver class to provide a common interface for all drivers.
 
  */
-export class NovaDriver {
+export class NovaDriver extends BaseDriver {
 
   /**
    * NovaDriver constructor.
    * @param {Object} configOverrides - Configuration overrides for the Nova driver.
    */
   constructor(configOverrides = {}) {
-    this.config = { ...DEFAULT_CONFIG, ...configOverrides };
-    this.log = this.config.logger;
-    this.enabled = this.config.enabled;
-    this.novaRequestId = null;
+    super(configOverrides);
   }
 
-  /**
-   * Provides a way to override the context of the driver. Specifically useful for logging
-   * and sending requests making use of the `distributedLoggingMiddleware` and it's reliance
-   * on the http header `x-nova-request-id`
-   *
-   * @param novaRequestId - The unique id of the request to send to external services
-   * @param log - The provided logger to use
-   */
-  useContext({ novaRequestId, log }) {
-    this.novaRequestId = novaRequestId;
-    this.log = log || this.log;
+  async getSecret() {
+    if (!this.secretKey) {
+      return undefined;
+    }
+
+    const secret = await secretsManager.getSecret(this.secretKey, this.secretKeyId, this.region, this.rootEnvironmentAwsAccountId);
+    return secret;
   }
 }

package/packages/drivers/src/oauth.js

@@ -4,8 +4,6 @@ import { HttpDriver } from './http.js';
 import { ApiToken } from '../../nova-model/src/model/api-token.js';
 import { apiTokenRepo } from '../../nova-model/src/repo/api-token.js';
 
-import { secretsManager } from './aws/secrets-manager.js';
-
 const TOKEN_EXPIRATION_WINDOW_SECONDS = 60;
 
 /**
@@ -55,8 +53,6 @@ export class OAuthDriver extends HttpDriver {
     this.secretKey = oauth.client.secret;
     this.secretKeyId = oauth.client.secretKeyId;
 
-    this.region = configuration.region;
-    this.rootEnvironmentAwsAccountId = configuration.rootEnvironmentAwsAccountId
   }
 
   /**
@@ -147,7 +143,7 @@ export class OAuthDriver extends HttpDriver {
     if (this.clientCredentialsInstance) {
       return this.clientCredentialsInstance;
     }
-    if (this.secretKey) this.clientConfig.client.secret = await secretsManager.getSecret(this.secretKey, this.secretKeyId, this.region, this.rootEnvironmentAwsAccountId);
+    if (this.secretKey) this.clientConfig.client.secret = await this.getSecret();
     delete this.clientConfig.client.secretKeyId;
     this.clientCredentialsInstance = new ClientCredentials(this.clientConfig);
     return this.clientCredentialsInstance;

package/packages/nova-middleware/package.json

@@ -3,7 +3,7 @@
   "name": "@skillswaveca/nova-middleware",
   "description": "A collection of middleware used by nova projects",
   "repository": "https://github.com/SkillsWave/nova-shared-libraries",
-  "version": "4.18.1",
+  "version": "4.19.0",
   "main": "index.js",
   "scripts": {
     "pre-release": "pnpm run create-index",

package/packages/nova-model/package.json

@@ -3,7 +3,7 @@
   "name": "@skillswaveca/nova-model",
   "description": "Nova model stuff",
   "repository": "https://github.com/SkillsWave/nova-shared-libraries",
-  "version": "4.18.1",
+  "version": "4.19.0",
   "main": "index.js",
   "scripts": {
     "pre-release": "pnpm run create-index",

package/packages/nova-model/src/repo/nova-model-repo.js

@@ -162,55 +162,15 @@ export class NovaModelRepo {
     return undefined;
   }
 
-  // This recursive code handles paged data in query results
-  async getAllResultsRecursive(context, params, results, limit, level = 0, startTime = 0, startingParams) {
-    if (level === 0) {
-      startTime = Date.now();
-      startingParams = Object.assign({}, params);
-    }
-    level++;
-
-    if (limit) {
-      params.Limit = limit - results.length;
-    }
-
-    const data = await this.query(context, params);
-
-    if (data?.Items?.length > 0) {
-      results.push(...data.Items);
-    }
-
-    if (data.LastEvaluatedKey) {
-      params.ExclusiveStartKey = data.LastEvaluatedKey;
-    } else if (params.ExclusiveStartKey) {
-      delete params.ExclusiveStartKey;
-    }
-
-    if (data.LastEvaluatedKey && (!limit || results.length < limit)) {
-      return await this.getAllResultsRecursive(context, params, results, limit, level, startTime, startingParams);
-    } else {
-      const endTime = Date.now();
-      const timeTaken = endTime - startTime;
-      if ((level >= DDB_WARN_RECURSION_LEVELS) || (timeTaken >= DDB_WARN_TIME)) {
-        context.log.warn({ startingParams, timeTaken, recursionLevel: level }, `getAllResultsRecursive: ${level} ${(level === 1) ? 'query' : 'queries'} for startingParams; took ${timeTaken} ms`);
-      }
-
-      return limit ? results.slice(0, limit) : results;
-    }
-  }
-
   /**
    * This function returns the array of recursively retrieved results based
    * on a DynamoDB query with the given parameters. It uses the
    * getAllResultsRecursive function and returns all pages of results.
-   * @param {Object} context
    * @param {Object} params - DynamoDB query params
    * @returns {Array<*>} recursively retrieved results from dynamoDb query
    */
-  async getAllResults(context, params) {
-    const results = [];
-    await this.getAllResultsRecursive(context, params, results);
-    return results?.Items || results;
+  async getAllResults(params) {
+    return await this.dynamodb.getAllResults(params);
   }
 
   /**

package/packages/nova-router/package.json

@@ -3,13 +3,12 @@
   "name": "@skillswaveca/nova-router",
   "description": "An extended Koa router that enables better validation",
   "repository": "https://github.com/SkillsWave/nova-shared-libraries",
-  "version": "4.18.1",
+  "version": "4.19.0",
   "main": "index.js",
   "scripts": {
     "pre-release": "pnpm run create-index",
     "create-index": "node ../../scripts/create-index.js",
-    "generate-docs": "documentation build src/** -f html -o docs",
-    "test": "mocha --parallel 'test/**/*.test.js'"
+    "generate-docs": "documentation build src/** -f html -o docs"
   },
   "author": "SkillsWave",
   "license": "UNLICENSED",

package/packages/nova-utils/package.json

@@ -3,7 +3,7 @@
   "name": "@skillswaveca/nova-utils",
   "description": "A collection of random utils used in nova repos",
   "repository": "https://github.com/SkillsWave/nova-shared-libraries",
-  "version": "4.18.1",
+  "version": "4.19.0",
   "main": "index.js",
   "scripts": {
     "pre-release": "pnpm run create-index",