Initial commit

Author: gondzo

.eslintrc

@@ -0,0 +1,20 @@
+{
+  "extends": "airbnb-base",
+  "rules": {
+    "no-use-before-define": 1,
+    "strict": 0,
+    "comma-dangle": 1,
+    "func-names": 0,
+    "no-underscore-dangle": 0,
+    "prefer-rest-params": 0,
+    "no-param-reassign": 0,
+    "prefer-template": 0,
+    "new-cap": 0,
+    "global-require": 0,
+    "consistent-return": 0,
+    "max-len": [2, 120]
+  },
+  "parserOptions": {
+    "ecmaVersion": 6
+  }
+}

.gitignore

@@ -0,0 +1,4 @@
+.idea
+node_modules
+*.log
+.DS_Store

README.md

@@ -0,0 +1,107 @@
+# TOPCODER NOTIFICATIONS SERIES - NOTIFICATIONS SERVER
+
+
+## Dependencies
+- nodejs https://nodejs.org/en/ (v6+)
+- Heroku Toolbelt https://toolbelt.heroku.com
+- git
+- PostgreSQL 9.5
+
+
+## Configuration
+Configuration for the notification server is at `config/default.js`.
+The following parameters can be set in config files or in env variables:
+- LOG_LEVEL: the log level
+- PORT: the notification server port
+- JWT_SECRET: JWT secret
+- DATABASE_URL: URI to PostgreSQL database
+- DATABASE_OPTIONS: database connection options
+- KAFKA_URL: comma separated Kafka hosts
+- KAFKA_TOPIC_IGNORE_PREFIX: ignore this prefix for topics in the Kafka
+- KAFKA_GROUP_ID: Kafka consumer group id
+- KAFKA_CLIENT_CERT: Kafka connection certificate, optional;
+    if not provided, then SSL connection is not used, direct insecure connection is used;
+    if provided, it can be either path to certificate file or certificate content
+- KAFKA_CLIENT_CERT_KEY: Kafka connection private key, optional;
+    if not provided, then SSL connection is not used, direct insecure connection is used;
+    if provided, it can be either path to private key file or private key content
+
+
+Configuration for the connect notification server is at `connect/config.js`.
+The following parameters can be set in config files or in env variables:
+- TC_API_BASE_URL: the TopCoder API base URL
+- TC_ADMIN_TOKEN: the admin token to access TopCoder API
+
+
+Note that the above two configuration are separate because the common notification server config
+will be deployed to a NPM package, the connect notification server will use that NPM package,
+the connection notification server should only use API exposed by the index.js.
+
+
+## JWT Token Generation
+
+JWT token can be generated using the script test/token.js, its usage: `node test/token {user-id}`.
+Then use the generated token to manage the user's notifications.
+
+In the Postman bus API, the `Post Connect event` will create a Kafka event of project id 1936;
+In the Postman notification server API, the `TC API - get project` will get details of project id 1936,
+we can see the project has one member of user id 305384;
+so we can run `node test/token 305384` to generate a token to manage notifications of the user of id 305384.
+
+The generated token is already configured in the Postman notification server API environment TOKEN variable.
+You may reuse it during review.
+
+
+## TC API Admin Token
+
+An admin token is needed to access TC API. This is already configured in connect/config.js and Postman notification
+server API environment TC_ADMIN_TOKEN variable.
+In case it expires, you may get a new token in this way:
+
+- use Chrome to browse connect.topcoder-dev.com
+- open developer tools, click the Network tab
+- log in with suser1 / Topcoder123
+- once logged in, open some project, for example https://connect.topcoder-dev.com/projects/1936 and in the network inspector
+  look for the call to the project api and get the token from the auth header, see
+  http://pokit.org/get/img/68cdd34f3d205d6d9bd8bddb07bdc216.jpg
+
+
+## Local deployment
+- start local PostgreSQL db, create an empty database, update the config/default.js DATABASE_URL param to point to the db
+- install dependencies `npm i`
+- run code lint check `npm run lint`
+- start connect notification server `npm start`
+- the app is running at `http://localhost:3000`, it also starts Kafka consumer to listen for events and save unroll-ed notifications to db
+
+
+## Heroku deployment
+
+- git init
+- git add .
+- git commit -m 'message'
+- heroku login
+- heroku create [application-name] // choose a name, or leave it empty to use generated one
+- heroku addons:create heroku-postgresql:hobby-dev
+- note that you may need to wait for several minutes before the PostgreSQL database is ready
+- optionally, to set some environment variables in heroku, run command like:
+  `heroku config:set KAFKA_CLIENT_CERT=path/to/certificate/file`
+  `heroku config:set KAFKA_CLIENT_CERT_KEY=path/to/private/key/file`
+  `heroku config:set KAFKA_GROUP_ID=some-group`
+  etc.
+- git push heroku master // push code to Heroku
+
+
+## Verification
+
+- start the app following above sections
+- in Postman, using the bus API collection and environment, run the `POST /events` / `Post Connect event` test,
+  you may run it multiple times to create multiple events in Kafka,
+  then you may watch the console output in the app, it should show info about handling the events
+- in Postman, using the notification server API collection and environment, run the tests
+
+
+## Swagger
+
+Swagger API definition is provided at `docs/swagger_api.yaml`,
+you may check it at `http://editor.swagger.io`.
+

config/default.js

@@ -0,0 +1,90 @@
+/**
+ * The configuration file.
+ */
+
+module.exports = {
+  LOG_LEVEL: process.env.LOG_LEVEL || 'info',
+  PORT: process.env.PORT || 3000,
+
+  JWT_SECRET: process.env.JWT_SECRET || 'hjijfvbw859',
+
+  DATABASE_URL: process.env.DATABASE_URL || 'postgres://postgres:123456@localhost:5432/notification',
+  DATABASE_OPTIONS: {
+    dialect: 'postgres',
+    pool: {
+      max: 5,
+      min: 0,
+      idle: 10000,
+    },
+  },
+
+  // comma separated Kafka hosts
+  KAFKA_URL: process.env.KAFKA_URL || 'ec2-34-205-227-216.compute-1.amazonaws.com:9096,ec2-34-233-75-247.compute-1.amazonaws.com:9096,ec2-34-198-118-170.compute-1.amazonaws.com:9096,ec2-34-231-150-104.compute-1.amazonaws.com:9096,ec2-34-233-209-20.compute-1.amazonaws.com:9096,ec2-34-233-131-252.compute-1.amazonaws.com:9096,ec2-52-205-198-73.compute-1.amazonaws.com:9096,ec2-52-4-109-80.compute-1.amazonaws.com:9096', // eslint-disable-line max-len
+
+  // ignore prefix for topics in the Kafka, e.g.
+  // 'joan-26673.notifications.connect.project.updated' is considered as 'notifications.connect.project.updated'
+  KAFKA_TOPIC_IGNORE_PREFIX: process.env.KAFKA_TOPIC_IGNORE_PREFIX || 'joan-26673.',
+
+  // when notification server is deployed to multiple instances, the instances should use same group id so that
+  // Kafka event is not handled duplicately in the group, an event is handled by only one instance in the group
+  KAFKA_GROUP_ID: process.env.KAFKA_GROUP_ID || 'tc-notification-server',
+
+  // Kafka connection certificate, optional;
+  // if not provided, then SSL connection is not used, direct insecure connection is used;
+  // if provided, it can be either path to certificate file or certificate content
+  KAFKA_CLIENT_CERT: process.env.KAFKA_CLIENT_CERT ||
+`-----BEGIN CERTIFICATE-----
+MIIDQzCCAiugAwIBAgIBADANBgkqhkiG9w0BAQsFADAyMTAwLgYDVQQDDCdjYS1j
+YmJiNGVkZi1mNDFhLTRjNzMtYTg5OC01NDYyMjhkNmQyNDIwHhcNMTcwOTI3MDUw
+MTIyWhcNMjcwOTI3MDUwMTIyWjAZMRcwFQYDVQQDDA51ODFvcjFsdTl2dTB1bzCC
+ASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAKjkcV/BXD13Q09bRKohN/sK
+iDMGFA2QZ57TGd7svX7iZQIk9HmXEPd5zCTHZ6nZBbcGDQ9P+zGlJIGZQuRVKLOn
+ZPilaeUHRGrvCWGJZ6lVPNqInC1STHTfFJhcUNMG6qaD2ayBAw16f13vD1wGEWCm
+/DRfvrjIp3JIetGdKctmdiGLYH7CQecRW88Czx9e3Vpl1nxGcNAPDDCj0nRwuPse
+fVrg5onPX355om+Ct/teSeSONhio4dFL3fwl47CXFCReZFYOrBoLexfHXHumJ/Kp
+TQW+k056hhoagykcpTf8uNjxNRalDPkw7ngt+1IzatbhOacea1/WUE1444eEak8C
+AwEAAaN9MHswHQYDVR0OBBYEFJJzd6OZVLthBkhVZEW42CR8NJbtMFoGA1UdIwRT
+MFGAFORcypfrQ0tfS5tyBdv89jfpZEMaoTakNDAyMTAwLgYDVQQDDCdjYS1jYmJi
+NGVkZi1mNDFhLTRjNzMtYTg5OC01NDYyMjhkNmQyNDKCAQAwDQYJKoZIhvcNAQEL
+BQADggEBALVAdOWXdnSqhucXHjpIf0lxlH6WhzhhlctLCreSf+/7y6pPVpWSVIEl
+seVxOE5tsO2OzdtGgN2t7rr6bHuakL5rk9rH06r1jYAVQBR+T6SSLFbSVzl4Q5TO
+b+T9/sHx5QtXSYgMh4FhZcBjrmDmWvpd42Y4MPfjLTqTP8RWHHib8E4/FYS9txk6
+WoxrKcgnm/RmOcFWrjNjgm6JJprO1BSnbc2i/Rs5rxG2tRTTmXp6d7QCRa0bdhKz
+yETgcStnaVvyh64zhls3xXBm06rvpu2wwo6QHcPeekvQwxQvb63oovD8b+pFJri+
+6MBSQE4TtQenlVx7Ksy9UdNmU21xCYU=
+-----END CERTIFICATE-----
+`,
+
+  // Kafka connection private key, optional;
+  // if not provided, then SSL connection is not used, direct insecure connection is used;
+  // if provided, it can be either path to private key file or private key content
+  KAFKA_CLIENT_CERT_KEY: process.env.KAFKA_CLIENT_CERT_KEY ||
+`-----BEGIN RSA PRIVATE KEY-----
+MIIEogIBAAKCAQEAqORxX8FcPXdDT1tEqiE3+wqIMwYUDZBnntMZ3uy9fuJlAiT0
+eZcQ93nMJMdnqdkFtwYND0/7MaUkgZlC5FUos6dk+KVp5QdEau8JYYlnqVU82oic
+LVJMdN8UmFxQ0wbqpoPZrIEDDXp/Xe8PXAYRYKb8NF++uMinckh60Z0py2Z2IYtg
+fsJB5xFbzwLPH17dWmXWfEZw0A8MMKPSdHC4+x59WuDmic9ffnmib4K3+15J5I42
+GKjh0Uvd/CXjsJcUJF5kVg6sGgt7F8dce6Yn8qlNBb6TTnqGGhqDKRylN/y42PE1
+FqUM+TDueC37UjNq1uE5px5rX9ZQTXjjh4RqTwIDAQABAoIBAEGCOid2DJ0awVTq
+hbunntsUvrdryCNqu4ZzQzmgge/RSHSIePsgiUg0SeaKIb9Tmk/fXPlvgHNFJt/N
+3pBKJ7tnVlbLckOPig4gIXdfoIGhujTZgBpkLZu3W3mtdPwlVqa3xZqPf+uedACv
+VTnQcLUYkAKQkJ2D1s8RJfJgD3IA7nbZkzjVdUFdpl5m2Rijs3oLvVYVsAJBSsJK
+AjGWobf9pgvXhUnBxmtWKEYsnrAwNF8j+uXo8uTXZj6KMWSmKMI5urykKw/LiSk3
+u0IsweCE2cqtTgP3Os5b+au/SVNfFlNOLlic/XX3Z28AvupfuoNWx30VpUsqFBE8
+LQEG9EECgYEA3Z6QJKcdMmETN6C0+nMAqdibqMv4su3dmfW3M3Hw4IH/pdsQ7aOa
+tn2w01BxYaYfaPjN4cksmJnYLyAHp3D8nxopKtYnS+ky162Wya1ETowjd5+0X0Lq
+tMGATPzqcysVt+OO+stRuTkLKXy0OANH1OCEhzlPtFEbYDmKt6srRAkCgYEAwxfe
+Ky5eJB63sEkUg0QbXsDr5to1RMrvxjmWVF51LXHBSJl/UFde6l8fOHVtDbG08XGR
+lIsQ4f4vsbNOiR7bim0opYPxcxWCD13GBP1u0eUbBPpU4ac0JT12uMYRg9bB7RMl
+3eWJU3qmddeAOq0oCsC7aimEFih6QCr4TNcxQZcCgYBddrzFqHDIyWXoZO9OXGfg
+OYjUNEmLdIOrpZQAr0Ht/QVK9kt6XTAnXHTRebCHhR7kD2IMoeIb7W3d2f1AYYc4
+tji8ZxqlihC2IvBf16HiGnnuvjy8nCUN3Dl2vodF0NrU9bRcEplBq0wI0B3VLZUC
+szlRKhtyKW6JM1tMQHT7uQKBgEOP+Hirzh5kJOj/5gKvi2r9FLUVzGzOessDFnSR
+YbMjOfSSc+y21UAFQSKkR+f+KtOSqP/wSSB6jrnThtclwJHny7PGRc+9GxWHPBRu
+T/qQhRLsPokHBp/+8SZ8MYSe0vnvL6Xw3+XxC8SzpMytOri+lijlx8CEtBGUz/iM
+bZpxAoGAEnJFUEGCB1ta3RQpI5L4nH2Rex0Avv8rkXGK2T/t5z2h8Ujg4WW3J7DD
+Jp8xItVz3sqz5aCg+EvcewSGZ18AC+9cbxrbI2I83jQDHw+DQmVUyR6rl5+r+S6O
+69wdZ08Y/jYkltb5PbhPqs0Kfr86cUqBuKEptRtto6Wto3k/Za4=
+-----END RSA PRIVATE KEY-----
+`,
+};

connect/config.js

@@ -0,0 +1,8 @@
+/**
+ * The configuration file for connectNotificationServer.js.
+ */
+
+module.exports = {
+  TC_API_BASE_URL: process.env.TC_API_BASE_URL || 'https://api.topcoder-dev.com/v4',
+  TC_ADMIN_TOKEN: process.env.TC_ADMIN_TOKEN || 'eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJyb2xlcyI6WyJUb3Bjb2RlciBVc2VyIiwiYWRtaW5pc3RyYXRvciJdLCJpc3MiOiJodHRwczovL2FwaS50b3Bjb2Rlci1kZXYuY29tIiwiaGFuZGxlIjoic3VzZXIxIiwiZXhwIjoxNTEwNTAxNjM5LCJ1c2VySWQiOiI0MDE1MzkzOCIsImlhdCI6MTUwOTYzNzYzOSwiZW1haWwiOiJtdHdvbWV5QGJlYWtzdGFyLmNvbSIsImp0aSI6IjIzZTE2YjA2LWM1NGItNDNkNS1iY2E2LTg0ZGJiN2JiNDA0NyJ9.Pp0GERZZGxFbNvplc-B4rKJ2DB7IABpcVQTWGSuJItY', // eslint-disable-line max-len
+};

connect/connectNotificationServer.js

@@ -0,0 +1,58 @@
+/**
+ * This is TopCoder connect notification server.
+ */
+'use strict';
+
+const notificationServer = require('../index');
+const request = require('superagent');
+const _ = require('lodash');
+const config = require('./config');
+
+// set configuration for the server, see ../config/default.js for available config parameters
+// setConfig should be called before initDatabase and start functions
+notificationServer.setConfig({ LOG_LEVEL: 'debug' });
+
+// add topic handlers,
+// handler is used to find user ids that should receive notifications for a message of a topic,
+// it is defined as: function(topic, message, callback),
+// the topic is topic name,
+// the message is JSON event message,
+// the callback is function(error, userIds), where userIds is an array of user ids to receive notifications
+const handler = (topic, message, callback) => {
+  const projectId = message.projectId;
+  if (!projectId) {
+    return callback(new Error('Missing projectId in the event message'));
+  }
+
+  // get project details
+  request
+    .get(`${config.TC_API_BASE_URL}/projects/${projectId}`)
+    .set('accept', 'application/json')
+    .set('authorization', `Bearer ${config.TC_ADMIN_TOKEN}`)
+    .end((err, res) => {
+      if (err) {
+        return callback(err);
+      }
+      if (!_.get(res, 'body.result.success')) {
+        return callback(new Error(`Failed to get project details of project id: ${projectId}`));
+      }
+      // return member user ids
+      callback(null, _.map(_.get(res, 'body.result.content.members', []), (member) => member.userId));
+    });
+};
+
+notificationServer.addTopicHandler('notifications.connect.project.created', handler);
+notificationServer.addTopicHandler('notifications.connect.project.updated', handler);
+notificationServer.addTopicHandler('notifications.connect.message.posted', handler);
+notificationServer.addTopicHandler('notifications.connect.message.edited', handler);
+notificationServer.addTopicHandler('notifications.connect.message.deleted', handler);
+notificationServer.addTopicHandler('notifications.connect.project.submittedForReview', handler);
+
+// init database, it will clear and re-create all tables
+notificationServer
+  .initDatabase()
+  .then(() => notificationServer.start())
+  .catch((e) => console.log(e)); // eslint-disable-line no-console
+
+// if no need to init database, then directly start the server:
+// notificationServer.start();