Use a SQLAlchemy event

Author: DarkaMaul

tests/unit/packaging/test_views.py

@@ -191,53 +191,51 @@ def test_normalizing_version_redirects(self, db_request):
     def test_detail_rendered(self, db_request):
         users = [UserFactory.create(), UserFactory.create(), UserFactory.create()]
         project = ProjectFactory.create()
-        releases = (
-            [
-                ReleaseFactory.create(
-                    project=project,
-                    version=v,
-                    description=DescriptionFactory.create(
-                        raw="unrendered description",
-                        html="rendered description",
-                        content_type="text/html",
-                    ),
-                )
-                for v in ["1.0", "2.0", "3.0", "4.0.dev0"]
-            ]
-            + [
-                ReleaseFactory.create(
-                    project=project,
-                    version="5.0",
-                    description=DescriptionFactory.create(
-                        raw="plaintext description",
-                        html="",
-                        content_type="text/plain",
-                    ),
-                    yanked=True,
-                    yanked_reason="plaintext yanked reason",
-                )
-            ]
-            + [
-                ReleaseFactory.create(
-                    project=project,
-                    version="5.1",
-                    description=DescriptionFactory.create(
-                        raw="unrendered description",
-                        html="rendered description",
-                        content_type="text/html",
-                    ),
-                    published=False,
-                )
-            ]
+        releases = [
+            ReleaseFactory.create(
+                project=project,
+                version=v,
+                description=DescriptionFactory.create(
+                    raw="unrendered description",
+                    html="rendered description",
+                    content_type="text/html",
+                ),
+            )
+            for v in ["1.0", "2.0", "3.0", "4.0.dev0"]
+        ] + [
+            ReleaseFactory.create(
+                project=project,
+                version="5.0",
+                description=DescriptionFactory.create(
+                    raw="plaintext description",
+                    html="",
+                    content_type="text/plain",
+                ),
+                yanked=True,
+                yanked_reason="plaintext yanked reason",
+            )
+        ]
+
+        # Add an unpublished version
+        staged_release = ReleaseFactory.create(
+            project=project,
+            version="5.1",
+            description=DescriptionFactory.create(
+                raw="unrendered description",
+                html="rendered description",
+                content_type="text/html",
+            ),
+            published=False,
         )
+
         files = [
             FileFactory.create(
                 release=r,
                 filename=f"{project.name}-{r.version}.tar.gz",
                 python_version="source",
                 packagetype="sdist",
             )
-            for r in releases
+            for r in releases + [staged_release]
         ]
 
         # Create a role for each user

warehouse/legacy/api/json.py

@@ -64,7 +64,6 @@ def _json_data(request, project, release, *, all_releases):
         .outerjoin(File)
         .filter(
             Release.project == project,
-            Release.published.is_(True),
         )
     )
 
@@ -210,7 +209,6 @@ def latest_release_factory(request):
                 Project.lifecycle_status.is_distinct_from(
                     LifecycleStatus.QuarantineEnter
                 ),
-                Release.published.is_(True),
             )
             .order_by(
                 Release.yanked.asc(),

warehouse/locale/messages.pot

@@ -776,7 +776,7 @@ msgstr ""
 msgid "Provide an Inspector link to specific lines of code."
 msgstr ""
 
-#: warehouse/packaging/views.py:355
+#: warehouse/packaging/views.py:352
 msgid "Your report has been recorded. Thank you for your help."
 msgstr ""
 

warehouse/packaging/models.py

@@ -52,10 +52,12 @@
 from sqlalchemy.ext.hybrid import hybrid_property
 from sqlalchemy.orm import (
     Mapped,
+    ORMExecuteState,
     attribute_keyed_dict,
     declared_attr,
     mapped_column,
     validates,
+    with_loader_criteria,
 )
 from urllib3.exceptions import LocationParseError
 from urllib3.util import parse_url
@@ -469,7 +471,6 @@ def latest_version(self):
             .filter(
                 Release.project == self,
                 Release.yanked.is_(False),
-                Release.published.is_(True),
             )
             .order_by(Release.is_prerelease.nullslast(), Release._pypi_ordering.desc())
             .first()
@@ -628,7 +629,7 @@ def __table_args__(cls):  # noqa
     _pypi_ordering: Mapped[int | None]
     requires_python: Mapped[str | None] = mapped_column(Text)
     created: Mapped[datetime_now] = mapped_column()
-    published: Mapped[bool_true]
+    published: Mapped[bool_true] = mapped_column()
 
     description_id: Mapped[UUID] = mapped_column(
         ForeignKey("release_descriptions.id", onupdate="CASCADE", ondelete="CASCADE"),
@@ -1046,6 +1047,21 @@ def ensure_monotonic_journals(config, session, flush_context, instances):
             return
 
 
+@db.listens_for(db.Session, "do_orm_execute")
+def filter_staged_release(config, state: ORMExecuteState):
+    if (
+        state.is_select
+        and not state.is_column_load
+        and not state.is_relationship_load
+        and not state.statement.get_execution_options().get("include_staged", False)
+    ):
+        state.statement = state.statement.options(
+            with_loader_criteria(
+                Release, lambda cls: cls.published, include_aliases=True
+            )
+        )
+
+
 class ProhibitedProjectName(db.Model):
     __tablename__ = "prohibited_project_names"
     __table_args__ = (

warehouse/packaging/utils.py

@@ -57,7 +57,6 @@ def _simple_detail(project, request):
         .join(Project)
         .filter(
             Project.lifecycle_status.is_distinct_from(LifecycleStatus.QuarantineEnter),
-            Release.published.is_(True),
         )
         .all(),
         key=lambda f: (packaging_legacy.version.parse(f.release.version), f.filename),

warehouse/packaging/views.py

@@ -179,10 +179,7 @@ def project_detail(project, request):
     try:
         release = (
             request.db.query(Release)
-            .filter(
-                Release.project == project,
-                Release.published.is_(True),
-            )
+            .filter(Release.project == project)
             .order_by(
                 Release.yanked,
                 Release.is_prerelease.nullslast(),

warehouse/search/tasks.py

@@ -42,9 +42,7 @@
 def _project_docs(db, project_name=None):
     releases_list = (
         select(Release.id)
-        .filter(
-          Release.yanked.is_(False), Release.published.is_(True), Release.files.any()
-        )
+        .filter(Release.yanked.is_(False), Release.files.any())
         .order_by(
             Release.project_id,
             Release.is_prerelease.nullslast(),