@adobe/spacecat-shared-utils 1.36.3 → 1.37.0

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [@adobe/spacecat-shared-utils-v1.37.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-utils-v1.36.3...@adobe/spacecat-shared-utils-v1.37.0) (2025-04-28)
+
+
+### Features
+
+* **xray:** non-aws ie local friendly xray instrumentation ([#710](https://github.com/adobe/spacecat-shared/issues/710)) ([5184b4d](https://github.com/adobe/spacecat-shared/commit/5184b4dc3ddff8a6e44d12129475fa323533be2c))
+
 # [@adobe/spacecat-shared-utils-v1.36.3](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-utils-v1.36.2...@adobe/spacecat-shared-utils-v1.36.3) (2025-04-26)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/spacecat-shared-utils",
-  "version": "1.36.3",
+  "version": "1.37.0",
   "description": "Shared modules of the Spacecat Services - utils",
   "type": "module",
   "engines": {
@@ -38,6 +38,7 @@
     "@adobe/spacecat-shared-data-access": "2.0.2",
     "chai": "5.2.0",
     "chai-as-promised": "8.0.1",
+    "esmock": "2.7.0",
     "husky": "9.1.7",
     "nock": "14.0.4",
     "sinon": "20.0.0",

package/src/index.js

@@ -41,10 +41,15 @@ export {
   getQuery,
 } from './helpers.js';
 
+export {
+  isAWSLambda,
+} from './runtimes.js';
+
 export { sqsWrapper } from './sqs.js';
 export { sqsEventAdapter } from './sqs.js';
 
 export { logWrapper } from './log-wrapper.js';
+export { xrayWrapper } from './xray.js';
 
 export {
   composeBaseURL,

package/src/runtimes.js

@@ -0,0 +1,17 @@
+/*
+ * Copyright 2025 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 { hasText } from './functions.js';
+
+export function isAWSLambda() {
+  return hasText(process.env.AWS_EXECUTION_ENV) && process.env.AWS_EXECUTION_ENV.startsWith('AWS_Lambda');
+}

package/src/tracing-fetch.js

@@ -14,6 +14,7 @@ import AWSXRay from 'aws-xray-sdk';
 
 import { fetch as adobeFetch } from './adobe-fetch.js';
 import { isNumber, isObject } from './functions.js';
+import { isAWSLambda } from './runtimes.js';
 
 export const SPACECAT_USER_AGENT = 'Mozilla/5.0 (Linux; Android 11; moto g power (2022)) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/119.0.0.0 Mobile Safari/537.36 Spacecat/1.0';
 
@@ -150,6 +151,11 @@ const fetchWithTimeout = async (resource, options, signal) => {
  * @returns {Promise<Response>} The response from the fetch request.
  */
 export async function tracingFetch(url, options) {
+  // fallback to adobe fetch outside an aws lambda function
+  if (!isAWSLambda()) {
+    return adobeFetch;
+  }
+
   const parentSegment = AWSXRay.getSegment();
 
   options = isObject(options) ? { ...options } : {};

package/src/xray.js

@@ -0,0 +1,28 @@
+/*
+ * Copyright 2025 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 AWSXray from 'aws-xray-sdk';
+import { isAWSLambda } from './runtimes.js';
+
+export function xrayWrapper(fn) {
+  return async (req, context) => {
+    if (context.xray) {
+      return context.xray;
+    }
+
+    context.xray = {
+      instrument: (client) => (isAWSLambda() ? AWSXray.captureAWSv3Client(client) : client),
+    };
+
+    return fn(req, context);
+  };
+}