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

Eliminate RepositoryPlugin.list_partitions (#6531) #6554

Merged

Conversation

nadove-ucsc
Copy link
Contributor

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

Connected issues: #6531

Note: this is to be promoted separately.

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
  • Performed equivalent reindex on develop to serve as a baseline (dev Job 100952, anvildev Job 48695)
  • 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 https://gitlab.anvil.gi.ucsc.edu/ucsc/azul/-/jobs/48994
  • 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 (Job 101121)
  • Started reindex in anvildev or this PR does not require reindexing anvildev (Job 48855)
  • 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

@nadove-ucsc nadove-ucsc added the upgrade [process] PR includes commit requiring manual upgrade label Sep 10, 2024
@github-actions github-actions bot added the orange [process] Done by the Azul team label Sep 10, 2024
@@ -143,7 +138,7 @@
# https://github.com/DataBiosphere/azul/issues/2621
es_type = 'keyword'

def to_index(self, value_unit: Optional[JSON]) -> str:
def to_index(self, value_unit: JSON | None) -> str:

Check notice

Code scanning / CodeQL

Explicit returns mixed with implicit (fall through) returns Note

Mixing implicit and explicit returns may indicate an error as implicit returns always return None.
@nadove-ucsc nadove-ucsc force-pushed the issues/nadove-ucsc/6531-eliminate-list-partitions branch from 850ebdb to e125c68 Compare September 10, 2024 04:46
Copy link

codecov bot commented Sep 10, 2024

Codecov Report

Attention: Patch coverage is 83.42541% with 30 lines in your changes missing coverage. Please review.

Project coverage is 85.46%. Comparing base (319995f) to head (77afdb0).
Report is 14 commits behind head on develop.

Files with missing lines Patch % Lines
src/azul/plugins/__init__.py 74.46% 12 Missing ⚠️
test/integration_test.py 0.00% 12 Missing ⚠️
src/azul/plugins/repository/canned/__init__.py 81.81% 2 Missing ⚠️
src/azul/plugins/repository/tdr_anvil/__init__.py 60.00% 2 Missing ⚠️
src/azul/plugins/repository/dss/__init__.py 88.88% 1 Missing ⚠️
src/azul/plugins/repository/tdr_hca/__init__.py 75.00% 1 Missing ⚠️
Additional details and impacted files
@@             Coverage Diff             @@
##           develop    #6554      +/-   ##
===========================================
+ Coverage    85.38%   85.46%   +0.08%     
===========================================
  Files          155      155              
  Lines        20754    20740      -14     
===========================================
+ Hits         17720    17726       +6     
+ Misses        3034     3014      -20     
Flag Coverage Δ
85.46% <83.42%> (+0.08%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

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

@coveralls
Copy link

coveralls commented Sep 10, 2024

Coverage Status

coverage: 85.484% (+0.09%) from 85.398%
when pulling 77afdb0 on issues/nadove-ucsc/6531-eliminate-list-partitions
into 319995f on develop.

@nadove-ucsc nadove-ucsc force-pushed the issues/nadove-ucsc/6531-eliminate-list-partitions branch 7 times, most recently from a8dae53 to 7f8360f Compare September 13, 2024 07:44
@@ -397,14 +392,14 @@ def __init__(self, id: str, title: str, category: SubmitterCategory):
self.by_id[id] = self

@classmethod
def for_id(cls, submitter_id: str) -> Optional['Submitter']:
def for_id(cls, submitter_id: str) -> 'Submitter | None':
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
def for_id(cls, submitter_id: str) -> 'Submitter | None':
def for_id(cls, submitter_id: str) -> Self | None:

try:
return cls.by_id[submitter_id]
except KeyError:
return None

@classmethod
def for_file(cls, file: api.File) -> Optional['Submitter']:
def for_file(cls, file: api.File) -> 'Submitter | None':
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
def for_file(cls, file: api.File) -> 'Submitter | None':
def for_file(cls, file: api.File) -> Self | None:

mksrc('bigquery', 'datarepo-dev-2a4ab485', 'hca_dev_d2111fac3fc44f429b6d32cd6a828267__20210830_20230215'),
mksrc('bigquery', 'datarepo-dev-1005632d', 'hca_dev_d3ac7c1b53024804b611dad9f89c049d__20210827_20230215'),
mksrc('bigquery', 'datarepo-dev-8709b362', 'hca_dev_df88f39f01a84b5b92f43177d6c0f242__20210827_20230215'),
mksrc('bigquery', 'datarepo-dev-e1712bfa', 'hca_dev_e526d91dcf3a44cb80c5fd7676b55a1d__20210902_20230215'),
]))

lungmap_sources = mkdict({}, 2, mkdelta([
Copy link
Contributor

@dsotirho-ucsc dsotirho-ucsc Sep 13, 2024

Choose a reason for hiding this comment

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

The old subgraphs argument 1 needs to be removed from the lungmap_sources sources.

@dsotirho-ucsc dsotirho-ucsc removed their assignment Sep 13, 2024
@nadove-ucsc nadove-ucsc force-pushed the issues/nadove-ucsc/6531-eliminate-list-partitions branch 2 times, most recently from ecc64da to 1c36709 Compare September 17, 2024 22:26
@nadove-ucsc nadove-ucsc added reindex:dev [process] PR requires reindexing dev reindex:anvildev [process] PR requires reindexing anvildev reindex:anvilprod [process] PR requires reindexing anvilprod reindex:prod [process] PR requires reindexing prod labels Sep 17, 2024
@nadove-ucsc nadove-ucsc force-pushed the issues/nadove-ucsc/6531-eliminate-list-partitions branch 3 times, most recently from a6390ce to da3b971 Compare September 18, 2024 00:34

return source, partition_prefix, fqids

def _list_bundles(self,
Copy link
Contributor

Choose a reason for hiding this comment

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

A comment in _prepare_notifications() that references _list_bundles() needs to be updated.

@dsotirho-ucsc dsotirho-ucsc removed their assignment Sep 18, 2024
@achave11-ucsc
Copy link
Member

achave11-ucsc commented Sep 27, 2024

Assigned @dsotirho-ucsc for a second approval on this PR, as prescribed in Slack.

Copy link
Contributor

@dsotirho-ucsc dsotirho-ucsc left a comment

Choose a reason for hiding this comment

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

Nit:

  • typing.Self could be applied in other locations inside /src/azul/indexer/__init__.py such as SimpleSourceSpec.parse, SourceRef.from_json, SourcedBundleFQID.from_json, and Bundle.from_json.

@dsotirho-ucsc dsotirho-ucsc removed their assignment Sep 27, 2024
@nadove-ucsc
Copy link
Contributor Author

As discussed at PL, I'm choosing not to incorporate every potential use of typing.Self in this PR to avoid modifying a large number of unrelated files.

Copy link
Contributor

@dsotirho-ucsc dsotirho-ucsc left a comment

Choose a reason for hiding this comment

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

Approved.

@nadove-ucsc nadove-ucsc requested review from hannes-ucsc and removed request for hannes-ucsc September 27, 2024 23:17
@nadove-ucsc nadove-ucsc dismissed hannes-ucsc’s stale review September 27, 2024 23:21

Hannes agreed at PL this morning that we could merge the PR in his absence. The changes he requested in his latest review have been addressed verbatim.

@nadove-ucsc
Copy link
Contributor Author

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

@dsotirho-ucsc dsotirho-ucsc added the sandbox [process] Resolution is being verified in sandbox deployment label Sep 27, 2024
@dsotirho-ucsc dsotirho-ucsc merged commit 9cc41a5 into develop Sep 28, 2024
11 checks passed
@achave11-ucsc achave11-ucsc deleted the issues/nadove-ucsc/6531-eliminate-list-partitions branch October 1, 2024 04:02
@achave11-ucsc
Copy link
Member

Removing do not promote label, since it's no longer appropriate.

@achave11-ucsc achave11-ucsc removed the do not promote [process] Do not promote to prod label Oct 2, 2024
@achave11-ucsc achave11-ucsc removed their assignment Oct 2, 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 upgrade [process] PR includes commit requiring manual upgrade
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants