@adobe/spacecat-shared-utils 1.20.8 → 1.21.0

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [@adobe/spacecat-shared-utils-v1.21.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-utils-v1.20.8...@adobe/spacecat-shared-utils-v1.21.0) (2024-10-23)
+
+
+### Features
+
+* tracing fetch ([#409](https://github.com/adobe/spacecat-shared/issues/409)) ([6579a26](https://github.com/adobe/spacecat-shared/commit/6579a26d917db0bb8dc3baa2e19a0dfee8db5fc8))
+
 # [@adobe/spacecat-shared-utils-v1.20.8](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-utils-v1.20.7...@adobe/spacecat-shared-utils-v1.20.8) (2024-10-21)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/spacecat-shared-utils",
-  "version": "1.20.8",
+  "version": "1.21.0",
   "description": "Shared modules of the Spacecat Services - utils",
   "type": "module",
   "engines": {
@@ -47,7 +47,7 @@
     "@adobe/fetch": "4.1.9",
     "@aws-sdk/client-s3": "3.675.0",
     "@aws-sdk/client-sqs": "3.675.0",
-    "aws-xray-sdk": "3.10.1",
-    "@json2csv/plainjs": "7.0.6"
+    "@json2csv/plainjs": "7.0.6",
+    "aws-xray-sdk": "3.10.1"
   }
 }

package/src/adobe-fetch.js

@@ -0,0 +1,14 @@
+/*
+ * 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 { context as h2, h1 } from '@adobe/fetch';
+
+export const { fetch } = process.env.HELIX_FETCH_FORCE_HTTP1 ? h1() : h2();

package/src/index.d.ts

@@ -10,6 +10,8 @@
  * governing permissions and limitations under the License.
  */
 
+import { Request, RequestOptions, Response } from '@adobe/fetch';
+
 /** UTILITY FUNCTIONS */
 export function arrayEquals<T>(a: T[], b: T[]): boolean;
 
@@ -159,3 +161,7 @@ export function storeMetrics(content: object, config: object, context: object):
 
 export function s3Wrapper(fn: (request: object, context: object) => Promise<Response>):
     (request: object, context: object) => Promise<Response>;
+
+export function fetch(url: string|Request, options?: RequestOptions): Promise<Response>;
+
+export function tracingFetch(url: string|Request, options?: RequestOptions): Promise<Response>;

package/src/index.js

@@ -53,3 +53,6 @@ export {
 export { getStoredMetrics, storeMetrics } from './metrics-store.js';
 
 export { s3Wrapper } from './s3.js';
+
+export { fetch } from './adobe-fetch.js';
+export { tracingFetch } from './tracing-fetch.js';

package/src/tracing-fetch.js

@@ -0,0 +1,43 @@
+/*
+ * 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 AWSXRay from 'aws-xray-sdk';
+
+import { fetch as adobeFetch } from './adobe-fetch.js';
+
+export async function tracingFetch(url, options = {}) {
+  const parentSegment = AWSXRay.getSegment();
+
+  if (!parentSegment) {
+    return adobeFetch(url, options);
+  }
+
+  const method = options.method || 'GET';
+  const subsegment = parentSegment.addNewSubsegment(`HTTP ${method} ${url}`);
+
+  try {
+    subsegment.addAnnotation('url', url);
+    subsegment.addAnnotation('method', method);
+
+    const response = await adobeFetch(url, options);
+
+    subsegment.addMetadata('statusCode', response.status);
+
+    subsegment.close();
+
+    return response;
+  } catch (error) {
+    subsegment.addError(error);
+    subsegment.close();
+
+    throw error;
+  }
+}