Skip to content

Verify digest of file objects in mirror (#7069, #7089) #7090

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

Merged
merged 7 commits into from
May 8, 2025

Conversation

nadove-ucsc
Copy link
Contributor

@nadove-ucsc nadove-ucsc commented May 3, 2025

Connected issues: #7069

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 marked as approved
  • 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
  • Confirmed all checks in PR are OK and the PR is mergeable
  • 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
  • Restarted the Data Browser pipeline for the ucsc/hca/dev branch on GitLab in dev or this PR does not require reindexing dev
  • Restarted the Data Browser pipeline for the ucsc/lungmap/dev branch on GitLab in dev or this PR does not require reindexing dev
  • Restarted deploy_browser job in the GitLab pipeline for this PR in dev or this PR does not require reindexing dev
  • Restarted the Data Browser pipeline for the ucsc/anvil/anvildev branch on GitLab in anvildev or this PR does not require reindexing anvildev
  • Restarted deploy_browser job in the GitLab pipeline for this PR 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

@nadove-ucsc nadove-ucsc added reqs [process] PR includes commit requiring ``make requirements`` chained [process] PR needs to based of develop before merging labels May 3, 2025
@nadove-ucsc nadove-ucsc changed the base branch from develop to issues/nadove-ucsc/6862-implement-mirror-file May 3, 2025 03:49
@github-actions github-actions bot added the orange [process] Done by the Azul team label May 3, 2025
@nadove-ucsc nadove-ucsc force-pushed the issues/nadove-ucsc/7069-verify-digest-mirror branch 2 times, most recently from 5675607 to 8ac6802 Compare May 5, 2025 23:01
Copy link

codecov bot commented May 5, 2025

Codecov Report

Attention: Patch coverage is 65.51724% with 40 lines in your changes missing coverage. Please review.

Project coverage is 85.18%. Comparing base (0ef2e99) to head (5543e11).
Report is 8 commits behind head on develop.

Files with missing lines Patch % Lines
src/azul/args.py 27.27% 16 Missing ⚠️
src/azul/azulclient.py 50.00% 10 Missing ⚠️
src/azul/indexer/mirror_service.py 77.50% 9 Missing ⚠️
src/azul/digests.py 70.58% 5 Missing ⚠️
Additional details and impacted files
@@             Coverage Diff             @@
##           develop    #7090      +/-   ##
===========================================
- Coverage    85.27%   85.18%   -0.10%     
===========================================
  Files          151      152       +1     
  Lines        21846    21948     +102     
===========================================
+ Hits         18629    18696      +67     
- Misses        3217     3252      +35     

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@hannes-ucsc hannes-ucsc force-pushed the issues/nadove-ucsc/6862-implement-mirror-file branch from 33d63d0 to 50f39fb Compare May 6, 2025 00:01
@nadove-ucsc nadove-ucsc force-pushed the issues/nadove-ucsc/6862-implement-mirror-file branch from 50f39fb to 37c4900 Compare May 6, 2025 01:51
@nadove-ucsc nadove-ucsc force-pushed the issues/nadove-ucsc/7069-verify-digest-mirror branch from 8ac6802 to 797754e Compare May 6, 2025 02:54
@nadove-ucsc nadove-ucsc force-pushed the issues/nadove-ucsc/6862-implement-mirror-file branch from 0071471 to fe9a0b3 Compare May 6, 2025 06:40
@hannes-ucsc hannes-ucsc force-pushed the issues/nadove-ucsc/6862-implement-mirror-file branch from 6cdc15d to cd69dc8 Compare May 6, 2025 16:13
@achave11-ucsc achave11-ucsc changed the base branch from issues/nadove-ucsc/6862-implement-mirror-file to develop May 6, 2025 17:33
@achave11-ucsc achave11-ucsc removed the chained [process] PR needs to based of develop before merging label May 6, 2025
@nadove-ucsc nadove-ucsc force-pushed the issues/nadove-ucsc/7069-verify-digest-mirror branch from 797754e to 4e36a22 Compare May 6, 2025 18:01
@coveralls
Copy link

coveralls commented May 6, 2025

Coverage Status

coverage: 85.362% (-0.09%) from 85.452%
when pulling 5543e11 on issues/nadove-ucsc/7069-verify-digest-mirror
into 0ef2e99 on develop.

@nadove-ucsc nadove-ucsc force-pushed the issues/nadove-ucsc/7069-verify-digest-mirror branch from 4e36a22 to e084cdf Compare May 6, 2025 23:51
@nadove-ucsc nadove-ucsc changed the title Verify digest of file objects in mirror (#7069) Verify digest of file objects in mirror (#7069, #7089) May 6, 2025
@nadove-ucsc nadove-ucsc force-pushed the issues/nadove-ucsc/7069-verify-digest-mirror branch from fcef109 to 8a18e23 Compare May 7, 2025 01:06
@nadove-ucsc nadove-ucsc force-pushed the issues/nadove-ucsc/7069-verify-digest-mirror branch 2 times, most recently from febc6b6 to e6143f6 Compare May 7, 2025 02:56
@nadove-ucsc nadove-ucsc marked this pull request as ready for review May 7, 2025 03:23
@nadove-ucsc nadove-ucsc requested a review from hannes-ucsc as a code owner May 7, 2025 03:23
Copy link
Member

@hannes-ucsc hannes-ucsc left a comment

Choose a reason for hiding this comment

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

Subject: [PATCH] REVIEW 1
---
Index: src/azul/digests.py
IDEA additional info:
Subsystem: com.intellij.openapi.diff.impl.patch.CharsetEP
<+>UTF-8
===================================================================
diff --git a/src/azul/digests.py b/src/azul/digests.py
--- a/src/azul/digests.py	(revision 7e9ef6fe283c02343f85699fb2ea0e5c286f5ed1)
+++ b/src/azul/digests.py	(date 1746601204964)
@@ -2,6 +2,7 @@
 import pickle
 from typing import (
     Any,
+    TYPE_CHECKING,
 )
 
 import resumablesha256
@@ -10,8 +11,13 @@
     R,
 )
 
-# TODO: add type stub
-Hasher = Any
+if TYPE_CHECKING:
+    class Hasher:
+        def hexdigest(self) -> str: ...
+
+        def update(self, data: bytes, /) -> None: ...
+else:
+    Hasher = Any  # REVIEW: without the else branch we would need to put any mention of Hasher in quotes, and the import would also need to be conditional on TYPE_CHECKING
 
 
 def get_resumable_hasher(digest_type: str) -> Hasher:
Index: src/azul/azulclient.py
IDEA additional info:
Subsystem: com.intellij.openapi.diff.impl.patch.CharsetEP
<+>UTF-8
===================================================================
diff --git a/src/azul/azulclient.py b/src/azul/azulclient.py
--- a/src/azul/azulclient.py	(revision 7e9ef6fe283c02343f85699fb2ea0e5c286f5ed1)
+++ b/src/azul/azulclient.py	(date 1746600449726)
@@ -708,7 +708,7 @@
             for file in plugin.list_files(source, prefix):
                 info_key = self.mirror_service.info_object_key(file)
                 if info_key in already_mirrored:
-                    log.info('Not mirroring file %r because an info object is already present at %r',
+                    log.info('Not mirroring file %r because info object already exists at %r',
                              file.uuid, info_key)
                 else:
                     log.info('Mirroring file %r', file.uuid)
Index: src/azul/service/storage_service.py
IDEA additional info:
Subsystem: com.intellij.openapi.diff.impl.patch.CharsetEP
<+>UTF-8
===================================================================
diff --git a/src/azul/service/storage_service.py b/src/azul/service/storage_service.py
--- a/src/azul/service/storage_service.py	(revision 7e9ef6fe283c02343f85699fb2ea0e5c286f5ed1)
+++ b/src/azul/service/storage_service.py	(date 1746601204969)
@@ -37,9 +37,11 @@
 )
 
 from azul.collections import (
+    OrderedSet,
     adict,
 )
 from azul.deployment import (
+    R,
     aws,
 )
 
@@ -114,14 +116,19 @@
                             **self._object_creation_kwargs(content_type=content_type, tagging=tagging),
                             **kwargs)
 
-    def list(self, prefix: str) -> list[str]:
-        keys = []
+    # REVIEW: Consider OrderedSet. It better reflects S3's ordering and uniqueness guarantees
+
+    def list(self, prefix: str) -> OrderedSet[str]:
+        keys, num_keys = OrderedSet(), 0
         token = None
-        while True:
+        while True:  # REVIEW: Consider using a paginator (https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/s3/paginator/ListObjectsV2.html#listobjectsv2)
             response = self._s3.list_objects_v2(Bucket=self.bucket_name,
                                                 Prefix=prefix,
                                                 **adict(ContinuationToken=token))
-            keys.extend(object['Key'] for object in response.get('Contents', ()))
+            contents = response.get('Contents', ())
+            num_keys += len(contents)
+            keys.update(object['Key'] for object in contents)
+            assert len(keys) == num_keys, R('Got duplicate keys from S3')
             token = response.get('NextContinuationToken')
             if token is None:
                 break

@hannes-ucsc hannes-ucsc added the 0 reviews [process] Lead didn't request any changes label May 7, 2025
@hannes-ucsc hannes-ucsc removed their assignment May 7, 2025
@nadove-ucsc nadove-ucsc force-pushed the issues/nadove-ucsc/7069-verify-digest-mirror branch from 7e9ef6f to 3716614 Compare May 7, 2025 20:22
@nadove-ucsc nadove-ucsc force-pushed the issues/nadove-ucsc/7069-verify-digest-mirror branch from 1d26528 to 16a4215 Compare May 7, 2025 20:55
@nadove-ucsc nadove-ucsc requested a review from hannes-ucsc May 7, 2025 21:28
hannes-ucsc
hannes-ucsc previously approved these changes May 7, 2025
@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 python Pull requests that update Python code label May 7, 2025
@achave11-ucsc achave11-ucsc force-pushed the issues/nadove-ucsc/7069-verify-digest-mirror branch from 608521c to a007756 Compare May 7, 2025 23:40
@achave11-ucsc achave11-ucsc added the sandbox [process] Resolution is being verified in sandbox deployment label May 7, 2025
@hannes-ucsc hannes-ucsc removed their assignment May 8, 2025
@achave11-ucsc achave11-ucsc merged commit 6d542eb into develop May 8, 2025
11 checks passed
@achave11-ucsc achave11-ucsc deleted the issues/nadove-ucsc/7069-verify-digest-mirror branch May 8, 2025 03:32
@achave11-ucsc achave11-ucsc removed their assignment May 8, 2025
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 python Pull requests that update Python code reqs [process] PR includes commit requiring ``make requirements`` sandbox [process] Resolution is being verified in sandbox deployment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants