Merge tag '8.7.0' into rel

Author: humitos

CHANGELOG.rst

@@ -1,3 +1,22 @@
+Version 8.7.0
+-------------
+
+:Date: October 11, 2022
+
+* `@github-actions[bot] <https://github.com/github-actions[bot]>`__: Dependencies: all packages updated via pip-tools (`#9648 <https://github.com/readthedocs/readthedocs.org/pull/9648>`__)
+* `@humitos <https://github.com/humitos>`__: Settings: enable `django-debug-toolbar` when Django Admin is enabled (`#9641 <https://github.com/readthedocs/readthedocs.org/pull/9641>`__)
+* `@stsewd <https://github.com/stsewd>`__: Subscriptions: use stripe price instead of relying on plan object (`#9640 <https://github.com/readthedocs/readthedocs.org/pull/9640>`__)
+* `@github-actions[bot] <https://github.com/github-actions[bot]>`__: Dependencies: all packages updated via pip-tools (`#9636 <https://github.com/readthedocs/readthedocs.org/pull/9636>`__)
+* `@humitos <https://github.com/humitos>`__: Query: minor improvement (`#9634 <https://github.com/readthedocs/readthedocs.org/pull/9634>`__)
+* `@ericholscher <https://github.com/ericholscher>`__: Release 8.6.0 (`#9630 <https://github.com/readthedocs/readthedocs.org/pull/9630>`__)
+* `@humitos <https://github.com/humitos>`__: Run django-upgrade (`#9628 <https://github.com/readthedocs/readthedocs.org/pull/9628>`__)
+* `@stsewd <https://github.com/stsewd>`__: Search: refactor serializer's context (`#9624 <https://github.com/readthedocs/readthedocs.org/pull/9624>`__)
+* `@benjaoming <https://github.com/benjaoming>`__: Docs: Re-scope Intersphinx article as a how-to (`#9622 <https://github.com/readthedocs/readthedocs.org/pull/9622>`__)
+* `@evildmp <https://github.com/evildmp>`__: Made some small changes to the MyST migration how-to (`#9620 <https://github.com/readthedocs/readthedocs.org/pull/9620>`__)
+* `@stsewd <https://github.com/stsewd>`__: Search: move api.py into a module (`#9616 <https://github.com/readthedocs/readthedocs.org/pull/9616>`__)
+* `@humitos <https://github.com/humitos>`__: Build: remove `DEDUPLICATE_BUILDS` feature (`#9591 <https://github.com/readthedocs/readthedocs.org/pull/9591>`__)
+* `@stsewd <https://github.com/stsewd>`__: Email: render template before sending it to the task (`#9538 <https://github.com/readthedocs/readthedocs.org/pull/9538>`__)
+
 Version 8.6.0
 -------------
 

dockerfiles/settings/proxito.py

@@ -6,9 +6,11 @@
 class ProxitoDevSettings(CommunityProxitoSettingsMixin, DockerBaseSettings):
 
     # El Proxito does not have django-debug-toolbar installed
-    DEBUG_TOOLBAR_CONFIG = {
-        'SHOW_TOOLBAR_CALLBACK': lambda request: False,
-    }
+    @property
+    def DEBUG_TOOLBAR_CONFIG(self):
+        return {
+            'SHOW_TOOLBAR_CALLBACK': lambda request: False,
+        }
 
 
 ProxitoDevSettings.load_settings(__name__)

docs/conf.py

@@ -69,7 +69,7 @@
 
 master_doc = "index"
 copyright = "2010, Read the Docs, Inc & contributors"
-version = "8.6.0"
+version = "8.7.0"
 release = version
 exclude_patterns = ["_build"]
 default_role = "obj"

docs/user/guides/authors.rst

@@ -14,6 +14,6 @@ and :doc:`/intro/getting-started-with-mkdocs`.
    :maxdepth: 1
 
    cross-referencing-with-sphinx
-   intersphinx
+   Link to external projects (Intersphinx) <intersphinx>
    jupyter
    Migrate from rST to MyST <migrate-rest-myst>

docs/user/guides/intersphinx.rst

@@ -1,5 +1,7 @@
-Link to Other Projects' Documentation With Intersphinx
-======================================================
+How to Link to Other Documentation Projects With Intersphinx
+============================================================
+
+This section shows you how to maintain references to named sections of other external Sphinx projects.
 
 You may be familiar with using the :ref:`:ref: role <sphinx:ref-role>` to
 :doc:`link to any location of your docs </guides/cross-referencing-with-sphinx>`.

package.json

@@ -1,6 +1,6 @@
 {
   "name": "readthedocs",
-  "version": "8.6.0",
+  "version": "8.7.0",
   "description": "Read the Docs build dependencies",
   "author": "Read the Docs, Inc <[email protected]>",
   "scripts": {

readthedocs/__init__.py

@@ -1,4 +1,4 @@
 """Read the Docs."""
 
 
-__version__ = "8.6.0"
+__version__ = "8.7.0"

readthedocs/analytics/tests.py

@@ -88,9 +88,9 @@ def test_get_client_ip_with_x_forwarded_for(self):
 
     def test_get_client_ip_with_remote_addr(self):
 
-        request = RequestFactory().get('/')
-        self.assertIsNone(request.META.get('HTTP_X_FORWARDED_FOR'))
-        request.META['REMOTE_ADDR'] = '203.0.113.195'
+        request = RequestFactory().get("/")
+        self.assertIsNone(request.headers.get("X-Forwarded-For"))
+        request.META["REMOTE_ADDR"] = "203.0.113.195"
         client_ip = get_client_ip(request)
         self.assertEqual(client_ip, '203.0.113.195')
 

readthedocs/analytics/utils.py

@@ -1,18 +1,16 @@
-# -*- coding: utf-8 -*-
 
 """Utilities related to analytics."""
 
 import hashlib
 import ipaddress
-import structlog
 
 import requests
+import structlog
 from django.conf import settings
 from django.utils.crypto import get_random_string
 from django.utils.encoding import force_bytes, force_str
 from user_agents import parse
 
-
 log = structlog.get_logger(__name__)  # noqa
 
 
@@ -24,7 +22,7 @@ def get_client_ip(request):
     header. If ``HTTP_X_FORWARDED_FOR`` is not found, it returns the value of
     ``REMOTE_ADDR`` header and returns ``None`` if both the headers are not found.
     """
-    x_forwarded_for = request.META.get('HTTP_X_FORWARDED_FOR', None)
+    x_forwarded_for = request.headers.get("X-Forwarded-For", None)
     if x_forwarded_for:
         # HTTP_X_FORWARDED_FOR can be a comma-separated list of IPs.
         # The client's IP will be the first one.
@@ -114,6 +112,6 @@ def generate_client_id(ip_address, user_agent):
         # Since no IP and no UA were specified,
         # there's no way to distinguish sessions.
         # Instead, just treat every user differently
-        hash_id.update(force_bytes(get_random_string()))
+        hash_id.update(force_bytes(get_random_string(length=12)))
 
     return hash_id.hexdigest()

readthedocs/api/v2/proxied_urls.py

@@ -9,7 +9,7 @@
 
 from readthedocs.analytics.proxied_api import AnalyticsView
 from readthedocs.api.v2.views.proxied import ProxiedEmbedAPI, ProxiedFooterHTML
-from readthedocs.search.proxied_api import ProxiedPageSearchAPIView
+from readthedocs.search.api.v2.views import ProxiedPageSearchAPIView
 
 api_footer_urls = [
     re_path(r'footer_html/', ProxiedFooterHTML.as_view(), name='footer_html'),

readthedocs/api/v2/urls.py

@@ -1,15 +1,11 @@
 """Define routes between URL paths and views/endpoints."""
 
 from django.conf import settings
-from django.conf.urls import include, re_path
+from django.conf.urls import re_path
+from django.urls import include
 from rest_framework import routers
 
-from readthedocs.api.v2.views import (
-    core_views,
-    footer_views,
-    integrations,
-    task_views,
-)
+from readthedocs.api.v2.views import core_views, footer_views, integrations, task_views
 from readthedocs.constants import pattern_opts
 from readthedocs.gold.views import StripeEventView
 
@@ -24,7 +20,6 @@
     VersionViewSet,
 )
 
-
 router = routers.DefaultRouter()
 router.register(r'build', BuildViewSet, basename='build')
 router.register(r'command', BuildCommandViewSet, basename='buildcommandresult')
@@ -117,9 +112,7 @@
 
 if 'readthedocsext.donate' in settings.INSTALLED_APPS:
     # pylint: disable=import-error
-    from readthedocsext.donate.restapi.urls import (
-        urlpatterns as sustainability_urls,
-    )
+    from readthedocsext.donate.restapi.urls import urlpatterns as sustainability_urls
 
     urlpatterns += [
         re_path(r'^sustainability/', include(sustainability_urls)),

readthedocs/builds/constants.py

@@ -140,10 +140,8 @@
 }
 
 BUILD_STATUS_NORMAL = 'normal'
-BUILD_STATUS_DUPLICATED = 'duplicated'
 BUILD_STATUS_CHOICES = (
     (BUILD_STATUS_NORMAL, 'Normal'),
-    (BUILD_STATUS_DUPLICATED, 'Duplicated'),
 )
 
 

readthedocs/builds/migrations/0045_alter_build_status.py

@@ -0,0 +1,25 @@
+# Generated by Django 3.2.15 on 2022-10-06 09:03
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("builds", "0044_alter_version_documentation_type"),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name="build",
+            name="status",
+            field=models.CharField(
+                blank=True,
+                choices=[("normal", "Normal")],
+                default=None,
+                max_length=32,
+                null=True,
+                verbose_name="Status",
+            ),
+        ),
+    ]

readthedocs/builds/tasks.py

@@ -542,8 +542,6 @@ def send(self):
 
     def send_email(self, email):
         """Send email notifications for build failures."""
-        # We send only what we need from the Django model objects here to avoid
-        # serialization problems in the ``readthedocs.core.tasks.send_email_task``
         protocol = 'http' if settings.DEBUG else 'https'
         context = {
             'version': {

readthedocs/core/tasks.py

@@ -1,28 +1,21 @@
-# -*- coding: utf-8 -*-
-
 """Basic tasks."""
 
 import structlog
-
 from django.conf import settings
 from django.core.mail import EmailMultiAlternatives
-from django.template import TemplateDoesNotExist
-from django.template.loader import get_template
 from django.utils import timezone
 from messages_extends.models import Message as PersistentMessage
 
 from readthedocs.worker import app
 
-
 log = structlog.get_logger(__name__)
 
 EMAIL_TIME_LIMIT = 30
 
 
 @app.task(queue='web', time_limit=EMAIL_TIME_LIMIT)
 def send_email_task(
-        recipient, subject, template, template_html, context=None,
-        from_email=None, **kwargs
+    recipient, subject, content, content_html=None, from_email=None, **kwargs
 ):
     """
     Send multipart email.
@@ -33,34 +26,26 @@ def send_email_task(
     subject
         Email subject header
 
-    template
+    content
         Plain text template to send
 
-    template_html
-        HTML template to send as new message part
-
-    context
-        A dictionary to pass into the template calls
+    content_html
+        HTML content to send as new message part
 
     kwargs
         Additional options to the EmailMultiAlternatives option.
     """
     msg = EmailMultiAlternatives(
         subject,
-        get_template(template).render(context), from_email or
-        settings.DEFAULT_FROM_EMAIL,
-        [recipient], **kwargs
+        content,
+        from_email or settings.DEFAULT_FROM_EMAIL,
+        [recipient],
+        **kwargs
     )
-    try:
-        msg.attach_alternative(
-            get_template(template_html).render(context),
-            'text/html',
-        )
-    except (TypeError, TemplateDoesNotExist):
-        # TypeError is raised when ``template_html`` is ``None``
-        pass
+    if content_html:
+        msg.attach_alternative(content_html, "text/html")
+    log.info("Sending email to recipient.", recipient=recipient)
     msg.send()
-    log.info('Sent email to recipient.', recipient=recipient)
 
 
 @app.task(queue='web')