@adobe/spacecat-shared-utils 1.22.2 → 1.22.3

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [@adobe/spacecat-shared-utils-v1.22.3](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-utils-v1.22.2...@adobe/spacecat-shared-utils-v1.22.3) (2024-11-07)
+
+
+### Bug Fixes
+
+* proper http data for x-ray trace ([#427](https://github.com/adobe/spacecat-shared/issues/427)) ([4fa4d2d](https://github.com/adobe/spacecat-shared/commit/4fa4d2d417d51e911957e37df5136453dea521b2))
+
 # [@adobe/spacecat-shared-utils-v1.22.2](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-utils-v1.22.1...@adobe/spacecat-shared-utils-v1.22.2) (2024-11-07)
 
 

package/package.json

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

package/src/tracing-fetch.js

@@ -9,35 +9,140 @@
  * OF ANY KIND, either express or implied. See the License for the specific language
  * governing permissions and limitations under the License.
  */
+import { Request } from '@adobe/fetch';
 import AWSXRay from 'aws-xray-sdk';
 
 import { fetch as adobeFetch } from './adobe-fetch.js';
+import { isNumber } from './functions.js';
 
-export async function tracingFetch(url, options = {}) {
+/**
+ * Creates a subsegment for a given hostname based on whether the parent segment is traced or not.
+ * @param {Object} parentSegment - The parent X-Ray segment.
+ * @param {string} hostname - The hostname to associate with the subsegment.
+ * @returns {Object} The created subsegment.
+ */
+const createSubsegment = (parentSegment, hostname) => (parentSegment.notTraced
+  ? parentSegment.addNewSubsegmentWithoutSampling(hostname)
+  : parentSegment.addNewSubsegment(hostname));
+
+/**
+ * Sets the AWS X-Ray trace headers on the request object.
+ * @param {Request} request - The request object on which headers are set.
+ * @param {Object} parentSegment - The parent X-Ray segment.
+ * @param {Object} subSegment - The subsegment to include in the headers.
+ */
+const setTraceHeaders = (request, parentSegment, subSegment) => {
+  const effectiveParentSegment = parentSegment.segment || parentSegment;
+  request.headers.set(
+    'X-Amzn-Trace-Id',
+    `Root=${effectiveParentSegment.trace_id};Parent=${subSegment.id};Sampled=0`,
+  );
+};
+
+/**
+ * Adds flags to the given subsegment based on the status code of the response.
+ * @param {Object} subSegment - The X-Ray subsegment to which flags are added.
+ * @param {number} status - The status code of the response.
+ */
+const setSubSegmentFlagsByStatusCode = (
+  subSegment,
+  status,
+) => { /* eslint-disable no-param-reassign */
+  if (status === 429) {
+    subSegment.throttled = true;
+    return;
+  }
+  if (status >= 400 && status < 500) {
+    subSegment.error = true;
+    return;
+  }
+  if (status >= 500 && status < 600) {
+    subSegment.fault = true;
+  }
+};
+
+/**
+ * Adds request and response data to the given segment for AWS X-Ray tracing.
+ * @param {Object} segment - The X-Ray segment to which request and response data are added.
+ * @param {Request} request - The original request object.
+ * @param {Response} [response] - The response object (if available).
+ */
+const addFetchRequestDataToSegment = (
+  segment,
+  request,
+  response,
+) => { /* eslint-disable no-param-reassign */
+  const { url, method } = request;
+  segment.http = {
+    request: { url, method },
+  };
+
+  if (!response) {
+    return;
+  }
+
+  segment.http.response = {
+    status: response.status,
+  };
+
+  const contentLength = Number.parseInt(response.headers.get('content-length'), 10);
+  if (isNumber(contentLength)) {
+    segment.http.response.content_length = contentLength;
+  }
+};
+
+/**
+ * Adds error data to the given segment for AWS X-Ray tracing.
+ * @param {Object} subSegment - The X-Ray subsegment to which error data is added.
+ * @param {Request} request - The original request object.
+ * @param {Error} error - The error object.
+ */
+const handleSubSegmentError = (subSegment, request, error) => {
+  subSegment.addErrorFlag();
+  addFetchRequestDataToSegment(subSegment, request);
+  subSegment.addAnnotation('errorMessage', error.message);
+  subSegment.addAnnotation('errorStack', error.stack);
+  subSegment.close(error);
+};
+
+/**
+ * Performs a fetch request and adds AWS X-Ray tracing, including request/response tracking.
+ * @param {string} url - The URL for the request.
+ * @param {Object} options - Options to be passed to the fetch call.
+ * @returns {Promise<Response>} The response from the fetch request.
+ */
+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}`);
+  const request = new Request(url, options);
+  const { hostname } = new URL(request.url);
+  const subSegment = createSubsegment(parentSegment, hostname);
 
-  try {
-    subsegment.addAnnotation('url', url);
-    subsegment.addAnnotation('method', method);
+  subSegment.namespace = 'remote';
 
-    const response = await adobeFetch(url, options);
+  if (!parentSegment.noOp) {
+    setTraceHeaders(request, parentSegment, subSegment);
+  }
 
-    subsegment.addMetadata('statusCode', response.status);
+  const capturedAdobeFetch = async () => {
+    let response = null;
+    try {
+      response = await adobeFetch(request);
+    } catch (e) {
+      handleSubSegmentError(subSegment, request, e);
+      throw e;
+    }
 
-    subsegment.close();
+    setSubSegmentFlagsByStatusCode(subSegment, response.status);
 
+    addFetchRequestDataToSegment(subSegment, request, response);
+    subSegment.close();
     return response;
-  } catch (error) {
-    subsegment.addError(error);
-    subsegment.close();
+  };
 
-    throw error;
-  }
+  return capturedAdobeFetch();
 }