@adobe/spacecat-shared-utils 1.9.0 → 1.11.0

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [@adobe/spacecat-shared-utils-v1.11.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-utils-v1.10.0...@adobe/spacecat-shared-utils-v1.11.0) (2024-02-07)
+
+
+### Features
+
+* url helpers in utils ([#139](https://github.com/adobe/spacecat-shared/issues/139)) ([0a90c1b](https://github.com/adobe/spacecat-shared/commit/0a90c1b80a1fd7fb0cd267b7f7fca45fb1186c48))
+
+# [@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)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/spacecat-shared-utils",
-  "version": "1.9.0",
+  "version": "1.11.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,11 +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",
-    "@aws-sdk/client-s3": "3.507.0"
+    "@aws-sdk/client-s3": "3.507.0",
+    "@aws-sdk/client-sqs": "3.507.0"
   }
 }

package/src/index.d.ts

@@ -39,3 +39,45 @@ export function dateAfterDays(days: string): Date;
 
 export function sqsEventAdapter(fn: (message: object, context: object) => Promise<Response>):
   (request: object, context: object) => Promise<Response>;
+
+/**
+ * Prepends 'https://' schema to the URL if it's not already present.
+ * @param url - The URL to modify.
+ * @returns The URL with 'https://' schema prepended.
+ */
+declare function prependSchema(url: string): string;
+
+/**
+ * Strips the port number from the end of the URL.
+ * @param url - The URL to modify.
+ * @returns The URL with the port removed.
+ */
+declare function stripPort(url: string): string;
+
+/**
+ * Strips the trailing dot from the end of the URL.
+ * @param url - The URL to modify.
+ * @returns The URL with the trailing dot removed.
+ */
+declare function stripTrailingDot(url: string): string;
+
+/**
+ * Strips the trailing slash from the end of the URL.
+ * @param url - The URL to modify.
+ * @returns The URL with the trailing slash removed.
+ */
+declare function stripTrailingSlash(url: string): string;
+
+/**
+ * Strips 'www.' from the beginning of the URL if present.
+ * @param url - The URL to modify.
+ * @returns The URL with 'www.' removed.
+ */
+declare function stripWWW(url: string): string;
+
+/**
+ * Composes a base URL by applying a series of transformations to the given domain.
+ * @param domain - The domain to compose the base URL from.
+ * @returns The composed base URL.
+ */
+declare function composeBaseURL(domain: string): string;

package/src/index.js

@@ -30,3 +30,12 @@ export {
 export { resolveSecretsName } from './helpers.js';
 
 export { sqsEventAdapter } from './sqs.js';
+
+export {
+  composeBaseURL,
+  prependSchema,
+  stripPort,
+  stripTrailingDot,
+  stripTrailingSlash,
+  stripWWW,
+} from './url-helpers.js';

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

package/src/url-helpers.js

@@ -0,0 +1,81 @@
+/*
+ * 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.
+ */
+
+/**
+ * Prepends 'https://' schema to the URL if it's not already present.
+ * @param {string} url - The URL to modify.
+ * @returns {string} - The URL with 'https://' schema prepended.
+ */
+function prependSchema(url) {
+  return url.startsWith('http://') || url.startsWith('https://') ? url : `https://${url}`;
+}
+
+/**
+ * Strips the port number from the end of the URL.
+ * @param {string} url - The URL to modify.
+ * @returns {string} - The URL with the port removed.
+ */
+function stripPort(url) {
+  return url.replace(/:\d{1,5}(\/|$)/, '');
+}
+
+/**
+ * Strips the trailing dot from the end of the URL.
+ * @param {string} url - The URL to modify.
+ * @returns {string} - The URL with the trailing dot removed.
+ */
+function stripTrailingDot(url) {
+  return url.endsWith('.') ? url.slice(0, -1) : url;
+}
+
+/**
+ * Strips the trailing slash from the end of the URL.
+ * @param {string} url - The URL to modify.
+ * @returns {string} - The URL with the trailing slash removed.
+ */
+function stripTrailingSlash(url) {
+  return url.endsWith('/') ? url.slice(0, -1) : url;
+}
+
+/**
+ * Strips 'www.' from the beginning of the URL if present.
+ * @param {string} url - The URL to modify.
+ * @returns {string} - The URL with 'www.' removed.
+ */
+function stripWWW(url) {
+  const regex = /^(https?:\/\/)?(www\.)?/;
+  // Replace "www." with an empty string, preserving the schema if present
+  return url.replace(regex, (match, schema) => (schema || ''));
+}
+
+/**
+ * Composes a base URL by applying a series of transformations to the given domain.
+ * @param {string} domain - The domain to compose the base URL from.
+ * @returns {string} - The composed base URL.
+ */
+function composeBaseURL(domain) {
+  let baseURL = stripTrailingDot(domain);
+  baseURL = stripPort(baseURL);
+  baseURL = stripTrailingSlash(baseURL);
+  baseURL = stripWWW(baseURL);
+  baseURL = prependSchema(baseURL);
+  return baseURL;
+}
+
+export {
+  composeBaseURL,
+  prependSchema,
+  stripPort,
+  stripTrailingDot,
+  stripTrailingSlash,
+  stripWWW,
+};