search

broadinstitute / genetic-prevalence-estimator

https://genie.broadinstitute.org/
BSD 3-Clause "New" or "Revised" License
1 stars 0 forks source link

Add shared annotations #158

Closed rileyhgrant closed 10 months ago

rileyhgrant commented 1 year ago

Part 2/2 for: #145

Adds functionality for shared annotations.

If a user does have sharing permissions for the list, they can toggle between the set of shared annotations and their personal annotations. They can view and edit both their set of personal annotations and the shared annotations. The view defaults to the shared annotations.

If a user does not have sharing permissions to the variant list (if they are added as a viewer, or if the list is public), they can view the shared annotations associated with the variant list.

Screenshots

Editor viewing shared annotations

Editor viewing personal annotations

Viewer viewing shared annotations (views the same set of annotations in the first screenshot, but has read-only permissions and view)

rileyhgrant commented 1 year ago

This is to be rebased off of main after the public lists PR gets merged. At that time, some additional nox tests confirming the behavior of viewing the shared annotations on a public list will be added.

This feels like a distinct feature that should not be squashed into a single commit (alongside the public lists) via the "squash and merge" option that is the only option on this repo. As such I've opted to make this a separate PR.

rileyhgrant commented 1 year ago

The data model for shared variant annotations in this PR has been changed from the initial design of a new table, to the suggested design of having a null foreign key for the user of a given VariantListAnnotation denote the shared variant list. This reduces unnecessary duplication of very similar code, thank you Phil for the helpful suggestions.

rileyhgrant commented 1 year ago

Hiya @phildarnowsky-broad, at your convenience, I'm requesting your review on this PR since this was the other of the two PRs we discussed in our 1:1.

For future PRs I will begin to request Matt's review to distribute the review workload.

Thank you!

rileyhgrant commented 1 year ago

Hiya @phildarnowsky-broad,

Apologies to be a squeaky wheel on this one - I'm about to be out of office until the 16th of October, and some other work that Josephine will be working this semester on is partially contingent on this feature.

Could I trouble you to try and get to this review before I get back? Thank you!

rileyhgrant commented 11 months ago

Hiya @phildarnowsky-broad, requesting review again after addressing two comments, and replying to two comments.

Also - I saw your advice about rebasing to remove the old data model, I will plan on doing that before this gets merged to keep the history around as long as possible.