UI updates and better processing of close events.

Author: jmgasper

README.md

@@ -41,6 +41,9 @@ 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
 For using with SSL, the options should be as
@@ -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

@@ -80,4 +80,7 @@ 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',
+  TC_OR_DETAIL_LINK: process.env.TC_OR_DETAIL_LINK || 'https://software.topcoder-dev.com/review/actions/ViewProjectDetails?pid='
 };

configuration.md

@@ -23,6 +23,9 @@ 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
 For using with SSL, the options should be as

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;

services/GithubService.js

@@ -12,11 +12,13 @@
 const _ = require('lodash');
 const Joi = require('joi');
 const GitHubApi = require('github');
+const config = require('config');
 const logger = require('../utils/logger');
 
 const copilotUserSchema = Joi.object().keys({
   accessToken: Joi.string().required(),
-  userProviderId: Joi.number().required()
+  userProviderId: Joi.number().required(),
+  topcoderUsername: Joi.string()
 }).required();
 
 /**
@@ -147,7 +149,7 @@ async function createComment(copilot, repo, number, body) {
   const github = await _authenticate(copilot.accessToken);
   const owner = await _getUsernameById(github, copilot.userProviderId);
   await github.issues.createComment({owner, repo, number, body});
-  logger.debug('Github comment is added on issue notifying user to assign using Topcoder x tool');
+  logger.debug(`Github comment is added on issue with message: "${body}"`);
 }
 
 createComment.schema = {
@@ -193,11 +195,60 @@ getUserIdByLogin.schema = {
   login: Joi.string().required()
 };
 
+/**
+ * updates the github issue as paid and fix accepted
+ * @param {Object} copilot the copilot
+ * @param {string} repo the repository
+ * @param {Number} number the issue number
+ * @param {Number} challengeId the challenge id
+ */
+async function markIssueAsPaid(copilot, repo, number, challengeId) {
+  Joi.attempt({copilot, repo, number, challengeId}, markIssueAsPaid.schema);
+  const github = await _authenticate(copilot.accessToken);
+  const owner = await _getUsernameById(github, copilot.userProviderId);
+  const labels = [config.PAID_ISSUE_LABEL, config.FIX_ACCEPTED_ISSUE_LABEL];
+  await github.issues.edit({owner, repo, number, labels});
+  const body = `Payment task has been updated: ${config.TC_OR_DETAIL_LINK}${challengeId}`;
+  await github.issues.createComment({owner, repo, number, body});
+  logger.debug(`Github issue title is updated for as paid and fix accepted for ${number}`);
+}
+
+markIssueAsPaid.schema = {
+  copilot: copilotUserSchema,
+  repo: Joi.string().required(),
+  number: Joi.number().required(),
+  challengeId: Joi.number().positive().required()
+};
+
+/**
+ * change the state of github issue
+ * @param {Object} copilot the copilot
+ * @param {string} repo the repository
+ * @param {Number} number the issue number
+ * @param {string} state new state
+ */
+async function changeState(copilot, repo, number, state) {
+  Joi.attempt({copilot, repo, number, state}, changeState.schema);
+  const github = await _authenticate(copilot.accessToken);
+  const owner = await _getUsernameById(github, copilot.userProviderId);
+  await github.issues.edit({owner, repo, number, state});
+  logger.debug(`Github issue state is updated to '${state}' for issue number ${number}`);
+}
+
+changeState.schema = {
+  copilot: copilotUserSchema,
+  repo: Joi.string().required(),
+  number: Joi.number().required(),
+  state: Joi.string().required()
+};
+
 module.exports = {
   updateIssue,
   assignUser,
   removeAssign,
   createComment,
   getUsernameById,
-  getUserIdByLogin
+  getUserIdByLogin,
+  markIssueAsPaid,
+  changeState
 };

services/GitlabService.js

@@ -17,7 +17,8 @@ const logger = require('../utils/logger');
 
 const copilotUserSchema = Joi.object().keys({
   accessToken: Joi.string().required(),
-  userProviderId: Joi.number().required()
+  userProviderId: Joi.number().required(),
+  topcoderUsername: Joi.string()
 }).required();
 
 /**
@@ -59,7 +60,7 @@ async function createComment(copilot, projectId, issueId, body) {
   Joi.attempt({copilot, projectId, issueId, body}, createComment.schema);
   const gitlab = await _authenticate(copilot.accessToken);
   await gitlab.projects.issues.notes.create(projectId, issueId, {body});
-  logger.debug(`Gitlab comment is added on issue with message "${body}"`);
+  logger.debug(`Gitlab comment is added on issue with message: "${body}"`);
 }
 
 createComment.schema = {
@@ -168,11 +169,58 @@ getUserIdByLogin.schema = {
   login: Joi.string().required()
 };
 
+/**
+ * updates the gitlab issue as paid and fix accepted
+ * @param {Object} copilot the copilot
+ * @param {Number} projectId the project id
+ * @param {Number} issueId the issue number
+ * @param {Number} challengeId the challenge id
+ */
+async function markIssueAsPaid(copilot, projectId, issueId, challengeId) {
+  Joi.attempt({copilot, projectId, issueId, challengeId}, markIssueAsPaid.schema);
+  const gitlab = await _authenticate(copilot.accessToken);
+  await gitlab.projects.issues.edit(projectId, issueId, {labels: `${config.PAID_ISSUE_LABEL},${config.FIX_ACCEPTED_ISSUE_LABEL}`});
+  const body = `Payment task has been updated: ${config.TC_OR_DETAIL_LINK}${challengeId}`;
+  await gitlab.projects.issues.notes.create(projectId, issueId, {body});
+  logger.debug(`Gitlab issue is updated for as paid and fix accepted for ${issueId}`);
+}
+
+markIssueAsPaid.schema = {
+  copilot: copilotUserSchema,
+  projectId: Joi.number().positive().required(),
+  issueId: Joi.number().positive().required(),
+  challengeId: Joi.number().positive().required()
+};
+
+/**
+ * change the state of gitlab issue
+ * @param {Object} copilot the copilot
+ * @param {string} projectId the project id
+ * @param {Number} issueId the issue issue id
+ * @param {string} state new state
+ */
+async function changeState(copilot, projectId, issueId, state) {
+  Joi.attempt({copilot, projectId, issueId, state}, changeState.schema);
+  const gitlab = await _authenticate(copilot.accessToken);
+  await gitlab.projects.issues.edit(projectId, issueId, {state_event: state});
+  logger.debug(`Gitlab issue state is updated to '${state}' for issue number ${issueId}`);
+}
+
+changeState.schema = {
+  copilot: copilotUserSchema,
+  projectId: Joi.number().positive().required(),
+  issueId: Joi.number().positive().required(),
+  state: Joi.string().required()
+};
+
+
 module.exports = {
   createComment,
   updateIssue,
   assignUser,
   removeAssign,
   getUsernameById,
-  getUserIdByLogin
+  getUserIdByLogin,
+  markIssueAsPaid,
+  changeState
 };