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

Improve/Fix documentation to correctly define aspectLibrary in pom.xml for Powertool idempotency for v2 #1785

Open
1 task done
Vadym79 opened this issue Mar 4, 2025 · 1 comment
Labels
documentation Improvements or additions to documentation v2 Version 2

Comments

@Vadym79
Copy link

Vadym79 commented Mar 4, 2025

What were you searching in the docs?

For preview of v2 this page states that the following dependency needs to be defined in the pom.xml

     <plugin>
             <aspectLibraries>
                 <aspectLibrary>
                     <groupId>software.amazon.lambda</groupId>
                     <artifactId>powertools-idempotency-dynamodb</artifactId>
                 </aspectLibrary>
             </aspectLibraries>
    </plugin>

My tests revealed that instead of artifact id "powertools-idempotency-dynamodb", artifact id "powertools-idempotency-core" needs to be defined, see my working example.

Is this related to an existing documentation section?

https://docs.powertools.aws.dev/lambda/java/preview/utilities/idempotency/

How can we improve?

My tests revealed that instead of artifact id "powertools-idempotency-dynamodb", artifact id "powertools-idempotency-core" needs to be defined, see my working example.

Got a suggestion in mind?

User powertools-idempotency-core instead

Acknowledgment

  • I understand the final update might be different from my proposed suggestion, or refused.
@Vadym79 Vadym79 added documentation Improvements or additions to documentation triage labels Mar 4, 2025
@Vadym79 Vadym79 changed the title Fix documention regarding powertool idempotency Improve/Fix documention regarding defined aspectLibrary for Powertool idempotency for v2 Mar 4, 2025
@Vadym79 Vadym79 changed the title Improve/Fix documention regarding defined aspectLibrary for Powertool idempotency for v2 Improve/Fix documention to correctl define aspectLibrary in pom.xml for Powertool idempotency for v2 Mar 4, 2025
@Vadym79 Vadym79 changed the title Improve/Fix documention to correctl define aspectLibrary in pom.xml for Powertool idempotency for v2 Improve/Fix documentation to correctly define aspectLibrary in pom.xml for Powertool idempotency for v2 Mar 4, 2025
@phipag
Copy link
Contributor

phipag commented Mar 6, 2025

I tested this today and can confirm that this is a miss in the v2 documentation. As part of #1467 we split the idempotency module into submodules to foster clearer separation between persistence stores and the idempotency logic.

We keep the logic including the AspectJ weaving in the core module now while the persistence store is split into a corresponding DynamoDB sub-module. Similar to what you did in your example (thanks for providing this 🙏) we should modify the documentation.

@phipag phipag moved this from Triage to Backlog in Powertools for AWS Lambda (Java) Mar 6, 2025
@phipag phipag added v2 Version 2 and removed triage labels Mar 6, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation v2 Version 2
Projects
Status: Backlog
Development

No branches or pull requests

2 participants