Skip to content

Addons: always sort versions in descending order #11691

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Oct 21, 2024
Merged

Addons: always sort versions in descending order #11691

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1a41a4d
Addons: always sort versions in descending order
stsewd Oct 16, 2024
a087727
Fix tests
stsewd Oct 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 18 additions & 18 deletions readthedocs/projects/tests/test_version_handling.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,12 +40,12 @@ def test_sort_versions_python_packaging(self):
# `latest` and `stable` are at the beginning
"latest",
"2.5.3",
"1.1",
"1.1.0",
"1.1",
Comment on lines -43 to +44
Copy link
Member Author

@stsewd stsewd Oct 16, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

Since 1.1 and 1.1.0 are the same version, it falls back to sort them alphabetically in descending order now.

Copy link
Member

Choose a reason for hiding this comment

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

This should probably be a code comment :)

Copy link
Member Author

Choose a reason for hiding this comment

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

I mean, all tests are like this now.

Copy link
Member

Choose a reason for hiding this comment

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

There is a lot of comments that are incorrect after this change: Invalid versions are at the end sorted alphabetically.

Copy link
Member Author

Choose a reason for hiding this comment

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

They are still sorted alphabetically, but in descending order.

"v1.0",
# Invalid versions are at the end sorted alphabetically.
"another-invalid",
"invalid",
"another-invalid",
]

for slug in slugs:
Expand Down Expand Up @@ -73,13 +73,13 @@ def test_sort_versions_python_packaging_latest_stable_not_at_beginning(self):

expected = [
"2.5.3",
"1.1",
"1.1.0",
"1.1",
"v1.0",
# Invalid versions are at the end sorted alphabetically.
"another-invalid",
"invalid",
"latest",
"invalid",
"another-invalid",
]

for slug in slugs:
Expand Down Expand Up @@ -121,14 +121,14 @@ def test_sort_versions_calver(self):
"2022.01.22",
"2021.01.22",
# invalid ones (alphabetically)
"1.1",
"1.1.0",
"2.5.3",
"2001-02-27",
"2001.02.2",
"2001.16.32",
"another-invalid",
"invalid",
"another-invalid",
"2001.16.32",
"2001.02.2",
"2001-02-27",
"2.5.3",
"1.1.0",
"1.1",
]

for slug in slugs:
Expand Down Expand Up @@ -175,13 +175,13 @@ def test_sort_versions_custom_pattern(self):
"v1.1",
"v1.0",
# invalid ones (alphabetically)
"1.1",
"2.5.3",
"2022.01.22",
"another-invalid",
"invalid",
"v1.1.0",
"v2.3rc1",
"v1.1.0",
"invalid",
"another-invalid",
"2022.01.22",
"2.5.3",
"1.1",
]

for slug in slugs:
Expand Down
7 changes: 4 additions & 3 deletions readthedocs/projects/version_handling.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -187,15 +187,15 @@ def sort_versions_generic(
alphabetically_sorted_version_list = sorted(
version_list,
key=operator.attrgetter("slug"),
reverse=True,
)

initial_versions = []
valid_versions = []
invalid_versions = []
for i, version in enumerate(alphabetically_sorted_version_list):
for version in alphabetically_sorted_version_list:
if latest_stable_at_beginning:
if version.slug in (STABLE, LATEST):
# It relies on the version list sorted alphabetically first ("l" comes first than "s")
initial_versions.append((version, version.slug))
continue

Expand All @@ -215,7 +215,8 @@ def sort_versions_generic(
invalid_versions.append((version, None))

all_versions = (
initial_versions
# It relies on the version list sorted alphabetically first ("l" comes first than "s")
sorted(initial_versions, key=operator.itemgetter(1))
+ sorted(valid_versions, key=operator.itemgetter(1), reverse=True)
+ invalid_versions
)
Expand Down
155 changes: 155 additions & 0 deletions readthedocs/proxito/tests/test_hosting.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,9 @@
from readthedocs.builds.constants import LATEST
from readthedocs.builds.models import Build, Version
from readthedocs.projects.constants import (
ADDONS_FLYOUT_SORTING_ALPHABETICALLY,
ADDONS_FLYOUT_SORTING_CALVER,
ADDONS_FLYOUT_SORTING_PYTHON_PACKAGING,
MULTIPLE_VERSIONS_WITH_TRANSLATIONS,
PRIVATE,
PUBLIC,
Expand Down Expand Up @@ -841,3 +844,155 @@ def test_number_of_queries_url_translations(self):
},
)
assert r.status_code == 200

def test_version_ordering(self):
for slug in ["1.0", "1.2", "1.12", "2.0", "2020.01.05", "a-slug", "z-slug"]:
fixture.get(
Version,
project=self.project,
privacy_level=PUBLIC,
slug=slug,
verbose_name=slug,
built=True,
active=True,
)
self.project.update_stable_version()
self.project.versions.update(
privacy_level=PUBLIC,
built=True,
active=True,
)

kwargs = {
"path": reverse("proxito_readthedocs_docs_addons"),
"data": {
"url": "https://project.dev.readthedocs.io/en/latest/",
"client-version": "0.6.0",
"api-version": "1.0.0",
},
"secure": True,
"headers": {
"host": "project.dev.readthedocs.io",
},
}

# Default ordering (SemVer)
expected = [
"latest",
"stable",
"2020.01.05",
"2.0",
"1.12",
"1.2",
"1.0",
"z-slug",
"a-slug",
]
r = self.client.get(**kwargs)
assert r.status_code == 200
assert [v["slug"] for v in r.json()["versions"]["active"]] == expected

self.project.refresh_from_db()
addons = self.project.addons

# The order of latest and stable doesn't change when using semver.
addons.flyout_sorting_latest_stable_at_beginning = False
addons.save()
r = self.client.get(**kwargs)
assert r.status_code == 200
assert [v["slug"] for v in r.json()["versions"]["active"]] == expected

addons.flyout_sorting = ADDONS_FLYOUT_SORTING_ALPHABETICALLY
addons.flyout_sorting_latest_stable_at_beginning = True
addons.save()
expected = [
"z-slug",
"stable",
"latest",
"a-slug",
"2020.01.05",
"2.0",
"1.2",
"1.12",
"1.0",
]
r = self.client.get(**kwargs)
assert r.status_code == 200
assert [v["slug"] for v in r.json()["versions"]["active"]] == expected

# The order of latest and stable doesn't change when using alphabetical sorting.
addons.flyout_sorting_latest_stable_at_beginning = False
addons.save()
r = self.client.get(**kwargs)
assert r.status_code == 200
assert [v["slug"] for v in r.json()["versions"]["active"]] == expected

addons.flyout_sorting = ADDONS_FLYOUT_SORTING_PYTHON_PACKAGING
addons.flyout_sorting_latest_stable_at_beginning = True
addons.save()
r = self.client.get(**kwargs)
assert r.status_code == 200
expected = [
"latest",
"stable",
"2020.01.05",
"2.0",
"1.12",
"1.2",
"1.0",
"z-slug",
"a-slug",
]
assert [v["slug"] for v in r.json()["versions"]["active"]] == expected

addons.flyout_sorting_latest_stable_at_beginning = False
addons.save()
r = self.client.get(**kwargs)
assert r.status_code == 200
expected = [
"2020.01.05",
"2.0",
"1.12",
"1.2",
"1.0",
"z-slug",
"stable",
"latest",
"a-slug",
]
assert [v["slug"] for v in r.json()["versions"]["active"]] == expected

addons.flyout_sorting = ADDONS_FLYOUT_SORTING_CALVER
addons.flyout_sorting_latest_stable_at_beginning = True
addons.save()
r = self.client.get(**kwargs)
assert r.status_code == 200
expected = [
"latest",
"stable",
"2020.01.05",
"z-slug",
"a-slug",
"2.0",
"1.2",
"1.12",
"1.0",
]
assert [v["slug"] for v in r.json()["versions"]["active"]] == expected

addons.flyout_sorting_latest_stable_at_beginning = False
addons.save()
r = self.client.get(**kwargs)
assert r.status_code == 200
expected = [
"2020.01.05",
"z-slug",
"stable",
"latest",
"a-slug",
"2.0",
"1.2",
"1.12",
"1.0",
]
assert [v["slug"] for v in r.json()["versions"]["active"]] == expected
2 changes: 1 addition & 1 deletion readthedocs/proxito/views/hosting.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -336,7 +336,7 @@ def _v1(self, project, version, build, filename, url, request):
versions_active_built_not_hidden = (
self._get_versions(request, project)
.select_related("project")
.order_by("slug")
.order_by("-slug")
)
sorted_versions_active_built_not_hidden = versions_active_built_not_hidden

Expand Down