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(idempotency): remove decorators #1554

Merged
merged 5 commits into from
Jun 28, 2023

Conversation

dreamorosi
Copy link
Contributor

Description of your changes

As described in the linked issue, this PR removes the Idempotency decorators from the current implementation which will be soon released as public beta. For more info on why we decided to remove them, please refer to #1553.

Related issues, RFCs

Issue number: #1553

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 as a code owner June 26, 2023 16:27
@dreamorosi dreamorosi self-assigned this Jun 26, 2023
@dreamorosi dreamorosi linked an issue Jun 26, 2023 that may be closed by this pull request
2 tasks
@boring-cyborg boring-cyborg bot added idempotency This item relates to the Idempotency Utility tests PRs that add or change tests labels Jun 26, 2023
@pull-request-size pull-request-size bot added the size/XL PRs between 500-999 LOC, often PRs that grown with feedback label Jun 26, 2023
@dreamorosi dreamorosi added the do-not-merge This item should not be merged label Jun 26, 2023
@dreamorosi
Copy link
Contributor Author

@mergify rebase

@mergify
Copy link

mergify bot commented Jun 27, 2023

rebase

✅ Branch has been successfully rebased

@dreamorosi dreamorosi force-pushed the 1553-maintenance-remove-idempotency-decorators branch from 5d9b98d to c63768d Compare June 27, 2023 15:07
@dreamorosi
Copy link
Contributor Author

@dreamorosi dreamorosi removed the do-not-merge This item should not be merged label Jun 27, 2023
@dreamorosi dreamorosi requested a review from am29d June 27, 2023 15:22
@am29d
Copy link
Contributor

am29d commented Jun 28, 2023

We should probably also remove references in the documentation.

@boring-cyborg boring-cyborg bot added the internal PRs that introduce changes in governance, tech debt and chores (linting setup, baseline, etc.) label Jun 28, 2023
@pull-request-size pull-request-size bot added size/XXL PRs with 1K+ LOC, largely documentation related and removed size/XL PRs between 500-999 LOC, often PRs that grown with feedback labels Jun 28, 2023
@dreamorosi
Copy link
Contributor Author

Good catch Alex, I have updated the README and removed all references.

While there, I also added a section for the Middy Middleware and consolidated the examples under their respective title.
Before it was:

  • Usage
    • Function wrapper
    • Middy middleware
  • Examples
    • Function wrapper
    • Middy middleware

Now it's

  • Usage
    • Function wrapper
      • Example
    • Middy middleware
      • Example

Also, I noticed that the DynamoDBPersitenceLayer and its options were not exported in the API docs, I added it and did a find&replace for s/persistance/persistence/ which was used in some places.

Finally, as a side note, I noticed that when we use intersection types the documentation for those resulting types is not rendered correctly. For instance, even though we wrote the docstring for DynamoDBPersistenceOptions, it's rendered empty:
image

This is because the actual properties are in the base type.

Apparently this is an intended behavior in typedoc: TypeStrong/typedoc#1021. For now I added a @see and exported+linked the actual types but in a separate issue we should look into whether there's a solution for this.

@dreamorosi
Copy link
Contributor Author

@am29d addressed the comments, ready for review

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.

LGTM!

@dreamorosi dreamorosi merged commit 3a982fc into main Jun 28, 2023
@dreamorosi dreamorosi deleted the 1553-maintenance-remove-idempotency-decorators branch June 28, 2023 13:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
idempotency This item relates to the Idempotency Utility internal PRs that introduce changes in governance, tech debt and chores (linting setup, baseline, etc.) size/XXL PRs with 1K+ LOC, largely documentation related tests PRs that add or change tests
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Maintenance: remove Idempotency decorators
2 participants