@adobe/spacecat-shared-utils 1.8.0 → 1.10.0

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [@adobe/spacecat-shared-utils-v1.10.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-utils-v1.9.0...@adobe/spacecat-shared-utils-v1.10.0) (2024-02-07)
+
+
+### Features
+
+* move sqs wrapper to scpacecat-shared ([#136](https://github.com/adobe/spacecat-shared/issues/136)) ([b9f6d75](https://github.com/adobe/spacecat-shared/commit/b9f6d75d755cdd3d093f1bc016e643de6ef0abcd))
+
+# [@adobe/spacecat-shared-utils-v1.9.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-utils-v1.8.0...@adobe/spacecat-shared-utils-v1.9.0) (2024-02-06)
+
+
+### Features
+
+* introduce AWS S3 wrapper ([#135](https://github.com/adobe/spacecat-shared/issues/135)) ([4ad1bb6](https://github.com/adobe/spacecat-shared/commit/4ad1bb64414086af5d399317697debb6aff0fb74))
+
 # [@adobe/spacecat-shared-utils-v1.8.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-utils-v1.7.4...@adobe/spacecat-shared-utils-v1.8.0) (2024-02-05)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/spacecat-shared-utils",
-  "version": "1.8.0",
+  "version": "1.10.0",
   "description": "Shared modules of the Spacecat Services - utils",
   "type": "module",
   "main": "src/index.js",
@@ -11,6 +11,7 @@
     "clean": "rm -rf package-lock.json node_modules"
   },
   "mocha": {
+    "require": "test/setup-env.js",
     "reporter": "mocha-multi-reporters",
     "reporter-options": "configFile=.mocha-multi.json",
     "spec": "test/*.test.js"
@@ -29,10 +30,17 @@
     "access": "public"
   },
   "devDependencies": {
+    "@adobe/helix-shared-wrap": "2.0.1",
     "chai": "4.4.1",
-    "sinon": "17.0.1"
+    "chai-as-promised": "7.1.1",
+    "husky": "9.0.6",
+    "nock": "13.5.1",
+    "sinon": "17.0.1",
+    "sinon-chai": "3.7.0"
   },
   "dependencies": {
-    "@adobe/fetch": "4.1.1"
+    "@adobe/fetch": "4.1.1",
+    "@aws-sdk/client-s3": "3.507.0",
+    "@aws-sdk/client-sqs": "3.507.0"
   }
 }

package/src/s3.js

@@ -0,0 +1,28 @@
+/*
+ * 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 { S3Client } from '@aws-sdk/client-s3';
+
+export function s3Bucket(fn) {
+  return async (req, context) => {
+    if (!context.s3) {
+      const {
+        AWS_REGION: region,
+        S3_BUCKET_NAME: bucket,
+      } = context.env;
+
+      context.s3 = new S3Client({ region });
+      context.s3Bucket = bucket;
+    }
+    return fn(req, context);
+  };
+}

package/src/sqs.js

@@ -10,6 +10,53 @@
  * governing permissions and limitations under the License.
  */
 
+import { SendMessageCommand, SQSClient } from '@aws-sdk/client-sqs';
+
+/**
+ * @class SQS utility to send messages to SQS
+ * @param {string} region - AWS region
+ * @param {object} log - log object
+ */
+class SQS {
+  constructor(region, log) {
+    this.sqsClient = new SQSClient({ region });
+    this.log = log;
+  }
+
+  async sendMessage(queueUrl, message) {
+    const body = {
+      ...message,
+      timestamp: new Date().toISOString(),
+    };
+
+    const msgCommand = new SendMessageCommand({
+      MessageBody: JSON.stringify(body),
+      QueueUrl: queueUrl,
+    });
+
+    try {
+      const data = await this.sqsClient.send(msgCommand);
+      this.log.info(`Success, message sent. MessageID:  ${data.MessageId}`);
+    } catch (e) {
+      const { type, code, message: msg } = e;
+      this.log.error(`Message sent failed. Type: ${type}, Code: ${code}, Message: ${msg}`);
+      throw e;
+    }
+  }
+}
+
+export default function sqsWrapper(fn) {
+  return async (request, context) => {
+    if (!context.sqs) {
+      const { log } = context;
+      const { region } = context.runtime;
+      context.sqs = new SQS(region, log);
+    }
+
+    return fn(request, context);
+  };
+}
+
 /**
  * Wrapper to turn an SQS record into a function param
  * Inspired by https://github.com/adobe/helix-admin/blob/main/src/index.js#L108-L133