✨ adds notifications service (⚠️ devops) (#7436)

Co-authored-by: Andrei Neagu <[email protected]>

Author: GitHK

.env-devel

@@ -132,7 +132,7 @@ DYNAMIC_SIDECAR_API_SAVE_RESTORE_STATE_TIMEOUT=01:00:00
 DIRECTOR_V2_TRACING=null
 
 # DYNAMIC_SCHEDULER ----
-DYNAMIC_SCHEDULER_LOGLEVEL=DEBUG
+DYNAMIC_SCHEDULER_LOGLEVEL=INFO
 DYNAMIC_SCHEDULER_PROFILING=1
 DYNAMIC_SCHEDULER_USE_INTERNAL_SCHEDULER=0
 DYNAMIC_SCHEDULER_STOP_SERVICE_TIMEOUT=01:00:00
@@ -164,6 +164,9 @@ INVITATIONS_TRACING=null
 LOG_FORMAT_LOCAL_DEV_ENABLED=1
 LOG_FILTER_MAPPING='{}'
 
+NOTIFICATIONS_LOGLEVEL=INFO
+NOTIFICATIONS_TRACING=null
+
 PAYMENTS_ACCESS_TOKEN_EXPIRE_MINUTES=30
 PAYMENTS_ACCESS_TOKEN_SECRET_KEY=2c0411810565e063309be1457009fb39ce023946f6a354e6935107b57676
 PAYMENTS_AUTORECHARGE_DEFAULT_MONTHLY_LIMIT=10000

.github/CODEOWNERS

@@ -35,6 +35,7 @@ Makefile                                           @pcrespov @sanderegg
 /services/efs-guardian/                            @matusdrobuliak66
 /services/invitations/                             @pcrespov
 /services/migration/                               @pcrespov
+/services/notifications/                           @GitHK
 /services/payments/                                @pcrespov @matusdrobuliak66
 /services/resource-usage-tracker/                  @matusdrobuliak66
 /services/static-webserver/                        @GitHK

.github/workflows/ci-testing-deploy.yml

@@ -62,6 +62,7 @@ jobs:
       settings-library: ${{ steps.filter.outputs.settings-library }}
       simcore-sdk: ${{ steps.filter.outputs.simcore-sdk }}
       agent: ${{ steps.filter.outputs.agent }}
+      notifications: ${{ steps.filter.outputs.notifications }}
       api: ${{ steps.filter.outputs.api }}
       api-server: ${{ steps.filter.outputs.api-server }}
       autoscaling: ${{ steps.filter.outputs.autoscaling }}
@@ -150,6 +151,12 @@ jobs:
               - 'services/docker-compose*'
               - 'scripts/mypy/*'
               - 'mypy.ini'
+            notifications:
+              - 'packages/**'
+              - 'services/notifications/**'
+              - 'services/docker-compose*'
+              - 'scripts/mypy/*'
+              - 'mypy.ini'
             api:
               - 'api/**'
             api-server:
@@ -602,6 +609,49 @@ jobs:
         with:
           flags: unittests #optional
 
+  unit-test-notifications:
+    needs: changes
+    if: ${{ needs.changes.outputs.notifications == 'true' || github.event_name == 'push' }}
+    timeout-minutes: 18 # if this timeout gets too small, then split the tests
+    name: "[unit] notifications"
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        python: ["3.11"]
+        os: [ubuntu-24.04]
+      fail-fast: false
+    steps:
+      - uses: actions/checkout@v4
+      - name: setup docker buildx
+        id: buildx
+        uses: docker/setup-buildx-action@v3
+        with:
+          driver: docker-container
+      - name: setup python environment
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python }}
+      - name: install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          version: "0.5.x"
+          enable-cache: false
+          cache-dependency-glob: "**/notifications/requirements/ci.txt"
+      - name: show system version
+        run: ./ci/helpers/show_system_versions.bash
+      - name: install
+        run: ./ci/github/unit-testing/notifications.bash install
+      - name: typecheck
+        run: ./ci/github/unit-testing/notifications.bash typecheck
+      - name: test
+        if: ${{ !cancelled() }}
+        run: ./ci/github/unit-testing/notifications.bash test
+      - uses: codecov/codecov-action@v5
+        if: ${{ !cancelled() }}
+        env:
+          CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
+        with:
+          flags: unittests #optional
 
   unit-test-api:
     needs: changes
@@ -1834,6 +1884,7 @@ jobs:
         unit-test-common-library,
         unit-test-notifications-library,
         unit-test-payments,
+        unit-test-notifications,
         unit-test-dynamic-scheduler,
         unit-test-postgres-database,
         unit-test-python-linting,

Makefile

@@ -44,6 +44,7 @@ SERVICES_NAMES_TO_BUILD := \
 	efs-guardian \
 	invitations \
   migration \
+	notifications \
 	payments \
 	resource-usage-tracker \
 	dynamic-scheduler \

ci/github/unit-testing/notifications.bash

@@ -0,0 +1,43 @@
+#!/bin/bash
+# http://redsymbol.net/articles/unofficial-bash-strict-mode/
+set -o errexit  # abort on nonzero exitstatus
+set -o nounset  # abort on unbound variable
+set -o pipefail # don't hide errors within pipes
+IFS=$'\n\t'
+
+install() {
+  make devenv
+  # shellcheck source=/dev/null
+  source .venv/bin/activate
+  pushd services/notifications
+  make install-ci
+  popd
+  uv pip list
+}
+
+test() {
+  # shellcheck source=/dev/null
+  source .venv/bin/activate
+  pushd services/notifications
+  make test-ci-unit
+  popd
+}
+
+typecheck() {
+  # shellcheck source=/dev/null
+  source .venv/bin/activate
+  uv pip install mypy
+  pushd services/notifications
+  make mypy
+  popd
+}
+
+# Check if the function exists (bash specific)
+if declare -f "$1" >/dev/null; then
+  # call arguments verbatim
+  "$@"
+else
+  # Show a helpful error
+  echo "'$1' is not a known function name" >&2
+  exit 1
+fi

packages/models-library/src/models_library/api_schemas_notifications/__init__.py

@@ -0,0 +1,9 @@
+from typing import Final
+
+from pydantic import TypeAdapter
+
+from ..rabbitmq_basic_types import RPCNamespace
+
+NOTIFICATIONS_RPC_NAMESPACE: Final[RPCNamespace] = TypeAdapter(
+    RPCNamespace
+).validate_python("notifications")

packages/models-library/src/models_library/errors.py

@@ -34,9 +34,10 @@ class ErrorDict(_ErrorDictRequired, total=False):
     ctx: dict[str, Any]
 
 
-RABBITMQ_CLIENT_UNHEALTHY_MSG = "RabbitMQ client is in a bad state!"
+RABBITMQ_CLIENT_UNHEALTHY_MSG = "RabbitMQ cannot be reached!"
+POSRGRES_DATABASE_UNHEALTHY_MSG = "Postgres cannot be reached!"
 REDIS_CLIENT_UNHEALTHY_MSG = "Redis cannot be reached!"
-DOCKER_API_PROXY_UNHEALTHY_MSG = "docker-api-proxy service is not reachable!"
+DOCKER_API_PROXY_UNHEALTHY_MSG = "docker-api-proxy cannot be reached!"
 
 
 # NOTE: Here we do not just import as 'from pydantic.error_wrappers import ErrorDict'

packages/pytest-simcore/src/pytest_simcore/simcore_services.py

@@ -47,6 +47,7 @@
     "autoscaling": "/",
     "clusters-keeper": "/",
     "dask-scheduler": "/health",
+    "notifications": "/",
     "datcore-adapter": "/v0/live",
     "director-v2": "/",
     "dynamic-schdlr": "/",

services/docker-compose-build.yml

@@ -169,6 +169,23 @@ services:
         org.opencontainers.image.source: "${VCS_URL}"
         org.opencontainers.image.revision: "${VCS_REF}"
 
+  notifications:
+    image: local/notifications:${BUILD_TARGET:?build_target_required}
+    build:
+      context: ../
+      dockerfile: services/notifications/Dockerfile
+      cache_from:
+        - local/notifications:${BUILD_TARGET:?build_target_required}
+        - ${DOCKER_REGISTRY:-itisfoundation}/notifications:master-github-latest
+        - ${DOCKER_REGISTRY:-itisfoundation}/notifications:staging-github-latest
+        - ${DOCKER_REGISTRY:-itisfoundation}/notifications:release-github-latest
+      target: production
+      labels:
+        org.label-schema.schema-version: "1.0"
+        org.opencontainers.image.created: "${BUILD_DATE}"
+        org.opencontainers.image.source: "${VCS_URL}"
+        org.opencontainers.image.revision: "${VCS_REF}"
+
   resource-usage-tracker:
     image: local/resource-usage-tracker:${BUILD_TARGET:?build_target_required}
     build:

services/docker-compose-deploy.yml

@@ -25,6 +25,8 @@ services:
     image: ${DOCKER_REGISTRY:-itisfoundation}/invitations:${DOCKER_IMAGE_TAG:-latest}
   migration:
     image: ${DOCKER_REGISTRY:-itisfoundation}/migration:${DOCKER_IMAGE_TAG:-latest}
+  notifications:
+    image: ${DOCKER_REGISTRY:-itisfoundation}/notifications:${DOCKER_IMAGE_TAG:-latest}
   payments:
     image: ${DOCKER_REGISTRY:-itisfoundation}/payments:${DOCKER_IMAGE_TAG:-latest}
   dynamic-scheduler: