Merge pull request #4 from topcoder-platform/feature/use-projects-api

Feature - Replace direct Project DB queries with Projects API calls

Author: vikasrohit

.gitignore

@@ -5,3 +5,4 @@ node_modules
 .env
 .nyc_output
 coverage/
+docker/api.env

ReadMe.md

@@ -5,7 +5,6 @@
 - nodejs https://nodejs.org/en/ (v8)
 - Kafka
 - Informix
-- Postgres
 - Docker, Docker Compose
 
 ## Configuration
@@ -25,9 +24,15 @@ The following parameters can be set in config files or in env variables:
 - UPDATE_PROJECT_TOPIC: update project Kafka topic, default value is 'project.action.update'
 - DELETE_PROJECT_TOPIC: delete project member Kafka topic, default value is 'project.action.delete'
 - INFORMIX: Informix database configuration parameters, refer `config/default.js` for more information
-- POSTGRES: Postgres database configuration parameters, refer `config/default.js` for more information
+- AUTH0_URL: AUTH0 URL, used to get M2M token
+- AUTH0_PROXY_SERVER_URL: AUTH0 proxy server URL, used to get M2M token
+- AUTH0_AUDIENCE: AUTH0 audience, used to get M2M token
+- TOKEN_CACHE_TIME: AUTH0 token cache time, used to get M2M token
+- AUTH0_CLIENT_ID: AUTH0 client id, used to get M2M token
+- AUTH0_CLIENT_SECRET: AUTH0 client secret, used to get M2M token
+- PROJECTS_API: the topcoder projects API
 
-generally, we only need to update INFORMIX_HOST, KAFKA_URL and POSTGRES_URL via environment variables, see INFORMIX_HOST, KAFKA_URL and POSTGRES_URL parameter in docker/sample.api.env
+generally, we only need to update INFORMIX_HOST, KAFKA_URL, PROJECTS_API and M2M-related configuration via environment variables, see the parameters in docker/sample.api.env
 
 There is a `/health` endpoint that checks for the health of the app. This sets up an expressjs server and listens on the environment variable `PORT`. It's not part of the configuration file and needs to be passed as an environment variable
 
@@ -68,17 +73,6 @@ We will use Topcoder Informix database setup on Docker.
 
 Go to `docker-ifx` folder and run `docker-compose up`
 
-## Postgres database setup
-
-- Checkout tc-project-service `v5-upgrade` branch
-```bash
-git clone https://github.com/topcoder-platform/tc-project-service.git
-git checkout v5-upgrade
-```
-- Modify `dbConfig.masterUrl` in `config/default.json`
-- Run command `npm install` to install dependencies
-- Run command `npm run sync:db` to create tables on Postgres database
-
 ## Local deployment
 - Given the fact that the library used to access Informix DB depends on Informix Client SDK.
 We will run the application on Docker using a base image with Informix Client SDK installed and properly configured.
@@ -88,15 +82,15 @@ For deployment, please refer to next section 'Local Deployment with Docker'
 
 To run the Legacy Project Processor using docker, follow the steps below
 
-1. Make sure that Kafka, Postgres and Informix are running as per instructions above.
+1. Make sure that Kafka, Project Service and Informix are running as per instructions above.
 
 2. Go to `docker` folder
 
-3. Rename the file `sample.api.env` to `api.env` And properly update the IP addresses to match your environment for the variables : KAFKA_URL, INFORMIX_HOST and POSTGRES_URL( make sure to use IP address instead of hostname ( i.e localhost will not work)).Here is an example:
+3. Rename the file `sample.api.env` to `api.env` And properly update M2M-related configuration and the IP addresses to match your environment for the variables : KAFKA_URL, INFORMIX_HOST and PROJECTS_API ( make sure to use IP address instead of hostname ( i.e localhost will not work)).Here is an example:
 ```
 KAFKA_URL=192.168.31.8:9092
 INFORMIX_HOST=192.168.31.8
-POSTGRES_URL=postgres://postgres:password@192.168.31.8:5432/postgres
+PROJECTS_API=192.168.31.8:8001/v5
 ```
 
 4. Once that is done, go to run the following command
@@ -109,7 +103,7 @@ docker-compose up
 
 ## Running e2e tests
 You need to run `docker-compose build` if modify source files.
-Make sure run `docker-compose up` in `docker` folder once to make sure application will install dependencies and run successfully with Kafka, Postgres and Informix.
+Make sure run `docker-compose up` in `docker` folder once to make sure application will install dependencies and run successfully with Kafka and Informix.
 
 To run e2e tests
 Modify `docker/docker-compose.yml` with `command: run test`(uncomment it) and run `docker-compose up` in `docker` folder

Verification.md

@@ -18,42 +18,42 @@ npm run test-data
 1. start kafka-console-producer to write messages to `project.action.create` topic:
   `bin/kafka-console-producer.sh --broker-list localhost:9092 --topic project.action.create`
 2. write message:
-  `{ "topic": "project.action.create", "originator": "project-api", "timestamp": "2018-07-02T00:00:00", "mime-type": "application/json", "payload": { "resource": "project", "id": 1000, "name": "Develop website", "description": "<h>Test</h><p>This is description</p>", "directProjectId": null, "billingAccountId": 70015983,  "type": "Web Application", "createdBy": 132458 } }`
+  `{ "topic": "project.action.create", "originator": "project-api", "timestamp": "2018-07-02T00:00:00", "mime-type": "application/json", "payload": { "resource": "project", "id": 1, "name": "Develop website", "description": "<h>Test</h><p>This is description</p>", "directProjectId": null, "billingAccountId": 70015983,  "type": "Web Application", "createdBy": 132458 } }`
 3. check the app console to verify message has been properly handled.
 4. Again, write another message(directProjectId is provided at this time):
-  `{ "topic": "project.action.create", "originator": "project-api", "timestamp": "2018-07-02T00:00:00", "mime-type": "application/json", "payload": { "resource": "project", "id": 1001, "name": "<h1>Test Project</h1>", "description": "<h>Test</h><p>This is description</p>", "directProjectId": 500, "billingAccountId": null, "type": "Web", "createdBy": 132458 } }`
+  `{ "topic": "project.action.create", "originator": "project-api", "timestamp": "2018-07-02T00:00:00", "mime-type": "application/json", "payload": { "resource": "project", "id": 2, "name": "<h1>Test Project</h1>", "description": "<h>Test</h><p>This is description</p>", "directProjectId": 500, "billingAccountId": null, "type": "Web", "createdBy": 132458 } }`
 5. check the app console to verify message has been properly handled.
 6. Try to write an invalid message:
-  `{ "topic": "project.action.create", "originator": "project-api", "timestamp": "2018-07-02T00:00:00", "mime-type": "application/json", "payload": { "resource": "project", "id": 1001, "name": "<h1>Test Project</h1>", "description": "<h>Test</h><p>This is description</p>", "directProjectId": 500, "billingAccountId": 100, "type": "Web", "createdBy": 132458 } }`
+  `{ "topic": "project.action.create", "originator": "project-api", "timestamp": "2018-07-02T00:00:00", "mime-type": "application/json", "payload": { "resource": "project", "id": 2, "name": "<h1>Test Project</h1>", "description": "<h>Test</h><p>This is description</p>", "directProjectId": 500, "billingAccountId": 100, "type": "Web", "createdBy": 132458 } }`
 7. You will see error message in the app console.
 8. start kafka-console-producer to write messages to `project.action.update` topic:
   `bin/kafka-console-producer.sh --broker-list localhost:9092 --topic project.action.update`
 9. write message:
-  `{ "topic": "project.action.update", "originator": "project-api", "timestamp": "2018-07-02T00:00:00", "mime-type": "application/json", "payload": { "resource": "project", "id": 1001, "directProjectId": 500, "billingAccountId": 70015984, "updatedBy": 132458 } }`
+  `{ "topic": "project.action.update", "originator": "project-api", "timestamp": "2018-07-02T00:00:00", "mime-type": "application/json", "payload": { "resource": "project", "id": 2, "directProjectId": 500, "billingAccountId": 70015984, "updatedBy": 132458 } }`
 10. check the app console to verify message has been properly handled.
 11. Try to write an invalid message:
-  `{ "topic": "project.action.update", "originator": "project-api", "timestamp": "2018-07-02T00:00:00", "mime-type": "application/json", "payload": { "resource": "project", "id": 1001, "directProjectId": 500, "billingAccountId": 1, "updatedBy": 132458 } }`
+  `{ "topic": "project.action.update", "originator": "project-api", "timestamp": "2018-07-02T00:00:00", "mime-type": "application/json", "payload": { "resource": "project", "id": 2, "directProjectId": 500, "billingAccountId": 1, "updatedBy": 132458 } }`
 12. You will see error message in the app console.
 13. start kafka-console-producer to write messages to `project.action.update` topic:
   `bin/kafka-console-producer.sh --broker-list localhost:9092 --topic project.action.create`
 14. write messages:
-`{ "topic": "project.action.create", "originator": "project-api", "timestamp": "2018-07-02T00:00:00", "mime-type": "application/json", "payload": { "resource": "project.member", "projectId": 1001, "userId": 132457, "role": "copilot", "createdBy": 132458 } }`
+`{ "topic": "project.action.create", "originator": "project-api", "timestamp": "2018-07-02T00:00:00", "mime-type": "application/json", "payload": { "resource": "project.member", "projectId": 2, "userId": 132457, "role": "copilot", "createdBy": 132458 } }`
 
-`{ "topic": "project.action.create", "originator": "project-api", "timestamp": "2018-07-02T00:00:00", "mime-type": "application/json", "payload": { "resource": "project.member", "projectId": 1001, "userId": 124835, "role": "manager", "createdBy": 132458 } }`
+`{ "topic": "project.action.create", "originator": "project-api", "timestamp": "2018-07-02T00:00:00", "mime-type": "application/json", "payload": { "resource": "project.member", "projectId": 2, "userId": 124835, "role": "manager", "createdBy": 132458 } }`
 
-`{ "topic": "project.action.create", "originator": "project-api", "timestamp": "2018-07-02T00:00:00", "mime-type": "application/json", "payload": { "resource": "project.member", "projectId": 1001, "userId": 124836, "role": "account_manager", "createdBy": 132458 } }`
+`{ "topic": "project.action.create", "originator": "project-api", "timestamp": "2018-07-02T00:00:00", "mime-type": "application/json", "payload": { "resource": "project.member", "projectId": 2, "userId": 124836, "role": "account_manager", "createdBy": 132458 } }`
 
 15. check the app console to verify messages has been properly handled.
 16. Repeat step 14 again.
 17. You will see error messages in the app console.
 18. start kafka-console-producer to write messages to `project.action.update` topic:
   `bin/kafka-console-producer.sh --broker-list localhost:9092 --topic project.action.delete`
 19. write messages:
-`{ "topic": "project.action.delete", "originator": "project-api", "timestamp": "2018-07-02T00:00:00", "mime-type": "application/json", "payload": { "resource": "project.member", "projectId": 1001, "userId": 132457, "role": "copilot", "deletedBy": 132458 } }`
+`{ "topic": "project.action.delete", "originator": "project-api", "timestamp": "2018-07-02T00:00:00", "mime-type": "application/json", "payload": { "resource": "project.member", "projectId": 2, "userId": 132457, "role": "copilot", "deletedBy": 132458 } }`
 
-`{ "topic": "project.action.delete", "originator": "project-api", "timestamp": "2018-07-02T00:00:00", "mime-type": "application/json", "payload": { "resource": "project.member", "projectId": 1001, "userId": 124835, "role": "manager", "deletedBy": 132458 } }`
+`{ "topic": "project.action.delete", "originator": "project-api", "timestamp": "2018-07-02T00:00:00", "mime-type": "application/json", "payload": { "resource": "project.member", "projectId": 2, "userId": 124835, "role": "manager", "deletedBy": 132458 } }`
 
-`{ "topic": "project.action.delete", "originator": "project-api", "timestamp": "2018-07-02T00:00:00", "mime-type": "application/json", "payload": { "resource": "project.member", "projectId": 1001, "userId": 124836, "role": "account_manager", "deletedBy": 132458 } }`
+`{ "topic": "project.action.delete", "originator": "project-api", "timestamp": "2018-07-02T00:00:00", "mime-type": "application/json", "payload": { "resource": "project.member", "projectId": 2, "userId": 124836, "role": "account_manager", "deletedBy": 132458 } }`
 
 20. check the app console to verify messages has been properly handled.
 21. Repeat step 14 again.
@@ -77,20 +77,29 @@ select * from projects;
 
 ## E2E tests coverage
 
-  103 passing (3m)
+``` code
+   103 passing (2m)
 
- File                  |  % Stmts | % Branch |  % Funcs |  % Lines | Uncovered Line #s
- ----------------------|----------|----------|----------|----------|------------------
- All files             |    98.23 |    91.98 |      100 |    98.21 |
-  config               |      100 |    89.74 |      100 |      100 |
-   default.js          |      100 |    89.74 |      100 |      100 |           8,25,36
-   test.js             |      100 |      100 |      100 |      100 |
-  src                  |    98.57 |       85 |      100 |    98.51 |
-   app.js              |    98.41 |       85 |      100 |    98.39 |                85
-   bootstrap.js        |      100 |      100 |      100 |      100 |
-   constants.js        |      100 |      100 |      100 |      100 |
-  src/common           |    92.59 |    70.83 |      100 |    92.59 |
-   helper.js           |      100 |      100 |      100 |      100 |
-   logger.js           |    90.63 |       65 |      100 |    90.63 |32,55,60,84,98,118
-  src/services         |    99.67 |    99.04 |      100 |    99.66 |
-   ProcessorService.js |    99.67 |    99.04 |      100 |    99.66 |               875
+
+ > legacy-project-processor@1.0.0 cover:report /legacy-project-processor
+ > nyc report --reporter=html --reporter=text
+
+ ----------------------|----------|----------|----------|----------|-------------------|
+ File                  |  % Stmts | % Branch |  % Funcs |  % Lines | Uncovered Line #s |
+ ----------------------|----------|----------|----------|----------|-------------------|
+ All files             |    96.75 |    91.01 |    96.72 |    96.72 |                   |
+  config               |      100 |    93.75 |      100 |      100 |                   |
+   default.js          |      100 |    93.75 |      100 |      100 |              8,25 |
+   test.js             |      100 |      100 |      100 |      100 |                   |
+  src                  |       90 |       75 |    71.43 |    89.55 |                   |
+   app.js              |    88.89 |       75 |       60 |    88.71 |... 87,88,89,90,92 |
+   bootstrap.js        |      100 |      100 |      100 |      100 |                   |
+   constants.js        |      100 |      100 |      100 |      100 |                   |
+  src/common           |     92.5 |    70.83 |      100 |     92.5 |                   |
+   helper.js           |      100 |      100 |      100 |      100 |                   |
+   logger.js           |    90.63 |       65 |      100 |    90.63 |32,55,60,84,98,118 |
+  src/services         |    99.35 |    98.04 |      100 |    99.35 |                   |
+   ProcessorService.js |    99.33 |    98.04 |      100 |    99.33 |           712,882 |
+   ProjectService.js   |      100 |      100 |      100 |      100 |                   |
+ ----------------------|----------|----------|----------|----------|-------------------|
+```

config/default.js

@@ -31,12 +31,13 @@ module.exports = {
     POOL_MAX_SIZE: parseInt(process.env.IFX_POOL_MAX_SIZE) || 10 // use connection pool in processor, the pool size
   },
 
-  // postgres database configuration
-  POSTGRES: {
-    URL: process.env.POSTGRES_URL || 'postgres://coder:mysecretpassword@dockerhost:5432/projectsdb', // url
-    MAX_POOL_SIZE: parseInt(process.env.POSTGRES_MAX_POOL_SIZE) || 50, // max pool size
-    MIN_POOL_SIZE: parseInt(process.env.POSTGRES_MIN_POOL_SIZE) || 4, // min pool size
-    IDLE_TIME_OUT: parseInt(process.env.POSTGRES_IDLE_TIME_OUT) || 1000, // idle time
-    PROJECT_TABLE_NAME: 'projects' // project table name
-  }
+  // used to get M2M token
+  AUTH0_URL: process.env.AUTH0_URL,
+  AUTH0_PROXY_SERVER_URL: process.env.AUTH0_PROXY_SERVER_URL,
+  AUTH0_AUDIENCE: process.env.AUTH0_AUDIENCE,
+  TOKEN_CACHE_TIME: process.env.TOKEN_CACHE_TIME,
+  AUTH0_CLIENT_ID: process.env.AUTH0_CLIENT_ID,
+  AUTH0_CLIENT_SECRET: process.env.AUTH0_CLIENT_SECRET,
+
+  PROJECTS_API: process.env.PROJECTS_API || 'http://localhost:8001/v5'
 }

docker/api.env

@@ -6,8 +6,8 @@ services:
     build:
       context: ../
       dockerfile: docker/Dockerfile
-    # env_file:
-    #   - api.env
-    # command: run start
+    env_file:
+      - api.env
+    command: run start
     # command: run test
-    command: run test:cov
+    # command: run test:cov

docker/docker-compose.yml

@@ -1,3 +1,8 @@
-KAFKA_URL=<KAFKA URL>
-INFORMIX_HOST=<INFORMIX HOST>
-POSTGRES_URL=<POSTGRES URL>
+KAFKA_URL=host.docker.internal:9092
+INFORMIX_HOST=host.docker.internal
+PROJECTS_API=host.docker.internal:8001/v5
+AUTH0_CLIENT_ID=<AUTH0 CLIENT ID>
+AUTH0_CLIENT_SECRET=<AUTH0 CLIENT SECRET>
+AUTH0_URL=<AUTH0 URL>
+AUTH0_AUDIENCE=<AUTH0 AUDIENCE>
+AUTH0_PROXY_SERVER_URL=<AUTH0 PROXY SERVER URL>

docker/sample.api.env

@@ -9,21 +9,24 @@
     "lint:fix": "standard --fix",
     "init-db": "node scripts/init-db.js",
     "test-data": "node scripts/test-data.js",
-    "test": "mocha test/helper.test.js && mocha test/processor.test.js --timeout 20000 --exit",
+    "test": "mocha test/helper.test.js && mocha --require test/prepare.js test/processor.test.js --timeout 20000 --exit",
     "helper:test": "nyc --silent mocha test/helper.test.js --exit",
-    "processor:test": "nyc --silent --no-clean mocha test/processor.test.js --timeout 20000 --exit",
+    "processor:test": "nyc --silent --no-clean mocha --require test/prepare.js test/processor.test.js --timeout 20000 --exit",
     "cover:report": "nyc report --reporter=html --reporter=text",
     "test:cov": "npm run helper:test && npm run processor:test && npm run cover:report"
   },
   "author": "TCSCODER",
   "license": "none",
   "devDependencies": {
-    "should": "^13.2.3",
     "mocha": "^6.1.4",
+    "mocha-prepare": "^0.1.0",
+    "nock": "^11.7.0",
     "nyc": "^14.1.1",
-    "superagent": "^5.1.0",
+    "q": "^1.5.1",
+    "should": "^13.2.3",
+    "sinon": "^7.3.2",
     "standard": "^12.0.1",
-    "sinon": "^7.3.2"
+    "superagent": "^5.1.2"
   },
   "dependencies": {
     "@hapi/joi": "^15.1.0",
@@ -34,10 +37,7 @@
     "ifxnjs": "^8.0.1",
     "lodash": "^4.17.11",
     "no-kafka": "^3.4.3",
-    "pg": "^7.11.0",
-    "pg-hstore": "^2.3.3",
-    "q": "^1.5.1",
-    "sequelize": "^5.9.0",
+    "tc-core-library-js": "github:appirio-tech/tc-core-library-js#v2.6.3",
     "topcoder-healthcheck-dropin": "^1.0.3",
     "winston": "^3.2.1"
   },

package.json

@@ -3,11 +3,10 @@
  */
 
 require('../src/bootstrap')
-const { getPostgresConnection, getInformixConnection } = require('../src/common/helper')
+const { getInformixConnection } = require('../src/common/helper')
 const logger = require('../src/common/logger')
 
 async function initDB () {
-  await getPostgresConnection().query(`delete from projects`)
   const connection = await getInformixConnection()
   try {
     await connection.queryAsync(`delete from tcs_catalog:direct_project_metadata_audit`)

scripts/init-db.js

@@ -3,13 +3,10 @@
  */
 
 require('../src/bootstrap')
-const { getPostgresConnection, getInformixConnection } = require('../src/common/helper')
+const { getInformixConnection } = require('../src/common/helper')
 const logger = require('../src/common/logger')
 
 async function insertData () {
-  await getPostgresConnection().query(`delete from projects`)
-  await getPostgresConnection().query(`insert into projects(id, name, description, terms, type, status, "createdBy", "updatedBy", version, "lastActivityAt", "lastActivityUserId") values(1000, 'name-1', 'description-1', '{1}', 'test', 'draft', 8547899, 8547899, '1.0', now(), '8547899')`)
-  await getPostgresConnection().query(`insert into projects(id, "directProjectId", name, description, terms, type, status, "createdBy", "updatedBy", version, "lastActivityAt", "lastActivityUserId") values(1001, 500, 'name-2', 'description-2', '{1}', 'test', 'draft', 8547899, 8547899, '1.0', now(), '8547899')`)
   const connection = await getInformixConnection()
   try {
     await connection.queryAsync(`delete from tcs_catalog:copilot_profile`)