[COMPASS-6383] Investigate changes in NODE-4898: Make @aws-sdk/credential-providers an optional peerDependency Created: 16/Dec/22  Updated: 27/Jan/23

Status: Open
Project: Compass
Component/s: None
Affects Version/s: None
Fix Version/s: None

Type: Investigation Priority: Major - P3
Reporter: PM Bot Assignee: Unassigned
Resolution: Unresolved Votes: 0
Labels: node-driver
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Depends
depends on NODE-4898 Make @aws-sdk/credential-providers an... Closed
Related
related to MONGOSH-1358 Update to driver and bson v5.x Closed

 Description   

Use Case

As a non aws user
I want to not have aws-sdk installed by default
So that I don't have extra modules installed

As an aws user
I want to have the aws-sdk version I install to be validated by npm
So that I know I'm using a compatible version with the mongodb driver

User Impact

  • Users need to install the aws-sdk as a dependency of their project if they are AWS auth users.

Unknowns

  • questions that need to be answered to determine implementation

Acceptance Criteria

Implementation Requirements

  • Move aws-sdk to a peerDependency in package.json
  • Add optional: true to peerDependeciesMeta for aws-sdk
  • Import aws-sdk lazily inside aws auth logic

Testing Requirements

  • Test dynamic import behavior

Documentation Requirements

  • Add migration guide description

Follow Up Requirements

  • additional tickets to file, required releases, etc

Generated at Wed Feb 07 22:42:54 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.