Skip to content
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.

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

chore(clients): Make signing functions synchronous #11307

Merged

Conversation

cshfang
Copy link
Member

@cshfang cshfang commented Apr 26, 2023

Description of changes

In order to limit the impact of updating our existing Signer to use the updated signing functions, the underlying signing functions need to be synchronous calls as well. We will revisit this in the future in a breaking change.

Description of how you validated changes

Tested that signing functions now generate the same output without being awaited.

Checklist

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

@cshfang cshfang requested review from a team as code owners April 26, 2023 16:09
Copy link
Contributor

@jimblanc jimblanc left a comment

Choose a reason for hiding this comment

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

Approach makes sense to me

Copy link
Member

@AllanZhengYP AllanZhengYP left a comment

Choose a reason for hiding this comment

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

It makes sense, thank you for the fix!

const sha256 = new Sha256(key);
sha256.update(data);
const hashedData = await sha256.digest();
// TODO: V6 flip to async digest
const hashedData = sha256.digestSync();
Copy link
Member

Choose a reason for hiding this comment

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

Nice. TIL they sha256 digest is synchroneous by default: https://github.com/aws/aws-sdk-js-crypto-helpers/blob/2480e49a114b6b18f7a1536cb65abb19f1412cd2/packages/sha256-js/src/jsSha256.ts#L49-L56

The async interface is only for compatibility with other hash implementations.

@cshfang cshfang merged commit 56dc9e0 into aws-amplify:v5/custom-clients Apr 26, 2023
@cshfang cshfang deleted the v5/update-signing-functions branch April 26, 2023 17:18
AllanZhengYP added a commit that referenced this pull request May 5, 2023
* feat(clients): Add custom signature v4 signer (#11273)

* feat(clients): Add custom signature v4 signer

* Updated docstrings

* Extracted common code

* Use == null instead of isNil

* Add unit tests

* Add missing licensing headers

* Use test case options in presign tests

* Fixed comment

* Add test for data hashing with SourceData keys

* Remove buffer dependency

* Remove internal sdk dependency

* chore(clients): Make signing functions synchronous (#11307)

* chore(clients): Replace existing Signer implementation (#11310)

* feat(clients): basic types and fetch handler (#11120)

* chore(core): clean up signer types

* chore(api-rest): bundle size limit

* chore(clients): Add @internal annotation (#11320)

* chore(core): remove unused unfetch dependency

* chore: enable integ test on signer-refactor branch

* fix(core): parse region and signing service from url

* fix(core): signer handles iot gateway url

* chore(api-rest): update bundle size limit

* Revert "chore: enable integ test on signer-refactor branch"

This reverts commit 4789625.

* fix(core): precompire signer regex of aws endpoints

---------

Co-authored-by: Chris F <5827964+cshfang@users.noreply.github.com>
erinleigh90 pushed a commit that referenced this pull request Jun 6, 2023
* chore(core): bump to ts 5.0 (#11077)

* feat(clients): basic types and fetch handler (#11120)

* feat(clients): compose transfer handler with middleware & retry middleware (#11188)

* feat(clients): middleware interface and retry middleware

* test(clients): retry middleare unit test

* fix(clients): middleware type to include options

* feat(clients): add retry middleware unit test and update interface

* chore(clients): update bundle size limit for fetch and retry

* chore(clients): add retry docs; fix format

* fix(clients): address feedbacks

* fix(retry): add metadata to returns from retry middldeware (#11212)

* fix(retry): add metadata to returns from retry middldeware; fix minor bugs

* feat(clients): address retry middleware feedbacks

Co-authored-by: Chris F <5827964+cshfang@users.noreply.github.com>

* chore(core): update size limit

* feat(clients): cognito identity client (#11213)

* feat(clients): implement service API composer

* chore(clients): rename middleware interface

* feat(clients): middleware handler interface can be non request/response interface

* chore(clients): move fetch handler to handlers folder

* feat(clients): implement user agent middleware

* feat(clients): implement unauth aws transfer handler

* feat(clients): implement api handler composer

* feat(clients): implement cognito-identity client

* chore(clients): update bundle size limit

* feat(clients): add serde utils; remove retry in api handler composer

* feat(clients): integrate cognito-identity client to Credentials class

* fix(clients): make retryDecider interface async

* chore: move cognito client to dev dep

* chore(clients): use Pascale path name

* fix(clients): handle fetch response.body undefined in RN

* chore: publish under v5-custom-clients dist-tag

* fix(clients): read body once for errors

* chore(clients): enable tagged release of custom clients (#11267)

* test(clients): add functional test to cognito identity client (#11266)

* test(clients): add cognito-identity functional test

* chore(clients): prefer destructuring parameters at top

* feat(clients): add useragent to cognito identity (#11269)

* chore(clients): add license header to files (#11292)

* feat(clients): Add custom signature v4 signer (#11273)

* feat(clients): Add custom signature v4 signer

* Updated docstrings

* Extracted common code

* Use == null instead of isNil

* Add unit tests

* Add missing licensing headers

* Use test case options in presign tests

* Fixed comment

* Add test for data hashing with SourceData keys

* Remove buffer dependency

* Remove internal sdk dependency

* chore(clients): Make signing functions synchronous (#11307)

* chore(clients): Replace existing Signer implementation (#11310)

* chore(clients): Add @internal annotation (#11320)

* feat(clients): Add signing middleware (#11323)

* feat(clients): Add signing middleware

* Use closure for clock offset

* Add bundle size test entry

* Address comments

* feat(clients): support CN partition by adding DNS suffix resolver (#11311)

* feat(clients): support CN partition by adding DNS suffix resolver

* chore(clients): update bundle size test limit

* fix(clients): address feedbacks

* chore: update bundle size limit

* chore(clients): Add context to some regex (#11334)

* feat(clients) Add updateEndpoint API (#11330)

* feat(clients) Add updateEndpoint API

* Rename handler

* chore(clients): Use DNS suffix util in Pinpoint client (#11340)

* chore(clients): Annotate custom client APIs with @internal (#11347)

* feat(clients) Add putEvents API (#11342)

* feat(clients) Add putEvents API

* Add additional verification for expected date format

* Mark API as internal

* feat(clients) Add getInAppMessages API (#11348)

* feat(clients) Add getInAppMessages API

* Update unit test

* chore(clients): Replace SDK Pinpoint Client (#11359)

Co-authored-by: Allan Zheng <zheallan@amazon.com>

* chore: update size limit

* chore(clients): export pinpoint client from internal subpath (#11369)

* feat(clients): allow fetch handler to read body multiple times

* chore: update size limit

* fix(clients): add react-native entrypoint for internal modules

* chore: address feedbacks

* feat(clients): vendor TS types from pinpoint and cognito-identity clients (#11393)

* chore: dts bundler script for AWS SDK types

* feat(clients): vendor AWS SDK client types

* chore: workaround the tslint errors for generated rollup types

* docs: add readme to build clients script

* feat: update SDK types

* chore(storage): update size limit (#11406)

* fix(clients): middleware chain revert after every invocation (#11432)

* chore: prepare for release; split out data packages diffs

* fix: address feedbacks

* fix(analytics): apply useragent enhancement to pinpoint client

* chore: update size limit

* fix: Auth bundle size test

* fix: Update bundle size for pubsub

* fix: api-graphql bundle size update

* fix: Update api bundle sizes

* fix: DataStore bundle size test

---------

Co-authored-by: Chris F <5827964+cshfang@users.noreply.github.com>
Co-authored-by: Aaron S <94858815+stocaaro@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants