Add ansible api hostname to api cache key.

fixes #1833
pulp · May 2, 2024 · ca866f8 · ca866f8
1 parent 3212416
commit ca866f8
Show file tree

Hide file tree

Showing 2 changed files with 28 additions and 14 deletions.
diff --git a/CHANGES/1833.bugfix b/CHANGES/1833.bugfix
@@ -0,0 +1 @@
+Add ansible hostname to API v3 cache key
diff --git a/pulp_ansible/app/galaxy/v3/views.py b/pulp_ansible/app/galaxy/v3/views.py
@@ -1,6 +1,7 @@
 from datetime import datetime
 from gettext import gettext as _
 import semantic_version
+import base64
 
 from django.db import DatabaseError, IntegrityError
 from django.db.models import F, OuterRef, Exists, Subquery, Prefetch
@@ -97,6 +98,15 @@
 }
 
 
+def encode_cache_key(key):
+    """
+    Base64 encode the cache key to avoid any unpleasantness with unsupported
+    characters.
+    """
+    b64 = base64.b64encode(key.encode())
+    return b64.decode()
+
+
 class AnsibleDistributionMixin:
     """
     A mixin for ViewSets that use AnsibleDistribution.
@@ -925,14 +935,17 @@ def list(self, request, *args, **kwargs):
                 cache_request = False
                 break
 
-        cache_key = "".join(
-            [
-                str(self._repository_version.pk),
-                kwargs["namespace"],
-                kwargs["name"],
-                str(request.query_params.get("offset", "0")),
-                str(request.query_params.get("limit", "0")),
-            ]
+        cache_key = encode_cache_key(
+            "-".join(
+                [
+                    settings.ANSIBLE_API_HOSTNAME,
+                    str(self._repository_version.pk),
+                    kwargs["namespace"],
+                    kwargs["name"],
+                    str(request.query_params.get("offset", "0")),
+                    str(request.query_params.get("limit", "0")),
+                ]
+            )
         )
 
         if cache_key in cache and cache_request:
@@ -976,9 +989,9 @@ def retrieve(self, request, *args, **kwargs):
         repo_version = self._repository_version
         # the contents of a repo version can be cached without worry because repo
         # versions are immutable
-        cache_key = (
-            f"version-details-{repo_version.pk}"
-            f"{kwargs['namespace']}{kwargs['name']}{kwargs['version']}"
+        cache_key = encode_cache_key(
+            f"{settings.ANSIBLE_API_HOSTNAME}-version-details-{repo_version.pk}"
+            f"-{kwargs['namespace']}-{kwargs['name']}-{kwargs['version']}"
         )
 
         if data := cache.get(cache_key):
@@ -1122,9 +1135,9 @@ def retrieve(self, request, *args, **kwargs):
         repo_version = self._repository_version
         # the contents of a repo version can be cached without worry because repo
         # versions are immutable
-        cache_key = (
-            f"version-docs-{repo_version.pk}"
-            f"{kwargs['namespace']}{kwargs['name']}{kwargs['version']}"
+        cache_key = encode_cache_key(
+            f"version-docs-{repo_version.pk}-"
+            f"{kwargs['namespace']}-{kwargs['name']}-{kwargs['version']}"
         )
 
         if data := cache.get(cache_key):