refactor: Updated aws sdk instrumentation to construct specs at instr…

…umentation (#259)

lib/util.js

@@ -27,16 +27,17 @@ function grabLastUrlSegment(url = '/') {
 /**
  * Retrieves the db segment params from endpoint and command parameters
  *
+ * @param {function} DatastoreParameters constructor of `shim.spec.DatastoreParameters`
  * @param {Object} endpoint instance of ddb endpoint
  * @param {Object} params parameters passed to a ddb command
  * @returns {Object}
  */
-function setDynamoParameters(endpoint, params) {
-  return {
+function setDynamoParameters(DatastoreParameters, endpoint, params) {
+  return new DatastoreParameters({
     host: endpoint && (endpoint.host || endpoint.hostname),
     port_path_or_id: (endpoint && endpoint.port) || 443,
     collection: (params && params.TableName) || UNKNOWN
-  }
+  })
 }
 
 module.exports = {

lib/v2/dynamodb.js

@@ -43,12 +43,16 @@ function instrument(shim, AWS) {
       function wrapMethod(shim, original, operationName, args) {
         const params = args[0]
 
-        return {
+        return new shim.specs.OperationSpec({
           name: operationName,
-          parameters: setDynamoParameters(this.endpoint, params),
+          parameters: setDynamoParameters(
+            shim.specs.params.DatastoreParameters,
+            this.endpoint,
+            params
+          ),
           callback: shim.LAST,
           opaque: true
-        }
+        })
       }
     )
   })
@@ -70,16 +74,16 @@ function instrument(shim, AWS) {
       // the eventual cached endpoint to be hit is not known at this point.
       const endpoint = this.service && this.service.endpoint
 
-      return {
+      return new shim.specs.OperationSpec({
         name: dynamoOperation,
-        parameters: {
-          host: endpoint && endpoint.host,
-          port_path_or_id: endpoint && endpoint.port,
-          collection: (params && params.TableName) || 'Unknown'
-        },
+        parameters: new shim.specs.params.DatastoreParameters({
+          host: endpoint?.host,
+          port_path_or_id: endpoint?.port,
+          collection: params?.TableName || 'Unknown'
+        }),
         callback: shim.LAST,
         opaque: true
-      }
+      })
     }
   )
 }

lib/v2/sns.js

@@ -27,12 +27,12 @@ function instrument(shim, AWS) {
 }
 
 function wrapPublish(shim, original, name, args) {
-  return {
+  return new shim.specs.MessageSpec({
     callback: shim.LAST,
     destinationName: getDestinationName(args[0]),
     destinationType: shim.TOPIC,
     opaque: true
-  }
+  })
 }
 
 function getDestinationName({ TopicArn, TargetArn }) {

lib/v2/sqs.js

@@ -38,10 +38,10 @@ function recordMessageApi(shim, original, name, args) {
   const params = args[0]
   const queueName = grabLastUrlSegment(params.QueueUrl)
 
-  return {
+  return new shim.specs.MessageSpec({
     callback: shim.LAST,
     destinationName: queueName,
     destinationType: shim.QUEUE,
     opaque: true
-  }
+  })
 }

lib/v3/bedrock.js

@@ -187,7 +187,7 @@ function getBedrockSpec({ commandName }, shim, _original, _name, args) {
   const bedrockCommand = new BedrockCommand(input)
   const { modelType } = bedrockCommand
 
-  return {
+  return new shim.specs.RecorderSpec({
     promise: true,
     name: `Llm/${modelType}/Bedrock/${commandName}`,
     // eslint-disable-next-line max-params
@@ -222,7 +222,7 @@ function getBedrockSpec({ commandName }, shim, _original, _name, args) {
         addLlmMeta({ agent, segment })
       }
     }
-  }
+  })
 }
 
 function handleResponse({ shim, err, response, segment, bedrockCommand, modelType }) {

lib/v3/dynamodb.js

@@ -17,13 +17,13 @@ const { setDynamoParameters } = require('../util')
  */
 function getDynamoSpec(shim, original, name, args) {
   const [{ input }] = args
-  return {
+  return new shim.specs.OperationSpec({
     name: this.commandName,
-    parameters: setDynamoParameters(this.endpoint, input),
+    parameters: setDynamoParameters(shim.specs.params.DatastoreParameters, this.endpoint, input),
     callback: shim.LAST,
     opaque: true,
     promise: true
-  }
+  })
 }
 
 /**

lib/v3/sns.js

@@ -33,13 +33,13 @@ function snsMiddleware(shim, config, next, context) {
  */
 function getSnsSpec(shim, original, name, args) {
   const [command] = args
-  return {
+  return new shim.specs.MessageSpec({
     promise: true,
     callback: shim.LAST,
     destinationName: getDestinationName(command.input),
     destinationType: shim.TOPIC,
     opaque: true
-  }
+  })
 }
 
 /**

lib/v3/sqs.js

@@ -42,12 +42,12 @@ function sqsMiddleware(shim, config, next, context) {
 function getSqsSpec(shim, original, name, args) {
   const [command] = args
   const { QueueUrl } = command.input
-  return {
+  return new shim.specs.MessageSpec({
     callback: shim.LAST,
     destinationName: grabLastUrlSegment(QueueUrl),
     destinationType: shim.QUEUE,
     opaque: true
-  }
+  })
 }
 
 module.exports.sqsMiddlewareConfig = {

tests/unit/util.tap.js

@@ -6,6 +6,13 @@
 'use strict'
 const tap = require('tap')
 const { grabLastUrlSegment, setDynamoParameters } = require('../../lib/util')
+
+function DatastoreParametersMock(params) {
+  this.host = params.host ?? null
+  this.port_path_or_id = params.port_path_or_id ?? null
+  this.database_name = params.database_name ?? null
+  this.collection = params.collection ?? null
+}
 tap.test('Utility Functions', (t) => {
   t.ok(grabLastUrlSegment, 'imported function successfully')
 
@@ -41,11 +48,12 @@ tap.test('DB parameters', (t) => {
   t.test('default values', (t) => {
     const input = {}
     const endpoint = {}
-    const result = setDynamoParameters(endpoint, input)
+    const result = setDynamoParameters(DatastoreParametersMock, endpoint, input)
     t.same(
       result,
       {
         host: undefined,
+        database_name: null,
         port_path_or_id: 443,
         collection: 'Unknown'
       },
@@ -58,11 +66,12 @@ tap.test('DB parameters', (t) => {
   t.test('host, port, collection', (t) => {
     const input = { TableName: 'unit-test' }
     const endpoint = { host: 'unit-test-host', port: '123' }
-    const result = setDynamoParameters(endpoint, input)
+    const result = setDynamoParameters(DatastoreParametersMock, endpoint, input)
     t.same(
       result,
       {
         host: endpoint.host,
+        database_name: null,
         port_path_or_id: endpoint.port,
         collection: input.TableName
       },
@@ -75,11 +84,12 @@ tap.test('DB parameters', (t) => {
   t.test('hostname, port, collection', (t) => {
     const input = { TableName: 'unit-test' }
     const endpoint = { hostname: 'unit-test-host', port: '123' }
-    const result = setDynamoParameters(endpoint, input)
+    const result = setDynamoParameters(DatastoreParametersMock, endpoint, input)
     t.same(
       result,
       {
         host: endpoint.hostname,
+        database_name: null,
         port_path_or_id: endpoint.port,
         collection: input.TableName
       },

third_party_manifest.json

@@ -1,5 +1,5 @@
 {
-  "lastUpdated": "Tue Feb 27 2024 15:25:14 GMT-0500 (Eastern Standard Time)",
+  "lastUpdated": "Tue Feb 27 2024 15:27:30 GMT-0500 (Eastern Standard Time)",
   "projectName": "New Relic AWS-SDK Instrumentation",
   "projectUrl": "https://github.com/newrelic/node-newrelic-aws-sdk",
   "includeOptDeps": false,