@adobe/spacecat-shared-utils 1.19.3 → 1.19.5

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [@adobe/spacecat-shared-utils-v1.19.5](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-utils-v1.19.4...@adobe/spacecat-shared-utils-v1.19.5) (2024-08-20)
+
+
+### Bug Fixes
+
+* move metrics-store and s3 in shared utils ([#327](https://github.com/adobe/spacecat-shared/issues/327)) ([bff367c](https://github.com/adobe/spacecat-shared/commit/bff367cf05f9b7d802a7b8c24bc81abbf0e2665c))
+
+# [@adobe/spacecat-shared-utils-v1.19.4](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-utils-v1.19.3...@adobe/spacecat-shared-utils-v1.19.4) (2024-08-19)
+
+
+### Bug Fixes
+
+* **deps:** update external fixes ([#332](https://github.com/adobe/spacecat-shared/issues/332)) ([b2bb2a4](https://github.com/adobe/spacecat-shared/commit/b2bb2a4dd1a0995c36cd2b64510b7c4e0e05436f))
+
 # [@adobe/spacecat-shared-utils-v1.19.3](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-utils-v1.19.2...@adobe/spacecat-shared-utils-v1.19.3) (2024-08-14)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/spacecat-shared-utils",
-  "version": "1.19.3",
+  "version": "1.19.5",
   "description": "Shared modules of the Spacecat Services - utils",
   "type": "module",
   "main": "src/index.js",
@@ -32,17 +32,17 @@
   "devDependencies": {
     "@adobe/helix-shared-wrap": "2.0.2",
     "@adobe/spacecat-shared-data-access": "file:../spacecat-shared-data-access",
-    "chai": "4.5.0",
+    "chai": "5.1.1",
     "chai-as-promised": "8.0.0",
     "husky": "9.1.4",
     "nock": "13.5.4",
     "sinon": "18.0.0",
-    "sinon-chai": "3.7.0"
+    "sinon-chai": "4.0.0"
   },
   "dependencies": {
     "@adobe/fetch": "4.1.8",
-    "@aws-sdk/client-s3": "3.627.0",
-    "@aws-sdk/client-sqs": "3.624.0",
+    "@aws-sdk/client-s3": "3.633.0",
+    "@aws-sdk/client-sqs": "3.632.0",
     "@json2csv/plainjs": "7.0.6"
   }
 }

package/src/functions.js

@@ -180,7 +180,7 @@ function isValidUrl(urlString) {
   try {
     const url = new URL(urlString);
     return url.protocol === 'http:' || url.protocol === 'https:';
-  } catch (e) {
+  } catch {
     return false;
   }
 }

package/src/helpers.js

@@ -47,7 +47,7 @@ export function resolveCustomerSecretsName(baseURL, ctx) {
   let customer;
   try {
     customer = new URL(baseURL).host.replace(/[^a-zA-Z0-9]/g, '_').toLowerCase();
-  } catch (e) {
+  } catch {
     throw new Error('Invalid baseURL: must be a valid URL');
   }
   return resolveSecretsName({}, ctx, `${basePath}/${customer}`);

package/src/index.d.ts

@@ -124,3 +124,38 @@ declare function resolveCustomerSecretsName(baseURL: string, ctx: object): strin
  * @returns {Buffer} A Buffer containing the CSV formatted data, encoded in UTF-8.
  */
 declare function generateCSVFile(data: object[]): Buffer;
+
+/**
+ * Retrieves stored metrics from S3.
+ * @param config - Configuration object
+ * @param config.siteId - The site ID.
+ * @param config.source - The source of the metrics.
+ * @param config.metric - The metric name.
+ * @param context - Context object
+ * @param context.log - Logger
+ * @param context.s3 - S3 configuration
+ * @param context.s3.s3Client - S3 client
+ * @param context.s3.s3Bucket - S3 bucket name
+ * @returns {Promise<any|*[]>} - The stored metrics
+ */
+export function getStoredMetrics(config: object, context: object):
+    Promise<Array<object>>;
+
+/**
+ * Stores metrics in S3.
+ * @param content - The metrics to store
+ * @param config - Configuration object
+ * @param config.siteId - The site ID
+ * @param config.source - The source of the metrics
+ * @param config.metric - The metric name
+ * @param context - Context object
+ * @param context.log - Logger
+ * @param context.s3 - S3 configuration
+ * @param context.s3.s3Client - S3 client
+ * @param context.s3.s3Bucket - S3 bucket name
+ * @returns {Promise<string>} - The path where the metrics are stored
+ */
+export function storeMetrics(content: object, config: object, context: object): Promise<string>;
+
+export function s3Wrapper(fn: (request: object, context: object) => Promise<Response>):
+    (request: object, context: object) => Promise<Response>;

package/src/index.js

@@ -47,3 +47,7 @@ export {
   stripTrailingSlash,
   stripWWW,
 } from './url-helpers.js';
+
+export { getStoredMetrics, storeMetrics } from './metrics-store.js';
+
+export { s3Wrapper } from './s3.js';

package/src/metrics-store.js

@@ -0,0 +1,82 @@
+/*
+ * Copyright 2024 Adobe. All rights reserved.
+ * This file is licensed to you under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License. You may obtain a copy
+ * of the License at http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under
+ * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+ * OF ANY KIND, either express or implied. See the License for the specific language
+ * governing permissions and limitations under the License.
+ */
+import { GetObjectCommand, PutObjectCommand } from '@aws-sdk/client-s3';
+
+function createFilePath({ siteId, source, metric }) {
+  if (!siteId) {
+    throw new Error('siteId is required to compose metrics storage path');
+  }
+
+  if (!source) {
+    throw new Error('source is required to compose metrics storage path');
+  }
+
+  if (!metric) {
+    throw new Error('metric is required to compose metrics storage path');
+  }
+
+  return `metrics/${siteId}/${source}/${metric}.json`;
+}
+
+export async function getStoredMetrics(config, context) {
+  const { log, s3 } = context;
+
+  if (!s3.s3Bucket) {
+    throw new Error('S3 bucket name is required to get stored metrics');
+  }
+
+  const filePath = createFilePath(config);
+
+  const command = new GetObjectCommand({
+    Bucket: s3.s3Bucket,
+    Key: filePath,
+  });
+
+  try {
+    const response = await s3.s3Client.send(command);
+    const content = await response.Body?.transformToString();
+    const metrics = JSON.parse(content);
+    log.info(`Successfully retrieved ${metrics.length} metrics from ${filePath}`);
+
+    return metrics;
+  } catch (e) {
+    log.error(`Failed to retrieve metrics from ${filePath}, error: ${e.message}`);
+    return [];
+  }
+}
+
+export async function storeMetrics(content, config, context) {
+  const { log, s3 } = context;
+
+  if (!s3.s3Bucket) {
+    throw new Error('S3 bucket name is required to store metrics');
+  }
+
+  const filePath = createFilePath(config);
+
+  const command = new PutObjectCommand({
+    Bucket: s3.s3Bucket,
+    Key: filePath,
+    Body: JSON.stringify(content, null, 2),
+    ContentType: 'application/json',
+  });
+
+  try {
+    const response = await s3.s3Client.send(command);
+    log.info(`Successfully uploaded metrics to ${filePath}, response: ${JSON.stringify(response)}`);
+
+    return filePath;
+  } catch (e) {
+    log.error(`Failed to upload metrics to ${filePath}, error: ${e.message}`);
+    throw new Error(`Failed to upload metrics to ${filePath}, error: ${e.message}`);
+  }
+}

package/src/s3.js

@@ -12,17 +12,26 @@
 
 import { S3Client } from '@aws-sdk/client-s3';
 
-export function s3Bucket(fn) {
-  return async (req, context) => {
+/**
+ * Adds an S3Client instance and bucket to the context.
+ *
+ * @param {UniversalAction} fn
+ * @returns {function(object, UniversalContext): Promise<Response>}
+ */
+export function s3Wrapper(fn) {
+  return async (request, context) => {
     if (!context.s3) {
+      context.s3 = {};
+
       const {
         AWS_REGION: region,
         S3_BUCKET_NAME: bucket,
       } = context.env;
 
-      context.s3 = new S3Client({ region });
-      context.s3Bucket = bucket;
+      context.s3.s3Client = new S3Client({ region });
+      context.s3.s3Bucket = bucket;
     }
-    return fn(req, context);
+
+    return fn(request, context);
   };
 }