@adobe/spacecat-shared-utils 1.31.1 → 1.33.0

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [@adobe/spacecat-shared-utils-v1.33.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-utils-v1.32.0...@adobe/spacecat-shared-utils-v1.33.0) (2025-02-21)
+
+
+### Features
+
+* set default fetch user-agent ([#620](https://github.com/adobe/spacecat-shared/issues/620)) ([bd4b38c](https://github.com/adobe/spacecat-shared/commit/bd4b38c84ba4e85ec4d375a3e110de8845688d2a))
+
+# [@adobe/spacecat-shared-utils-v1.32.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-utils-v1.31.1...@adobe/spacecat-shared-utils-v1.32.0) (2025-02-17)
+
+
+### Features
+
+* introduce fetch config for site to use custom headers ([#585](https://github.com/adobe/spacecat-shared/issues/585)) ([10a2892](https://github.com/adobe/spacecat-shared/commit/10a28928c3946ea05c4644f16971ccff8d43e994))
+
 # [@adobe/spacecat-shared-utils-v1.31.1](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-utils-v1.31.0...@adobe/spacecat-shared-utils-v1.31.1) (2025-02-16)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/spacecat-shared-utils",
-  "version": "1.31.1",
+  "version": "1.33.0",
   "description": "Shared modules of the Spacecat Services - utils",
   "type": "module",
   "engines": {

package/src/index.d.ts

@@ -103,7 +103,7 @@ declare function composeBaseURL(domain: string): string;
  * @param {string} [userAgent] - Optional user agent to use in the audit URL.
  * @returns a promise that resolves the composed audit URL.
  */
-declare function composeAuditURL(url: string, userAgent: string): Promise<string>;
+declare function composeAuditURL(url: string, userAgent?: string): Promise<string>;
 
 /**
  * Resolves the name of the secret based on the function version.
@@ -242,3 +242,5 @@ export function s3Wrapper(fn: (request: object, context: object) => Promise<Resp
 export function fetch(url: string | Request, options?: RequestOptions): Promise<Response>;
 
 export function tracingFetch(url: string | Request, options?: RequestOptions): Promise<Response>;
+
+export const SPACECAT_USER_AGENT: string;

package/src/index.js

@@ -60,5 +60,5 @@ export { getStoredMetrics, storeMetrics } from './metrics-store.js';
 export { s3Wrapper } from './s3.js';
 
 export { fetch } from './adobe-fetch.js';
-export { tracingFetch } from './tracing-fetch.js';
+export { tracingFetch, SPACECAT_USER_AGENT } from './tracing-fetch.js';
 export { getHighFormViewsLowConversionMetrics, getHighPageViewsLowFormViewsMetrics, getHighPageViewsLowFormCtrMetrics } from './formcalc.js';

package/src/tracing-fetch.js

@@ -13,7 +13,9 @@ import { Request } from '@adobe/fetch';
 import AWSXRay from 'aws-xray-sdk';
 
 import { fetch as adobeFetch } from './adobe-fetch.js';
-import { isNumber } from './functions.js';
+import { isNumber, isObject } from './functions.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';
 
 /**
  * Creates a subsegment for a given hostname based on whether the parent segment is traced or not.
@@ -114,6 +116,21 @@ const handleSubSegmentError = (subSegment, request, error) => {
 export async function tracingFetch(url, options) {
   const parentSegment = AWSXRay.getSegment();
 
+  options = isObject(options) ? options : {};
+  options.headers = isObject(options.headers) ? options.headers : new Headers();
+
+  // find user-agent header in headers case insensitively
+  let hasUserAgent = false;
+  Object.keys(options.headers).forEach((key) => {
+    if (key.toLowerCase() === 'user-agent') {
+      hasUserAgent = true;
+    }
+  });
+
+  if (!hasUserAgent) {
+    options.headers['User-Agent'] = SPACECAT_USER_AGENT;
+  }
+
   if (!parentSegment) {
     return adobeFetch(url, options);
   }