#24 make static paths relative

cellxgene_gateway/cache_entry.py

@@ -12,13 +12,13 @@ import datetime
 
 from flask import make_response, request, render_template
 from requests import get, post, put
+import re
 
 from cellxgene_gateway import env
 from cellxgene_gateway.cellxgene_exception import CellxgeneException
 from cellxgene_gateway.util import current_time_stamp
 from cellxgene_gateway.flask_util import querystring
 
-
 class CacheEntry:
     def __init__(
         self,
@@ -97,8 +97,20 @@ class CacheEntry:
             )
         self.status = "terminated"
 
+    def rewrite_text_content(self, cellxgene_content):
+        # for v0.16.0 compatibility, see issue #24
+        gateway_content = re.sub('(="|\()/static/', r'\1static/', cellxgene_content).replace(
+            "http://fonts.gstatic.com", "https://fonts.gstatic.com"
+        ).replace(self.cellxgene_basepath(), self.gateway_basepath())
+        return gateway_content
+
+    def gateway_basepath(self):
+        return f"{env.external_protocol}://{env.external_host}/view/{self.key.pathpart}/"
+    def cellxgene_basepath(self):
+        return f"http://127.0.0.1:{self.port}"
+
     def serve_content(self, path):
-        gateway_basepath = f"{env.external_protocol}://{env.external_host}/view/{self.key.pathpart}/"
+        gateway_basepath = self.gateway_basepath()
         subpath = path[len(self.key.pathpart) :]  # noqa: E203
 
         if len(subpath) == 0:
@@ -113,8 +125,6 @@ class CacheEntry:
                 all_output=self.all_output,
             )
 
-        port = self.port
-        cellxgene_basepath = f"http://127.0.0.1:{port}"
         headers = {}
         copy_headers = [
             "accept",
@@ -137,7 +147,7 @@ class CacheEntry:
             if h in request.headers:
                 headers[h] = request.headers[h]
 
-        full_path = cellxgene_basepath + subpath + querystring()
+        full_path = self.cellxgene_basepath() + subpath + querystring()
 
         if request.method in ["GET", "HEAD", "OPTIONS"]:
             cellxgene_response = get(full_path, headers=headers)
@@ -155,10 +165,7 @@ class CacheEntry:
             )
         content_type = cellxgene_response.headers["content-type"]
         if "text" in content_type:
-            cellxgene_content = cellxgene_response.content.decode()
+            gateway_content = self.rewrite_text_content(cellxgene_response.content.decode())
-            gateway_content = cellxgene_content.replace(
-                "http://fonts.gstatic.com", "https://fonts.gstatic.com"
-            ).replace(cellxgene_basepath, gateway_basepath)
         else:
             gateway_content = cellxgene_response.content
 

cellxgene_gateway/cache_key.py

@@ -7,13 +7,6 @@
 # OR CONDITIONS OF ANY KIND, either express or implied. See the License for
 # the specific language governing permissions and limitations under the License.
 
-import os
-
-from flask_api import status
-
-from cellxgene_gateway import env
-from cellxgene_gateway.cellxgene_exception import CellxgeneException
-
 # There are three kinds of CacheKey:
 # 1) somedir/dataset.h5ad: a dataset
 #    in this case, pathpart == dataset == 'somedir/dataset.h5ad'

tests/test_cache_entry.py

@@ -0,0 +1,16 @@
+import unittest
+from cellxgene_gateway.cache_entry import CacheEntry
+from cellxgene_gateway.cache_key import CacheKey
+
+key = CacheKey('path/part', 'dataset', 'tmp.csv')
+
+class TestRenderEntry(unittest.TestCase):
+    def test_GIVEN_absolute_static_url_THEN_return_relative(self):
+        actual = CacheEntry.for_key(key, 8000).rewrite_text_content("src:url(/static/assets/")
+        expected = "src:url(static/assets/"
+        self.assertEqual(actual, expected)
+    def test_GIVEN_absolute_src_THEN_return_relative(self):
+        actual = CacheEntry.for_key(key, 8000).rewrite_text_content('<link rel="shortcut icon" href="/static/assets/favicon.ico">')
+        expected = '<link rel="shortcut icon" href="static/assets/favicon.ico">'
+        self.assertEqual(actual, expected)
+