.c8rc.json

@@ -0,0 +1,5 @@
+{
+    "reporter": ["html", "lcov"],
+    "all": true,
+    "exclude": ["tests/*", "coverage/*", ".eslintrc.js"]
+}

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,6 @@
+blank_issues_enabled: false
+contact_links:
+  - name: Troubleshooting
+    url:  https://github.com/newrelic/node-newrelic-aws-sdk/blob/main/README.md#support
+    about: Check out the README for troubleshooting directions
+

.github/workflows/ci-workflow.yml

@@ -11,9 +11,9 @@ jobs:
         node-version: [lts/*]
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
     - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v2
+      uses: actions/setup-node@v3
       with:
         node-version: ${{ matrix.node-version }}
     - name: Install Dependencies
@@ -29,15 +29,22 @@ jobs:
         node-version: [14.x, 16.x, 18.x]
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
     - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v2
+      uses: actions/setup-node@v3
       with:
         node-version: ${{ matrix.node-version }}
     - name: Install Dependencies
       run: npm install
     - name: Run Unit Tests
       run: npm run unit
+    - name: Post Unit Test Coverage
+      uses: codecov/codecov-action@v3
+      with:
+        token: ${{ secrets.CODECOV_TOKEN }}
+        directory: ./coverage/unit/
+        files: lcov.info
+        flags: unit-tests-${{ matrix.node-version }}
 
   versioned:
     runs-on: ubuntu-latest
@@ -47,9 +54,9 @@ jobs:
         node-version: [14.x, 16.x, 18.x]
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
     - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v2
+      uses: actions/setup-node@v3
       with:
         node-version: ${{ matrix.node-version }}
     - name: Install Dependencies
@@ -60,3 +67,10 @@ jobs:
     - name: Run Versioned Tests (npm v7+ / Node 16+)
       if: ${{ matrix.node-version != '14.x' }}
       run: npm run versioned:npm7
+    - name: Post Versioned Test Coverage
+      uses: codecov/codecov-action@v3
+      with:
+        token: ${{ secrets.CODECOV_TOKEN }}
+        directory: ./coverage/versioned/
+        files: lcov.info
+        flags: versioned-tests-${{ matrix.node-version }}

.github/workflows/repolinter.yml

@@ -15,14 +15,14 @@ jobs:
     steps:
       - name: Test Default Branch
         id: default-branch
-        uses: actions/github-script@v2
+        uses: actions/github-script@v6
         with:
           script: |
-            const data = await github.repos.get(context.repo)
+            const data = await github.rest.repos.get(context.repo)
             return data.data && data.data.default_branch === context.ref.split('/').slice(-1)[0]
       - name: Checkout Self
         if: ${{ steps.default-branch.outputs.result == 'true' }}
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
       - name: Run Repolinter
         if: ${{ steps.default-branch.outputs.result == 'true' }}
         uses: newrelic/repolinter-action@v1

CHANGELOG.md

@@ -1,3 +1,13 @@
+### v5.0.2 (2022-11-07)
+
+* Fixed a crash when using versions >3.192.0 of AWS sdk v3 where a customer would see an error of `error: TypeError: config.endpoint is not a function`.
+
+* Updated versioned tests to exclude 3.194.0-3.196.0 from tests because they contain breaking changes. 
+
+### v5.0.1 (2022-10-10)
+
+* Updated DynamoDB instrumentation to default port to 443 when not specified from the endpoint.
+
 ### v5.0.0 (2022-07-28)
 
 * **BREAKING** Removed support for Node 12.

README.md

@@ -1,6 +1,7 @@
-[![Community Plus header](https://github.com/newrelic/opensource-website/raw/master/src/images/categories/Community_Plus.png)](https://opensource.newrelic.com/oss-category/#community-plus)
+[![Community Plus header](https://github.com/newrelic/opensource-website/raw/main/src/images/categories/Community_Plus.png)](https://opensource.newrelic.com/oss-category/#community-plus)
 
-# New Relic AWS SDK Instrumentation [![aws-sdk Instrumentation CI][1]][2]
+# New Relic AWS SDK Instrumentation
+[![npm status badge][5]][6] [![aws-sdk Instrumentation CI][1]][2] [![codecov][3]][4]
 
 New Relic's official AWS SDK package instrumentation for use with [the Node.js agent](https://github.com/newrelic/node-newrelic). Provides instrumentation for the [AWS SDK (`aws-sdk`)](https://www.npmjs.com/package/aws-sdk) npm package.
 
@@ -86,3 +87,7 @@ The New Relic AWS SDK Instrumentation package is licensed under the [Apache 2.0]
 
 [1]: https://github.com/newrelic/node-newrelic-aws-sdk/workflows/aws-sdk%20Instrumentation%20CI/badge.svg
 [2]: https://github.com/newrelic/node-newrelic-aws-sdk/actions?query=workflow%3A%22aws-sdk+Instrumentation+CI%22
+[3]: https://codecov.io/gh/newrelic/node-newrelic-aws-sdk/branch/main/graph/badge.svg?token=26ZH9QhLNn
+[4]: https://codecov.io/gh/newrelic/node-newrelic-aws-sdk
+[5]: https://img.shields.io/npm/v/@newrelic/aws-sdk.svg
+[6]: https://www.npmjs.com/package/@newrelic/aws-sdk

THIRD_PARTY_NOTICES.md

@@ -21,6 +21,7 @@ code, the source code can be found at [https://github.com/newrelic/node-newrelic
 * [@newrelic/newrelic-oss-cli](#newrelicnewrelic-oss-cli)
 * [@newrelic/test-utilities](#newrelictest-utilities)
 * [aws-sdk](#aws-sdk)
+* [c8](#c8)
 * [eslint-config-prettier](#eslint-config-prettier)
 * [eslint-plugin-header](#eslint-plugin-header)
 * [eslint-plugin-node](#eslint-plugin-node)
@@ -458,7 +459,7 @@ This product includes source derived from [@newrelic/newrelic-oss-cli](https://g
 
 ### @newrelic/test-utilities
 
-This product includes source derived from [@newrelic/test-utilities](https://github.com/newrelic/node-test-utilities) ([v6.1.1](https://github.com/newrelic/node-test-utilities/tree/v6.1.1)), distributed under the [Apache-2.0 License](https://github.com/newrelic/node-test-utilities/blob/v6.1.1/LICENSE):
+This product includes source derived from [@newrelic/test-utilities](https://github.com/newrelic/node-test-utilities) ([v7.1.1](https://github.com/newrelic/node-test-utilities/tree/v7.1.1)), distributed under the [Apache-2.0 License](https://github.com/newrelic/node-test-utilities/blob/v7.1.1/LICENSE):
 
 ```
                                  Apache License
@@ -875,6 +876,28 @@ This product includes source derived from [aws-sdk](https://github.com/aws/aws-s
 
 ```
 
+### c8
+
+This product includes source derived from [c8](https://github.com/bcoe/c8) ([v7.12.0](https://github.com/bcoe/c8/tree/v7.12.0)), distributed under the [ISC License](https://github.com/bcoe/c8/blob/v7.12.0/LICENSE.txt):
+
+```
+Copyright (c) 2017, Contributors
+
+Permission to use, copy, modify, and/or distribute this software
+for any purpose with or without fee is hereby granted, provided
+that the above copyright notice and this permission notice
+appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES
+OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE
+LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES
+OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
+WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
+ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+
+```
+
 ### eslint-config-prettier
 
 This product includes source derived from [eslint-config-prettier](https://github.com/prettier/eslint-config-prettier) ([v8.3.0](https://github.com/prettier/eslint-config-prettier/tree/v8.3.0)), distributed under the [MIT License](https://github.com/prettier/eslint-config-prettier/blob/v8.3.0/LICENSE):

lib/util.js

@@ -4,6 +4,8 @@
  */
 
 'use strict'
+const UNKNOWN = 'Unknown'
+
 function grabLastUrlSegment(url = '/') {
   // cast URL as string, and an empty
   // string for null, undefined, NaN etc.
@@ -14,6 +16,22 @@ function grabLastUrlSegment(url = '/') {
   return lastItem
 }
 
+/**
+ * Retrieves the db segment params from endpoint and command parameters
+ *
+ * @param {Object} endpoint instance of ddb endpoint
+ * @param {Object} params parameters passed to a ddb command
+ * @returns {Object}
+ */
+function setDynamoParameters(endpoint, params) {
+  return {
+    host: endpoint && (endpoint.host || endpoint.hostname),
+    port_path_or_id: (endpoint && endpoint.port) || 443,
+    collection: (params && params.TableName) || UNKNOWN
+  }
+}
+
 module.exports = {
-  grabLastUrlSegment
+  grabLastUrlSegment,
+  setDynamoParameters
 }

lib/v2/dynamodb.js

@@ -29,6 +29,8 @@ const DOC_CLIENT_OPERATIONS = [
   'scan'
 ]
 
+const { setDynamoParameters } = require('../util')
+
 function instrument(shim, AWS) {
   shim.setDatastore(shim.DYNAMODB)
 
@@ -43,11 +45,7 @@ function instrument(shim, AWS) {
 
         return {
           name: operationName,
-          parameters: {
-            host: this.endpoint && this.endpoint.host,
-            port_path_or_id: this.endpoint && this.endpoint.port,
-            collection: (params && params.TableName) || 'Unknown'
-          },
+          parameters: setDynamoParameters(this.endpoint, params),
           callback: shim.LAST,
           opaque: true
         }

lib/v3/dynamodb-util.js

@@ -4,8 +4,7 @@
  */
 
 'use strict'
-
-const UNKNOWN = 'Unknown'
+const { setDynamoParameters } = require('../util')
 
 /**
  * Returns the spec for Dynamo commands
@@ -18,18 +17,32 @@ const UNKNOWN = 'Unknown'
  */
 function getDynamoSpec(shim, original, name, args) {
   const [{ input }] = args
-  const collection = (input && input.TableName) || UNKNOWN
-  const host = this.endpoint && this.endpoint.hostname
-  const portPathOrId = this.endpoint && this.endpoint.port
   return {
     name: this.commandName,
-    parameters: { host, port_path_or_id: portPathOrId, collection },
+    parameters: setDynamoParameters(this.endpoint, input),
     callback: shim.LAST,
     opaque: true,
     promise: true
   }
 }
 
+/**
+ * AWS sdk v 3.194?.0 released a breaking change.
+ * See: https://github.com/aws/aws-sdk-js-v3/issues/4122
+ * What this means is config.endpoint is not always a function
+ * unless you provide an endpoint override to your library constructor
+ * This function will derive the endpoint in that scenario by grabbing the region
+ * and building the URL
+ */
+async function getEndpoint(config) {
+  if (typeof config.endpoint === 'function') {
+    return await config.endpoint()
+  }
+
+  const region = await config.region()
+  return new URL(`https://dynamodb.${region}.amazonaws.com`)
+}
+
 /**
  * Middleware hook that records the middleware chain
  * when command is in a list of monitored commands.
@@ -43,7 +56,13 @@ function getDynamoSpec(shim, original, name, args) {
 function dynamoMiddleware(shim, config, next, context) {
   const { commandName } = context
   return async function wrappedMiddleware(args) {
-    const endpoint = await config.endpoint()
+    let endpoint = null
+    try {
+      endpoint = await getEndpoint(config)
+    } catch (err) {
+      shim.logger.debug(err, 'Failed to get the endpoint.')
+    }
+
     const getSpec = getDynamoSpec.bind({ endpoint, commandName })
     const wrappedNext = shim.recordOperation(next, getSpec)
     return wrappedNext(args)