Merge pull request #34 from alkem-io/develop

Notifications Stabilization

Dockerfile

@@ -15,6 +15,10 @@ COPY package*.json ./
 RUN npm i -g [email protected]
 RUN npm install
 
+## Add the wait script to the image
+ADD https://github.com/ufoscout/docker-compose-wait/releases/download/2.7.3/wait /wait
+RUN chmod +x /wait
+
 # If you are building your code for production
 # RUN npm ci --only=production
 
@@ -28,5 +32,4 @@ RUN npm run build
 
 ENV NODE_ENV=${ENV_ARG}
 
-EXPOSE ${GRAPHQL_ENDPOINT_PORT_ARG}
 CMD ["/bin/sh", "-c", "npm run start:prod"]

README.md

@@ -13,7 +13,7 @@ Alkemio out-of-band notifications service.
 2. Start mailslurper:
 
 ```
-docker-compose -f quickstart-mailslurper.yml -f quickstart-notifications.yml --env-file .env.docker up --build --force-recreate
+npm run start:services
 ```
 
 3. Go to http://localhost:15672/#/queues/%2F/alkemio-notifications.

notifications.yml

@@ -76,8 +76,8 @@ hosting:
 alkemio:
   endpoint: ${ALKEMIO_SERVER_ENDPOINT}:http://localhost:3000/admin/graphql
   service_account:
-    username: ${SERVICE_ACCOUNT_USERNAME}:admin@alkem.io
-    password: ${SERVICE_ACCOUNT_PASSWORD}:obichamazis
+    username: ${SERVICE_ACCOUNT_USERNAME}:notifications@alkem.io
+    password: ${SERVICE_ACCOUNT_PASSWORD}:change-me-now
 
 kratos:
   public_endpoint: ${KRATOS_API_PUBLIC_ENDPOINT}:http://localhost:3000/identity/ory/kratos/public

package.json

@@ -1,6 +1,6 @@
 {
   "name": "alkemio-notifications",
-  "version": "0.3.0",
+  "version": "0.3.1",
   "description": "Alkemio notifications service",
   "author": "Cherrytwist Foundation",
   "private": false,
@@ -20,6 +20,7 @@
     "start:dev": "nest start --watch",
     "start:debug": "nest start --debug --watch",
     "start:prod": "node dist/main",
+    "start:services": "docker-compose -f quickstart-mailslurper.yml --env-file .env.docker up --build --force-recreate",
     "lint": "tsc --noEmit && eslint src/**/*.ts{,x}",
     "lint:prod": "tsc --noEmit && cross-env NODE_ENV=production eslint src/**/*.ts{,x}",
     "lint:fix": "tsc --noEmit && eslint src/**/*.ts{,x} --fix",
@@ -29,10 +30,11 @@
     "test:debug": "node --inspect-brk -r tsconfig-paths/register -r ts-node/register node_modules/.bin/jest --runInBand",
     "test:ci:coverage": "jest --runInBand --config ./test/config/jest.config.ci.js && cat ./coverage-ci/lcov.info | coveralls",
     "test:ci": "jest --runInBand --config ./test/config/jest.config.ci.js",
-    "typeorm": "ts-node -r tsconfig-paths/register ./node_modules/typeorm/cli.js --config src/config/typeorm.cli.config.ts"
+    "typeorm": "ts-node -r tsconfig-paths/register ./node_modules/typeorm/cli.js --config src/config/typeorm.cli.config.ts",
+    "validate-connection": "ts-node src/utils/validate-connection.ts"
   },
   "dependencies": {
-    "@alkemio/client-lib": "^0.9.9",
+    "@alkemio/client-lib": "^0.10.1",
     "@nestjs/axios": "^0.0.1",
     "@nestjs/common": "^8.0.5",
     "@nestjs/config": "^1.0.1",
@@ -47,6 +49,7 @@
     "class-transformer": "^0.4.0",
     "class-validator": "^0.13.1",
     "cross-env": "^7.0.3",
+    "dotenv": "^10.0.0",
     "helmet": "^4.6.0",
     "module-alias": "^2.2.2",
     "nest-winston": "^1.5.0",

quickstart-mailslurper.yml

@@ -8,8 +8,8 @@ services:
     container_name: alkemio_notifications_mailslurper
     image: oryd/mailslurper:latest-smtps
     ports:
-      - 4436
-      - 5051:4437
+      - 4436:4436
+      - 4437:4437
       - 1025:1025
     networks:
       - alkemio_notifications_net

src/app.controller.ts

@@ -2,7 +2,7 @@ import { Controller, Inject, LoggerService } from '@nestjs/common';
 import { Ctx, EventPattern, Payload, RmqContext } from '@nestjs/microservices';
 import { WINSTON_MODULE_NEST_PROVIDER } from 'nest-winston';
 import { Channel, Message } from 'amqplib';
-import { ALKEMIO_CLIENT_ADAPTER } from './common';
+import { ALKEMIO_CLIENT_ADAPTER, LogContext } from './common';
 import { NotificationService } from '@src/services';
 import { IFeatureFlagProvider } from '@core/contracts';
 import { ApplicationCreatedEventPayload } from '@src/types/application.created.event.payload';
@@ -23,30 +23,29 @@ export class AppController {
     @Payload() payload: ApplicationCreatedEventPayload,
     @Ctx() context: RmqContext
   ) {
+    this.logger.verbose?.(JSON.stringify(payload), LogContext.NOTIFICATIONS);
+
     const channel: Channel = context.getChannelRef();
     const originalMsg = context.getMessage() as Message;
 
     if (!(await this.featureFlagProvider.areNotificationsEnabled())) {
-      //toDo make this nack
       channel.ack(originalMsg);
+      return;
     }
 
     this.notificationService
       .sendApplicationNotifications(payload)
       .then(x => {
-        const shouldNack = x.some(y => y.status === 'rejected');
+        const nacked = x.filter(y => y.status === 'rejected');
 
-        if (shouldNack) {
-          //toDo make this nack
-          channel.ack(originalMsg);
+        if (nacked.length === 0) {
+          this.logger.verbose?.(`All ${x.length} messages successfully sent!`);
         } else {
-          channel.ack(originalMsg);
+          this.logger.verbose?.(`${nacked.length} messages failed to be sent!`);
         }
       })
       .catch(err => {
         this.logger.error(err);
-        // toDo check how to reject a message
-        // channel.reject(originalMsg);
       });
   }
 }

src/common/constants/defaults.ts

@@ -0,0 +1,9 @@
+export const DEFAULT_ENDPOINTS = {
+  alkemioServer: 'http://localhost:3000/admin/graphql',
+  kratosApiEndpoint: 'http://localhost:3000/identity/ory/kratos/public',
+};
+
+export const DEFAULT_SERVICE_ACCOUNT_CREDENTIALS = {
+  email: '[email protected]',
+  password: 'change-me-now',
+};

src/common/constants/index.ts

@@ -0,0 +1 @@
+export * from './defaults';

src/common/index.ts

@@ -1,2 +1,3 @@
 export * from './enums';
 export * from './exceptions';
+export * from './constants';

src/services/alkemio-client-adapter/alkemio.client.adapter.ts

@@ -24,7 +24,8 @@ export class AlkemioClientAdapter
 
   async getApplicant(payload: any): Promise<User> {
     const applicant = await this.alkemioClient.user(payload.applicantID);
-    if (!applicant) throw new Error('Applicant not found!');
+    if (!applicant)
+      throw new Error(`Applicant with id: ${payload.applicantID} not found!`);
 
     return applicant;
   }

src/services/application-notification-builder/application.notification.builder.ts

@@ -91,7 +91,7 @@ export class ApplicationNotificationBuilder {
 }
 
 const getBaseNotification = (payload: any, applicant: User) => ({
-  emailFrom: '<[email protected]>',
+  emailFrom: '[email protected]',
   applicant: {
     name: applicant.displayName,
     email: applicant.email,

src/templates/_layouts/email-transactional.html

@@ -253,10 +253,22 @@
                               white-space: nowrap;
                             "
                           >
-                             
                           </div>
                         </td>
                       </tr>
+                    <tr>
+                      <td>
+                        <b>Team Alkemio</b>
+                        <br>
+                        <b>website</b>: <a href="https://alkem.io">https://alkem.io</a>
+                        <br>
+                        <a href="https://alkem.io">
+                          <img src="https://alkem.io/uploads/logos/alkemio-logo.png" width="120">
+                        </a>
+                        <br>
+                        <i>Enabling society to collaborate. Building a better future, together.</i>
+                      </td>
+                    </tr>
                     </tbody>
                   </table>
                 </div>

src/utils/validate-connection.ts

@@ -0,0 +1,46 @@
+import { AlkemioClient } from '@alkemio/client-lib';
+import {
+  DEFAULT_ENDPOINTS,
+  DEFAULT_SERVICE_ACCOUNT_CREDENTIALS,
+} from '@src/common/constants/defaults';
+import * as dotenv from 'dotenv';
+
+const main = async () => {
+  dotenv.config();
+
+  const alkemioClient = new AlkemioClient({
+    graphqlEndpoint:
+      process.env.ALKEMIO_SERVER_ENDPOINT ?? DEFAULT_ENDPOINTS.alkemioServer,
+    authInfo: {
+      credentials: {
+        email:
+          process.env.SERVICE_ACCOUNT_USERNAME ??
+          DEFAULT_SERVICE_ACCOUNT_CREDENTIALS.email,
+        password:
+          process.env.SERVICE_ACCOUNT_PASSWORD ??
+          DEFAULT_SERVICE_ACCOUNT_CREDENTIALS.password,
+      },
+      kratosPublicApiEndpoint:
+        process.env.KRATOS_API_PUBLIC_ENDPOINT ??
+        DEFAULT_ENDPOINTS.kratosApiEndpoint,
+    },
+  });
+
+  console.log(`Client config: ${JSON.stringify(alkemioClient.config)}`);
+  await alkemioClient.enableAuthentication();
+
+  console.log(`API Token: ${alkemioClient.apiToken}`);
+
+  const serverVersion = await alkemioClient.validateConnection();
+  console.log(`Alkemio platform version: ${serverVersion}`);
+
+  const hubID = 'Test';
+  const hubExists = await alkemioClient.hubExists(hubID);
+  console.log(`Hub '${hubID}' exists: ${hubExists}`);
+};
+
+try {
+  main();
+} catch (error) {
+  console.error(error);
+}

src/wrappers/alkemio-client/alkemio.client.factory.ts

@@ -9,7 +9,11 @@ export async function alkemioClientFactory(
 ): Promise<AlkemioClient | undefined> {
   try {
     const server = configService.get(ConfigurationTypes.ALKEMIO)?.endpoint;
-    const alkemioClient = new AlkemioClient({
+    const kratosApiEndpoint = configService.get(
+      ConfigurationTypes.KRATOS
+    )?.public_endpoint;
+
+    const alkemioClientConfig = {
       graphqlEndpoint: server,
       authInfo: {
         credentials: {
@@ -18,11 +22,14 @@ export async function alkemioClientFactory(
           password: configService.get(ConfigurationTypes.ALKEMIO)
             ?.service_account?.password,
         },
-        apiEndpointFactory: () => {
-          return configService.get(ConfigurationTypes.KRATOS)?.public_endpoint;
-        },
+        kratosPublicApiEndpoint: kratosApiEndpoint,
       },
-    });
+    };
+    logger.verbose?.(
+      `Alkemio client config: ${JSON.stringify(alkemioClientConfig)}`,
+      LogContext.NOTIFICATIONS
+    );
+    const alkemioClient = new AlkemioClient(alkemioClientConfig);
 
     await alkemioClient.enableAuthentication();