fix(deps): request consumers to install react-native polyfills

[trivikr]

Co-authored-by: Nicolas Perraut n.perraut@gmail.com

Issue

Related to #1536
Replaces #2108

Fixes: #1797
Fixes: #2051
Fixes: #2192
Fixes: #2199
Fixes: #2219

Description

This PR marks react-native-get-random-values as optional peer dependency to prevent install on non React Native environments.

Testing

Verified that ReactNative E2E tests are successful.

Command line output

$ pwd
/Users/trivikr/workspace/aws-sdk-js-v3/tests/react-native/End2End

$ node launch-app.js --local-publish
...
 PASS  e2e/End2EndTest.spec.js (14.5s)
  S3
    ✓ should upload an object after tapping putObject button (2276ms)
    ✓ after tapping getObject, App should get the same object that uploaded (2224ms)
    ✓ should list Objects after tapping listObjects button (1496ms)
    ✓ should conduct multipart upload after tapping createMultipartUpload, uploadPart, completeMultipartUpload buttons (3096ms)

Details

react-native-e2e-tests.mov

---

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

[G-Rath]

@trivikr have you tested this to confirm it doesn't throw an error on import if the package isn't installed?

I would expect it to, which is why we used a try/catch over in #2108

[trivikr]

@trivikr have you tested this to confirm it doesn't throw an error on import if the package isn't installed?

The AWS SDK for JavaScript no longer imports react-native polyfills, and expect them to be imported by the app using the SDK in react-native environment.

I'll evaluate the behavior if the react-native app doesn't contain react-native polyfills, and update this PR.

[G-Rath]

Ah right I see - sorry it didn't click that this change was an add, not a modify 😅

[trivikr]

The reason for removing require/import for react-native-get-random-values dependency is that our react-native End2End tests fail with "Unable to resolve module" error.

Screenshot

Just like uuid expects it's users to import react-native polyfills, AWS SDK for JavaScript would do the same.

[trivikr]

This PR is currently pending review from amplify-js team.
cc @Ashish-Nanda @amhinson

[trivikr]

Notes from the meeting on 3/31 with Amplify team:

• Remove requirement of react-native polyfills as peerDependencies, as peerDependenciesMeta just removes the warnings but installs peerDependencies by default.
• Check if a custom error can be emitted for react-native customers requesting particular polyfill as a requirement for aws-sdk just like uuid does https://github.com/uuidjs/uuid#getrandomvalues-not-supported. Amplify team had tried in the past, and it was not straight-forward.

[trivikr]

• Remove requirement of react-native polyfills as peerDependencies, as peerDependenciesMeta just removes the warnings but installs peerDependencies by default.

Removed in 5baa663 (#2191)

• Check if a custom error can be emitted for react-native customers requesting particular polyfill as a requirement for aws-sdk just like uuid does uuidjs/uuid#getrandomvalues-not-supported. Amplify team had tried in the past, and it was not straight-forward.

This isn't possible, as it's an implementation detail in https://github.com/uuidjs/uuid/blob/91805f665c38b691ac2cbda56a99231432b00a1a/src/rng-browser.js#L21-L25

I've updated README to share react-native polyfills import example instead d67256e (#2191)

[aws-sdk-js-automation]

AWS CodeBuild CI Report

• CodeBuild project: sdk-staging-test
• Commit ID: d3fa8a1
• Result: SUCCEEDED
• Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

[iartemiev]

Approved after testing the effect of this PR on Amplify RN apps.

[AllanZhengYP]

So nice to get rid of react-native from most users' dependencies.

[J-Krush]

So much appreciation for this PR! Unblocked on my work now :D

[github-actions]

This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs and link to relevant comments in this thread.

[github-actions]

This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs and link to relevant comments in this thread.