Add support for PEP 700 (#12727)

di · dstufft · web-flow · commit 80d136a07591 · 2023-02-25T14:04:49.000-05:00
* Change API version to 1.1

* Fix flaky test

* Add versions field

* Add file size field

* Add file upload-time field

---------

Co-authored-by: Donald Stufft &lt;donald@stufft.io&gt;
diff --git a/tests/common/db/packaging.py b/tests/common/db/packaging.py
@@ -111,6 +111,7 @@ class Meta:
             ]
         )
     )
+    size = factory.Faker("pyint")
 
 
 class RoleFactory(WarehouseFactory):
diff --git a/tests/unit/api/test_simple.py b/tests/unit/api/test_simple.py
@@ -13,10 +13,12 @@
 import pretend
 import pytest
 
+from packaging.version import parse
 from pyramid.httpexceptions import HTTPMovedPermanently
 from pyramid.testing import DummyRequest
 
 from warehouse.api import simple
+from warehouse.packaging.utils import API_VERSION
 
 from ...common.db.accounts import UserFactory
 from ...common.db.packaging import (
@@ -81,7 +83,7 @@ class TestSimpleIndex:
     def test_no_results_no_serial(self, db_request, content_type, renderer_override):
         db_request.accept = content_type
         assert simple.simple_index(db_request) == {
-            "meta": {"_last-serial": 0, "api-version": "1.0"},
+            "meta": {"_last-serial": 0, "api-version": API_VERSION},
             "projects": [],
         }
         assert db_request.response.headers["X-PyPI-Last-Serial"] == "0"
@@ -99,7 +101,7 @@ def test_no_results_with_serial(self, db_request, content_type, renderer_overrid
         user = UserFactory.create()
         je = JournalEntryFactory.create(submitted_by=user)
         assert simple.simple_index(db_request) == {
-            "meta": {"_last-serial": je.id, "api-version": "1.0"},
+            "meta": {"_last-serial": je.id, "api-version": API_VERSION},
             "projects": [],
         }
         assert db_request.response.headers["X-PyPI-Last-Serial"] == str(je.id)
@@ -119,7 +121,7 @@ def test_with_results_no_serial(self, db_request, content_type, renderer_overrid
             for x in [ProjectFactory.create() for _ in range(3)]
         ]
         assert simple.simple_index(db_request) == {
-            "meta": {"_last-serial": 0, "api-version": "1.0"},
+            "meta": {"_last-serial": 0, "api-version": API_VERSION},
             "projects": [
                 {"name": x[0], "_last-serial": 0}
                 for x in sorted(projects, key=lambda x: x[1])
@@ -147,7 +149,7 @@ def test_with_results_with_serial(
         je = JournalEntryFactory.create(submitted_by=user)
 
         assert simple.simple_index(db_request) == {
-            "meta": {"_last-serial": je.id, "api-version": "1.0"},
+            "meta": {"_last-serial": je.id, "api-version": API_VERSION},
             "projects": [
                 {"name": x[0], "_last-serial": 0}
                 for x in sorted(projects, key=lambda x: x[1])
@@ -187,9 +189,10 @@ def test_no_files_no_serial(self, db_request, content_type, renderer_override):
         JournalEntryFactory.create(submitted_by=user)
 
         assert simple.simple_detail(project, db_request) == {
-            "meta": {"_last-serial": 0, "api-version": "1.0"},
+            "meta": {"_last-serial": 0, "api-version": API_VERSION},
             "name": project.normalized_name,
             "files": [],
+            "versions": [],
         }
 
         assert db_request.response.headers["X-PyPI-Last-Serial"] == "0"
@@ -210,9 +213,10 @@ def test_no_files_with_serial(self, db_request, content_type, renderer_override)
         je = JournalEntryFactory.create(name=project.name, submitted_by=user)
 
         assert simple.simple_detail(project, db_request) == {
-            "meta": {"_last-serial": je.id, "api-version": "1.0"},
+            "meta": {"_last-serial": je.id, "api-version": API_VERSION},
             "name": project.normalized_name,
             "files": [],
+            "versions": [],
         }
 
         assert db_request.response.headers["X-PyPI-Last-Serial"] == str(je.id)
@@ -229,6 +233,7 @@ def test_with_files_no_serial(self, db_request, content_type, renderer_override)
         db_request.accept = content_type
         project = ProjectFactory.create()
         releases = [ReleaseFactory.create(project=project) for _ in range(3)]
+        release_versions = sorted([r.version for r in releases], key=parse)
         files = [
             FileFactory.create(release=r, filename=f"{project.name}-{r.version}.tar.gz")
             for r in releases
@@ -242,15 +247,18 @@ def test_with_files_no_serial(self, db_request, content_type, renderer_override)
         JournalEntryFactory.create(submitted_by=user)
 
         assert simple.simple_detail(project, db_request) == {
-            "meta": {"_last-serial": 0, "api-version": "1.0"},
+            "meta": {"_last-serial": 0, "api-version": API_VERSION},
             "name": project.normalized_name,
+            "versions": release_versions,
             "files": [
                 {
                     "filename": f.filename,
                     "url": f"/file/{f.filename}",
                     "hashes": {"sha256": f.sha256_digest},
                     "requires-python": f.requires_python,
                     "yanked": False,
+                    "size": f.size,
+                    "upload-time": f.upload_time.isoformat() + "Z",
                 }
                 for f in files
             ],
@@ -270,28 +278,32 @@ def test_with_files_with_serial(self, db_request, content_type, renderer_overrid
         db_request.accept = content_type
         project = ProjectFactory.create()
         releases = [ReleaseFactory.create(project=project) for _ in range(3)]
+        release_versions = sorted([r.version for r in releases], key=parse)
         files = [
             FileFactory.create(release=r, filename=f"{project.name}-{r.version}.tar.gz")
             for r in releases
         ]
-        # let's assert the result is ordered by string comparison of filename
-        files = sorted(files, key=lambda key: key.filename)
+        # let's assert the result is ordered by version and filename
+        files = sorted(files, key=lambda f: (parse(f.release.version), f.filename))
         urls_iter = (f"/file/{f.filename}" for f in files)
         db_request.matchdict["name"] = project.normalized_name
         db_request.route_url = lambda *a, **kw: next(urls_iter)
         user = UserFactory.create()
         je = JournalEntryFactory.create(name=project.name, submitted_by=user)
 
         assert simple.simple_detail(project, db_request) == {
-            "meta": {"_last-serial": je.id, "api-version": "1.0"},
+            "meta": {"_last-serial": je.id, "api-version": API_VERSION},
             "name": project.normalized_name,
+            "versions": release_versions,
             "files": [
                 {
                     "filename": f.filename,
                     "url": f"/file/{f.filename}",
                     "hashes": {"sha256": f.sha256_digest},
                     "requires-python": f.requires_python,
                     "yanked": False,
+                    "size": f.size,
+                    "upload-time": f.upload_time.isoformat() + "Z",
                 }
                 for f in files
             ],
@@ -361,15 +373,18 @@ def test_with_files_with_version_multi_digit(
         je = JournalEntryFactory.create(name=project.name, submitted_by=user)
 
         assert simple.simple_detail(project, db_request) == {
-            "meta": {"_last-serial": je.id, "api-version": "1.0"},
+            "meta": {"_last-serial": je.id, "api-version": API_VERSION},
             "name": project.normalized_name,
+            "versions": release_versions,
             "files": [
                 {
                     "filename": f.filename,
                     "url": f"/file/{f.filename}",
                     "hashes": {"sha256": f.sha256_digest},
                     "requires-python": f.requires_python,
                     "yanked": False,
+                    "size": f.size,
+                    "upload-time": f.upload_time.isoformat() + "Z",
                 }
                 for f in files
             ],
diff --git a/warehouse/packaging/utils.py b/warehouse/packaging/utils.py
@@ -21,7 +21,7 @@
 from warehouse.packaging.interfaces import ISimpleStorage
 from warehouse.packaging.models import File, Project, Release
 
-API_VERSION = "1.0"
+API_VERSION = "1.1"
 
 
 def _simple_index(request, serial):
@@ -48,10 +48,12 @@ def _simple_detail(project, request):
         .all(),
         key=lambda f: (parse(f.release.version), f.filename),
     )
+    versions = sorted({f.release.version for f in files}, key=parse)
 
     return {
         "meta": {"api-version": API_VERSION, "_last-serial": project.last_serial},
         "name": project.normalized_name,
+        "versions": versions,
         "files": [
             {
                 "filename": file.filename,
@@ -60,6 +62,8 @@ def _simple_detail(project, request):
                     "sha256": file.sha256_digest,
                 },
                 "requires-python": file.release.requires_python,
+                "size": file.size,
+                "upload-time": file.upload_time.isoformat() + "Z",
                 "yanked": file.release.yanked_reason
                 if file.release.yanked and file.release.yanked_reason
                 else file.release.yanked,

Original file line number	Diff line number	Diff line change
`@@ -111,6 +111,7 @@ class Meta:`
`111`	`111`	`]`
`112`	`112`	`)`
`113`	`113`	`)`
	`114`	`+ size = factory.Faker("pyint")`
`114`	`115`
`115`	`116`
`116`	`117`	`class RoleFactory(WarehouseFactory):`