Merge pull request #118 from topcoder-platform/develop

PROD - Standardized skills support and preliminary private fork implementation

Author: jmgasper

.circleci/config.yml

@@ -9,6 +9,7 @@ install_dependency: &install_dependency
     sudo apt install jq
     sudo apt install python3-pip
     sudo pip3 install awscli --upgrade
+    sudo pip3 install docker==6.1.3
     sudo pip3 install docker-compose
 install_deploysuite: &install_deploysuite
   name: Installation of install_deploysuite.

.eslintrc

@@ -3,8 +3,11 @@
         "node": true,
         "mocha": true
     },
+    "plugins": [
+        "jsdoc"
+    ],
     "parserOptions": {
-        "ecmaVersion": 8,
+        "ecmaVersion": 2023,
         "ecmaFeatures": {
             "experimentalObjectRestSpread": true
         }
@@ -42,7 +45,10 @@
                 "functions": "ignore"
             }
         ],
+        "import/no-unresolved": 0,
+        "max-params": 0,
         "max-lines": 0,
-        "max-statements": 0
+        "max-statements": 0,
+        "valid-jsdoc": 0
     }
-}
+}

.gitignore

@@ -6,3 +6,6 @@
 *.cer
 *.key
 .idea
+
+.env
+.envrc

config/default.js

@@ -16,11 +16,12 @@ module.exports = {
   LOG_LEVEL: process.env.LOG_LEVEL || 'debug',
   PARTITION: process.env.PARTITION || 0,
   TOPIC: process.env.TOPIC || 'tc-x-events',
+  TOPIC_CHALLENGE_ACTION_RESOURCE_CREATE: process.env.TOPIC_CHALLENGE_ACTION_RESOURCE_CREATE || 'challenge.action.resource.create',
   TOPIC_NOTIFICATION: process.env.TOPIC_NOTIFICATION || 'notifications.action.create',
   KAFKA_OPTIONS: {
     connectionString: process.env.KAFKA_URL || 'localhost:9092',
     groupId: process.env.KAFKA_GROUP_ID || 'topcoder-x-processor',
-    ssl: {
+    ssl: process.env.KAFKA_DISABLE_SSL ? false : {
       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
       passphrase: 'secret', // NOTE:* This configuration specifies the private key passphrase used while creating it.
@@ -67,17 +68,19 @@ module.exports = {
   GRANT_TYPE: 'client_credentials',
 
   // used as base to construct various URLs
-  WEBSITE_SECURE: process.env.WEBSITE_SECURE || 'https://topcoderx.topcoder-dev.com',
+  WEBSITE_SECURE: process.env.WEBSITE_SECURE || 'http://topcoderx.topcoder-dev.com',
 
   ROLE_ID_COPILOT: process.env.ROLE_ID_COPILOT || 'cfe12b3f-2a24-4639-9d8b-ec86726f76bd',
   ROLE_ID_ITERATIVE_REVIEWER: process.env.ROLE_ID_ITERATIVE_REVIEWER || 'f6df7212-b9d6-4193-bfb1-b383586fce63',  
   ROLE_ID_SUBMITTER: process.env.ROLE_ID_SUBMITTER || '732339e7-8e30-49d7-9198-cccf9451e221',
   TYPE_ID_TASK: process.env.TYPE_ID_TASK || 'ecd58c69-238f-43a4-a4bb-d172719b9f31',
   DEFAULT_TIMELINE_TEMPLATE_ID: process.env.DEFAULT_TIMELINE_TEMPLATE_ID || '53a307ce-b4b3-4d6f-b9a1-3741a58f77e6',
   DEFAULT_TRACK_ID: process.env.DEFAULT_TRACK_ID || '9b6fc876-f4d9-4ccb-9dfd-419247628825',
+  WORK_TYPE_ID: process.env.WORK_TYPE_ID || 'b658b280-6c4d-11e5-9d70-22000b2c9aef',
   GITLAB_ACCESS_TOKEN_DEFAULT_EXPIRATION: 3600 * 2,
   GITLAB_REFRESH_TOKEN_BEFORE_EXPIRATION: 300,
   GITLAB_CLIENT_ID: process.env.GITLAB_CLIENT_ID,
   GITLAB_CLIENT_SECRET: process.env.GITLAB_CLIENT_SECRET,
-  GITLAB_OWNER_USER_CALLBACK_URL: process.env.GITLAB_OWNER_USER_CALLBACK_URL
+  GITLAB_OWNER_USER_CALLBACK_URL: process.env.GITLAB_OWNER_USER_CALLBACK_URL,
+  GITLAB_GUEST_USER_CALLBACK_URL: process.env.GITLAB_GUEST_USER_CALLBACK_URL
 };

constants.js

@@ -19,7 +19,8 @@ const USER_TYPES = {
 
 // The user roles
 const USER_ROLES = {
-  OWNER: 'owner'
+  OWNER: 'owner',
+  GUEST: 'guest'
 };
 
 // The challenge status
@@ -43,10 +44,20 @@ const ISSUE_STATUS = {
   CHALLENGE_PAYMENT_FAILED: 'challenge_payment_failed'
 };
 
+const GITLAB_ACCESS_LEVELS = {
+  NO_ACCESS: 0,
+  GUEST: 10,
+  REPORTER: 20,
+  DEVELOPER: 30,
+  MAINTAINER: 40,
+  OWNER: 50
+};
+
 module.exports = {
   USER_ROLES,
   USER_TYPES,
   SERVICE_ERROR_STATUS,
   CHALLENGE_STATUS,
-  ISSUE_STATUS
+  ISSUE_STATUS,
+  GITLAB_ACCESS_LEVELS
 };

docker/Dockerfile

@@ -1,15 +1,9 @@
 # Use the base image with Node.js
-FROM node:8.12
+FROM node:20
 
-# Copy the current directory into the Docker image
-COPY . /topcoder-x-processor
-
-# Set working directory for future use
 WORKDIR /topcoder-x-processor
+COPY package.json package-lock.json ./
+RUN npm ci --silent --legacy-peer-deps
+COPY . .
 
-# Install the dependencies from package.json
-RUN npm install
-#RUN npm run build
-#RUN npm run test
-
-CMD npm start
+CMD node ./index.js

models/CopilotPayment.js

@@ -14,6 +14,19 @@ const dynamoose = require('dynamoose');
 
 const Schema = dynamoose.Schema;
 
+/**
+ * @typedef {Object} CopilotPayment
+ * @property {String} id The unique identifier for the CopilotPayment entity.
+ * @property {String} project The project associated with the payment.
+ * @property {Number} amount The payment amount.
+ * @property {String} description The description of the payment.
+ * @property {Number} challengeId The ID of the associated challenge (if applicable).
+ * @property {String} challengeUUID The UUID of the associated challenge (if applicable).
+ * @property {String} closed Indicates whether the payment is closed or not (default is 'false').
+ * @property {String} username The username of the Copilot receiving the payment.
+ * @property {String} status The status of the payment.
+ */
+
 const schema = new Schema({
   id: {
     type: String,

models/GithubUserMapping.js

@@ -7,6 +7,14 @@ const dynamoose = require('dynamoose');
 
 const Schema = dynamoose.Schema;
 
+/**
+ * @typedef {Object} GithubUserMapping
+ * @property {String} id The unique identifier for the GithubUserMapping entity.
+ * @property {String} topcoderUsername The Topcoder username associated with the GitHub user.
+ * @property {String} githubUsername The GitHub username.
+ * @property {Number} githubUserId The GitHub user's numeric identifier.
+ */
+
 const schema = new Schema({
   id: {
     type: String,

models/GitlabUserMapping.js

@@ -7,6 +7,14 @@ const dynamoose = require('dynamoose');
 
 const Schema = dynamoose.Schema;
 
+/**
+ * @typedef {Object} GitlabUserMapping
+ * @property {String} id The unique identifier for the GitlabUserMapping entity.
+ * @property {String} topcoderUsername The Topcoder username associated with the GitLab user.
+ * @property {String} gitlabUsername The GitLab username.
+ * @property {Number} gitlabUserId The GitLab user's numeric identifier.
+ */
+
 const schema = new Schema({
   id: {
     type: String,

models/Issue.js

@@ -12,6 +12,27 @@ const dynamoose = require('dynamoose');
 
 const Schema = dynamoose.Schema;
 
+/**
+ * @typedef {Object} Issue
+ * @property {String} id The id.
+ * @property {Number} number From the receiver service.
+ * @property {String} title The title.
+ * @property {String} body The body.
+ * @property {Number[]} prizes Prizes extracted from title.
+ * @property {String} provider Provider (github or gitlab).
+ * @property {Number} repositoryId Repository ID.
+ * @property {String} repoUrl Repository URL.
+ * @property {String} repositoryIdStr Repository ID as a String.
+ * @property {Array} labels Labels associated with the issue.
+ * @property {String} assignee Assignee for the issue.
+ * @property {Date} updatedAt Date when the issue was last updated.
+ * @property {Number} challengeId Challenge ID from topcoder API.
+ * @property {String} challengeUUID Challenge UUID.
+ * @property {String} projectId Project ID.
+ * @property {String} status Status of the issue.
+ * @property {Date} assignedAt Date when the issue was assigned (if applicable).
+ */
+
 const schema = new Schema({
   id: {type: String, hashKey: true, required: true},
   // From the receiver service

models/Project.js

@@ -12,6 +12,23 @@ const dynamoose = require('dynamoose');
 
 const Schema = dynamoose.Schema;
 
+/**
+ * @typedef {Object} ProjectChallengeMapping
+ * @property {String} id The id.
+ * @property {String} title The title.
+ * @property {Number} tcDirectId The tc direct id.
+ * @property {Array<{id: string, name: string}>} tags The tags.
+ * @property {String} rocketChatWebhook The rocket chat webhook.
+ * @property {String} rocketChatChannelName The rocket chat channel name.
+ * @property {String} archived The archived.
+ * @property {String} owner The owner.
+ * @property {String} secretWebhookKey The secret webhook key.
+ * @property {String} copilot The copilot.
+ * @property {Date} updatedAt The updated at.
+ * @property {String} createCopilotPayments The create copilot payments.
+ * @property {Boolean} isConnect Is Topcoder connect.
+ */
+
 const schema = new Schema({
   id: {
     type: String,
@@ -24,9 +41,33 @@ const schema = new Schema({
     required: true
   },
   tags: {
-    type: String,
+    type: 'list',
+    list: [{
+      type: 'map',
+      map: {
+        id: {type: String, required: true},
+        name: {type: String, required: true}
+      }
+    }],
     required: true,
-    default: ''
+    default: [],
+    fromDynamo(value) {
+      if (value.S) {
+        return value.S;
+      }
+      if (value.L) {
+        return value.L.map((item) => {
+          if (item.M && item.M.name && item.M.id) {
+            return {
+              id: item.M.id.S,
+              name: item.M.name.S
+            };
+          }
+          return null;
+        });
+      }
+      return [];
+    }
   },
   rocketChatWebhook: {type: String, required: false},
   rocketChatChannelName: {type: String, required: false},

models/ProjectChallengeMapping.js

@@ -0,0 +1,41 @@
+/*
+ * Copyright (c) 2017 TopCoder, Inc. All rights reserved.
+ */
+'use strict';
+
+/**
+ * This defines TCX project to TC challenge mapping model.
+ */
+const dynamoose = require('dynamoose');
+
+const Schema = dynamoose.Schema;
+
+/**
+ * @typedef {Object} ProjectChallengeMapping
+ * @property {String} id the id
+ * @property {String} projectId the project id
+ * @property {String} challengeId the challenge id
+ */
+
+const schema = new Schema({
+  id: {
+    type: String,
+    required: true,
+    hashKey: true
+  },
+  projectId: {
+    type: String,
+    required: true,
+    index: {
+      global: true,
+      project: true,
+      name: 'ProjectIdIndex'
+    }
+  },
+  challengeId: {
+    type: String,
+    required: true
+  }
+});
+
+module.exports = schema;

models/Repository.js

@@ -12,6 +12,16 @@ const dynamoose = require('dynamoose');
 
 const Schema = dynamoose.Schema;
 
+/**
+ * @typedef {Object} Repository
+ * @property {String} id The unique identifier for the Repository entity.
+ * @property {String} projectId The project ID associated with the repository.
+ * @property {String} url The URL of the repository.
+ * @property {String} archived Indicates whether the repository is archived or not.
+ * @property {String} repoId The repository ID (if applicable).
+ * @property {String} registeredWebhookId The ID of the registered webhook (if applicable).
+ */
+
 const schema = new Schema({
   id: {
     type: String,

models/User.js

@@ -12,6 +12,21 @@ const constants = require('../constants');
 
 const Schema = dynamoose.Schema;
 
+/**
+ * @typedef {Object} User
+ * @property {String} id The user's unique identifier.
+ * @property {Number} userProviderId The user provider's numeric identifier.
+ * @property {String} userProviderIdStr The user provider's identifier as a string.
+ * @property {String} username The user's username.
+ * @property {String} role The user's role, one of the allowed constants.USER_ROLES.
+ * @property {String} type The user's type, one of the allowed constants.USER_TYPES.
+ * @property {String} accessToken GitLab token data (if applicable).
+ * @property {Date} accessTokenExpiration Expiration date of the access token (if applicable).
+ * @property {String} refreshToken GitLab token refresh token (if applicable).
+ * @property {String} lockId Lock identifier (if applicable).
+ * @property {Date} lockExpiration Expiration date of the lock (if applicable).
+ */
+
 const schema = new Schema({
   id: {
     type: String,
@@ -49,7 +64,9 @@ const schema = new Schema({
   // gitlab token data
   accessToken: {type: String, required: false},
   accessTokenExpiration: {type: Date, required: false},
-  refreshToken: {type: String, required: false}
+  refreshToken: {type: String, required: false},
+  lockId: {type: String, required: false},
+  lockExpiration: {type: Date, required: false}
 });
 
 module.exports = schema;

models/index.js

@@ -35,15 +35,23 @@ if (process.env.CREATE_DB) {
 
 /* eslint-disable global-require */
 const models = {
+  /** @type {import('dynamoose').ModelConstructor<import('./Issue').Issue>} */
   Issue: dynamoose.model('Topcoder_X.Issue', require('./Issue')),
+  /** @type {import('dynamoose').ModelConstructor<import('./Project').Project>} */
   Project: dynamoose.model('Topcoder_X.Project', require('./Project')),
+  /** @type {import('dynamoose').ModelConstructor<import('./ProjectChallengeMapping').ProjectChallengeMapping>} */
+  ProjectChallengeMapping: dynamoose.model('Topcoder_X.ProjectChallengeMapping', require('./ProjectChallengeMapping')),
+  /** @type {import('dynamoose').ModelConstructor<import('./User').User>} */
   User: dynamoose.model('Topcoder_X.User', require('./User')),
+  /** @type {import('dynamoose').ModelConstructor<import('./CopilotPayment').CopilotPayment>} */
   CopilotPayment: dynamoose.model('Topcoder_X.CopilotPayment', require('./CopilotPayment')),
+  /** @type {import('dynamoose').ModelConstructor<import('./GithubUserMapping').GithubUserMapping>} */
   GithubUserMapping: dynamoose.model('Topcoder_X.GithubUserMapping', require('./GithubUserMapping')),
+  /** @type {import('dynamoose').ModelConstructor<import('./GitlabUserMapping').GitlabUserMapping>} */
   GitlabUserMapping: dynamoose.model('Topcoder_X.GitlabUserMapping', require('./GitlabUserMapping')),
+  /** @type {import('dynamoose').ModelConstructor<import('./Repository').Repository>} */
   Repository: dynamoose.model('Topcoder_X.Repository', require('./Repository'))
 };
 /* eslint-enable global-require */
 
-
 module.exports = models;