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

Allow getting all secondary keys and values for a KKV top level key #1016

Merged
merged 1 commit into from
Feb 12, 2024

Conversation

jbirddog
Copy link
Contributor

@jbirddog jbirddog commented Feb 12, 2024

Feature request from @calexh-sar - via the function placed into task data when a KKV data store is being read, allowing fetching all secondary keys and their values instead of just a value for a secondary key.

Summary by CodeRabbit

  • New Features
    • Enhanced data retrieval functionality to support fetching all values associated with a primary key when no secondary key is provided.

Copy link
Contributor

coderabbitai bot commented Feb 12, 2024

Walkthrough

Walkthrough

The modification in the spiffworkflow-backend involves enhancing the getter function within the kkv.py file to support an optional secondary_key. This adaptability allows the function to either fetch a specific value associated with a secondary_key or, when secondary_key is not provided, to retrieve all values linked to the top_level_key. This adjustment broadens the function's utility in data retrieval scenarios.

Changes

File Change Summary
.../data_stores/kkv.py Updated getter function to accept an optional secondary_key, enabling it to return either a specific value or all values associated with top_level_key.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit-tests for this file.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit tests for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository from git and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Review Status

Actionable comments generated: 1

Configuration used: .coderabbit.yaml

Commits Files that changed from the base of the PR and between 08002d2 and 115f980.
Files selected for processing (1)
  • spiffworkflow-backend/src/spiffworkflow_backend/data_stores/kkv.py (2 hunks)
Additional comments: 2
spiffworkflow-backend/src/spiffworkflow_backend/data_stores/kkv.py (2)
  • 74-74: The function getter now accepts secondary_key as an optional parameter, aligning with the PR objectives. Ensure all calls to this function are updated accordingly.
  • 101-101: Using a dictionary comprehension to map secondary_key to value is efficient for this use case. Ensure that the keys are unique to avoid data loss.

Comment on lines +84 to +103
if secondary_key is not None:
model = (
db.session.query(KKVDataStoreEntryModel)
.filter_by(kkv_data_store_id=store_model.id, top_level_key=top_level_key, secondary_key=secondary_key)
.first()
)

if model is not None:
return model.value
return None

models = (
db.session.query(KKVDataStoreEntryModel)
.filter_by(kkv_data_store_id=store_model.id, top_level_key=top_level_key, secondary_key=secondary_key)
.first()
.filter_by(kkv_data_store_id=store_model.id, top_level_key=top_level_key)
.all()
)

if model is not None:
return model.value
return None
values = {model.secondary_key: model.value for model in models}

return values
Copy link
Contributor

Choose a reason for hiding this comment

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

The logic to handle secondary_key being None is correctly implemented, fetching all secondary keys and their values for the given top_level_key. However, consider adding error handling for potential database query failures to improve robustness.

@burnettk burnettk merged commit c6c1a4a into main Feb 12, 2024
22 checks passed
@burnettk burnettk deleted the all_2nd_keys branch February 12, 2024 14:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants