Merge remote-tracking branch 'github/develop'

Author: jmgasper

.eslintrc

@@ -3,11 +3,17 @@
         "node": true
     },
     "parserOptions": {
-        "ecmaVersion": 8
+        "ecmaVersion": 8,
+        "ecmaFeatures": {
+            "experimentalObjectRestSpread": true
+        }
     },
     "extends": "eslint-config-topcoder/nodejs",
     "rules": {
-        "max-len": ["error", 160],
+        "max-len": [
+            "error",
+            160
+        ],
         "indent": [
             "error",
             2
@@ -25,12 +31,16 @@
             "always"
         ],
         "no-console": 0,
-        "comma-dangle": ["error", {
-            "arrays": "never",
-            "objects": "never",
-            "imports": "never",
-            "exports": "never",
-            "functions": "ignore"
-        }]
+        "comma-dangle": [
+            "error",
+            {
+                "arrays": "never",
+                "objects": "never",
+                "imports": "never",
+                "exports": "never",
+                "functions": "ignore"
+            }
+        ],
+        "max-lines": 0,
     }
-}
+}

README.md

@@ -41,13 +41,16 @@ The following config parameters are supported, they are defined in `config/defau
 |ISSUE_BID_EMAIL_RECEIVER| the email receiver about bid email||
 |TC_URL| the base URL of topcoder to get the challenge URL| defaults to `https://www.topcoder-dev.com`|
 |GITLAB_API_BASE_URL| the URL for gitlab host| defaults to `https://gitlab.com`|
+|PAID_ISSUE_LABEL|the label name for paid, should be one of the label configured in topcoder x ui|'Paid'|
+|FIX_ACCEPTED_ISSUE_LABEL|the label name for fix accepted, should be one of the label configured in topcoder x ui|'Fix Accepted'|
+|TC_OR_DETAIL_LINK|the link to online review detail of challenge| see `default.js`, OR link for dev environment|
 
-KAFKA_OPTIONS should be object as described in https://github.com/SOHU-Co/kafka-node#kafkaclient
+KAFKA_OPTIONS should be object as described in https://github.com/oleksiyk/kafka#ssl
 For using with SSL, the options should be as
 ```
  {
-    kafkaHost: '<server>',
-    sslOptions: {
+    connectionString: '<server>',
+    ssl: {
       cert: '<certificate>', 
       key:  '<key>'
     }
@@ -85,6 +88,7 @@ Now, receiver service can receive the webhooks from git host's project and proce
 - create a pull request, you can see the logs in `receiver` and `processor`, the `pull_request.created` event is generated.
 - close a pull request without merge, you can see the logs in `receiver` and `processor`, the `pull_request.closed` event is generated and the `merged` property is `false`.
 - merge a pull request, you can see the logs in `receiver` and `processor`, the `pull_request.closed` event is generated and the `merged` property is `true`.
+- close an issue in the repo, you can see the logs in `receiver` and `processor`, the `issue.closed` event is generated
 
 ### Create a new challenge for a new issue
 - Create a new issue in the repo. E.g.
@@ -132,7 +136,7 @@ Now, receiver service can receive the webhooks from git host's project and proce
   debug: nothing changed for issue 3
   ```
 
-- Update the tilte by removing `[$50 ]`, you'll get an error:
+- Update the title by removing `[$50 ]`, you'll get an error:
   ```
   error:  Error: Cannot parse prize from title: A new issue title - Updated the prize
   ```
@@ -157,3 +161,38 @@ When an user is assigned to an issue then 'issue.assigned' event will be capture
   @username, please sign-up with Topcoder x Self-service tool.
   ```
   - user will be unassigned from issue
+
+### Closing issue
+
+When an issue is closed it will first check if issue has any assignee or not,
+
+- if there is no assignee then simply ignores the issue closed event with message in logger
+- if there is an assignee then it will 
+  - first set the current assignee user as challenge assignee, 
+  - activate the challenge with project's billing
+  - closes the challenge with winner as assignee
+  - you can verify the challenge closed in OR (link will be commented in same issue in git host)
+  - issue label will be updated from configured paid and fix accepted label name
+
+You can see following logs
+```
+debug: Looking up TC handle of git user: 82332
+debug: Getting the billing account ID for project ID: 15180
+debug: Getting project billing detail 15180
+debug: assigning the billing account id 70016668 to challenge
+debug: Updating challenge 30052019 with {"billingAccountId":70016668,"prizes":[234]}
+debug: Getting the topcoder member ID for member name: tonyj
+debug: Getting the topcoder member ID for copilot name : tonyj
+debug: adding resource to challenge 30052019
+debug: resource is added to challenge 30052019 successfully.
+debug: adding resource to challenge 30052019
+debug: Activating challenge 30052019
+debug: Challenge 30052019 is activated successfully.
+debug: close challenge with winner tonyj(8547899)
+debug: Closing challenge 30052019
+debug: Challenge 30052019 is closed successfully.
+debug: update issue as paid
+debug: Gitlab/Github issue is updated for as paid and fix accepted for 59
+```
+
+- if issue have already paid label it won't process

config/default.js

@@ -17,8 +17,8 @@ module.exports = {
   PARTITION: process.env.PARTITION || 0,
   TOPIC: process.env.TOPIC || 'tc-x-events',
   KAFKA_OPTIONS: {
-    kafkaHost: process.env.KAFKA_HOST || 'localhost:9092',
-    sslOptions: {
+    connectionString: process.env.KAFKA_HOST || 'localhost:9092',
+    ssl: {
       cert: process.env.KAFKA_CLIENT_CERT || fs.readFileSync('./kafka_client.cer'), // eslint-disable-line no-sync
       key: process.env.KAFKA_CLIENT_CERT_KEY || fs.readFileSync('./kafka_client.key'), // eslint-disable-line no-sync
     }
@@ -80,4 +80,10 @@ module.exports = {
   ISSUE_BID_EMAIL_RECEIVER: process.env.ISSUE_BID_EMAIL_RECEIVER || '',
   TC_URL: process.env.TC_URL || 'https://www.topcoder-dev.com',
   GITLAB_API_BASE_URL: process.env.GITLAB_API_BASE_URL || 'https://gitlab.com',
+  PAID_ISSUE_LABEL: process.env.PAID_ISSUE_LABEL || 'Paid',
+  FIX_ACCEPTED_ISSUE_LABEL: process.env.FIX_ACCEPTED_ISSUE_LABEL || 'Fix accepted',
+  READY_FOR_REVIEW_ISSUE_LABEL: process.env.READY_FOR_REVIEW_ISSUE_LABEL || 'Ready for review',
+  TC_OR_DETAIL_LINK: process.env.TC_OR_DETAIL_LINK || 'https://software.topcoder-dev.com/review/actions/ViewProjectDetails?pid=',
+  RETRY_COUNT: process.env.RETRY_COUNT || 3,
+  RETRY_INTERVAL: process.env.RETRY_INTERVAL || 120000, // 2 minutes
 };

configuration.md

@@ -0,0 +1,68 @@
+# Topcoder X Processor Configuration
+
+The following config parameters are supported, they are defined in `config/default.js` and can be configured as env variables:
+
+| Name                           | Description                                | Default                          |
+| :----------------------------- | :----------------------------------------: | :------------------------------: |
+| LOG_LEVEL                      | the log level                              |  debug                           |
+| PARTITION                  | The Kafka partition            |  0|
+| MONGODB_URI                            | The MongoDB URI.  This needs to be the same MongoDB used by topcoder-x-receiver, topcoder-x-processor, and topcoder-x-site                           | mongodb://127.0.0.1:27017/topcoderx |
+|TOPIC  | The Kafka topic where events are published.  This must be the same as the configured value for topcoder-x-processor| |
+|KAFKA_OPTIONS | Kafka connection options| |
+|KAFKA_HOST | The Kafka host to connect to| localhost:9092 |
+|KAFKA_CLIENT_CERT | The Kafka SSL certificate to use when connecting| Read from kafka_client.cer file, but this can be set as a string like it is on Heroku |
+|KAFKA_CLIENT_CERT_KEY | The Kafka SSL certificate key to use when connecting| Read from kafka_client.key file, but this can be set as a string like it is on Heroku|
+|TC_DEV_ENV| the flag whether to use topcoder development api or production| false|
+| TC_AUTHN_URL | the Topcoder authentication url | https://topcoder-dev.auth0.com/oauth/ro |
+| TC_AUTHN_REQUEST_BODY | the Topcoder authentication request body. This makes use of some environment variables: `TC_USERNAME`, `TC_PASSWORD`, `TC_CLIENT_ID`, `CLIENT_V2CONNECTION` | see `default.js` |
+| TC_AUTHZ_URL | the Topcoder authorization url | https://api.topcoder-dev.com/v3/authorizations |
+| NEW_CHALLENGE_TEMPLATE | the body template for new challenge request. You can change the subTrack, reviewTypes, technologies, .. here | see `default.js` |
+| NEW_CHALLENGE_DURATION_IN_DAYS | the duration of new challenge | 5 |
+| NODE_MAILER_OPTIONS| the node mailer smtp options, see [here](https://nodemailer.com/smtp/ for more detail)| see `default.js` |
+|EMAIL_SENDER_ADDRESS| the email sender email address||
+|ISSUE_BID_EMAIL_RECEIVER| the email receiver about bid email||
+|TC_URL| the base URL of topcoder to get the challenge URL| defaults to `https://www.topcoder-dev.com`|
+|GITLAB_API_BASE_URL| the URL for gitlab host| defaults to `https://gitlab.com`|
+|PAID_ISSUE_LABEL|the label name for paid, should be one of the label configured in topcoder x ui|'Paid'|
+|FIX_ACCEPTED_ISSUE_LABEL|the label name for fix accepted, should be one of the label configured in topcoder x ui|'Fix Accepted'|
+|TC_OR_DETAIL_LINK|the link to online review detail of challenge| see `default.js`, OR link for dev environment|
+|RETRY_COUNT| the number of times an event should be retried to process| 3|
+|RETRY_INTERVAL| the interval at which the event should be retried to process in milliseconds | 120000|
+|READY_FOR_REVIEW_ISSUE_LABEL| the label name for ready for review, should be one of the label configured in topcoder x ui|'Ready for review'|
+
+KAFKA_OPTIONS should be object as described in https://github.com/oleksiyk/kafka#ssl
+For using with SSL, the options should be as
+```
+ {
+    kafkaHost: '<server>',
+    sslOptions: {
+      cert: '<certificate>',
+      key:  '<key>'
+    }
+ }
+```
+## Github Verification
+
+#### Webhook configuration
+
+Configure a Github project with a webhook with a format like this: https://<receiver URL>:<receiver port>/webhooks/github
+
+#### Smoke test
+- Create an issue in the repo, you can see the logs in `receiver`, the `issue.created` event is generated.  You should then see the processor receive the event and process it accordingly.  It's important to validate that the issue.created event is seen by the receiver *and* the processor.  This ensures that the Kafka communication between the two services is working properly.
+
+You can test other events, but just validating that an issue.created event is generated in Kafka is enough to smoke test the receiver is set up properly.  
+
+## Github Verification
+
+#### Webhook configuration
+
+Configure a Gitlab project with a webhook with a format like this: https://<receiver URL>:<receiver port>/webhooks/gitlab
+
+#### Smoke test
+
+See above - the steps are the same for Github and Gitlab
+
+## Debugging
+You can re-run and debug the responses to webhook requests on Github and Gitlab, in the configuration for the webhook.  This can be useful if things aren't coming through properly in the receiver.
+
+If you see the event come into the receiver but the processor doesn't see it, make sure that Kafka is configured the same between the processor and receiver and that there aren't any Kafka connection errors being raised in the processor.

constants.js

@@ -22,7 +22,10 @@ const USER_ROLES = {
   OWNER: 'owner'
 };
 
+const SERVICE_ERROR_STATUS = 500;
+
 module.exports = {
   USER_ROLES,
-  USER_TYPES
+  USER_TYPES,
+  SERVICE_ERROR_STATUS
 };

models/Project.js

@@ -14,15 +14,13 @@ const schema = new mongoose.Schema({
   title: {type: String, required: true},
   tcDirectId: {type: Number, required: true},
   repoUrl: {type: String, required: true},
-  rocketChatWebhook: {type: String, required: true},
-  rocketChatChannelName: {type: String, required: true},
+  rocketChatWebhook: {type: String, required: false},
+  rocketChatChannelName: {type: String, required: false},
   archived: {type: String, required: true},
   username: {type: String, required: true},
   secretWebhookKey: {type: String, required: true}
 });
 
-// project id, provider, repositoryId must be unique
-schema.index({tcDirectId: 1}, {unique: true});
-
+schema.index({tcDirectId: 1});
 
 module.exports = schema;

models/UserMapping.js

@@ -15,6 +15,6 @@ const schema = new Schema({
   gitlabUserId: Number
 });
 
-schema.index({topcoderUsername: 1});
+schema.index({topcoderUsername: 1}, {unique: true});
 
 module.exports = schema;