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: No replicas for donors in HCA (#6582) #6584

Merged
merged 11 commits into from
Oct 6, 2024

Conversation

nadove-ucsc
Copy link
Contributor

@nadove-ucsc nadove-ucsc commented Sep 20, 2024

Connected issues: #6582

Checklist

Author

  • PR is a draft
  • Target branch is develop
  • Name of PR branch matches issues/<GitHub handle of author>/<issue#>-<slug>
  • On ZenHub, PR is connected to all issues it (partially) resolves
  • PR description links to connected issues
  • PR title matches1 that of a connected issue or comment in PR explains why they're different
  • PR title references all connected issues
  • For each connected issue, there is at least one commit whose title references that issue

1 when the issue title describes a problem, the corresponding PR
title is Fix: followed by the issue title

Author (partiality)

  • Added p tag to titles of partial commits
  • This PR is labeled partial or completely resolves all connected issues
  • This PR partially resolves each of the connected issues or does not have the partial label

Author (chains)

  • This PR is blocked by previous PR in the chain or is not chained to another PR
  • The blocking PR is labeled base or this PR is not chained to another PR
  • This PR is labeled chained or is not chained to another PR

Author (reindex, API changes)

  • Added r tag to commit title or the changes introduced by this PR will not require reindexing of any deployment
  • This PR is labeled reindex:dev or the changes introduced by it will not require reindexing of dev
  • This PR is labeled reindex:anvildev or the changes introduced by it will not require reindexing of anvildev
  • This PR is labeled reindex:anvilprod or the changes introduced by it will not require reindexing of anvilprod
  • This PR is labeled reindex:prod or the changes introduced by it will not require reindexing of prod
  • This PR is labeled reindex:partial and its description documents the specific reindexing procedure for dev, anvildev, anvilprod and prod or requires a full reindex or carries none of the labels reindex:dev, reindex:anvildev, reindex:anvilprod and reindex:prod
  • This PR and its connected issues are labeled API or this PR does not modify a REST API
  • Added a (A) tag to commit title for backwards (in)compatible changes or this PR does not modify a REST API
  • Updated REST API version number in app.py or this PR does not modify a REST API

Author (upgrading deployments)

  • Ran make docker_images.json and committed the resulting changes or this PR does not modify azul_docker_images, or any other variables referenced in the definition of that variable
  • Documented upgrading of deployments in UPGRADING.rst or this PR does not require upgrading deployments
  • Added u tag to commit title or this PR does not require upgrading deployments
  • This PR is labeled upgrade or does not require upgrading deployments
  • This PR is labeled deploy:shared or does not modify docker_images.json, and does not require deploying the shared component for any other reason
  • This PR is labeled deploy:gitlab or does not require deploying the gitlab component
  • This PR is labeled deploy:runner or does not require deploying the runner image

Author (hotfixes)

  • Added F tag to main commit title or this PR does not include permanent fix for a temporary hotfix
  • Reverted the temporary hotfixes for any connected issues or the none of the stable branches (anvilprod and prod) have temporary hotfixes for any of the issues connected to this PR

Author (before every review)

  • Rebased PR branch on develop, squashed old fixups
  • Ran make requirements_update or this PR does not modify requirements*.txt, common.mk, Makefile and Dockerfile
  • Added R tag to commit title or this PR does not modify requirements*.txt
  • This PR is labeled reqs or does not modify requirements*.txt
  • make integration_test passes in personal deployment or this PR does not modify functionality that could affect the IT outcome

Peer reviewer (after approval)

  • PR is not a draft
  • Ticket is in Review requested column
  • PR is awaiting requested review from system administrator
  • PR is assigned to only the system administrator

System administrator (after approval)

  • Actually approved the PR
  • Labeled connected issues as demo or no demo
  • Commented on connected issues about demo expectations or all connected issues are labeled no demo
  • Decided if PR can be labeled no sandbox
  • A comment to this PR details the completed security design review
  • PR title is appropriate as title of merge commit
  • N reviews label is accurate
  • Moved connected issues to Approved column
  • PR is assigned to only the operator

Operator (before pushing merge the commit)

  • Checked reindex:… labels and r commit title tag
  • Checked that demo expectations are clear or all connected issues are labeled no demo
  • Squashed PR branch and rebased onto develop
  • Sanity-checked history
  • Pushed PR branch to GitHub
  • Ran _select dev.shared && CI_COMMIT_REF_NAME=develop make -C terraform/shared apply_keep_unused or this PR is not labeled deploy:shared
  • Ran _select dev.gitlab && CI_COMMIT_REF_NAME=develop make -C terraform/gitlab apply or this PR is not labeled deploy:gitlab
  • Ran _select anvildev.shared && CI_COMMIT_REF_NAME=develop make -C terraform/shared apply_keep_unused or this PR is not labeled deploy:shared
  • Ran _select anvildev.gitlab && CI_COMMIT_REF_NAME=develop make -C terraform/gitlab apply or this PR is not labeled deploy:gitlab
  • Checked the items in the next section or this PR is labeled deploy:gitlab
  • PR is assigned to only the system administrator or this PR is not labeled deploy:gitlab

System administrator

  • Background migrations for dev.gitlab are complete or this PR is not labeled deploy:gitlab
  • Background migrations for anvildev.gitlab are complete or this PR is not labeled deploy:gitlab
  • PR is assigned to only the operator

Operator (before pushing merge the commit)

  • Ran _select dev.gitlab && make -C terraform/gitlab/runner or this PR is not labeled deploy:runner
  • Ran _select anvildev.gitlab && make -C terraform/gitlab/runner or this PR is not labeled deploy:runner
  • Added sandbox label or PR is labeled no sandbox
  • Pushed PR branch to GitLab dev or PR is labeled no sandbox
  • Pushed PR branch to GitLab anvildev or PR is labeled no sandbox
  • Build passes in sandbox deployment or PR is labeled no sandbox
  • Build passes in anvilbox deployment or PR is labeled no sandbox
  • Reviewed build logs for anomalies in sandbox deployment or PR is labeled no sandbox
  • Reviewed build logs for anomalies in anvilbox deployment or PR is labeled no sandbox
  • Deleted unreferenced indices in sandbox or this PR does not remove catalogs or otherwise causes unreferenced indices in dev
  • Deleted unreferenced indices in anvilbox or this PR does not remove catalogs or otherwise causes unreferenced indices in anvildev
  • Started reindex in sandbox or this PR is not labeled reindex:dev
  • Started reindex in anvilbox or this PR is not labeled reindex:anvildev
  • Checked for failures in sandbox or this PR is not labeled reindex:dev
  • Checked for failures in anvilbox or this PR is not labeled reindex:anvildev
  • The title of the merge commit starts with the title of this PR
  • Added PR # reference to merge commit title
  • Collected commit title tags in merge commit title but only included p if the PR is also labeled partial
  • Moved connected issues to Merged lower column in ZenHub
  • Moved blocked issues to Triage or no issues are blocked on the connected issues
  • Pushed merge commit to GitHub

Operator (chain shortening)

  • Changed the target branch of the blocked PR to develop or this PR is not labeled base
  • Removed the chained label from the blocked PR or this PR is not labeled base
  • Removed the blocking relationship from the blocked PR or this PR is not labeled base
  • Removed the base label from this PR or this PR is not labeled base

Operator (after pushing the merge commit)

  • Pushed merge commit to GitLab dev
  • Pushed merge commit to GitLab anvildev
  • Build passes on GitLab dev
  • Reviewed build logs for anomalies on GitLab dev
  • Build passes on GitLab anvildev
  • Reviewed build logs for anomalies on GitLab anvildev
  • Ran _select dev.shared && make -C terraform/shared apply or this PR is not labeled deploy:shared
  • Ran _select anvildev.shared && make -C terraform/shared apply or this PR is not labeled deploy:shared
  • Deleted PR branch from GitHub
  • Deleted PR branch from GitLab dev
  • Deleted PR branch from GitLab anvildev

Operator (reindex)

  • Deindexed all unreferenced catalogs in dev or this PR is neither labeled reindex:partial nor reindex:dev
  • Deindexed all unreferenced catalogs in anvildev or this PR is neither labeled reindex:partial nor reindex:anvildev
  • Deindexed specific sources in dev or this PR is neither labeled reindex:partial nor reindex:dev
  • Deindexed specific sources in anvildev or this PR is neither labeled reindex:partial nor reindex:anvildev
  • Indexed specific sources in dev or this PR is neither labeled reindex:partial nor reindex:dev
  • Indexed specific sources in anvildev or this PR is neither labeled reindex:partial nor reindex:anvildev
  • Started reindex in dev or this PR does not require reindexing dev
  • Started reindex in anvildev or this PR does not require reindexing anvildev
  • Checked for, triaged and possibly requeued messages in both fail queues in dev or this PR does not require reindexing dev
  • Checked for, triaged and possibly requeued messages in both fail queues in anvildev or this PR does not require reindexing anvildev
  • Emptied fail queues in dev or this PR does not require reindexing dev
  • Emptied fail queues in anvildev or this PR does not require reindexing anvildev

Operator

  • Propagated the deploy:shared, deploy:gitlab, deploy:runner, API, reindex:partial, reindex:anvilprod and reindex:prod labels to the next promotion PRs or this PR carries none of these labels
  • Propagated any specific instructions related to the deploy:shared, deploy:gitlab, deploy:runner, API, reindex:partial, reindex:anvilprod and reindex:prod labels, from the description of this PR to that of the next promotion PRs or this PR carries none of these labels
  • PR is assigned to no one

Shorthand for review comments

  • L line is too long
  • W line wrapping is wrong
  • Q bad quotes
  • F other formatting problem

@github-actions github-actions bot added the orange [process] Done by the Azul team label Sep 20, 2024
@nadove-ucsc nadove-ucsc added reindex:dev [process] PR requires reindexing dev reindex:prod [process] PR requires reindexing prod labels Sep 20, 2024
@nadove-ucsc nadove-ucsc force-pushed the issues/nadove-ucsc/6582-no-replicas-donors-hca branch 2 times, most recently from 0aa044e to b7c9cc2 Compare September 20, 2024 23:12
@nadove-ucsc nadove-ucsc force-pushed the issues/nadove-ucsc/6582-no-replicas-donors-hca branch 2 times, most recently from 5aaa1d1 to 4b7a516 Compare September 21, 2024 00:38
@nadove-ucsc nadove-ucsc force-pushed the issues/nadove-ucsc/6582-no-replicas-donors-hca branch 2 times, most recently from e5bc356 to 43c8989 Compare September 21, 2024 01:47
@coveralls
Copy link

coveralls commented Sep 21, 2024

Coverage Status

coverage: 85.382% (-0.02%) from 85.399%
when pulling da77107 on issues/nadove-ucsc/6582-no-replicas-donors-hca
into bbff541 on develop.

@nadove-ucsc nadove-ucsc force-pushed the issues/nadove-ucsc/6582-no-replicas-donors-hca branch 5 times, most recently from 9205a80 to a451386 Compare September 25, 2024 01:16
Copy link

codecov bot commented Sep 25, 2024

Codecov Report

Attention: Patch coverage is 98.41270% with 2 lines in your changes missing coverage. Please review.

Project coverage is 85.36%. Comparing base (bbff541) to head (da77107).
Report is 12 commits behind head on develop.

Files with missing lines Patch % Lines
src/azul/indexer/index_service.py 91.66% 1 Missing ⚠️
src/humancellatlas/data/metadata/api.py 83.33% 1 Missing ⚠️
Additional details and impacted files
@@             Coverage Diff             @@
##           develop    #6584      +/-   ##
===========================================
- Coverage    85.38%   85.36%   -0.02%     
===========================================
  Files          155      155              
  Lines        20788    20765      -23     
===========================================
- Hits         17749    17726      -23     
  Misses        3039     3039              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@nadove-ucsc nadove-ucsc force-pushed the issues/nadove-ucsc/6582-no-replicas-donors-hca branch 3 times, most recently from 9270cfd to 40cf855 Compare September 26, 2024 00:39
Copy link
Member

@achave11-ucsc achave11-ucsc left a comment

Choose a reason for hiding this comment

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

Looks good.

Just spotted some minor nits to fix.

super().__init__(entity.address +
' cannot ' + ('reference ' if forward else 'be referenced by ') +
other_entity.address)
super().__init__(f'{entity.ref} cannot {"reference" if forward else "be referenced by"} '
Copy link
Member

Choose a reason for hiding this comment

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

L

@@ -87,7 +85,7 @@ def estimate(self, partition: BundlePartition) -> int:
"""

@abstractmethod
def transform(self, partition: BundlePartition) -> Iterable[Transform]:
def transform(self, partition: BundlePartition) -> Iterable[Contribution | Replica]:
Copy link
Member

Choose a reason for hiding this comment

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

L

for entity in self._list_entities()
if self._contains(partition, entity)
)
def transform(self, partition: BundlePartition) -> Iterable[Contribution | Replica]:
Copy link
Member

Choose a reason for hiding this comment

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

L

@@ -1418,7 +1406,7 @@ def _entities_in(self, partition: BundlePartition) -> Iterator[ENTITY]:
def estimate(self, partition: BundlePartition) -> int:
return ilen(self._entities_in(partition))

def transform(self, partition: BundlePartition) -> Iterable[Transform]:
def transform(self, partition: BundlePartition) -> Iterable[Contribution | Replica]:
Copy link
Member

Choose a reason for hiding this comment

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

L

@@ -619,7 +597,7 @@ class DonorTransformer(BaseTransformer):
def entity_type(cls) -> str:
return 'donors'

def _transform(self, entity: EntityReference) -> Transform:
def _transform(self, entity: EntityReference) -> Iterable[Contribution | Replica]:
Copy link
Member

Choose a reason for hiding this comment

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

L

@@ -1431,7 +1419,7 @@ def entity_type(cls) -> str:
def _entities(self) -> Iterable[api.File]:
return self.api_bundle.not_stitched(self.api_bundle.files)

def _transform(self, files: Iterable[api.File]) -> Iterable[Contribution]:
def _transform(self, files: Iterable[api.File]) -> Iterable[Contribution | Replica]:
Copy link
Member

Choose a reason for hiding this comment

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

L

@@ -1649,11 +1643,11 @@ def _dated_entities(self) -> Iterable[DatedEntity]:
def estimate(self, partition: BundlePartition) -> int:
return int(partition.contains(self._singleton_id))

def transform(self, partition: BundlePartition) -> Iterable[Transform]:
def transform(self, partition: BundlePartition) -> Iterable[Contribution | Replica]:
Copy link
Member

Choose a reason for hiding this comment

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

L

Comment on lines 1472 to 1478
# The other hubs will be added when the indexer consolidates duplicate replicas.
[file_id])
yield self._replica(one(self.api_bundle.projects.values()).ref,
# Projects are linked to every file in their snapshot, making an explicit list
# of hub IDs for the project both redundant and impractically large. Therefore,
# we leave the hub IDs field empty for projects and rely on the tenet that every
# file is an implicit hub of its parent project.
Copy link
Member

Choose a reason for hiding this comment

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

L, https://github.com/DataBiosphere/azul/blob/develop/CONTRIBUTING.rst#12line-length

diff --git a/src/azul/plugins/metadata/hca/indexer/transform.py b/src/azul/plugins/metadata/hca/indexer/transform.py
index d263e7c2..f1942292 100644
--- a/src/azul/plugins/metadata/hca/indexer/transform.py
+++ b/src/azul/plugins/metadata/hca/indexer/transform.py
@@ -1469,13 +1469,19 @@ class FileTransformer(PartitionedTransformer[api.File]):
                 yield self._contribution(contents, file_id)
                 if config.enable_replicas:
                     yield self._replica(self.api_bundle.ref,
-                                        # The other hubs will be added when the indexer consolidates duplicate replicas.
+                                        # The other hubs will be added when the
+                                        # indexer consolidates duplicate
+                                        # replicas.
                                         [file_id])
                     yield self._replica(one(self.api_bundle.projects.values()).ref,
-                                        # Projects are linked to every file in their snapshot, making an explicit list
-                                        # of hub IDs for the project both redundant and impractically large. Therefore,
-                                        # we leave the hub IDs field empty for projects and rely on the tenet that every
-                                        # file is an implicit hub of its parent project.
+                                        # Projects are linked to every file in
+                                        # their snapshot, making an explicit
+                                        # list of hub IDs for the project both
+                                        # redundant and impractically large.
+                                        # Therefore, we leave the hub IDs field
+                                        # empty for projects and rely on the
+                                        # tenet that every file is an implicit
+                                        # hub of its parent project.
                                         [])
                     for linked_entity in visitor.entities:
                         yield self._replica(linked_entity, [file_id])

Comment on lines 613 to 619
# The other hubs will be added when the indexer consolidates duplicate replicas.
yield self._replica(entity, [entity.entity_id])
for linked_entity in linked:
# Datasets are linked to every file in their snapshot, making an explicit list
# of hub IDs for the dataset both redundant and impractically large. Therefore,
# we leave the hub IDs field empty for datasets and rely on the tenet that every
# file is an implicit hub of its parent dataset.
Copy link
Member

Choose a reason for hiding this comment

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

L

diff --git a/src/azul/plugins/metadata/anvil/indexer/transform.py b/src/azul/plugins/metadata/anvil/indexer/transform.py
index 06464c9a..5e004beb 100644
--- a/src/azul/plugins/metadata/anvil/indexer/transform.py
+++ b/src/azul/plugins/metadata/anvil/indexer/transform.py
@@ -610,12 +610,14 @@ class FileTransformer(BaseTransformer):
         )
         yield self._contribution(contents, entity.entity_id)
         if config.enable_replicas:
-            # The other hubs will be added when the indexer consolidates duplicate replicas.
+            # The other hubs will be added when the indexer consolidates
+            # duplicate replicas.
             yield self._replica(entity, [entity.entity_id])
             for linked_entity in linked:
-                # Datasets are linked to every file in their snapshot, making an explicit list
-                # of hub IDs for the dataset both redundant and impractically large. Therefore,
-                # we leave the hub IDs field empty for datasets and rely on the tenet that every
-                # file is an implicit hub of its parent dataset.
+                # Datasets are linked to every file in their snapshot, making an
+                # explicit list of hub IDs for the dataset both redundant and
+                # impractically large. Therefore, we leave the hub IDs field
+                # empty for datasets and rely on the tenet that every file is an
+                # implicit hub of its parent dataset.
                 yield self._replica(linked_entity,
                                     hub_ids=[] if linked_entity.entity_type == 'dataset' else [entity.entity_id])


ENTITY = TypeVar('ENTITY', bound=api.Entity)


class PartitionedTransformer(BaseTransformer, Generic[ENTITY]):

@abstractmethod
def _transform(self, entities: Iterable[ENTITY]) -> Iterable[Transform]:
def _transform(self, entities: Iterable[ENTITY]) -> Iterable[Contribution | Replica]:
Copy link
Member

Choose a reason for hiding this comment

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

L

@achave11-ucsc achave11-ucsc removed their assignment Sep 27, 2024
@nadove-ucsc nadove-ucsc force-pushed the issues/nadove-ucsc/6582-no-replicas-donors-hca branch 2 times, most recently from ac4f8b0 to 16bb687 Compare September 27, 2024 23:13
@hannes-ucsc hannes-ucsc added reindex:anvildev [process] PR requires reindexing anvildev reindex:anvilprod [process] PR requires reindexing anvilprod labels Oct 4, 2024
@hannes-ucsc
Copy link
Member

hannes-ucsc commented Oct 4, 2024

I added the reindex:anvildev and reindex:anvilprod labels because I would like to verify the impact of these changes for both AnVIL and HCA. As in the previous PR on this track, I would like to run a reindex immediately before and after merging the PR, and compare the runs via the dev and anvildev CW dashboards.

@hannes-ucsc
Copy link
Member

Security design review

  • Security design review completed; this PR does not
    • … affect authentication; for example:
      • OAuth 2.0 with the application (API or Swagger UI)
      • Authentication of developers with Google Cloud APIs
      • Authentication of developers with AWS APIs
      • Authentication with a GitLab instance in the system
      • Password and 2FA authentication with GitHub
      • API access token authentication with GitHub
      • Authentication with Terra
    • … affect the permissions of internal users like access to
      • Cloud resources on AWS and GCP
      • GitLab repositories, projects and groups, administration
      • an EC2 instance via SSH
      • GitHub issues, pull requests, commits, commit statuses, wikis, repositories, organizations
    • … affect the permissions of external users like access to
      • TDR snapshots
    • … affect permissions of service or bot accounts
      • Cloud resources on AWS and GCP
    • … affect audit logging in the system, like
      • adding, removing or changing a log message that represents an auditable event
      • changing the routing of log messages through the system
    • … affect monitoring of the system
    • … introduce a new software dependency like
      • Python packages on PYPI
      • Command-line utilities
      • Docker images
      • Terraform providers
    • … add an interface that exposes sensitive or confidential data at the security boundary
    • … affect the encryption of data at rest
    • … require persistence of sensitive or confidential data that might require encryption at rest
    • … require unencrypted transmission of data within the security boundary
    • … affect the network security layer; for example by
      • modifying, adding or removing firewall rules
      • modifying, adding or removing security groups
      • changing or adding a port a service, proxy or load balancer listens on
  • Documentation on any unchecked boxes is provided in comments below

@hannes-ucsc hannes-ucsc added the 0 reviews [process] Lead didn't request any changes label Oct 4, 2024
@nadove-ucsc nadove-ucsc added the base [process] Another PR needs to be rebased before merging this one label Oct 5, 2024
@achave11-ucsc achave11-ucsc force-pushed the issues/nadove-ucsc/6582-no-replicas-donors-hca branch from e895bd1 to db175f9 Compare October 5, 2024 06:01
@achave11-ucsc achave11-ucsc added the sandbox [process] Resolution is being verified in sandbox deployment label Oct 5, 2024
@achave11-ucsc achave11-ucsc force-pushed the issues/nadove-ucsc/6582-no-replicas-donors-hca branch from db175f9 to da77107 Compare October 5, 2024 18:15
@achave11-ucsc achave11-ucsc merged commit 8cebafe into develop Oct 6, 2024
11 checks passed
@achave11-ucsc achave11-ucsc removed the base [process] Another PR needs to be rebased before merging this one label Oct 6, 2024
@achave11-ucsc achave11-ucsc deleted the issues/nadove-ucsc/6582-no-replicas-donors-hca branch October 6, 2024 19:49
@dsotirho-ucsc dsotirho-ucsc removed their assignment Oct 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
0 reviews [process] Lead didn't request any changes orange [process] Done by the Azul team reindex:anvildev [process] PR requires reindexing anvildev reindex:anvilprod [process] PR requires reindexing anvilprod reindex:dev [process] PR requires reindexing dev reindex:prod [process] PR requires reindexing prod sandbox [process] Resolution is being verified in sandbox deployment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants