Implement Alternate Repository Location for PEP 708 #15716
Conversation
…ository-location # Conflicts: # warehouse/packaging/models.py
Fixed rendering for detail.html. Moved api mimetypes to const vars. Check delete confirmation name matches.
| @@ -943,3 +948,34 @@ class ProjectMacaroonWarningAssociation(db.Model): | |||
| ForeignKey("projects.id", onupdate="CASCADE", ondelete="CASCADE"), | |||
| primary_key=True, | |||
| ) | |||
|
|
|||
|
|
|||
| class AlternateRepository(db.Model): | |||
There was a problem hiding this comment.
I think we are going to need to register a cache/purge keys for this model similar to "Release" to ensure that when AlternateRepository objects are created/destroyed we purge the relevant pages.
Our cache keys are registered here.
And my best guess is that we need to add
config.register_origin_cache_keys(
AlternateRepository,
cache_keys=["project/{obj.project.normalized_name}"],
purge_keys=[
key_factory("project/{obj.project.normalized_name}"),
],
)To ensure that the simple index for the project is purged on update, to pick up the new metadata for display.
| @@ -15,6 +15,10 @@ | |||
| <html> | |||
| <head> | |||
| <meta name="pypi:repository-version" content="{{ meta['api-version'] }}"> | |||
| {# <meta name="pypi:alternate-locations" content="{{ request.route_path('api.simple.detail', name=name|canonicalize_name) }}">#} | |||
There was a problem hiding this comment.
In the PEP, I wasn't sure if the part about "... clients MUST implicitly assume that the url the response was fetched from was included in the list..." meant that the url of PyPI should be in the list presented to clients or not. If the url the client used, and the url rendered by PyPI differ, that might be a problem? Likely a question for @dstufft .
| from warehouse.utils.cors import _CORS_HEADERS | ||
|
|
||
| MIME_TEXT_HTML = "text/html" |
There was a problem hiding this comment.
We now have a constants module. Since these constants are not used elsewhere, I think we're fine to leave them in warehouse.api.simple, but thought I'd flag it if we are using them anywhere else.
|
Thanks very much for the initial review, @ewdurbin! I'll have a look at the cache keys for the model. |
| @@ -18,10 +18,11 @@ | |||
| from pyramid.testing import DummyRequest | |||
|
|
|||
| from warehouse.api import simple | |||
| from warehouse.packaging.utils import API_VERSION | |||
| from warehouse.packaging.utils import API_VERSION, _valid_simple_detail_context | |||
There was a problem hiding this comment.
I haven't changed the API_VERSION to 1.2, as I wasn't sure if or how PyPI presents different versions of APIs?
Adds per-project Alternate Repository Location as per PEP 708.
Notes:
Relates to #15431
Previews:
HTML:
curl http://localhost/simple/[project_name]/JSON:
curl -H "Accept: application/vnd.pypi.simple.v1+json" http://localhost/simple/[project_name]/{"alternate-locations":["https://example.org"], ... }