Fix dynamodb adapter find_by_key

[lilfaf]

Fix find_by_key failing with ValidationException when querying the KeyIndex GSI.

key is a DynamoDB reserved keyword.

Description

Type of Change

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• Documentation update
• Performance improvement
• Code refactoring

Testing

• Unit tests pass
• Integration tests pass
• Manual testing completed

Checklist

• My code follows the style guidelines of this project
• I have performed a self-review of my own code
• I have commented my code, particularly in hard-to-understand areas
• I have made corresponding changes to the documentation
• My changes generate no new warnings
• Any dependent changes have been merged and published

Build Artifacts

Additional Notes

[gemini-code-assist]

Summary of Changes

Hello @lilfaf, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request resolves a critical bug in the DynamoDB adapter's find_by_key functionality. Previously, attempts to query a specific GSI using the key attribute would fail due to DynamoDB's reserved keyword restrictions. The change introduces a standard practice of aliasing the reserved keyword in the query expression, ensuring robust and error-free data retrieval from the database.

Highlights

• Bug Fix: Addresses a ValidationException occurring in the find_by_key method of the DynamoDB adapter when querying the KeyIndex Global Secondary Index (GSI).
• Root Cause: The issue stemmed from using key directly in the key_condition_expression, which is a reserved keyword in DynamoDB.
• Solution: The fix involves aliasing the key attribute using expression_attribute_names (e.g., #k) to avoid conflict with the reserved keyword, allowing queries to execute successfully.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request correctly fixes a ValidationException in the find_by_key function when querying a DynamoDB GSI. The use of key as an attribute name, which is a reserved keyword, was causing the query to fail. The fix, which involves using an expression attribute name (#k) as a placeholder, is the standard and correct approach to resolve this issue. The change is effective and well-targeted. I've added one minor suggestion to improve the readability of the expression attribute name.