refactor(instrumentation-http): refactor getIncomingRequestAttributes() to reduce work (#6207)

Author: cjihrig

experimental/CHANGELOG.md

@@ -49,6 +49,7 @@ For notes on migrating to 2.x / 0.200.x see [the upgrade guide](doc/upgrade-to-2
 * chore(instrumentation-grpc): use local protobuf-ts plugin instead of buf.build remote [#6202](https://github.com/open-telemetry/opentelemetry-js/pull/6202) @overbalance
 * test(otlp-transformer): add benchmark for ProtobufTraceSerializer [#6226](https://github.com/open-telemetry/opentelemetry-js/pull/6226) @overbalance
 * chore(backcompat): fix backcompat tests and tsconfig cleanup [#6232](https://github.com/open-telemetry/opentelemetry-js/pull/6232) @overbalance
+* refactor(instrumentation-http): refactor getIncomingRequestAttributes() to reduce work [#6207](https://github.com/open-telemetry/opentelemetry-js/pull/6207) @cjihrig
 
 ## 0.208.0
 

experimental/packages/opentelemetry-instrumentation-http/src/utils.ts

@@ -886,96 +886,104 @@ export const getIncomingRequestAttributes = (
   },
   logger: DiagLogger
 ): Attributes => {
-  const headers = request.headers;
-  const userAgent = headers['user-agent'];
-  const ips = headers['x-forwarded-for'];
-  const httpVersion = request.httpVersion;
-  const host = headers.host;
-  const hostname = host?.replace(/^(.*)(:[0-9]{1,5})/, '$1') || 'localhost';
-
-  const method = request.method;
-  const normalizedMethod = normalizeMethod(method);
+  const {
+    component,
+    enableSyntheticSourceDetection,
+    hookAttributes,
+    semconvStability,
+    serverName,
+  } = options;
+  const { headers, httpVersion, method } = request;
+  const { host, 'user-agent': userAgent, 'x-forwarded-for': ips } = headers;
+  const parsedUrl = getInfoFromIncomingMessage(component, request, logger);
+  let newAttributes: Attributes;
+  let oldAttributes: Attributes;
+
+  if (semconvStability !== SemconvStability.OLD) {
+    // Stable attributes are used.
+    const normalizedMethod = normalizeMethod(method);
+    const serverAddress = getServerAddress(request, component);
+    const remoteClientAddress = getRemoteClientAddress(request);
+
+    newAttributes = {
+      [ATTR_HTTP_REQUEST_METHOD]: normalizedMethod,
+      [ATTR_URL_SCHEME]: component,
+      [ATTR_SERVER_ADDRESS]: serverAddress?.host,
+      [ATTR_NETWORK_PEER_ADDRESS]: request.socket.remoteAddress,
+      [ATTR_NETWORK_PEER_PORT]: request.socket.remotePort,
+      [ATTR_NETWORK_PROTOCOL_VERSION]: request.httpVersion,
+      [ATTR_USER_AGENT_ORIGINAL]: userAgent,
+    };
 
-  const serverAddress = getServerAddress(request, options.component);
-  const serverName = options.serverName;
-  const remoteClientAddress = getRemoteClientAddress(request);
+    if (parsedUrl.pathname != null) {
+      newAttributes[ATTR_URL_PATH] = parsedUrl.pathname;
+    }
 
-  const newAttributes: Attributes = {
-    [ATTR_HTTP_REQUEST_METHOD]: normalizedMethod,
-    [ATTR_URL_SCHEME]: options.component,
-    [ATTR_SERVER_ADDRESS]: serverAddress?.host,
-    [ATTR_NETWORK_PEER_ADDRESS]: request.socket.remoteAddress,
-    [ATTR_NETWORK_PEER_PORT]: request.socket.remotePort,
-    [ATTR_NETWORK_PROTOCOL_VERSION]: request.httpVersion,
-    [ATTR_USER_AGENT_ORIGINAL]: userAgent,
-  };
+    if (parsedUrl.search) {
+      // Remove leading '?' from URL search (https://developer.mozilla.org/en-US/docs/Web/API/URL/search).
+      newAttributes[ATTR_URL_QUERY] = parsedUrl.search.slice(1);
+    }
 
-  const parsedUrl = getInfoFromIncomingMessage(
-    options.component,
-    request,
-    logger
-  );
+    if (remoteClientAddress != null) {
+      newAttributes[ATTR_CLIENT_ADDRESS] = remoteClientAddress;
+    }
 
-  if (parsedUrl?.pathname != null) {
-    newAttributes[ATTR_URL_PATH] = parsedUrl.pathname;
-  }
+    if (serverAddress?.port != null) {
+      newAttributes[ATTR_SERVER_PORT] = Number(serverAddress.port);
+    }
 
-  if (parsedUrl.search) {
-    // Remove leading '?' from URL search (https://developer.mozilla.org/en-US/docs/Web/API/URL/search).
-    newAttributes[ATTR_URL_QUERY] = parsedUrl.search.slice(1);
-  }
+    // Conditionally required if request method required case normalization.
+    if (method !== normalizedMethod) {
+      newAttributes[ATTR_HTTP_REQUEST_METHOD_ORIGINAL] = method;
+    }
 
-  if (remoteClientAddress != null) {
-    newAttributes[ATTR_CLIENT_ADDRESS] = remoteClientAddress;
+    if (enableSyntheticSourceDetection && userAgent) {
+      newAttributes[ATTR_USER_AGENT_SYNTHETIC_TYPE] =
+        getSyntheticType(userAgent);
+    }
   }
 
-  if (serverAddress?.port != null) {
-    newAttributes[ATTR_SERVER_PORT] = Number(serverAddress.port);
-  }
+  if (semconvStability !== SemconvStability.STABLE) {
+    // Old attributes are used.
+    const hostname = host?.replace(/^(.*)(:[0-9]{1,5})/, '$1') || 'localhost';
 
-  // conditionally required if request method required case normalization
-  if (method !== normalizedMethod) {
-    newAttributes[ATTR_HTTP_REQUEST_METHOD_ORIGINAL] = method;
-  }
+    oldAttributes = {
+      [ATTR_HTTP_URL]: parsedUrl.toString(),
+      [ATTR_HTTP_HOST]: host,
+      [ATTR_NET_HOST_NAME]: hostname,
+      [ATTR_HTTP_METHOD]: method,
+      [ATTR_HTTP_SCHEME]: component,
+    };
 
-  if (options.enableSyntheticSourceDetection && userAgent) {
-    newAttributes[ATTR_USER_AGENT_SYNTHETIC_TYPE] = getSyntheticType(userAgent);
-  }
-  const oldAttributes: Attributes = {
-    [ATTR_HTTP_URL]: parsedUrl.toString(),
-    [ATTR_HTTP_HOST]: host,
-    [ATTR_NET_HOST_NAME]: hostname,
-    [ATTR_HTTP_METHOD]: method,
-    [ATTR_HTTP_SCHEME]: options.component,
-  };
+    if (typeof ips === 'string') {
+      oldAttributes[ATTR_HTTP_CLIENT_IP] = ips.split(',')[0];
+    }
 
-  if (typeof ips === 'string') {
-    oldAttributes[ATTR_HTTP_CLIENT_IP] = ips.split(',')[0];
-  }
+    if (typeof serverName === 'string') {
+      oldAttributes[ATTR_HTTP_SERVER_NAME] = serverName;
+    }
 
-  if (typeof serverName === 'string') {
-    oldAttributes[ATTR_HTTP_SERVER_NAME] = serverName;
-  }
+    if (parsedUrl.pathname) {
+      oldAttributes[ATTR_HTTP_TARGET] =
+        parsedUrl.pathname + parsedUrl.search || '/';
+    }
 
-  if (parsedUrl?.pathname) {
-    oldAttributes[ATTR_HTTP_TARGET] =
-      parsedUrl?.pathname + parsedUrl?.search || '/';
-  }
+    if (userAgent !== undefined) {
+      oldAttributes[ATTR_HTTP_USER_AGENT] = userAgent;
+    }
 
-  if (userAgent !== undefined) {
-    oldAttributes[ATTR_HTTP_USER_AGENT] = userAgent;
+    setRequestContentLengthAttribute(request, oldAttributes);
+    setAttributesFromHttpKind(httpVersion, oldAttributes);
   }
-  setRequestContentLengthAttribute(request, oldAttributes);
-  setAttributesFromHttpKind(httpVersion, oldAttributes);
 
-  switch (options.semconvStability) {
+  switch (semconvStability) {
     case SemconvStability.STABLE:
-      return Object.assign(newAttributes, options.hookAttributes);
+      return Object.assign(newAttributes!, hookAttributes);
     case SemconvStability.OLD:
-      return Object.assign(oldAttributes, options.hookAttributes);
+      return Object.assign(oldAttributes!, hookAttributes);
+    default:
+      return Object.assign(oldAttributes!, newAttributes!, hookAttributes);
   }
-
-  return Object.assign(oldAttributes, newAttributes, options.hookAttributes);
 };
 
 /**