feat(notifications): switch to notella

Author: gwennlbh

.changeset/fair-coats-talk.md

@@ -0,0 +1,7 @@
+---
+'@churros/api': minor
+'@churros/app': minor
+'@churros/db': minor
+---
+
+deprecate Article.notifiedAt

.changeset/purple-chefs-heal.md

@@ -0,0 +1,5 @@
+---
+'@churros/api': major
+---
+
+notifications are now handled by a separate scheduler process, see git.inpt.fr/churros/notella

.changeset/tall-ads-double.md

@@ -0,0 +1,5 @@
+---
+'@churros/api': major
+---
+
+default value for Mutation.acknowledgeChangelog:version and Query.combinedChangelog:to were removed

.env.example

@@ -9,9 +9,6 @@ REDIS_URL="redis://localhost:6379"
 PROMETHEUS_URL="http://localhost:9090"
 # School
 PUBLIC_SCHOOL_UID="o"
-# Notifications
-PUBLIC_VAPID_KEY="BO9G7s2ya5I-tgsClQs5m618yT5uwZkuWCVY0LC1Bvg_K_RsXF6dpNtipxzmrJeXZWbkDB-NkOnR_Tp3T9sOlNg"
-VAPID_PRIVATE_KEY="pud3TjuDNEf3fvkZ6JzVcKsymPdLrQTOhSeovEkERWU"
 # Lydia
 PUBLIC_LYDIA_API_URL="https://lydia-app.com"
 LYDIA_WEBHOOK_URL="http://localhost:5173/lydia-webhook"
@@ -126,9 +123,16 @@ PUBLIC_API_ORIGIN_WEB="http://localhost:4000"
 # To test on a physical device, install ngrok, setup your auth token, run `yarn ngrok` and set these origins to the ngrok URLs (API and frontend ports will be exposed to the Internet via Ngrok)
 PUBLIC_API_ORIGIN_ANDROID="http://10.0.2.2:4000"
 PUBLIC_FRONTEND_ORIGIN_ANDROID="http://10.0.2.2:5173"
-# JSON contents of the service account key file from Firebase Console
-FIREBASE_ADMIN_SERVICE_ACCOUNT_KEY=""
 PUBLIC_APP_PACKAGE_ID="app.churros"
+# Notella notifications scheduler server NATS URL. See https://git.inpt.fr/churros/notella
+NOTELLA_NATS_URL="nats://localhost:4222"
+NOTELLA_HEALTHCHECK_ENDPOINT="http://localhost:8080/health"
+# Used by notella, see services.notella in the docker-compose.yml
+PUBLIC_VAPID_KEY="BO9G7s2ya5I-tgsClQs5m618yT5uwZkuWCVY0LC1Bvg_K_RsXF6dpNtipxzmrJeXZWbkDB-NkOnR_Tp3T9sOlNg"
+# Used by notella, see services.notella in the docker-compose.yml
+VAPID_PRIVATE_KEY=""
+# Used by notella, see services.notella in the docker-compose.yml
+FIREBASE_ADMIN_SERVICE_ACCOUNT_KEY=""
 # Token to execute Mutation.housekeep
 HOUSEKEEPER_TOKEN="housekeeper"
 # In development, to test the webhook, you can start a quick & dirty server with `python -m http.server SOME_PORT` and use `http://localhost:SOME_PORT` here

.gitlab-ci.yml

@@ -10,3 +10,4 @@ include:
   - ci/volta.gitlab-ci.yml
   - ci/build.gitlab-ci.yml
   - ci/test.gitlab-ci.yml
+  - ci/misc.gitlab-ci.yml

CONTRIBUTING.md

@@ -87,7 +87,7 @@ Parmis d'autres choses, sont notamment lancés:
 
 - <http://localhost:5173>: l'application
 - <http://localhost:4000>: l'API
-- <http://localhost:8025>: un serveur mail de test reçevant tout les mails envoyés par l'application
+- <http://localhost:8025>: un serveur mail de test reçevant tout les mails envoyés par l'application: démarrer le docker compose avec le profil `mails` en plus: `docker compose --profile mails up -d`
 
 On peut lancer Prisma Studio pour inspecter la base de données:
 

Dockerfile

@@ -106,7 +106,7 @@ WORKDIR /app
 
 ENV NODE_ENV="production"
 
-RUN apk add --update --no-cache openssl
+RUN apk add --update --no-cache openssl git
 
 # Prisma
 COPY --from=builder-api /app/packages/db/prisma/ /app/packages/db/prisma/

ci/misc.gitlab-ci.yml

@@ -0,0 +1,11 @@
+trigger-notella-update:
+  stage: changesets
+  allow_failure: true
+  rules:
+    - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH
+      changes: [packages/db/prisma/schema.prisma]
+    - when: manual
+  variables:
+    SCHEMA_RAW_URL: $CI_PROJECT_URL/-/raw/$CI_COMMIT_SHA/packages/db/prisma/schema.prisma
+  trigger:
+    project: $CI_PROJECT_NAMESPACE/notella

docker-compose.yml

@@ -5,19 +5,58 @@ services:
       - 5432:5432
     environment:
       - POSTGRES_PASSWORD=dev
+
   smtp:
+    profiles:
+      - mails
     image: mailhog/mailhog
     ports:
       - 1025:1025
       - 8025:8025
+
   redis:
     image: redis/redis-stack:7.2.0-v11
     ports:
       - 6379:6379
       - 8001:8001
 
-  # peut être commenté pour alléger la charge du serveur de développement, si l'on est pas en train de tester des choses qui dépendent de prometheus
+  notella:
+    image: registry.inpt.fr/churros/notella:v0.11.1
+    profiles:
+      - notella
+    env_file:
+      - .env
+    ports:
+      - 8080:8080
+    environment:
+      - DATABASE_URL=${DATABASE_URL}
+      - REDIS_URL=${REDIS_URL}
+      - NATS_URL=nats://nats:4222
+      - PUBLIC_VAPID_KEY=${PUBLIC_VAPID_KEY}
+      - VAPID_PRIVATE_KEY=${VAPID_PRIVATE_KEY}
+      - CONTACT_EMAIL=${PUBLIC_CONTACT_EMAIL}
+      - FIREBASE_SERVICE_ACCOUNT=${FIREBASE_ADMIN_SERVICE_ACCOUNT_KEY}
+      - STARTUP_SCHEDULE_RESTORATION=enabled # enabled, disabled, eager
+      - APP_PACKAGE_ID=${PUBLIC_APP_PACKAGE_ID}
+      - HEALTH_CHECK_PORT=8080
+      - DEBUG=1
+    command: >
+      sh -c 'export DATABASE_URL=$${DATABASE_URL/localhost/db} && export REDIS_URL=$${REDIS_URL/localhost/redis} && exec /app/notella'
+
+  nats:
+    profiles:
+      - notella
+    image: nats:2.10.22
+    ports:
+      - '8222:8222'
+      - '4222:4222'
+    volumes:
+      - ./nats-dev-server.conf:/nats-server.conf
+    command: ['-c', '/nats-server.conf']
+
   prometheus:
+    profiles:
+      - prometheus
     image: prom/prometheus
     ports:
       - 9090:9090

nats-dev-server.conf

@@ -0,0 +1,4 @@
+# nats-server.conf
+jetstream {
+  enabled: true
+}