Skip to content

Resolver: use new methods to resolve documentation pages #10875

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.

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 3 commits into from
Oct 30, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 3 additions & 3 deletions readthedocs/analytics/models.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
from django.utils.translation import gettext_lazy as _

from readthedocs.builds.models import Version
from readthedocs.core.resolver import resolve, resolve_path
from readthedocs.core.resolver import resolver
from readthedocs.projects.models import Feature, Project


Expand Down Expand Up @@ -132,13 +132,13 @@ def top_viewed_pages(

PageViewResult = namedtuple("PageViewResult", "path, url, count")
result = []
parsed_domain = urlparse(resolve(project))
parsed_domain = urlparse(resolver.get_domain(project))
default_version = project.get_default_version()
for row in queryset:
if not per_version:
# If we aren't groupig by version,
# then always link to the default version.
url_path = resolve_path(
url_path = resolver.resolve_path(
project=project,
version_slug=default_version,
filename=row.path,
Expand Down
9 changes: 4 additions & 5 deletions readthedocs/api/v2/serializers.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@
from rest_framework import serializers

from readthedocs.api.v2.utils import normalize_build_command
from readthedocs.builds.constants import EXTERNAL
from readthedocs.builds.models import Build, BuildCommandResult, Version
from readthedocs.core.resolver import resolver
from readthedocs.oauth.models import RemoteOrganization, RemoteRepository
from readthedocs.projects.models import Domain, Project

Expand Down Expand Up @@ -180,10 +180,9 @@ def get_canonical_url(self, obj):
# relationships already cached from calling
# get_docs_url early when serializing the project.
project = self._get_project_serialized(obj).instance
return project.get_docs_url(
lang_slug=project.language,
version_slug=obj.slug,
external=obj.type == EXTERNAL,
return resolver.resolve_version(
project=project,
version=obj,
)

class Meta(VersionSerializer.Meta):
Expand Down
6 changes: 4 additions & 2 deletions readthedocs/api/v3/serializers.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
from taggit.serializers import TaggitSerializer, TagListSerializerField

from readthedocs.builds.models import Build, Version
from readthedocs.core.resolver import resolver
from readthedocs.core.utils import slugify
from readthedocs.core.utils.extend import SettingsOverrideObject
from readthedocs.oauth.models import RemoteOrganization, RemoteRepository
Expand Down Expand Up @@ -243,8 +244,9 @@ class VersionURLsSerializer(BaseLinksSerializer, serializers.Serializer):
dashboard = VersionDashboardURLsSerializer(source="*")

def get_documentation(self, obj):
return obj.project.get_docs_url(
version_slug=obj.slug,
return resolver.resolve_version(
project=obj.project,
version=obj,
)


Expand Down
9 changes: 3 additions & 6 deletions readthedocs/embed/views.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,7 @@
from readthedocs.api.mixins import CDNCacheTagsMixin, EmbedAPIMixin
from readthedocs.api.v2.permissions import IsAuthorizedToViewVersion
from readthedocs.api.v3.permissions import HasEmbedAPIAccess
from readthedocs.builds.constants import EXTERNAL
from readthedocs.core.resolver import resolve
from readthedocs.core.resolver import resolver
from readthedocs.embed.utils import clean_references, recurse_while_none
from readthedocs.storage import build_media_storage

Expand Down Expand Up @@ -135,12 +134,10 @@ def get(self, request):
def do_embed(*, project, version, doc=None, path=None, section=None, url=None):
"""Get the embed response from a document section."""
if not url:
external = version.type == EXTERNAL
Copy link
Member

Choose a reason for hiding this comment

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

Do we not need this anymore?

Copy link
Member Author

Choose a reason for hiding this comment

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

We get the type of the version from the version object itself

url = resolve(
url = resolver.resolve_version(
project=project,
version_slug=version.slug,
version=version,
filename=path or doc,
external=external,
)

content = None
Expand Down
15 changes: 5 additions & 10 deletions readthedocs/projects/models.py
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
STABLE,
)
from readthedocs.core.history import ExtraHistoricalRecords
from readthedocs.core.resolver import resolve, resolve_domain
from readthedocs.core.resolver import resolve, resolve_domain, resolver
from readthedocs.core.utils import extract_valid_attributes_for_model, slugify
from readthedocs.core.utils.url import unsafe_join_url_path
from readthedocs.domains.querysets import DomainQueryset
Expand Down Expand Up @@ -112,7 +112,7 @@ def save(self, *args, **kwargs):

# HACK
def get_absolute_url(self):
return resolve(self.child)
return resolver.resolve_version(project=self.child)

@cached_property
def subproject_prefix(self):
Expand Down Expand Up @@ -1510,12 +1510,10 @@ class ImportedFile(models.Model):
)

def get_absolute_url(self):
return resolve(
return resolver.resolve_version(
project=self.project,
version_slug=self.version.slug,
version=self.version.slug,
filename=self.path,
# this should always be False because we don't have ImportedFile's for external versions
external=False,
)

def __str__(self):
Expand Down Expand Up @@ -1659,10 +1657,7 @@ def get_payload(self, version, build, event):
protocol = 'http' if settings.DEBUG else 'https'
project_url = f'{protocol}://{settings.PRODUCTION_DOMAIN}{project.get_absolute_url()}'
build_url = f'{protocol}://{settings.PRODUCTION_DOMAIN}{build.get_absolute_url()}'
build_docsurl = project.get_docs_url(
version_slug=version.slug,
external=version.is_external,
)
build_docsurl = resolver.resolve_version(project, version=version)

# Remove timezone and microseconds from the date,
# so it's more readable.
Expand Down
10 changes: 4 additions & 6 deletions readthedocs/projects/views/mixins.py
Original file line number Diff line number Diff line change
@@ -1,17 +1,15 @@
"""Mixin classes for project views."""
from urllib.parse import urlparse

import structlog
from celery import chain
from django.shortcuts import get_object_or_404

import structlog

from readthedocs.core.resolver import resolve, resolve_path
from readthedocs.core.resolver import resolver
from readthedocs.core.utils import prepare_build
from readthedocs.projects.models import Project
from readthedocs.projects.signals import project_import


log = structlog.get_logger(__name__)


Expand Down Expand Up @@ -79,11 +77,11 @@ def _get_subprojects_and_urls(self):
if not subprojects.exists():
return subprojects_and_urls

main_domain = resolve(project)
main_domain = resolver.get_domain(project)
parsed_main_domain = urlparse(main_domain)

for subproject in subprojects:
subproject_path = resolve_path(subproject.child)
subproject_path = resolver.resolve_path(subproject.child)
parsed_subproject_domain = parsed_main_domain._replace(
path=subproject_path,
)
Expand Down
10 changes: 6 additions & 4 deletions readthedocs/projects/views/public.py
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@
from readthedocs.builds.views import BuildTriggerMixin
from readthedocs.core.mixins import CDNCacheControlMixin
from readthedocs.core.permissions import AdminPermission
from readthedocs.core.resolver import resolver
from readthedocs.core.utils.extend import SettingsOverrideObject
from readthedocs.projects.filters import ProjectVersionListFilterSet
from readthedocs.projects.models import Project
Expand Down Expand Up @@ -125,16 +126,17 @@ def get_context_data(self, **kwargs):
if self.request.is_secure():
protocol = "https"

version_slug = project.get_default_version()
default_version_slug = project.get_default_version()
default_version = project.versions.get(slug=default_version_slug)

context["badge_url"] = ProjectBadgeView.get_badge_url(
project.slug,
version_slug,
default_version_slug,
protocol=protocol,
)
context["site_url"] = "{url}?badge={version}".format(
url=project.get_docs_url(version_slug),
version=version_slug,
url=resolver.resolve_version(project, version=default_version),
version=default_version_slug,
)

context["is_project_admin"] = AdminPermission.is_admin(
Expand Down
15 changes: 8 additions & 7 deletions readthedocs/proxito/views/serve.py
Original file line number Diff line number Diff line change
Expand Up @@ -912,14 +912,15 @@ def changefreqs_generator():

if project.translations.exists():
for translation in project.translations.all():
translation_versions = (
Copy link
Member Author

Choose a reason for hiding this comment

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

We were fetching all versions from the translation, when we just need to get a version matching the same slug as the current version.

Version.internal.public(project=translation
).values_list('slug', flat=True)
translated_version = (
Version.internal.public(project=translation)
.filter(slug=version.slug)
.first()
)
if version.slug in translation_versions:
href = project.get_docs_url(
version_slug=version.slug,
lang_slug=translation.language,
if translated_version:
href = resolver.resolve_version(
project=translation,
version=translated_version,
)
element['languages'].append({
'hreflang': hreflang_formatter(translation.language),
Expand Down