Merge pull request #4 from zsudraco/develop

resource and submission statistics

Author: ThomasKranitsas

.dockerignore

@@ -1,4 +1,5 @@
 node_modules/
+mock/node_modules
 .env
 coverage/
 .nyc_output/

.gitignore

@@ -1,5 +1,6 @@
 .idea
 node_modules
+mock/node_modules
 *.log
 .DS_Store
 .env

README.md

@@ -28,10 +28,17 @@ This microservice processes kafka events related to challenges and updates data
 
 ## Configuration
 
-Configuration for the processor is at `config/default.js`.
+Configuration for the processor is at `config/default.js` and `config/production.js`.
 The following parameters can be set in config files or in env variables:
 
+- DISABLE_LOGGING: whether to disable logging, default is false
 - LOG_LEVEL: the log level; default value: 'debug'
+- AUTH0_URL: AUTH0 URL, used to get M2M token
+- AUTH0_AUDIENCE: AUTH0 audience, used to get M2M token, default value is 'https://www.topcoder-dev.com'
+- TOKEN_CACHE_TIME: AUTH0 token cache time, used to get M2M token
+- AUTH0_PROXY_SERVER_URL: Auth0 proxy server url, used to get TC M2M token
+- AUTH0_CLIENT_ID: AUTH0 client id, used to get M2M token
+- AUTH0_CLIENT_SECRET: AUTH0 client secret, used to get M2M token
 - KAFKA_URL: comma separated Kafka hosts; default value: 'localhost:9092'
 - KAFKA_GROUP_ID: the Kafka group id; default value: 'challenge-processor-es'
 - KAFKA_CLIENT_CERT: Kafka connection certificate, optional; default value is undefined;
@@ -42,13 +49,29 @@ if not provided, then SSL connection is not used, direct insecure connection is
 if provided, it can be either path to private key file or private key content
 - UPDATE_DATA_TOPIC: update data Kafka topic, default value is 'challenge.notification.update'
 - CREATE_RESOURCE_TOPIC: create resource Kafka topic, default value is 'challenge.action.resource.create'
+- UPDATE_RESOURCE_TOPIC: update resource Kafka topic, default value is 'challenge.action.resource.update'
 - DELETE_RESOURCE_TOPIC: delete resource Kafka topic, default value is 'challenge.action.resource.delete'
 - CREATE_SUBMISSION_TOPIC: create submission Kafka topic, default value is 'submission.notification.create'
+- UPDATE_SUBMISSION_TOPIC: update submission Kafka topic, default value is 'submission.notification.update'
 - DELETE_SUBMISSION_TOPIC: delete submission Kafka topic, default value is 'submission.notification.delete'
-- REGISTRANT_ROLE_ID: challenge registrant role id, if not provided then any role is considered as registrant
+- REGISTRANT_RESOURCE_ROLE_ID: challenge registrant resource role id, if not provided then any role is considered as registrant
+- SUBMISSIONS_API_URL: TC submissions API URL, default value is mock API 'http://localhost:4000/v5/submissions'
+- RESOURCES_API_URL: TC resources API URL, default value is mock API 'http://localhost:4000/v5/resources'
+- CONTEST_SUBMISSION_TYPE: contest submission type name, default value is 'Contest Submission'
+- CHECKPOINT_SUBMISSION_TYPE: checkpoint submission type name, default value is 'Checkpoint Submission'
+- REQUEST_TIMEOUT: superagent request timeout in milliseconds, default value is 20000
 - esConfig: config object for Elasticsearch
 
 Refer to `esConfig` variable in `config/default.js` for ES related configuration.
+
+Set the following environment variables so that the app can get TC M2M token (use 'set' insted of 'export' for Windows OS):
+```
+export AUTH0_CLIENT_ID=EkE9qU3Ey6hdJwOsF1X0duwskqcDuElW
+export AUTH0_CLIENT_SECRET=Iq7REiEacFmepPh0UpKoOmc6u74WjuoJriLayeVnt311qeKNBvhRNBe9BZ8WABYk
+export AUTH0_URL=https://topcoder-dev.auth0.com/oauth/token
+export AUTH0_AUDIENCE=https://m2m.topcoder-dev.com/
+```
+
 Also note that 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
 
 Config for tests are at `config/test.js`, it overrides some default config.
@@ -86,10 +109,14 @@ below provides details to setup Kafka server in Mac, Windows will use bat comman
 
 `bin/kafka-topics.sh --create --zookeeper localhost:2181 --replication-factor 1 --partitions 1 --topic challenge.action.resource.create`
 
+`bin/kafka-topics.sh --create --zookeeper localhost:2181 --replication-factor 1 --partitions 1 --topic challenge.action.resource.update`
+
 `bin/kafka-topics.sh --create --zookeeper localhost:2181 --replication-factor 1 --partitions 1 --topic challenge.action.resource.delete`
 
 `bin/kafka-topics.sh --create --zookeeper localhost:2181 --replication-factor 1 --partitions 1 --topic submission.notification.create`
 
+`bin/kafka-topics.sh --create --zookeeper localhost:2181 --replication-factor 1 --partitions 1 --topic submission.notification.update`
+
 `bin/kafka-topics.sh --create --zookeeper localhost:2181 --replication-factor 1 --partitions 1 --topic submission.notification.delete`
 
 - verify that the topics are created:
@@ -103,7 +130,7 @@ it should list out the created topics
 
 in the console, write message, one message per line:
 
-`{ "topic": "challenge.notification.update", "originator": "challenge-api", "timestamp": "2019-02-17T01:00:00", "mime-type": "application/json", "payload": { "id": "173803d3-019e-4033-b1cf-d7205c7f774c", "typeId": "8e17090c-465b-4c17-b6d9-dfa16300b0ff", "track": "Code", "name": "test3", "description": "desc3", "timelineTemplateId": "8e17090c-465b-4c17-b6d9-dfa16300b0dd", "groups": ["group2", "group3"], "updated": "2019-02-17T01:00:00", "updatedBy": "admin" } }`
+`{ "topic": "challenge.notification.update", "originator": "challenge-api", "timestamp": "2019-02-17T01:00:00", "mime-type": "application/json", "payload": { "id": "7b37a31e-484c-4d1e-aa9f-cfd6656e11d8", "typeId": "8e17090c-465b-4c17-b6d9-dfa16300b0ff", "track": "Code", "name": "test3", "description": "desc3", "timelineTemplateId": "8e17090c-465b-4c17-b6d9-dfa16300b0dd", "groups": ["group2", "group3"], "updated": "2019-02-17T01:00:00", "updatedBy": "admin" } }`
 
 - optionally, use another terminal, go to same directory, start a consumer to view the messages:
 
@@ -115,6 +142,7 @@ in the console, write message, one message per line:
 - in the `docker-es` folder, run `docker-compose up`
 
 ### Local deployment without Docker
+- start mock API, go to `mock` folder, run `npm i` and `npm start`, mock api is running at `http://localhost:4000`
 - install dependencies `npm i`
 - run code lint check `npm run lint`, running `npm run lint:fix` can fix some lint errors if any
 - initialize Elasticsearch, create configured Elasticsearch index if not present: `npm run init-es`
@@ -145,7 +173,6 @@ docker-compose up
 Test configuration is at `config/test.js`. You don't need to change them.
 The following test parameters can be set in config file or in env variables:
 
-- REGISTRANT_ROLE_ID: challenge registrant role id, if not provided then any role is considered as registrant
 - esConfig: config object for Elasticsearch
 
 Integration tests use different index `challenge-test` which is not same as the usual index `challenge`.
@@ -157,8 +184,8 @@ export ES_INDEX=challenge-test
 Or, you may temporarily modify the esConfig.ES_INDEX in config/default.js to `challenge-test` and run `npm run init-es` to create test index.
 
 ### Prepare
-- Start Local services.
-- initialize Elasticsearch.
+- Mock API should be started.
+- Initialize Elasticsearch.
 - Various config parameters should be properly set.
 
 ### Running unit tests