feat: Removed accessing transaction from segment

Author: bizob2828

lib/common.js

@@ -82,13 +82,12 @@ function createResolverSegment({ shim, parent, resolver, formattedPath }) {
  * @param {Object} params.config plugin config
  * @param {Object} segment relevant resolver segment
  * @param {string} scope name of transaction
+ * @param {Transaction} transaction active transaction
  */
-function recordResolveSegment(segment, scope) {
+function recordResolveSegment(segment, scope, transaction) {
   const duration = segment.getDurationInMillis()
   const exclusive = segment.getExclusiveDurationInMillis()
 
-  const transaction = segment.transaction
-
   const attributes = segment.getAttributes()
   const fieldName = attributes[FIELD_NAME_ATTR]
   const fieldType = attributes[PARENT_TYPE_ATTR]
@@ -102,12 +101,10 @@ function recordResolveSegment(segment, scope) {
   }
 }
 
-function recordOperationSegment(segment, scope) {
+function recordOperationSegment(segment, scope, transaction) {
   const duration = segment.getDurationInMillis()
   const exclusive = segment.getExclusiveDurationInMillis()
 
-  const transaction = segment.transaction
-
   createMetricPairs(transaction, segment.name, scope, duration, exclusive)
 }
 
@@ -132,9 +129,10 @@ function createModuleUsageMetric(agent) {
  *
  * @param {Object} context apollo request context
  * @param {Segment} operationSegment default segment created in request start
+ * @param {Transaction} transaction active transaction
  * @return {Boolean} true if document could be parsed from context
  */
-function updateOperationSegmentName(context, operationSegment) {
+function updateOperationSegmentName(context, operationSegment, transaction) {
   const operationDetails = getOperationDetails(context)
   if (operationDetails) {
     const { operationName, operationType, deepestUniquePath, cleanedQuery } = operationDetails
@@ -157,7 +155,7 @@ function updateOperationSegmentName(context, operationSegment) {
 
     const segmentName = formattedOperation
     const transactionName = formattedOperation
-    setTransactionName(operationSegment.transaction, transactionName)
+    setTransactionName(transaction, transactionName)
     operationSegment.name = `${OPERATION_PREFIX}/${segmentName}`
     return true
   }
@@ -172,14 +170,13 @@ function updateOperationSegmentName(context, operationSegment) {
  *
  * @param {Object} params
  * @param {Object} params.config plugin config
- * @param {Object} params.info info key from resolver context
- * @param {Object} params.operationSegment operation segment
+ * @param {Object} paramst.info info key from resolver context
+ * @param {Object} params.transaction active transaction
  * @param {Object} params.args args key from resolver context
  *
  */
-function maybeCaptureFieldMetrics({ config, info, operationSegment, args }) {
+function maybeCaptureFieldMetrics({ config, info, transaction, args }) {
   if (config.captureFieldMetrics) {
-    const transaction = operationSegment.transaction
     const fieldName = info.fieldName
     const fieldType = info.parentType.toString()
     captureFieldMetrics({ transaction, args, fieldName, fieldType })

lib/error-helper.js

@@ -30,8 +30,7 @@ class ErrorHelper {
 
   noticeError(instrumentationApi, error) {
     error = error.originalError || error
-    const activeSegment = instrumentationApi.getActiveSegment()
-    const transaction = activeSegment && activeSegment.transaction
+    const transaction = instrumentationApi.tracer.getTransaction()
     instrumentationApi.agent.errors.add(transaction, error, error.extensions)
   }
 }

lib/hooks.js

@@ -43,6 +43,7 @@ module.exports = function requestDidStart({ api, shim, logger, config }, request
   logger.trace('Begin requestDidStart')
 
   const requestParent = shim.getActiveSegment()
+  const transaction = shim.tracer.getTransaction()
 
   if (!requestParent) {
     logger.trace('No active segment found at query start. Not recording.')
@@ -60,10 +61,10 @@ module.exports = function requestDidStart({ api, shim, logger, config }, request
 
   return {
     didResolveOperation: didResolveOperation.bind(null, {
-      shim,
       config,
       logger,
-      operationSegment
+      operationSegment,
+      transaction
     }),
     didEncounterErrors: didEncounterErrors.bind(null, { shim, operationSegment }),
     executionDidStart() {
@@ -79,7 +80,8 @@ module.exports = function requestDidStart({ api, shim, logger, config }, request
           config,
           logger,
           operationSegment,
-          requestContext
+          requestContext,
+          transaction
         })
       }
     },
@@ -88,7 +90,8 @@ module.exports = function requestDidStart({ api, shim, logger, config }, request
       shim,
       config,
       logger,
-      operationSegment
+      operationSegment,
+      transaction
     })
   }
 }
@@ -104,14 +107,10 @@ module.exports = function requestDidStart({ api, shim, logger, config }, request
  * @param {TraceSegment} params.operationSegment the segment capturing the operation
  * @param {GraphQLRequestContext} requestContext context on operation resolution
  */
-function didResolveOperation({ shim, config, logger, operationSegment }, requestContext) {
-  updateOperationSegmentName(requestContext, operationSegment)
+function didResolveOperation({ config, logger, operationSegment, transaction }, requestContext) {
+  updateOperationSegmentName(requestContext, operationSegment, transaction)
   if (shouldIgnoreTransaction(requestContext.operation, config, logger)) {
-    const activeSegment = shim.getActiveSegment()
-    if (activeSegment) {
-      const transaction = activeSegment.transaction
-      transaction.setForceIgnore(true)
-    }
+    transaction.setForceIgnore(true)
   }
 }
 
@@ -146,15 +145,15 @@ function didEncounterErrors({ shim, operationSegment }, requestContext) {
  * @returns {Function} handler once field resolves, used to handle errors
  */
 function willResolveField(
-  { api, shim, logger, config, operationSegment, requestContext },
+  { api, shim, logger, config, operationSegment, requestContext, transaction },
   resolverContext
 ) {
   const { info, args } = resolverContext
   const pathArray = flattenToArray(info.path)
   const formattedPath = pathArray.reverse().join('.')
   const flattenedArgs = flattenArgs({ obj: args })
 
-  maybeCaptureFieldMetrics({ operationSegment, info, args: flattenedArgs, config })
+  maybeCaptureFieldMetrics({ transaction, info, args: flattenedArgs, config })
 
   if (!config.captureScalars && !isTopLevelField(info) && isScalar(info)) {
     return null
@@ -237,13 +236,16 @@ function fieldResolver({ shim, requestContext, resolverSegment, currentSegment }
  * @param {TraceSegment} params.operationSegment the segment capturing the operation
  * @param {GraphQLRequestContext} requestContext context on operation resolution
  */
-function willSendResponse({ api, shim, config, logger, operationSegment }, requestContext) {
+function willSendResponse(
+  { api, shim, config, logger, operationSegment, transaction },
+  requestContext
+) {
   // check if operation segment was never updated from default name
   // If so, try to rename before setting the transaction name to `*`
   if (operationSegment.name === DEFAULT_OPERATION_NAME) {
-    const updated = updateOperationSegmentName(requestContext, operationSegment)
+    const updated = updateOperationSegmentName(requestContext, operationSegment, transaction)
     if (!updated) {
-      setTransactionName(operationSegment.transaction, '*')
+      setTransactionName(transaction, '*')
     }
   }
 

tests/unit/create-plugin.test.js

@@ -34,6 +34,9 @@ test('createPlugin edge cases', async (t) => {
           }
         },
         getActiveSegment: sinon.stub().returns({}),
+        tracer: {
+          getTransaction: sinon.stub().returns({ nameState: { setName: sinon.stub() } })
+        },
         createSegment: sinon.stub().callsFake((name) => {
           ctx.nr.operationSegment.name = name
           return ctx.nr.operationSegment

tests/unit/error-helper.test.js

@@ -30,6 +30,9 @@ class MockedInstrumentationApi {
     }
 
     this.getActiveSegment = () => {}
+    this.tracer = {
+      getTransaction: () => {}
+    }
   }
 }