feat(util-dynamodb): add option to convert class instance to map #1969

trivikr · 2021-01-28T02:49:25Z

Issue

Refs: #1647
Closes: #1535
Closes: #1865
Closes: #1534
Closes: #1861
Closes: #1102
Closes: #1534

Description

adds option to convert class instance to map in @aws-sdk/util-dynamodb

convertToAttr(data, { convertClassInstanceToMap: true })

Testing

Unit tests for marshall and convertToAttr functions

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

reason: binary is of type object and the check needs to be done before typeof object

This will marshall objects with typeof === "object" using convertToMapAttr

docs: https://www.typescriptlang.org/docs/handbook/utility-types.html#instancetypetype

…arshall Refs: microsoft/TypeScript#15300 (comment)

…shall

codecov-io · 2021-01-28T03:00:18Z

Codecov Report

Merging #1969 (31b5683) into master (f2a47e8) will increase coverage by 0.52%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master    #1969      +/-   ##
==========================================
+ Coverage   79.30%   79.83%   +0.52%     
==========================================
  Files         368      368              
  Lines       15132    15553     +421     
  Branches     3222     3369     +147     
==========================================
+ Hits        12001    12417     +416     
- Misses       3131     3136       +5

Impacted Files	Coverage Δ
packages/util-waiter/src/utils/validate.ts	`81.81% <0.00%> (-18.19%)`	⬇️
lib/storage/src/data-chunk/readable-helper.ts	`86.84% <0.00%> (-5.47%)`	⬇️
packages/s3-request-presigner/src/getSignedUrl.ts	`92.85% <0.00%> (-2.98%)`	⬇️
packages/util-dynamodb/src/convertToAttr.ts	`98.70% <0.00%> (-1.30%)`	⬇️
packages/util-waiter/src/poller.ts	`100.00% <0.00%> (ø)`
packages/util-waiter/src/waiter.ts	`100.00% <0.00%> (ø)`
protocol_tests/aws-ec2/endpoints.ts	`81.48% <0.00%> (ø)`
protocol_tests/aws-json/endpoints.ts	`81.48% <0.00%> (ø)`
protocol_tests/aws-query/endpoints.ts	`81.48% <0.00%> (ø)`
packages/util-dynamodb/src/marshall.ts	`100.00% <0.00%> (ø)`
... and 156 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 63ad215...31b5683. Read the comment docs.

Reason: we already convert null, binary, array, sets, pure JavaScript objects which also belong to Object.Prototype inheritance chain. This configuration converts other objects, aka different constructor.

AllanZhengYP

🚢🚢 wow this closes a lot of issues!

Reason: converting undefined, null and binary attributes is already moved outside the function to support convertClassInstanceToMap configuration

… values

Number(1) creates JavaScript primitive value, while new Number(1) creates the Number class instance

aws-sdk-js-automation · 2021-01-28T21:20:32Z

AWS CodeBuild CI Report

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

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

github-actions · 2021-02-12T00:07:26Z

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.

trivikr added 9 commits January 27, 2021 21:34

chore: move isBinary check to convertToAttr

733b70d

reason: binary is of type object and the check needs to be done before typeof object

chore: move checks for undefined and null in convertToAttr

07ada57

feat(util-dynamodb): add option marshallObjects

2ba8e43

This will marshall objects with typeof === "object" using convertToMapAttr

test: options.marshallObjects doesn't affect binary and null values

553aaac

test: add tests for typeof object with marshallObjects

c05108e

feat: accept InstanceType in NativeAttributeValue

0cae7a3

docs: https://www.typescriptlang.org/docs/handbook/utility-types.html#instancetypetype

chore: state options.marshallObjects=true in unsupported type error

c80f05d

fix(util-dynamodb): accept interface/Class Instance as in input for m…

ca4d2b2

…arshall Refs: microsoft/TypeScript#15300 (comment)

test(util-dynamodb): accept interface/class instance as input for mar…

337291b

…shall

trivikr changed the title ~~feat(util-dynamodb): add option to marshall typeof object~~ feat(util-dynamodb): add option to convert typeof object Jan 28, 2021

AllanZhengYP self-requested a review January 28, 2021 18:06

trivikr added 2 commits January 28, 2021 19:35

fix: rename marshallObjects to convertTypeofObject

0c7658b

fix: rename convertTypeofObject to convertClassInstanceToMap

87d236c

Reason: we already convert null, binary, array, sets, pure JavaScript objects which also belong to Object.Prototype inheritance chain. This configuration converts other objects, aka different constructor.

trivikr force-pushed the util-dynamodb-marshallObjects branch from efb97fa to 87d236c Compare January 28, 2021 19:38

trivikr changed the title ~~feat(util-dynamodb): add option to convert typeof object~~ feat(util-dynamodb): add option to convert class instance to map Jan 28, 2021

AllanZhengYP approved these changes Jan 28, 2021

View reviewed changes

trivikr added 3 commits January 28, 2021 19:53

chore: remove convertToScalarAttribute function

c7dc995

Reason: converting undefined, null and binary attributes is already moved outside the function to support convertClassInstanceToMap configuration

feat: convert Boolean, Number and String class instances as native

a468026

test: additional tests to check convertClassInstanceToMap with native…

31b5683

… values

AllanZhengYP approved these changes Jan 28, 2021

View reviewed changes

test: create instance when isClassInstance is set to true

5d42786

Number(1) creates JavaScript primitive value, while new Number(1) creates the Number class instance

AllanZhengYP approved these changes Jan 28, 2021

View reviewed changes

trivikr merged commit 1783c69 into aws:master Jan 28, 2021

trivikr deleted the util-dynamodb-marshallObjects branch January 28, 2021 21:24

trivikr mentioned this pull request Jan 29, 2021

util-dynamodb convertToAddr function does not identify objects with null prototype #1861

Closed

This was referenced Feb 8, 2021

fix(util-dynamodb): accept interface as in input for marshall #1952

Closed

DynamoDB documentClient support #1223

Closed

The typings on marshall are too narrow #1647

Closed

trivikr mentioned this pull request Feb 10, 2021

Feature request (dynamodb-util): Expose premarshall configuration #1533

Closed

github-actions bot locked as resolved and limited conversation to collaborators Feb 12, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(util-dynamodb): add option to convert class instance to map #1969

feat(util-dynamodb): add option to convert class instance to map #1969

trivikr commented Jan 28, 2021 •

edited

Loading

codecov-io commented Jan 28, 2021 •

edited

Loading

AllanZhengYP left a comment

aws-sdk-js-automation commented Jan 28, 2021

github-actions bot commented Feb 12, 2021

feat(util-dynamodb): add option to convert class instance to map #1969

feat(util-dynamodb): add option to convert class instance to map #1969

Conversation

trivikr commented Jan 28, 2021 • edited Loading

Issue

Description

Testing

codecov-io commented Jan 28, 2021 • edited Loading

Codecov Report

AllanZhengYP left a comment

Choose a reason for hiding this comment

aws-sdk-js-automation commented Jan 28, 2021

AWS CodeBuild CI Report

github-actions bot commented Feb 12, 2021

trivikr commented Jan 28, 2021 •

edited

Loading

codecov-io commented Jan 28, 2021 •

edited

Loading