Sandbox for Notifications Functionality

scope_shared/scope/config/__init__.py

@@ -6,3 +6,4 @@
 from scope.config.documentdb import DocumentDBConfig
 from scope.config.flask import FlaskClientConfig
 from scope.config.flask import FlaskConfig
+from scope.config.vapid import VapidKeysConfig

scope_shared/scope/config/vapid.py

@@ -0,0 +1,33 @@
+from dataclasses import dataclass
+from pathlib import Path
+import ruamel.yaml
+from typing import Union
+
+
+@dataclass(frozen=True)
+class VapidKeysConfig:
+    """
+    Configuration for vapid keys.
+    """
+
+    public_key: str
+    private_key: str
+    claim_email: str
+
+    @staticmethod
+    def load(config_path: Union[Path, str]):
+        config_path = Path(config_path)
+
+        with open(config_path) as config_file:
+            yaml = ruamel.yaml.YAML(typ="safe", pure=True)
+            config_dict = yaml.load(config_file)
+
+        return VapidKeysConfig.parse(config_dict)
+
+    @staticmethod
+    def parse(config_dict: dict):
+        return VapidKeysConfig(
+            public_key=config_dict["vapid_public_key"],
+            private_key=config_dict["vapid_private_key"],
+            claim_email=config_dict["vapid_claim_email"],
+        )

scope_shared/scope/database/database_utils.py

@@ -0,0 +1,36 @@
+import pymongo.collection
+import pymongo.database
+
+from typing import List, Optional
+
+import scope.database.date_utils as date_utils
+import scope.database.collection_utils
+import scope.database.patient.assessments
+import scope.database.patient.clinical_history
+import scope.database.patient.patient_profile
+import scope.database.patient.safety_plan
+import scope.database.patient.values_inventory
+import scope.enums
+import scope.schema
+import scope.schema_utils as schema_utils
+
+
+def get_patient_collections(
+    *,
+    database: pymongo.database.Database,
+) -> Optional[List[pymongo.collection.Collection]]:
+    """
+    Retrieve all patient collections documents.
+    """
+
+    collection_names = database.list_collection_names()
+
+    patient_collection_names = list(
+        filter(lambda cn: "patient_" in cn, collection_names)
+    )
+
+    patient_collections: List[pymongo.collection.Collection] = []
+    for patient_collection_name in patient_collection_names:
+        patient_collections.append(database.get_collection(patient_collection_name))
+
+    return patient_collections

scope_shared/scope/database/patient/__init__.py

@@ -35,6 +35,12 @@
     get_patient_profile,
     put_patient_profile,
 )
+from scope.database.patient.push_subscriptions import (
+    get_push_subscriptions,
+    get_push_subscription,
+    post_push_subscription,
+    put_push_subscription,
+)
 from scope.database.patient.scheduled_activities import (
     get_scheduled_activities,
     get_scheduled_activity,

scope_shared/scope/database/patient/push_subscriptions.py

@@ -0,0 +1,91 @@
+from typing import List, Optional
+
+import pymongo.collection
+import scope.database.collection_utils
+
+DOCUMENT_TYPE = "pushSubscription"
+SEMANTIC_SET_ID = "pushSubscriptionId"
+
+
+def delete_push_subscription(
+    *,
+    collection: pymongo.collection.Collection,
+    set_id: str,
+    rev: int,
+) -> scope.database.collection_utils.SetPutResult:
+    """
+    Delete "push-subscription" document.
+    """
+
+    return scope.database.collection_utils.delete_set_element(
+        collection=collection,
+        document_type=DOCUMENT_TYPE,
+        set_id=set_id,
+        rev=rev,
+    )
+
+
+def get_push_subscriptions(
+    *,
+    collection: pymongo.collection.Collection,
+) -> Optional[List[dict]]:
+    """
+    Get list of "pushSubscription" documents.
+    """
+
+    return scope.database.collection_utils.get_set(
+        collection=collection,
+        document_type=DOCUMENT_TYPE,
+    )
+
+
+def get_push_subscription(
+    *,
+    collection: pymongo.collection.Collection,
+    set_id: str,
+) -> Optional[dict]:
+    """
+    Get "pushSubscription" document.
+    """
+
+    return scope.database.collection_utils.get_set_element(
+        collection=collection,
+        document_type=DOCUMENT_TYPE,
+        set_id=set_id,
+    )
+
+
+def post_push_subscription(
+    *,
+    collection: pymongo.collection.Collection,
+    push_subscription: dict,
+) -> scope.database.collection_utils.SetPostResult:
+    """
+    Post "pushSubscription" document.
+    """
+
+    return scope.database.collection_utils.post_set_element(
+        collection=collection,
+        document_type=DOCUMENT_TYPE,
+        semantic_set_id=SEMANTIC_SET_ID,
+        document=push_subscription,
+    )
+
+
+def put_push_subscription(
+    *,
+    collection: pymongo.collection.Collection,
+    push_subscription: dict,
+    set_id: str,
+) -> scope.database.collection_utils.SetPutResult:
+    """
+    Put "pushSubscription" document.
+    """
+
+    return scope.database.collection_utils.put_set_element(
+        collection=collection,
+        document_type=DOCUMENT_TYPE,
+        semantic_set_id=SEMANTIC_SET_ID,
+        set_id=set_id,
+        document=push_subscription,
+    )

scope_shared/scope/notifications/messages.py

@@ -0,0 +1,7 @@
+import pymongo.collection
+
+
+def compute_daily_summary(
+    collection: pymongo.collection.Collection,
+):
+    return "<Create notification message for daily patient summary>"

scope_shared/scope/notifications/webpush_handler.py

@@ -0,0 +1,34 @@
+"""Module provides a function to trigger a push notification to a web browser."""
+import json
+import requests
+from pywebpush import webpush, WebPushException
+import scope.config
+from typing import Union
+
+
+def trigger_push_notification(
+    vapid_config: scope.config.VapidKeysConfig,
+    push_subscription: dict,
+    title: str,
+    options: dict,
+) -> str:
+    """Function to trigger a push notification to a web browser."""
+    try:
+        subscription_info = {
+            "endpoint": push_subscription["endpoint"],
+            "keys": {
+                "auth": push_subscription["keys"]["auth"],
+                "p256dh": push_subscription["keys"]["p256dh"],
+            },
+        }
+
+        response = webpush(
+            subscription_info=subscription_info,
+            data=json.dumps({"title": title, "options": options}),
+            vapid_private_key=vapid_config.private_key,
+            vapid_claims={"sub": f"mailto:{vapid_config.claim_email}"},
+        )
+
+        return repr(response)
+    except WebPushException as ex:
+        return str(ex)

scope_shared/scope/schema.py

@@ -40,6 +40,8 @@
 populate_config_account_schema: Optional[jschon.JSONSchema] = None
 provider_identity_schema: Optional[jschon.JSONSchema] = None
 provider_identities_schema: Optional[jschon.JSONSchema] = None
+push_subscription_schema: Optional[jschon.JSONSchema] = None
+push_subscriptions_schema: Optional[jschon.JSONSchema] = None
 referral_status_schema: Optional[jschon.JSONSchema] = None
 regexes: Optional[jschon.JSONSchema] = None
 resource_content_schema: Optional[jschon.JSONSchema] = None
@@ -100,6 +102,8 @@
     "patient_profile_schema": "documents/patient-profile.json",
     "provider_identity_schema": "documents/provider-identity.json",
     "provider_identities_schema": "documents/provider-identities.json",
+    "push_subscription_schema": "documents/push-subscription.json",
+    "push_subscriptions_schema": "documents/push-subscriptions.json",
     "safety_plan_schema": "documents/safety-plan.json",
     "scheduled_activity_schema": "documents/scheduled-activity.json",
     "scheduled_activities_schema": "documents/scheduled-activities.json",

scope_shared/scope/schemas/api/patient.json

@@ -43,6 +43,9 @@
       "description": "IPatientProfile schema",
       "$ref": "/schemas/documents/patient-profile"
     },
+    "pushSubscriptions": {
+      "$ref": "/schemas/documents/push-subscriptions"
+    },
     "safetyPlan": {
       "type": "object",
       "description": "ISafetyPlan schema",

scope_shared/scope/schemas/document.json

@@ -36,6 +36,9 @@
     {
       "$ref": "/schemas/documents/patient-profile"
     },
+    {
+      "$ref": "/schemas/documents/push-subscription"
+    },
     {
       "$ref": "/schemas/documents/safety-plan"
     },

scope_shared/scope/schemas/documents/push-subscription.json

@@ -0,0 +1,45 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://uwscope.org/schemas/documents/push-subscription",
+    "title": "IPushSubscription",
+    "description": "IPushSubscription Type",
+    "type": "object",
+    "properties": {
+        "_id": {
+            "type": "string"
+        },
+        "_type": {
+            "const": "pushSubscription"
+        },
+        "_set_id": {
+            "type": "string"
+        },
+        "_rev": {
+            "type": "number"
+        },
+        "pushSubscriptionId": {
+            "type": "string"
+        },
+        "endpoint": {
+            "type": "string"
+        },
+        "expirationTime": {
+            "type": ["number", "null"]
+        },
+        "keys": {
+            "type": "object",
+            "properties": {
+                "p256dh": {
+                    "type": "string"
+                },
+                "auth": {
+                    "type": "string"
+                }
+            },
+            "additionalProperties": false,
+            "required": ["p256dh", "auth"]
+        }
+    },
+    "additionalProperties": false,
+    "required": ["_type", "endpoint", "expirationTime", "keys"]
+}

scope_shared/scope/schemas/documents/push-subscriptions.json

@@ -0,0 +1,9 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://uwscope.org/schemas/documents/push-subscriptions",
+    "title": "IPushSubscription[]",
+    "type": "array",
+    "items": {
+        "$ref": "/schemas/documents/push-subscription"
+    }
+}

scope_shared/scope/schemas/documents/web-push.json

@@ -0,0 +1,34 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://uwscope.org/schemas/documents/web-push",
+    "title": "Webpush Details",
+    "type": "object",
+    "properties": {
+        "_id": {
+            "type": "string"
+        },
+        "_type": {
+            "const": "webpushResponse"
+        },
+        "_set_id": {
+            "type": "string"
+        },
+        "_rev": {
+            "type": "number"
+        },
+        "webPushId": {
+            "type": "string"
+        },
+        "message": {
+            "type": "string"
+        },
+        "response": {
+            "type": "string"
+        },
+        "editedDateTime": {
+            "$ref": "/schemas/utils/datetime#/properties/datetime"
+        }
+    },
+    "additionalProperties": false,
+    "required": ["_type", "message", "response", "editedDateTime"]
+}

scope_shared/scope/schemas/documents/web-pushes.json

@@ -0,0 +1,9 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://uwscope.org/schemas/documents/web-pushes",
+    "title": "Webpush Details",
+    "type": "array",
+    "items": {
+        "$ref": "/schemas/documents/web-push"
+    }
+}