EVG-355: Email notification automation (#150)

* add relations for notifications and notification channels

* fill up notification channels and then create notifications

* use DocumentNode types for GraphQL queries in server-side groups module

* make notification related GraphQL queries use generated typings, split up gql files into folders

* integrate sendinblue API, allow sending, withholding and expiring email notifications

* stub sendinblue API key environment variable where necessary

* update dependencies

* inject SENDINBLUE_API_KEY environment variable from secrets

.github/workflows/workflow.yaml

@@ -19,6 +19,7 @@ jobs:
                   echo "POSTGRES_DB=everglot_app_db" >> .env
                   echo "SESSION_COOKIE_VALIDATION_SECRETS=[\"MySecretCookieValidationSecret123\"]" >> .env
                   echo "AGORA_APP_CERTIFICATE=whatever" >> .env
+                  echo "SENDINBLUE_API_KEY=whatever" >> .env
             - name: "Setup server-side Firebase credentials file"
               run: |
                   echo "${{ secrets.FIREBASE_SERVICE_ACCOUNT_JSON_BASE64 }}" | base64 -d > src/firebaseServiceAccount.json
@@ -97,6 +98,12 @@ jobs:
             - name: Inject Admin Emails from Github Secrets
               run: kubectl create secret generic adminemails --from-literal=admin-emails='${{ secrets.ADMIN_EMAILS }}'
 
+            - name: Delete Sendinblue API Key from Kubernetes Secrets if existed
+              run: kubectl delete secret sendinblueapikey --ignore-not-found
+
+            - name: Inject Sendinblue API Key from Github Secrets
+              run: kubectl create secret generic sendinblueapikey --from-literal=sendinblue-api-key='${{ secrets.SENDINBLUE_API_KEY }}'
+
             - name: Deploy Config to DigitalOcean Kubernetes
               run: kubectl apply -f $GITHUB_WORKSPACE/k8s-setup/everglot/service-deployment.yml
 

.persisted_operations/1f9769588899e34aee2006ff85dbe165fdc1da7e36f7233f40200b61749f7efb.graphql

@@ -0,0 +1,10 @@
+mutation MarkNotificationAsSent($id: Int!, $sentAt: Datetime) {
+  updateNotification(input: {patch: {sentAt: $sentAt}, id: $id}) {
+    notification {
+      id
+      sentAt
+      __typename
+    }
+    __typename
+  }
+}

.persisted_operations/20ed2a63302fafe0cb8c286367689e5df6b422655732cccf7f7ad794e6235f21.graphql

@@ -0,0 +1,9 @@
+query UsersWithoutNativeGroup($lid: Int!, $nativeSize: Int!) {
+  usersWithoutNativeGroup(lid: $lid, first: $nativeSize) {
+    nodes {
+      id
+      __typename
+    }
+    __typename
+  }
+}

.persisted_operations/87385710d4ae10734f8916bce50e540dd35a1ddd85cc2c15723457fad830e6da.graphql

@@ -0,0 +1,6 @@
+query NotificationChannelByName($name: String!) {
+  notificationChannelByName(name: $name) {
+    id
+    __typename
+  }
+}

.persisted_operations/c4ab767dd17854487e034a8d3908de1a0d703ccc5db00f6e25885b83fb3b71e3.graphql

@@ -0,0 +1,9 @@
+mutation CreateGroupUser($userType: UserType!, $userId: Int!, $groupId: Int!) {
+  createGroupUser(input: {groupUser: {userType: $userType, userId: $userId, groupId: $groupId}}) {
+    groupUser {
+      id
+      __typename
+    }
+    __typename
+  }
+}

.persisted_operations/d0bd9bea6c2e17a29bf91b315d5cb089fae4f13d2c19db0d563c2e9d7e890521.graphql

@@ -0,0 +1,9 @@
+query UsersWithoutLearnerGroup($lid: Int!, $lsklid: Int!, $learnerSize: Int!) {
+  usersWithoutLearnerGroup(lid: $lid, lsklid: $lsklid, first: $learnerSize) {
+    nodes {
+      id
+      __typename
+    }
+    __typename
+  }
+}

.persisted_operations/e1b54e7608975ab4f1565bfbf8850d82d02de79c5ca634b9c61cacabbe1e14c4.graphql

@@ -0,0 +1,22 @@
+query OutstandingEmailNotifications {
+  notificationChannelByName(name: "Email") {
+    notificationsByChannelId(orderBy: CREATED_AT_ASC, filter: {sentAt: {isNull: true}}) {
+      nodes {
+        id
+        user {
+          email
+          emailNotificationsEnabled
+          username
+          unconfirmedEmail
+          __typename
+        }
+        params
+        expiresAt
+        withheldUntil
+        __typename
+      }
+      __typename
+    }
+    __typename
+  }
+}

.persisted_operations/ec55bc9f282f269f335da935054a786d8bd69475be27ce0e432b2e304bcdaa8b.graphql

@@ -0,0 +1,13 @@
+mutation CreateNotification($channelId: Int!, $userId: Int!, $sentAt: Datetime, $params: JSON, $expiresAt: Datetime, $withheldUntil: Datetime) {
+  createNotification(input: {notification: {userId: $userId, channelId: $channelId, params: $params, sentAt: $sentAt, expiresAt: $expiresAt, withheldUntil: $withheldUntil}}) {
+    clientMutationId
+    notification {
+      createdAt
+      expiresAt
+      withheldUntil
+      id
+      __typename
+    }
+    __typename
+  }
+}

docker-compose.test.yml

@@ -26,6 +26,7 @@ services:
             DATABASE_URL: "postgres://${POSTGRES_USER}:${POSTGRES_PASSWORD}@${PGHOST:-everglot-db}:${PGPORT}/${POSTGRES_DB}"
             SESSION_COOKIE_VALIDATION_SECRETS: ${SESSION_COOKIE_VALIDATION_SECRETS:?Please set SESSION_COOKIE_VALIDATION_SECRETS}
             AGORA_APP_CERTIFICATE: ""
+            SENDINBLUE_API_KEY: ""
         entrypoint: entrypoints/test-after-app.sh
         # Avoid building the same image twice.
         image: everglot-app-image

docker-compose.yml

@@ -18,6 +18,7 @@ services:
             DATABASE_URL: "postgres://${POSTGRES_USER}:${POSTGRES_PASSWORD}@${PGHOST:-everglot-db}:${PGPORT}/${POSTGRES_DB}"
             SESSION_COOKIE_VALIDATION_SECRETS: ${SESSION_COOKIE_VALIDATION_SECRETS:?Please set SESSION_COOKIE_VALIDATION_SECRETS}
             AGORA_APP_CERTIFICATE: ${AGORA_APP_CERTIFICATE:?Please set AGORA_APP_CERTIFICATE}
+            SENDINBLUE_API_KEY: ${SENDINBLUE_API_KEY:?Please set SENDINBLUE_API_KEY}
 
     everglot-db:
         image: postgres:13-alpine