Skip to content

docs(idempotency): bring your own persistent store #1681

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

Merged
merged 8 commits into from
Sep 15, 2023

Conversation

dreamorosi
Copy link
Contributor

@dreamorosi dreamorosi commented Sep 14, 2023

Description of your changes

This PR introduces a new section to the docs that discusses how to build your own Persistence Layer for the Idempotency utility.

The section follows closely the structure of the same section found in the Python docs but instead it shows how to implement the alternative persistence layer with a generic key-value store.

The PR also:

  • extracts all the JSON events and infra snippets (i.e. SAM, Terraform, etc.) to their own dedicated files so that they can be linted/formatted
  • adds a missing CDK sample to show how to create the table required for Idempotency

Related issues, RFCs

Issue number: #1484

Checklist

  • My changes meet the tenets criteria
  • I have performed a self-review of my own code
  • I have commented my code where necessary, particularly in areas that should be flagged with a TODO, or hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my change is effective and works
  • The PR title follows the conventional commit semantics

Breaking change checklist

Is it a breaking change?: NO

  • I have documented the migration process
  • I have added, implemented necessary warnings (if it can live side by side)

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

Disclaimer: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.

@dreamorosi dreamorosi requested a review from a team September 14, 2023 12:08
@dreamorosi dreamorosi self-assigned this Sep 14, 2023
@dreamorosi dreamorosi linked an issue Sep 14, 2023 that may be closed by this pull request
1 task
@boring-cyborg boring-cyborg bot added documentation Improvements or additions to documentation dependencies Changes that touch dependencies, e.g. Dependabot, etc. labels Sep 14, 2023
@pull-request-size pull-request-size bot added the size/XL PRs between 500-999 LOC, often PRs that grown with feedback label Sep 14, 2023
@dreamorosi dreamorosi changed the title docs(idempotency): bring your own persistent store Momento Cache docs(idempotency): bring your own persistent store Sep 14, 2023
@dreamorosi dreamorosi requested a review from am29d September 14, 2023 14:07
Copy link
Contributor

@am29d am29d left a comment

Choose a reason for hiding this comment

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

Looks great, just a small change for the CDK example.

@sonarqubecloud
Copy link

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 1 Code Smell

No Coverage information No Coverage information
6.1% 6.1% Duplication

@dreamorosi dreamorosi requested a review from am29d September 14, 2023 19:54
@dreamorosi
Copy link
Contributor Author

Comments addressed, merging so I can unblock another PR and avoid merge conflicts on package-lock.json.

@dreamorosi dreamorosi merged commit 21d1a91 into main Sep 15, 2023
@dreamorosi dreamorosi deleted the 1484-docs-bring-your-own-persistent-store branch September 15, 2023 10:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Changes that touch dependencies, e.g. Dependabot, etc. documentation Improvements or additions to documentation size/XL PRs between 500-999 LOC, often PRs that grown with feedback
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docs: Bring your own persistent store
2 participants