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

fix: re-enable gnomad output for server #604

Merged
merged 2 commits into from
Nov 22, 2024
Merged

Conversation

holtgrewe
Copy link
Contributor

@holtgrewe holtgrewe commented Nov 22, 2024

Summary by CodeRabbit

  • New Features

    • Enhanced support for annotations from gnomAD exomes and genomes databases, providing more comprehensive variant information.
    • Updated response structure now includes results from gnomAD along with existing annotations from CADD, dbSNP, and ClinVar.
  • Bug Fixes

    • Improved error handling for database version fetching, ensuring robustness in response generation.

Copy link

coderabbitai bot commented Nov 22, 2024

Walkthrough

The pull request introduces significant updates to the handle_with_openapi function in src/server/run/annos_variant.rs. It implements logic to handle annotations from the gnomAD exomes and genomes databases, which were previously commented out. The function now retrieves the appropriate protobuf records based on the database version and includes error handling for unknown versions. Additionally, the response structure has been updated to incorporate results from both gnomAD databases alongside existing annotations from CADD, dbSNP, and ClinVar.

Changes

File Change Summary
src/server/run/annos_variant.rs - Updated handle_with_openapi to implement gnomAD exomes and genomes handling.
- Added logic to fetch records based on gnomAD database version.
- Updated SeqvarsAnnoResponseRecord to include gnomad_exomes and gnomad_genomes fields.
- Enhanced response structure to include new annotations from gnomAD alongside existing ones.

Possibly related PRs

  • feat: endpoint /api/v1/strucvars/clinvar-annos/query with OpenAPI (#578) #591: This PR modifies the handle function in src/server/run/annos_variant.rs, which is the same file where the main PR introduces significant changes to the handle_with_openapi function, indicating a direct relationship in terms of functionality related to variant annotations.
  • feat: add /api/v1/seqvars/annos/query with OpenAPI (#577) #592: This PR adds new structures and modifies the OpenAPI documentation in src/server/run/mod.rs, which includes the annos_variant module. The changes in the main PR also enhance the OpenAPI documentation for the same module, suggesting a connection in the context of API enhancements for variant annotations.

🐇 In the code, I hop and play,
With gnomAD’s data, come what may.
Annotations bloom, a garden bright,
Exomes and genomes, a wondrous sight!
Errors handled, responses clear,
In the world of variants, we cheer! 🎉


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>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • 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 testing code 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

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 using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • 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/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@holtgrewe holtgrewe enabled auto-merge (squash) November 22, 2024 10:33
Copy link

@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.

Actionable comments posted: 1

🧹 Outside diff range and nitpick comments (2)
src/server/run/annos_variant.rs (2)

2927-2979: Consider refactoring duplicate logic into a helper function

The logic for handling gnomAD versions in both gnomad_exomes and gnomad_genomes is very similar. Consider extracting this logic into a helper function to reduce code duplication and improve maintainability.


2981-3023: Consider refactoring duplicate logic into a helper function

As with gnomad_exomes, the version handling in gnomad_genomes can be refactored into a shared helper function to improve code clarity and reduce duplication.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 689e594 and 23afd38.

📒 Files selected for processing (1)
  • src/server/run/annos_variant.rs (1 hunks)

Comment on lines +2991 to +3020
if db_version.starts_with("2.") {
Ok(fetch_var_protobuf::<crate::pbs::gnomad::gnomad2::Record>(
&db.data,
AnnoDb::GnomadGenomes.cf_name(),
query.clone().into_inner().into(),
)?
.map(|record| {
Ok(GnomadRecord::Gnomad2(
record.try_into().map_err(CustomError::new)?,
))
})
.transpose()?)
} else if db_version.starts_with("4.") {
Ok(fetch_var_protobuf::<crate::pbs::gnomad::gnomad4::Record>(
&db.data,
AnnoDb::GnomadGenomes.cf_name(),
query.clone().into_inner().into(),
)?
.map(|record| {
Ok(GnomadRecord::Gnomad4(
record.try_into().map_err(CustomError::new)?,
))
})
.transpose()?)
} else {
Err(CustomError::new(anyhow::anyhow!(
"don't know how to handle gnomAD version {}",
db_version
)))
}
Copy link

Choose a reason for hiding this comment

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

⚠️ Potential issue

Missing handling for gnomAD Genomes version 3.x

The code does not handle gnomAD Genomes version 3.x in the gnomad_genomes block. This could lead to runtime errors if db_version starts with "3.".

Apply this diff to fix the issue:

                     if db_version.starts_with("2.") {
                         // existing code for version 2.x
+                    } else if db_version.starts_with("3.") {
+                        Ok(fetch_var_protobuf::<crate::pbs::gnomad::gnomad3::Record>(
+                            &db.data,
+                            AnnoDb::GnomadGenomes.cf_name(),
+                            query.clone().into_inner().into(),
+                        )?
+                        .map(|record| {
+                            Ok(GnomadRecord::Gnomad3(
+                                record.try_into().map_err(CustomError::new)?,
+                            ))
+                        })
+                        .transpose()?)
                     } else if db_version.starts_with("4.") {
                         // existing code for version 4.x
                     } else {
                         // existing error handling
                     }

Committable suggestion skipped: line range outside the PR's diff.

@holtgrewe holtgrewe disabled auto-merge November 22, 2024 10:38
@holtgrewe holtgrewe merged commit 5be7bd5 into main Nov 22, 2024
8 of 10 checks passed
@holtgrewe holtgrewe deleted the fix-gnomad-server-output branch November 22, 2024 10:39
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.

1 participant