Customize Health Page Title

.github/workflows/main.yml

@@ -61,6 +61,7 @@ jobs:
         if: ${{ matrix.test_type == 'INDEXING' }}
         env:
           S3_ENCRYPT_KEY: ${{ secrets.S3_ENCRYPT_KEY }}
+          GLOBAL_ENV_BUCKET: "foursight-prod-envs"
           # # The need for this old environment variable name will go away soon.
           # TRAVIS_JOB_ID: sno-x-test-${{ github.run_number }}-
           # This will be the new environment variable name.
@@ -72,6 +73,7 @@ jobs:
         if: ${{ matrix.test_type == 'UNIT' }}
         env:
           S3_ENCRYPT_KEY: ${{ secrets.S3_ENCRYPT_KEY }}
+          GLOBAL_ENV_BUCKET: "foursight-prod-envs"
           # # The need for this old environment variable name will go away soon.
           # TRAVIS_JOB_ID: sno-x-test-${{ github.run_number }}-
           # This will be the new environment variable name.
@@ -83,6 +85,7 @@ jobs:
         if: ${{ always() && matrix.test_type == 'INDEXING' }}
         env:
           S3_ENCRYPT_KEY: ${{ secrets.S3_ENCRYPT_KEY }}
+          GLOBAL_ENV_BUCKET: "foursight-prod-envs"
           # The need for this old environment variable name will go away soon.
           # TRAVIS_JOB_ID: sno-x-test-${{ github.run_number }}-
           # This will be the new environment variable name.
@@ -94,6 +97,7 @@ jobs:
         if: ${{ always() && matrix.test_type == 'UNIT' }}
         env:
           S3_ENCRYPT_KEY: ${{ secrets.S3_ENCRYPT_KEY }}
+          GLOBAL_ENV_BUCKET: "foursight-prod-envs"
           # The need for this old environment variable name will go away soon.
           # TRAVIS_JOB_ID: sno-x-test-${{ github.run_number }}-
           # This will be the new environment variable name.

CHANGELOG.rst

@@ -6,6 +6,12 @@ snovault
 Change Log
 ----------
 
+11.14.0
+=======
+
+* Allow customization of health page title
+
+
 11.13.0
 =======
 

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "dcicsnovault"
-version = "11.13.0"
+version = "11.14.0"
 description = "Storage support for 4DN Data Portals."
 authors = ["4DN-DCIC Team <[email protected]>"]
 license = "MIT"
@@ -84,6 +84,7 @@ xlrd = "^1.0.0"
 "zope.interface" = ">=4.7.2,<6"
 "zope.sqlalchemy" = "1.6"
 jsonschema = {extras = ["format-nongpl"], version = "^4.19.0"}
+uptime = "^3.0.1"
 
 [tool.poetry.dev-dependencies]
 boto3-stubs = ">=1.28.62"  # no particular version required, but this speeds up search

snovault/crud_views.py

@@ -70,6 +70,22 @@ def build_diff_from_request(context, request):
     return dm.patch_diffs(body)
 
 
+def build_comparison_from_request(context, request, props):
+    """ Very similar to above method but runs a comparison instead """
+    try:
+        item_type = context.type_info.name
+        body = json.loads(request.body)
+        extract_and_populate_deleted_fields(request, body)
+        dm = DiffManager(label=item_type)
+    except json.decoder.JSONDecodeError:
+        log.info('Request body is not valid JSON!')  # can happen from indirect patch, such as with access key
+        return None
+    except Exception as e:
+        log.error('Unknown error encountered building diff from request: %s' % e)
+        return None
+    return dm._diffs(props, body)
+
+
 def create_item(type_info, request, properties, sheets=None):
     '''
     Validates or generates new UUID, instantiates & saves an Item in
@@ -240,6 +256,10 @@ def item_edit(context, request, render=None):
         render = request.params.get('render', True)
 
     # This *sets* the property sheet and adds the item to the indexing queue
+    check_diff = asbool(request.params.get('check_diff', False))
+    if check_diff:
+        comparison = build_comparison_from_request(context, request, context.properties)
+    import pdb; pdb.set_trace()
     update_item(context, request, request.validated)
 
     rendered = render_item(request, context, render)

snovault/loadxl.py

@@ -684,13 +684,15 @@ def get_schema_info(type_name: str) -> (list, list):
                 if not identifying_path:
                     raise Exception("Item has no uuid nor any other identifying property; cannot PATCH.")
                 normalized_item, deleted_properties = normalize_deleted_properties(an_item)
+                identifying_path += '?check_diff=true'
                 if deleted_properties:
                     if validate_only and skip_links:
-                        identifying_path += f"?delete_fields={','.join(deleted_properties)}&skip_links=true"
+                        identifying_path += f"&delete_fields={','.join(deleted_properties)}&skip_links=true"
                     else:
-                        identifying_path += f"?delete_fields={','.join(deleted_properties)}"
+                        identifying_path += f"&delete_fields={','.join(deleted_properties)}"
                 elif validate_only and skip_links:
                     identifying_path += f"?skip_links=true"
+
                 res = testapp.patch_json(identifying_path, normalized_item)
                 assert res.status_code == 200
                 patched += 1

snovault/project/health.py

@@ -0,0 +1,5 @@
+class SnovaultProjectHealthValue:
+
+    @staticmethod
+    def get_app_namespace():
+        return 'ENCODED'

snovault/project_defs.py

@@ -6,6 +6,7 @@
 from .project.loadxl import SnovaultProjectLoadxl
 from .project.renderers import SnovaultProjectRenderers
 from .project.schema_views import SnovaultProjectSchemaViews
+from .project.health import SnovaultProjectHealthValue
 
 
 @C4ProjectRegistry.register("dcicsnovault")
@@ -16,6 +17,7 @@ class SnovaultProject(SnovaultProjectAccessKey,
                       SnovaultProjectLoadxl,
                       SnovaultProjectRenderers,
                       SnovaultProjectSchemaViews,
+                      SnovaultProjectHealthValue,
                       C4Project):
     NAMES = {"NAME": "snovault", "PYPI_NAME": "dcicsnovault"}
     ACCESSION_PREFIX = "SNO"

snovault/root.py

@@ -14,6 +14,7 @@
 from .appdefs import APP_VERSION_REGISTRY_KEY, ITEM_INDEX_ORDER
 from .schema_formats import is_accession
 from .util import SettingsKey
+from .project_app import app_project
 
 
 def includeme(config):
@@ -111,7 +112,10 @@ class ExtendedHealthPageKey(HealthPageKey):
         settings = request.registry.settings
 
         env_name = settings.get('env.name')
-        foursight_url = infer_foursight_url_from_env(request=request, envname=env_name)
+        try:
+            foursight_url = infer_foursight_url_from_env(request=request, envname=env_name)
+        except Exception:  # this can fail in unit testing depending on env_name
+            foursight_url = 'Could-not-resolve-foursight'
 
         response_dict = {
 
@@ -124,8 +128,8 @@ class ExtendedHealthPageKey(HealthPageKey):
             h.BEANSTALK_APP_VERSION: settings.get(s.EB_APP_VERSION),
             h.BEANSTALK_ENV: env_name,
             h.BLOB_BUCKET: settings.get(s.BLOB_BUCKET),
-            h.DATABASE: settings.get(s.SQLALCHEMY_URL).split('@')[1],  # don't show user /password
-            h.DISPLAY_TITLE: "ENCODED Portal Status and Foursight Monitoring",
+            h.DATABASE: settings.get(s.SQLALCHEMY_URL, 'dummy@postgres').split('@')[1],  # don't show user /password
+            h.DISPLAY_TITLE: f"{app_project().get_app_namespace()} Portal Status and Foursight Monitoring",
             h.ELASTICSEARCH: settings.get(s.ELASTICSEARCH_SERVER),
             h.FILE_UPLOAD_BUCKET: settings.get(s.FILE_UPLOAD_BUCKET),
             h.FOURSIGHT: foursight_url,

snovault/tests/root.py

@@ -8,6 +8,7 @@
     Deny,
     Everyone,
 )
+from ..root import health_check
 from ..schema_utils import format_checker
 from ..calculated import calculated_property
 from ..resources import Root
@@ -19,6 +20,7 @@
 
 
 def includeme(config):
+    config.include(health_check)
     config.scan(__name__)
 
 

snovault/tests/test_health_path.py

@@ -0,0 +1,12 @@
+import pytest
+from dcicutils.misc_utils import ignored
+
+
+ignored(pytest)
+
+
+def test_health_page_basic(testapp):
+    """ Tests that we can reach the health page and that the customization works """
+    health = testapp.get('/health').json
+    assert health['display_title'] == 'ENCODED Portal Status and Foursight Monitoring'
+    assert health['database'] == 'postgres'

snovault/tests/test_post_put_patch.py

@@ -110,7 +110,7 @@ def test_patch(content, testapp):
     assert res.json['simple1'] == 'simple1 default'
     assert res.json['simple2'] == 'simple2 default'
 
-    res = testapp.patch_json(url, {}, status=200)
+    res = testapp.patch_json(url+'?check_diff=true', {}, status=200)
     assert res.json['@graph'][0]['simple1'] == 'simple1 default'
     assert res.json['@graph'][0]['simple2'] == 'simple2 default'
 

snovault/tests/testappfixtures.py

@@ -6,6 +6,7 @@
 from .. import main  # Function main actually defined in __init__.py (should maybe be defined elsewhere)
 
 _app_settings = {
+    'env.name': 'snovault',
     'collection_datastore': 'database',
     'item_datastore': 'database',
     'load_test_only': True,