Merge pull request #182 from topcoder-platform/feature/project_activity

Feature/project activity

Author: RishiRajSahu

.gitignore

@@ -1,6 +1,8 @@
 
 # Created by https://www.gitignore.io/api/node
 config/local.js
+# can be used locally to config some env variables and after apply them using `source .env`
+.env
 ### Node ###
 # Logs
 logs

README.md

@@ -18,7 +18,7 @@ Microservice to manage CRUD operations for all things Projects.
 Copy config/sample.local.js as config/local.js, update the properties and according to your env setup
 
 #### Database
-Once you start your PostgreSQL database through docker, it will create a projectsDB.
+Once you start your PostgreSQL database through docker, it will create a projectsdb.
 *To create tables - note this will drop tables if they already exist*
 ```
 NODE_ENV=development npm run sync:db
@@ -40,6 +40,33 @@ Run `npm run sync:es` from the root of project to execute the script.
 
 **NOTE**: In production these dependencies / services are hosted & managed outside tc-projects-service.
 
+#### Kafka
+Kafka must be installed and configured prior starting the application.
+Following topics must be created:
+```
+notifications.connect.project.updated
+notifications.connect.project.files.updated
+notifications.connect.project.team.updated
+notifications.connect.project.plan.updated
+notifications.connect.project.topic.created
+notifications.connect.project.topic.updated
+notifications.connect.project.post.created
+notifications.connect.project.post.edited
+```
+
+New Kafka related configuration options has been introduced:
+```
+"kafkaConfig": {
+    "hosts": List of Kafka brokers. Default: localhost: 9092
+    "clientCert": SSL certificate
+    "clientCertKey": Certificate key
+}
+```
+Environment variables:
+KAFKA_HOSTS - same as "hosts"
+KAFKA_CLIENT_CERT - same as "clientCert"
+KAFKA_CLIENT_CERT_KEY - same as "clientCertKey"
+
 ### Test
 
 Each of the individual modules/services are unit tested.

config/custom-environment-variables.json

@@ -29,6 +29,11 @@
     "maxPoolSize": "DB_MAX_POOL_SIZE",
     "minPoolSize": "DB_MIN_POOL_SIZE"
   },
+  "kafkaConfig": {
+    "hosts": "KAFKA_HOSTS",
+    "clientCert": "KAFKA_CLIENT_CERT",
+    "clientCertKey": "KAFKA_CLIENT_CERT_KEY"
+  },
   "analyticsKey": "SEGMENT_ANALYTICS_KEY",
   "VALID_ISSUERS": "VALID_ISSUERS",
   "jwksUri": "JWKS_URI",

config/default.json

@@ -33,6 +33,8 @@
     "minPoolSize": 4,
     "idleTimeout": 1000
   },
+  "kafkaConfig": {
+  },
   "analyticsKey": "",
   "VALID_ISSUERS": "[\"https:\/\/topcoder-newauth.auth0.com\/\",\"https:\/\/api.topcoder-dev.com\"]",
   "validIssuers": "[\"https:\/\/topcoder-newauth.auth0.com\/\",\"https:\/\/api.topcoder-dev.com\"]",

migrations/20180910_project_activity.sql

@@ -0,0 +1,18 @@
+--
+-- UPDATE EXISTING TABLES:
+--   projects:
+--     added column `lastActivityAt`
+--     added column `lastActivityUserId`
+
+--
+-- projects
+
+-- Add new columns
+ALTER TABLE projects ADD COLUMN "lastActivityAt" timestamp with time zone;
+ALTER TABLE projects ADD COLUMN "lastActivityUserId" character varying(45);
+-- Update new colums
+UPDATE projects SET "lastActivityAt"="updatedAt" WHERE "lastActivityAt" is NULL;
+UPDATE projects SET "lastActivityUserId"=cast("updatedBy" as varchar) WHERE "lastActivityUserId" is NULL;
+-- Set not null
+ALTER TABLE projects ALTER COLUMN "lastActivityAt" SET NOT NULL;
+ALTER TABLE projects ALTER COLUMN "lastActivityUserId" SET NOT NULL;

migrations/elasticsearch_sync.js

@@ -281,6 +281,13 @@ function getRequestBody(indexName) {
       updatedBy: {
         type: 'integer',
       },
+      lastActivityAt: {
+        type: 'date',
+        format: 'strict_date_optional_time||epoch_millis',
+      },
+      lastActivityUserId: {
+        type: 'string',
+      },
       utm: {
         properties: {
           campaign: {