Skip to content

Commit de7be81

Browse files
author
Michael Wittwer
committed
docs(*): update v2-v3-migration guide
1 parent c5a1574 commit de7be81

File tree

2 files changed

+15
-14
lines changed

2 files changed

+15
-14
lines changed

src/aws-sdk-v2.types.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ export type AttributeMap = { [key: string]: AttributeValue }
1414

1515
export type Key = { [key: string]: AttributeValue }
1616

17-
// FIXME somehow the import of KeyType from @aws-sdk/client-dynamodb does not work at runtime
17+
// TODO v3: somehow the import of KeyType from @aws-sdk/client-dynamodb does not work at runtime
1818
export enum KeyType {
1919
HASH = 'HASH',
2020
RANGE = 'RANGE',

v2-v3-migration.md

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,21 @@
1-
# Migrate dynamo-easy to sdk v3
1+
# Migrate dynamo-easy to aws-sdk v3
22

3-
## To complete before releasing
4-
- [ ] Update demo
5-
- [ ] Update doc with new snippets
3+
## 📋 To complete before releasing
4+
- [x] Make sure the snippets compile
5+
- [x] Make tests compile and run successfully
6+
- [ ] Search for `TODO v3:` in the code to see open issues / notes, and create followup issues to decide if we have more to fix prior to a major release or keep it for later follow-up
7+
- [ ] Check on new attribute type [$UnknownAttribute](./src/mapper/type/attribute.type.ts) and implement tests
8+
- [ ] Remove [sessionValidityEnsurer](./src/config/dynamo-easy-config.ts) and add demo with using [middleware stack](https://github.com/aws/aws-sdk-js-v3#middleware-stack)
9+
to implement the same
10+
- [ ] The old behavior (sessionValidityEnsurer) was executed before every request, with the new implementation we
11+
only react to failing requests, so we should probably provide a way to automatically retry failed requests after
12+
successfully refreshing any invalid session.
13+
- [ ] Switch to new implementation of pagination, see [official doc](https://github.com/aws/aws-sdk-js-v3#paginators).
14+
- [ ] Use middleware stack to implement verbose logging of request / response data
15+
- [ ] Update [dynamo-easy-demo](https://github.com/shiftcode/dynamo-easy-demo) see [this](https://github.com/shiftcode/dynamo-easy-demo/issues/1) issue
616

717
## Useful Links
818

919
- [Doc in Repo](https://github.com/aws/aws-sdk-js-v3)
1020
- [Official migration Guide](https://github.com/aws/aws-sdk-js-v3/blob/main/UPGRADING.md)
1121

12-
## Todo
13-
Search for `TODO v3:` to see open issues / notes, here are some more general ones:
14-
- [x] Make sure the snippets compile
15-
- [ ] Check on new attribute type [$UnknownAttribute](./src/mapper/type/attribute.type.ts) and implement tests
16-
- [ ] Add new [demo](https://github.com/shiftcode/dynamo-easy-demo) with aws-cdk
17-
- [x] Make tests compile and run successfully
18-
- [ ] Remove [sessionValidityEnsurer](./src/config/dynamo-easy-config.ts) and add demo with using [middleware stack](https://github.com/aws/aws-sdk-js-v3#middleware-stack)
19-
to implement the same
20-
- [ ] Switch to new implementation of pagination, see [official doc](https://github.com/aws/aws-sdk-js-v3#paginators).

0 commit comments

Comments
 (0)