Skip to content

docs: add notes to discourage external usage of dependencies #1241

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 4 commits into from
Jun 5, 2020
Merged

docs: add notes to discourage external usage of dependencies #1241

merged 4 commits into from
Jun 5, 2020

Conversation

AllanZhengYP
Copy link
Contributor

@AllanZhengYP AllanZhengYP commented Jun 4, 2020 •
edited
Loading

Description of changes:

Some packages are not supposed to be consumed outside the SDK. So add notes to emphasize this. They are default values of client's dependencies. They are published because the modular nature of the service clients, but they are not fully tested/validated for any usecase outside the SDK.

/cc @Amplifiyer @seebees

Name external public?
abort-controller YES
body-checksum-browser NO
body-checksum-node NO
chunked-blob-reader NO
chunked-blob-reader-native NO
chunked-stream-reader-node NO
client-documentation-generator NO
config-resolver NO
credential-provider-cognito-identity YES
credential-provider-env YES
credential-provider-imds YES
credential-provider-ini YES
credential-provider-node YES
credential-provider-process YES
eventstream-handler-node NO
eventstream-marshaller YES
eventstream-serde-browser NO
eventstream-serde-config-resolver NO
eventstream-serde-node NO
eventstream-serde-universal NO
fetch-http-handler YES
hash-blob-browser NO
hash-node NO
hash-stream-node NO
invalid-dependency NO
is-array-buffer NO
is-node NO(to remove)
md5-js NO
middleware-apply-body-checksum YES
middleware-bucket-endpoint YES
middleware-content-length YES
middleware-eventstream YES
middleware-expect-continue YES
middleware-header-default YES
middleware-host-header YES
middleware-location-constraint YES
middleware-retry YES
middleware-sdk-api-gateway YES
middleware-sdk-ec2 YES
middleware-sdk-glacier YES
middleware-sdk-machinelearning YES
middleware-sdk-rds YES
middleware-sdk-route53 YES
middleware-sdk-s3 YES
middleware-sdk-s3-control YES
middleware-sdk-sqs YES
middleware-sdk-transcribe-streaming YES
middleware-serde YES
middleware-signing YES
middleware-ssec YES
middleware-stack YES
middleware-user-agent YES
node-http-handler YES
property-provider NO
protocol-http YES
querystring-builder NO
querystring-parser NO
region-provider NO
s3-request-presigner YES
service-error-classification YES
sha256-tree-hash NO
shared-ini-file-loader YES
signature-v4 YES
smithy-client NO
types YES
url-parser-browser NO
url-parser-node NO
util-base64-browser YES
util-base64-node YES
util-base64-universal NO(to remove)
util-body-length-browser NO
util-body-length-node NO
util-buffer-from NO
util-create-request YES
util-format-url YES
util-hex-encoding YES
util-locate-window YES
util-uri-escape NO
util-user-agent-browser NO
util-user-agent-node NO
util-utf8-browser YES
util-utf8-node YES
util-utf8-universal NO(ro remove)
xml-builder NO

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

@aws-sdk-js-automation
Copy link

AWS CodeBuild CI Report

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

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

@AllanZhengYP AllanZhengYP requested a review from trivikr June 4, 2020 16:15
@trivikr
Copy link
Member

trivikr commented Jun 4, 2020

We'll change terminology to what's done by Lerna https://github.com/lerna/lerna/tree/master/utils/create-symlink#usage

@aws-sdk-js-automation
Copy link

AWS CodeBuild CI Report

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

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

@aws-sdk-js-automation
Copy link

AWS CodeBuild CI Report

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

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

@Amplifiyer
Copy link
Contributor

Amplifiyer commented Jun 4, 2020 •
edited
Loading

We do use certain packages that are now marked internal, such as util-user-agent-browser to append Amplify's user agent for tracking Amplify metrics and other helper methods to keep consistency with aws-sdk such as @aws-sdk/util-format-url, @aws-sdk/eventstream-marshaller and @aws-sdk/util-utf8-node, @aws-sdk/util-utf8-browser, @aws-sdk/util-hex-encoding

@AllanZhengYP AllanZhengYP mentioned this pull request Jun 4, 2020
Merged
@AllanZhengYP
Copy link
Contributor Author

@Amplifiyer

I can only find @aws-sdk/util-user-agent-browser in the dependencies but cannot find where it's imported. Can this be a mistake and Amplify is not actually using the package?

@Amplifiyer
Copy link
Contributor

Amplifiyer commented Jun 5, 2020 via email •
edited
Loading

seebees added a commit to seebees/aws-encryption-sdk-javascript that referenced this pull request Jun 5, 2020
@seebees
chore: remove @aws-sdk/util-utf8-universal
93facb1 
It was not being used,
and was getting deprecated.

aws/aws-sdk-js-v3#1241
aws/aws-sdk-js-v3#1240?
@seebees seebees mentioned this pull request Jun 5, 2020
Merged
1 task
@aws-sdk-js-automation
Copy link

AWS CodeBuild CI Report

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

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

seebees added a commit to aws/aws-encryption-sdk-javascript that referenced this pull request Jun 5, 2020
@seebees
chore: remove @aws-sdk/util-utf8-universal (#368)
75803ed 
It was not being used,
and was getting deprecated.

aws/aws-sdk-js-v3#1241
aws/aws-sdk-js-v3#1240?
@Amplifiyer
Copy link
Contributor

Looks good to me!

seebees
seebees approved these changes Jun 5, 2020
View reviewed changes
Copy link
Contributor

@seebees seebees left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@AllanZhengYP AllanZhengYP merged commit 99c3823 into aws:master Jun 5, 2020
@github-actions
Copy link

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 github-actions bot locked as resolved and limited conversation to collaborators Jan 20, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@seebees seebees seebees approved these changes

@trivikr trivikr trivikr approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@AllanZhengYP @aws-sdk-js-automation @trivikr @Amplifiyer @seebees