Addons: expose readthedocs.resolver.filename in the API response (#…

…11940)

This is required to be able to dynamically update the URLs from the
versions in the flyout when the page is changed using `history` object
(without reloading / SPA) as Docusaurus does.

In that scenario we cannot use the HTML META tag because it was injected
with the old value by CF Worker. Note that the CF Worker is not run
after the initial request on SPA.

The addons frontend will use this attribute to update those URLs
accordingly when the URL changes.

Required by:
* readthedocs/addons#504

readthedocs/proxito/tests/responses/v1.json

@@ -118,6 +118,9 @@
   "readthedocs": {
     "analytics": {
       "code": null
+    },
+    "resolver": {
+      "filename": "/index.html"
     }
   },
   "addons": {

readthedocs/proxito/tests/test_hosting.py

@@ -667,6 +667,7 @@ def test_send_project_version_slugs(self):
         expected_response = self._get_response_dict("v1")
         # Remove `addons.doc_diff` from the response because it's not present when `url=` is not sent
         expected_response["addons"].pop("doc_diff")
+        expected_response["readthedocs"]["resolver"]["filename"] = None
 
         assert self._normalize_datetime_fields(r.json()) == expected_response
 

readthedocs/proxito/views/hosting.py

@@ -452,6 +452,9 @@ def _v1(self, project, version, build, filename, url, request):
                 "analytics": {
                     "code": settings.GLOBAL_ANALYTICS_CODE,
                 },
+                "resolver": {
+                    "filename": filename,
+                },
             },
             # TODO: the ``features`` is not polished and we expect to change drastically.
             # Mainly, all the fields including a Project, Version or Build will use the exact same