feat: add helper utilities #17
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
There was a problem hiding this comment.
Pull Request Overview
This pull request introduces a new helper module for idempotency key generation in HTTP requests and provides comprehensive test coverage for the functionality.
- Added
idempotency_headersfunction to generate idempotency headers with either provided keys or auto-generated UUIDs - Created comprehensive unit tests covering various edge cases and behavior validation
- Updated coverage reporting to reflect the new code and test coverage
Reviewed Changes
Copilot reviewed 4 out of 5 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| gavaconnect/helpers/init.py | Added module docstring for the new helpers package |
| gavaconnect/helpers/idempontency.py | Implemented the core idempotency_headers function with UUID fallback |
| tests/test_idempotency.py | Added comprehensive test suite covering all function behaviors and edge cases |
| coverage.xml | Updated coverage report to include the new helpers package and reflect increased coverage |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
…nect-sdk-python into feat/idempotency
…rove code readability
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request introduces a new helper module for idempotency key generation and adds comprehensive tests for its functionality. It also updates the code coverage report to reflect the new code and its test coverage.
Helpers and Idempotency Utilities:
idempontency.pymodule ingavaconnect/helperswith theidempotency_headersfunction, which generates idempotency headers for HTTP requests, using a provided key or generating a UUID4 if none is given.gavaconnect/helpers/__init__.py.Testing:
tests/test_idempotency.pywith extensive unit tests for theidempotency_headersfunction, covering cases for provided keys, auto-generated UUIDs, empty and whitespace keys, and ensuring correct types and uniqueness.Coverage Reporting:
coverage.xmlto include the newhelperspackage and reflect increased code and test coverage resulting from the new helper and its tests. [1] [2] [3]