Implement Alternate Repository Location for PEP 708 #15716

cofiem · 2024-04-03T13:29:56Z

Adds per-project Alternate Repository Location as per PEP 708.

Implements the UI and database changes.
Includes changes to the html and json APIs.
Includes tests.
The alternate repository location information is on the project settings page.
There is a form to add, and a list to show and delete existing entries.

Notes:

The 'tracks' metadata does not make sense for PyPI, as PyPI does not extend other repositories.

Relates to #15431

Previews:

HTML: curl http://localhost/simple/[project_name]/

<!DOCTYPE html>
<html>
  <head>
    <meta name="pypi:repository-version" content="1.1">
    <meta name="pypi:alternate-locations" content="https://example.org">
    <title>Links for [project_name]</title>
  </head>
...

JSON: curl -H "Accept: application/vnd.pypi.simple.v1+json" http://localhost/simple/[project_name]/

{"alternate-locations":["https://example.org"], ... }

…y-location

…ository-location # Conflicts: # warehouse/packaging/models.py

…ository-location

Fixed rendering for detail.html. Moved api mimetypes to const vars. Check delete confirmation name matches.

ewdurbin · 2024-07-09T22:34:24Z

Hi @cofiem and thank you for your contribution! I'm going to ask @dstufft to take a look as PEP author.

ewdurbin

This is a really strong and comprehensive start, thank you! I left some notes after an initial review.

warehouse/packaging/models.py

warehouse/templates/api/simple/detail.html

warehouse/api/simple.py

cofiem · 2024-07-10T03:02:27Z

Thanks very much for the initial review, @ewdurbin! I'll have a look at the cache keys for the model.

tests/unit/api/test_simple.py

…pository-location' into feature/add-project-alternate-repository-location # Conflicts: # tests/unit/manage/test_views.py

…ository-location # Conflicts: # warehouse/locale/messages.pot

This allows the migrations to run.

…ository-location

dstufft · 2024-08-22T02:18:39Z

Thanks for picking this up by the way! Really jazzed to see it getting worked on.

ewdurbin · 2024-08-22T13:49:56Z

Thanks for reviewing @dstufft! @cofiem, I believe the comments from Donald should address the outstanding open questions.

Once this is updated I think it is ready for final review and merge!

…ository-location # Conflicts: # tests/unit/api/test_simple.py # warehouse/locale/messages.pot

- route_path -> route_url to get full URL rather than path - move self reference to the _simple_detail helper

ewdurbin · 2024-08-23T12:15:11Z

@cofiem thank you! I pushed a commit to fix tests and include the self-reference in JSON API as well.

@dstufft I think this is ready to go, but I am curious if we should always send the self-reference in alternate-repositories value... or only when an alternate has been specified.

cofiem · 2024-08-26T07:47:23Z

@ewdurbin That commit to fix tests and make the JSON & HTML apis match makes sense!

…ation

warehouse/templates/api/simple/detail.html

…ation

ewdurbin · 2024-09-16T18:02:28Z

I'm going to hold off for a couple days, but if I don't hear from @dstufft on the two remaining open questions, I will remove the self-reference in alternate-repositories values and merge. The PEP reads as though they can be implied "When using alternate locations, clients MUST implicitly assume that the url the response was fetched from was included in the list."

…ation

The PEP reads as though they can be implied "When using alternate locations, clients MUST implicitly assume that the url the response was fetched from was included in the list."

PyPI's existing meta elements follow a `pypi:` naming convention. Implementation in pypi/warehouse#15716 will follow this convention.

…ation

ewdurbin · 2024-09-19T13:47:55Z

Added a small callout block that we should remove when PEP 708 provisional acceptance becomes acceptance acceptance.

cofiem · 2024-09-20T23:55:26Z

Excellent, thanks @ewdurbin!

woodruffw · 2024-09-23T15:49:10Z

tests/unit/api/test_simple.py

+def _update_context(context, content_type, renderer_override):
+    if renderer_override != "json" or content_type in [
+        simple.MIME_TEXT_HTML,
+        simple.MIME_PYPI_SIMPLE_V1_HTML,
+    ]:
+        return _valid_simple_detail_context(context)
+    return context


I might be missing something, but I think this helper is currently causing the test_with_files_quarantined_omitted_from_index test to be skipped (since it's an instance method, but it's currently indented into the helper.) I'll send a PR to fix it.

Opened #16777 with the fix.

See pypi#15716 (review) Signed-off-by: William Woodruff <[email protected]>

See #15716 (review) Signed-off-by: William Woodruff <[email protected]>

PyPI implemented alternate location for PEP 708. (pypi/warehouse#15716)

ewdurbin · 2024-09-26T23:46:55Z

warehouse/manage/views/__init__.py

+            description=form.description.data,
+        )
+        self.request.db.add(alt_repo)
+        self.request.db.add(


Ope, totally missed this in review, but this is pretty incorrect and the cause of #12933 (comment)

cofiem added 13 commits April 3, 2024 23:23

initial attempt at adding alternate repository location details

04e9ec1

Merge branch 'pypi:main' into feature/add-project-alternate-repositor…

837e464

…y-location

Merge branch 'refs/heads/main' into feature/add-project-alternate-rep…

401ed2b

…ository-location # Conflicts: # warehouse/packaging/models.py

implement per-project alternate locations metadata

6877707

starting to add tests

81cdf21

Merge branch 'refs/heads/main' into feature/add-project-alternate-rep…

cf94d59

…ository-location

Merge branch 'refs/heads/main' into feature/add-project-alternate-rep…

6759b55

…ository-location

starting to add tests

f21d788

Merge branch 'refs/heads/main' into feature/add-project-alternate-rep…

8d53891

…ository-location

added tests

cc9111b

Fixed rendering for detail.html. Moved api mimetypes to const vars. Check delete confirmation name matches.

updated translations

3517006

satisfy test coverage

5323726

update translations

bfab8e3

cofiem marked this pull request as ready for review June 30, 2024 05:32

cofiem requested a review from a team as a code owner June 30, 2024 05:32

ewdurbin reviewed Jul 9, 2024

View reviewed changes

warehouse/packaging/models.py Show resolved Hide resolved

warehouse/templates/api/simple/detail.html Outdated Show resolved Hide resolved

warehouse/api/simple.py Show resolved Hide resolved

cofiem commented Jul 10, 2024

View reviewed changes

tests/unit/api/test_simple.py Show resolved Hide resolved

cofiem added 8 commits July 13, 2024 11:57

Merge remote-tracking branch 'origin/feature/add-project-alternate-re…

ef9d6db

…pository-location' into feature/add-project-alternate-repository-location # Conflicts: # tests/unit/manage/test_views.py

Merge branch 'refs/heads/main' into feature/add-project-alternate-rep…

987d129

…ository-location # Conflicts: # warehouse/locale/messages.pot

update translations

e6fdd04

register cache and purge keys for AlternateRepository objects

52542f9

change db migration down revision to most recent migration

e52f44e

This allows the migrations to run.

update test after adding alternate repository cache and purge key

69c6362

Merge branch 'refs/heads/main' into feature/add-project-alternate-rep…

95ee51a

…ository-location

Merge branch 'refs/heads/main' into feature/add-project-alternate-rep…

60970a6

…ository-location

Merge branch 'refs/heads/main' into feature/add-project-alternate-rep…

1849468

…ository-location # Conflicts: # tests/unit/api/test_simple.py # warehouse/locale/messages.pot

match functionality between JSON and HTML simple API

64fa33b

- route_path -> route_url to get full URL rather than path - move self reference to the _simple_detail helper

ewdurbin requested a review from dstufft August 23, 2024 12:15

ewdurbin approved these changes Aug 23, 2024

View reviewed changes

Merge branch 'main' into feature/add-project-alternate-repository-loc…

21ddc57

…ation

ewdurbin reviewed Sep 6, 2024

View reviewed changes

warehouse/templates/api/simple/detail.html Show resolved Hide resolved

ewdurbin added 2 commits September 6, 2024 08:50

update migration

724fc0f

Merge branch 'main' into feature/add-project-alternate-repository-loc…

4e9e773

…ation

ewdurbin added 2 commits September 19, 2024 09:09

Merge branch 'main' into feature/add-project-alternate-repository-loc…

3fffca8

…ation

remove self-reference from Simple HTML and JSON

ebe29e8

The PEP reads as though they can be implied "When using alternate locations, clients MUST implicitly assume that the url the response was fetched from was included in the list."

ewdurbin added a commit to ewdurbin/peps that referenced this pull request Sep 19, 2024

PEP 708: update reference to match implementation

303a04f

PyPI's existing meta elements follow a `pypi:` naming convention. Implementation in pypi/warehouse#15716 will follow this convention.

ewdurbin mentioned this pull request Sep 19, 2024

PEP 708: update reference to match implementation python/peps#3977

Open

ewdurbin added 3 commits September 19, 2024 09:38

add a callout in project management settings around Alternate Locations

03c15ce

Merge branch 'main' into feature/add-project-alternate-repository-loc…

68afe18

…ation

translations

d1ac800

ewdurbin merged commit d3ed6e0 into pypi:main Sep 19, 2024
18 checks passed

woodruffw reviewed Sep 23, 2024

View reviewed changes

woodruffw added a commit to trail-of-forks/warehouse that referenced this pull request Sep 23, 2024

test_simple: fix accidentally skipped test

6a9271d

See pypi#15716 (review) Signed-off-by: William Woodruff <[email protected]>

woodruffw mentioned this pull request Sep 23, 2024

test_simple: fix accidentally skipped test #16777

Merged

di pushed a commit that referenced this pull request Sep 23, 2024

test_simple: fix accidentally skipped test (#16777)

0d7cb20

See #15716 (review) Signed-off-by: William Woodruff <[email protected]>

finswimmer added a commit to finswimmer/poetry that referenced this pull request Sep 23, 2024

fix(test): update pypi fixtures

29c14f2

PyPI implemented alternate location for PEP 708. (pypi/warehouse#15716)

finswimmer mentioned this pull request Sep 23, 2024

fix(tests): update PyPI fixtures python-poetry/poetry#9704

Merged

finswimmer added a commit to python-poetry/poetry that referenced this pull request Sep 23, 2024

fix(tests): update PyPI fixtures (#9704)

150ff09

PyPI implemented alternate location for PEP 708. (pypi/warehouse#15716)

di mentioned this pull request Sep 26, 2024

Implement PEP 708 #15431

Closed

ewdurbin reviewed Sep 26, 2024

View reviewed changes

miketheman mentioned this pull request Nov 1, 2024

Add Alternate Repository to Admin UI (PEP 708) #17019

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Implement Alternate Repository Location for PEP 708 #15716

Implement Alternate Repository Location for PEP 708 #15716

cofiem commented Apr 3, 2024 •

edited

Loading

ewdurbin commented Jul 9, 2024

ewdurbin left a comment

cofiem commented Jul 10, 2024

dstufft commented Aug 22, 2024

ewdurbin commented Aug 22, 2024

ewdurbin commented Aug 23, 2024

cofiem commented Aug 26, 2024

ewdurbin commented Sep 16, 2024

ewdurbin commented Sep 19, 2024

cofiem commented Sep 20, 2024

woodruffw Sep 23, 2024

woodruffw Sep 23, 2024

ewdurbin Sep 26, 2024

Implement Alternate Repository Location for PEP 708 #15716

Implement Alternate Repository Location for PEP 708 #15716

Conversation

cofiem commented Apr 3, 2024 • edited Loading

ewdurbin commented Jul 9, 2024

ewdurbin left a comment

Choose a reason for hiding this comment

cofiem commented Jul 10, 2024

dstufft commented Aug 22, 2024

ewdurbin commented Aug 22, 2024

ewdurbin commented Aug 23, 2024

cofiem commented Aug 26, 2024

ewdurbin commented Sep 16, 2024

ewdurbin commented Sep 19, 2024

cofiem commented Sep 20, 2024

woodruffw Sep 23, 2024

Choose a reason for hiding this comment

woodruffw Sep 23, 2024

Choose a reason for hiding this comment

ewdurbin Sep 26, 2024

Choose a reason for hiding this comment

cofiem commented Apr 3, 2024 •

edited

Loading