Fix for MIME type ordering in renderers. (#261)

* Fix for MIME type ordering in renderers.

* Static error fixes

* Minor fix for minor test breakage.

* debeta

---------

Co-authored-by: William Ronchetti <[email protected]>

CHANGELOG.rst

@@ -6,6 +6,11 @@ snovault
 Change Log
 ----------
 
+9.1.0
+=====
+* Fix for MIME type ordering in renderers.py (differs between cgap and fourfront).
+
+
 9.0.0
 =====
 * Merge/unify ingestion and other code from cgap-portal and fourfront.

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "dcicsnovault"
-version = "9.0.0"
+version = "9.1.0"
 description = "Storage support for 4DN Data Portals."
 authors = ["4DN-DCIC Team <[email protected]>"]
 license = "MIT"
@@ -123,7 +123,7 @@ pytest-timeout = ">=1.0.0"
 # 5.2 had soe bugs that were probably only in Python 2, but we require 5.2 here just in case.
 # Any narrowing beyond that is just to help 'poetry lock' converge faster.
 # And we only need .safe_load in testing, so we're moving this to dev dependencies. -kmp 22-Feb-2022
-PyYAML = ">=5.1,<5.5"
+PyYAML = "5.3.1"
 "repoze.debug" = ">=1.0.2"
 wheel = ">=0.40.0"
 

scripts/macpoetry-install

@@ -1,6 +1,6 @@
 #!/bin/bash
 
 # For some reason on Mac M1 (as of July 2023) pyyaml install via poetry is problematic.
-pip install pyyaml==5.4.1
+pip install pyyaml==5.3.1
 
 CFLAGS="-I$(brew --prefix zlib)/include" LDFLAGS="-L$(brew --prefix zlib)/lib" poetry install

snovault/mime_types.py

@@ -0,0 +1,5 @@
+# Web browsers send an Accept request header for initial (e.g. non-AJAX) page requests
+# which should contain 'text/html'
+MIME_TYPE_HTML = 'text/html'
+MIME_TYPE_JSON = 'application/json'
+MIME_TYPE_LD_JSON = 'application/ld+json'

snovault/project/renderers.py

@@ -0,0 +1,9 @@
+# Renderers related functions which may be overriden by an implementing app,
+# e.g. Foursight or CGAP portal, using the dcicutils project_utils mechanism.
+
+from ..mime_types import MIME_TYPE_HTML, MIME_TYPE_JSON, MIME_TYPE_LD_JSON
+
+
+class SnovaultProjectRenderers:
+    def renderers_mime_types_supported(self):
+        return [MIME_TYPE_JSON, MIME_TYPE_HTML, MIME_TYPE_LD_JSON]

snovault/project_defs.py

@@ -4,6 +4,7 @@
 from .project.authorization import SnovaultProjectAuthorization
 from .project.ingestion import SnovaultProjectIngestion
 from .project.loadxl import SnovaultProjectLoadxl
+from .project.renderers import SnovaultProjectRenderers
 
 
 @C4ProjectRegistry.register("dcicsnovault")
@@ -12,6 +13,7 @@ class SnovaultProject(SnovaultProjectAccessKey,
                       SnovaultProjectAuthorization,
                       SnovaultProjectIngestion,
                       SnovaultProjectLoadxl,
+                      SnovaultProjectRenderers,
                       C4Project):
     NAMES = {"NAME": "snovault", "PYPI_NAME": "dcicsnovault"}
     ACCESSION_PREFIX = "SNO"

snovault/renderers.py

@@ -5,6 +5,7 @@
 import psutil
 import time
 
+from dcicutils.misc_utils import exported
 from dcicutils.misc_utils import environ_bool, PRINT, ignored
 from functools import lru_cache
 from pkg_resources import resource_filename
@@ -24,8 +25,12 @@
 from subprocess_middleware.worker import TransformWorker
 from urllib.parse import urlencode
 from webob.cookies import Cookie
+from .mime_types import MIME_TYPE_HTML, MIME_TYPE_JSON, MIME_TYPE_LD_JSON
 from .project_app import app_project
 from .util import content_type_allowed
+exported(
+    MIME_TYPE_HTML, MIME_TYPE_JSON, MIME_TYPE_LD_JSON
+)
 
 
 log = logging.getLogger(__name__)
@@ -314,13 +319,9 @@ def canonical_redirect(event):
 
 # Web browsers send an Accept request header for initial (e.g. non-AJAX) page requests
 # which should contain 'text/html'
-MIME_TYPE_HTML = 'text/html'
-MIME_TYPE_JSON = 'application/json'
-MIME_TYPE_LD_JSON = 'application/ld+json'
-
 # Note: In cgap-portal, MIME_TYPE_JSON is at the head of this list. In fourfront, MIME_TYPE_HTML is.
 # The cgap-portal behavior might be a bug we should look at bringing into alignment. -kmp 29-Jan-2022
-MIME_TYPES_SUPPORTED = [MIME_TYPE_JSON, MIME_TYPE_HTML, MIME_TYPE_LD_JSON]
+MIME_TYPES_SUPPORTED = app_project().renderers_mime_types_supported()
 MIME_TYPE_DEFAULT = MIME_TYPES_SUPPORTED[0]
 MIME_TYPE_TRIAGE_MODE = 'modern'  # if this doesn't work, fall back to 'legacy'