Krist/be 443 configure notifications

oarepo_communities/cf/workflows.py

@@ -1,25 +1,32 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
 import marshmallow as ma
 from flask import current_app
 from invenio_records_resources.services.custom_fields import KeywordCF
 
+if TYPE_CHECKING:
+    from typing import Any
+
 
-def validate_workflow(value):
+def validate_workflow(value: str) -> bool:
     return value in current_app.config["WORKFLOWS"]
 
 
 class WorkflowSchemaField(ma.fields.Str):
-    def __init__(self, **kwargs):
+    def __init__(self, **kwargs: Any) -> None:
         super().__init__(validate=[validate_workflow], **kwargs)
 
 
 class WorkflowCF(KeywordCF):
-    def __init__(self, name, **kwargs):
+    def __init__(self, name: str, **kwargs: Any) -> None:
         super().__init__(name, field_cls=WorkflowSchemaField, **kwargs)
 
 
 # hack to get lazy choices serialized to JSON
 class LazyChoices(list):
-    def __init__(self, func):
+    def __init__(self, func: callable):
         self._func = func
 
     def __iter__(self):

oarepo_communities/config.py

@@ -1,14 +1,15 @@
+from invenio_communities.config import COMMUNITIES_ROUTES as INVENIO_COMMUNITIES_ROUTES
 from oarepo_runtime.i18n import lazy_gettext as _
 
 from .cf.workflows import WorkflowCF, lazy_workflow_options
+from .notifications.generators import CommunityRoleEmailRecipient
 from .requests.migration import (
     ConfirmCommunityMigrationRequestType,
     InitiateCommunityMigrationRequestType,
 )
 from .requests.remove_secondary import RemoveSecondaryCommunityRequestType
 from .requests.submission_secondary import SecondaryCommunitySubmissionRequestType
 from .resolvers.ui import CommunityRoleUIResolver
-from invenio_communities.config import COMMUNITIES_ROUTES as INVENIO_COMMUNITIES_ROUTES
 
 REQUESTS_REGISTERED_TYPES = [
     InitiateCommunityMigrationRequestType(),
@@ -67,3 +68,7 @@
 DISPLAY_USER_COMMUNITIES = True
 
 DISPLAY_NEW_COMMUNITIES = True
+
+NOTIFICATION_RECIPIENTS_RESOLVERS = {
+    "community_role": {"email": CommunityRoleEmailRecipient}
+}

oarepo_communities/errors.py

@@ -5,45 +5,51 @@
 class CommunityAlreadyIncludedException(Exception):
     """The record is already in the community."""
 
-    description = "The record is already included in this community."
+    description = _("The record is already included in this community.")
 
 
 class CommunityNotIncludedException(Exception):
     """The record is already in the community."""
 
-    description = "The record is not included in this community."
+    description = _("The record is not included in this community.")
 
 
 class PrimaryCommunityException(Exception):
     """The record is already in the community."""
 
-    description = "Primary community can't be removed, can only be migrated to another."
+    description = _(
+        "Primary community can't be removed, can only be migrated to another."
+    )
 
 
 class MissingDefaultCommunityError(ValidationError):
     """"""
 
+    description = _("Default community is not present in the input.")
+
 
 class MissingCommunitiesError(ValidationError):
     """"""
 
+    description = _("Communities are not present in the input.")
+
 
 class CommunityAlreadyExists(Exception):
     """The record is already in the community."""
 
-    description = "The record is already included in this community."
+    description = _("The record is already included in this community.")
 
 
 class RecordCommunityMissing(Exception):
     """Record does not belong to the community."""
 
-    def __init__(self, record_id, community_id):
+    def __init__(self, record_id: str, community_id: str):
         """Initialise error."""
         self.record_id = record_id
         self.community_id = community_id
 
     @property
-    def description(self):
+    def description(self) -> str:
         """Exception description."""
         return "The record {record_id} in not included in the community {community_id}.".format(
             record_id=self.record_id, community_id=self.community_id
@@ -53,11 +59,11 @@ def description(self):
 class OpenRequestAlreadyExists(Exception):
     """An open request already exists."""
 
-    def __init__(self, request_id):
+    def __init__(self, request_id: str):
         """Initialize exception."""
         self.request_id = request_id
 
     @property
-    def description(self):
+    def description(self) -> str:
         """Exception's description."""
         return _("There is already an open inclusion request for this community.")

oarepo_communities/ext.py

@@ -1,5 +1,9 @@
+from __future__ import annotations
+
 from functools import cached_property
+from typing import TYPE_CHECKING
 
+from deepmerge import conservative_merger
 from flask_principal import identity_loaded
 
 import oarepo_communities.cli  # noqa - imported to register CLI commands
@@ -9,19 +13,24 @@
 from .services.community_inclusion.service import CommunityInclusionService
 from .services.community_records.config import CommunityRecordsServiceConfig
 from .services.community_records.service import CommunityRecordsService
+from .services.community_role.config import CommunityRoleServiceConfig
+from .services.community_role.service import CommunityRoleService
 from .utils import get_urlprefix_service_id_mapping, load_community_user_needs
 from .workflow import community_default_workflow
 
+if TYPE_CHECKING:
+    from flask import Flask
+
 
 class OARepoCommunities(object):
     """OARepo extension of Invenio-Vocabularies."""
 
-    def __init__(self, app=None):
+    def __init__(self, app: Flask = None) -> None:
         """Extension initialization."""
         if app:
             self.init_app(app)
 
-    def init_app(self, app):
+    def init_app(self, app: Flask) -> None:
         """Flask application initialization."""
         self.app = app
         self.init_services(app)
@@ -30,7 +39,7 @@ def init_app(self, app):
         self.init_config(app)
         app.extensions["oarepo-communities"] = self
 
-    def init_config(self, app):
+    def init_config(self, app: Flask) -> None:
         """Initialize configuration."""
 
         from . import config, ext_config
@@ -68,51 +77,63 @@ def init_config(self, app):
             **app.config.get("COMMUNITIES_ROUTES", {}),
         }
 
+        app_registered_event_types = app.config.setdefault(
+            "NOTIFICATION_RECIPIENTS_RESOLVERS", {}
+        )
+        app.config["NOTIFICATION_RECIPIENTS_RESOLVERS"] = conservative_merger.merge(
+            app_registered_event_types, config.NOTIFICATION_RECIPIENTS_RESOLVERS
+        )
+
     @cached_property
-    def urlprefix_serviceid_mapping(self):
+    def urlprefix_serviceid_mapping(self) -> dict[str, str]:
         return get_urlprefix_service_id_mapping()
 
-    def get_community_default_workflow(self, **kwargs):
+    def get_community_default_workflow(self, **kwargs) -> str | None:
         return community_default_workflow(**kwargs)
 
-    def init_services(self, app):
+    def init_services(self, app: Flask) -> None:
         """Initialize communities service."""
         # Services
         self.community_records_service = CommunityRecordsService(
             config=CommunityRecordsServiceConfig.build(app),
         )
 
         self.community_inclusion_service = CommunityInclusionService()
+        self.community_role_service = CommunityRoleService(
+            config=CommunityRoleServiceConfig()
+        )
 
-    def init_resources(self, app):
+    def init_resources(self, app: Flask) -> None:
         """Initialize communities resources."""
         # Resources
         self.community_records_resource = CommunityRecordsResource(
             config=CommunityRecordsResourceConfig.build(app),
             service=self.community_records_service,
         )
 
-    def init_hooks(self, app):
+    def init_hooks(self, app: Flask) -> None:
         """Initialize hooks."""
 
         @identity_loaded.connect_via(app)
         def on_identity_loaded(_, identity):
             load_community_user_needs(identity)
 
-    def get_default_community_from_record(self, record, **kwargs):
+    """
+    def get_default_community_from_record(self, record: Record, **kwargs: Any):
         record = record.parent if hasattr(record, "parent") else record
         try:
             return record.communities.default.id
         except AttributeError:
             return None
+    """
 
 
-def api_finalize_app(app):
+def api_finalize_app(app: Flask) -> None:
     """Finalize app."""
     finalize_app(app)
 
 
-def finalize_app(app):
+def finalize_app(app: Flask) -> None:
     """Finalize app."""
 
     # Register services - cannot be done in extension because
@@ -126,6 +147,10 @@ def finalize_app(app):
         ext.community_records_service,
         service_id=ext.community_records_service.config.service_id,
     )
+    rr_ext.registry.register(
+        ext.community_role_service,
+        service_id=ext.community_role_service.config.service_id,
+    )
     # indexers
     # idx_ext.registry.register(ext.community_records_service.indexer, indexer_id="communities")
 

oarepo_communities/i18n/translations/cs/LC_MESSAGES/messages.po

@@ -326,3 +326,24 @@ msgstr "Odebrat sekundární komunitu"
 #: /home/ron/prace/oarepo-communities/oarepo_communities/requests/submission_secondary.py:29
 msgid "Secondary community submission"
 msgstr "Přijmout do sekundární komunity"
+
+#: /home/ron/prace/oarepo-communities/oarepo_communities/errors.py:8
+#: /home/ron/prace/oarepo-communities/oarepo_communities/errors.py:40
+msgid "The record is already included in this community."
+msgstr "Záznam už je v této komunitě."
+
+#: /home/ron/prace/oarepo-communities/oarepo_communities/errors.py:14
+msgid "The record is not included in this community."
+msgstr "Záznam není v této komunitě."
+
+#: /home/ron/prace/oarepo-communities/oarepo_communities/errors.py:20
+msgid "Primary community can't be removed, can only be migrated to another."
+msgstr "Záznam nemůže být odebrán z hlavní komunity, je možné ho pouze přesunout do jiné."
+
+#: /home/ron/prace/oarepo-communities/oarepo_communities/errors.py:28
+msgid "Default community is not present in the input."
+msgstr "Na vstupu chybí výchozí komunita."
+
+#: /home/ron/prace/oarepo-communities/oarepo_communities/errors.py:34
+msgid "Communities are not present in the input."
+msgstr "Na vstupu chybí komunity."

oarepo_communities/i18n/translations/en/LC_MESSAGES/messages.po

@@ -317,3 +317,24 @@ msgstr ""
 #: /home/ron/prace/oarepo-communities/oarepo_communities/requests/submission_secondary.py:29
 msgid "Secondary community submission"
 msgstr ""
+
+#: /home/ron/prace/oarepo-communities/oarepo_communities/errors.py:8
+#: /home/ron/prace/oarepo-communities/oarepo_communities/errors.py:40
+msgid "The record is already included in this community."
+msgstr ""
+
+#: /home/ron/prace/oarepo-communities/oarepo_communities/errors.py:14
+msgid "The record is not included in this community."
+msgstr ""
+
+#: /home/ron/prace/oarepo-communities/oarepo_communities/errors.py:20
+msgid "Primary community can't be removed, can only be migrated to another."
+msgstr ""
+
+#: /home/ron/prace/oarepo-communities/oarepo_communities/errors.py:28
+msgid "Default community is not present in the input."
+msgstr ""
+
+#: /home/ron/prace/oarepo-communities/oarepo_communities/errors.py:34
+msgid "Communities are not present in the input."
+msgstr ""

oarepo_communities/i18n/webpack.py

@@ -9,7 +9,9 @@
             "entry": {},
             "dependencies": {},
             "devDependencies": {},
-            "aliases": {"@translations/oarepo_communities": "translations/oarepo_communities/i18next.js"},
+            "aliases": {
+                "@translations/oarepo_communities": "translations/oarepo_communities/i18next.js"
+            },
         }
     },
 )

oarepo_communities/identity_to_entity_references.py

@@ -1,4 +1,12 @@
-def community_role_mappings(identity):
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from flask_principal import Identity
+
+
+def community_role_mappings(identity: Identity) -> list[dict[str, str]]:
     community_roles = [
         (n.value, n.role) for n in identity.provides if n.method == "community"
     ]

oarepo_communities/notifications/generators.py

@@ -0,0 +1,31 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from invenio_access.models import User
+from invenio_communities.members.records.models import MemberModel
+from invenio_notifications.models import Recipient
+from oarepo_requests.notifications.generators import SpecificEntityRecipient
+
+if TYPE_CHECKING:
+    from typing import Any
+
+
+class CommunityRoleEmailRecipient(SpecificEntityRecipient):
+    """Community role recipient generator for a notification."""
+
+    def _get_recipients(self, entity: Any) -> dict[Recipient]:
+        community_id = entity.community_id
+        role = entity.role
+
+        return {
+            user.email: Recipient(data={"email": user.email})
+            for user in (
+                User.query.join(MemberModel)
+                .filter(
+                    MemberModel.role == role,
+                    MemberModel.community_id == str(community_id),
+                )
+                .all()
+            )
+        }

oarepo_communities/records/systemfields/communities.py

@@ -15,5 +15,5 @@
 
 class OARepoCommunitiesFieldContext(MappingSystemFieldMixin, CommunitiesFieldContext):
     @property
-    def mapping(self):
+    def mapping(self) -> dict:
         return COMMUNITIES_MAPPING