Merge pull request #441 from topcoder-platform/develop

Prod release

Author: ThomasKranitsas

README.md

@@ -81,50 +81,82 @@ You can find sample `.env` files inside the `/docs` directory.
 5. View table data in default environment: `npm run view-data <ModelName>`, ModelName can be `Challenge`, `ChallengeType`, `AuditLog`, `Phase`, `TimelineTemplate`or `Attachment`
 6. Create Elasticsearch index: `npm run init-es`, or to re-create index: `npm run init-es force`
 7. Synchronize ES data and DynamoDB data: `npm run sync-es`
+8. Start all the depending services for local deployment: `npm run services:up`
+9. Stop all the depending services for local deployment: `npm run services:down`
+10. Check the logs of all the depending services for local deployment: `npm run services:logs`
+11. Initialize the local environments: `npm run local:init`
+12. Reset the local environments: `npm run local:reset`
+
 
 ### Notes
 - The seed data are located in `src/scripts/seed`
 
 ## Local Deployment
+0. Make sure to use Node v10+ by command `node -v`. We recommend using [NVM](https://github.com/nvm-sh/nvm) to quickly switch to the right version:
+
+   ```bash
+   nvm use
+   ```
+
+1. 📦 Install npm dependencies
+
+   ```bash
+   npm install
+   ```
+
+2. ⚙ Local config   
+  In the `challenge-api` root directory create `.env` file with the next environment variables. Values for **Auth0 config** should be shared with you on the forum.<br>
+     ```bash
+     # Auth0 config
+     AUTH0_URL=
+     AUTH0_PROXY_SERVER_URL=
+     AUTH0_AUDIENCE=
+     AUTH0_CLIENT_ID=
+     AUTH0_CLIENT_SECRET=
+
+     # Locally deployed services (via docker-compose)
+     IS_LOCAL_DB=true
+     DYNAMODB_URL=http://localhost:8000
+     ```
+
+    - Values from this file would be automatically used by many `npm` commands.
+    - ⚠️ Never commit this file or its copy to the repository!
+
+3. 🚢 Start docker-compose with services which are required to start Topcoder Challenges API locally
+
+   ```bash
+   npm run services:up
+   ```
+   
+4. ♻ Update following two parts:
+- https://github.com/topcoder-platform/challenge-api/blob/develop/src/models/Challenge.js#L116
+  `throughput: 'ON_DEMAND',` should be updated to `throughput:{ read: 4, write: 2 },`
+- https://github.com/topcoder-platform/challenge-api/blob/develop/config/default.js#L27-L28
 
-### AWS S3 Setup
-Go to https://console.aws.amazon.com/ and login. Choose S3 from Service folder and click `Create bucket`. Following the instruction to create S3 bucket.
+5. ♻ Create tables.
 
-### Local services setup
-In the `local` folder, run `docker-compose up` to start Elasticsearch, DynamoDB, S3 compatible server and Mock API.
+   ```bash
+   npm run create-tables
+   # Use `npm run drop-tables` to drop tables.
+   ```
 
-### Create Tables
-1. Make sure DynamoDB are running as per instructions above.
-2. Make sure you have configured all config parameters. Refer [Configuration](#configuration)
-3. Run `npm run create-tables` to create tables.
+6. ♻ Init DB, ES
 
-### Mock API
-The provided mock API provides mock endpoint to fetch challenge resources and groups so you don't have to deploy the related services locally.
-You need to ensure DynamoDB configuration in `mock-api/config/default.js` is consistent with `config/default.js`
-Mock API starts after running `docker-compose up` and expose port 4000.
+   ```bash
+   npm run local:init
+   ```
 
-### Notes
-There are two parts need to be updated for local development
-- https://github.com/topcoder-platform/challenge-api/blob/develop/src/models/Challenge.js#L116 
-`throughput: 'ON_DEMAND',` should be updated to `throughput:{ read: 4, write: 2 },`
-- https://github.com/topcoder-platform/challenge-api/blob/develop/config/default.js#L27-L28
-Two aws config should be uncommented
-
-and AUTH0 related configuration must be set at config file or in env variables.
-
-### Deploy the app
-
-- Follow the Notes section above
-- Install dependencies `npm install`
-- Run lint `npm run lint`
-- Run lint fix `npm run lint:fix`
-- initialize Elasticsearch, create configured Elasticsearch index if not present: `npm run init-es`,
-  or re-create the index: `npm run init-es force`
-- Create tables `npm run create-tables`
-- Clear and init db `npm run init-db`
-- Seed tables: `npm run seed-tables`
-- Start app `npm start`
-- App is running at `http://localhost:3000`
+   This command will do 3 things:
+  - create Elasticsearch indexes (drop if exists)
+  - Initialize the database by cleaning all the records.
+  - Import the data to the local database and index it to ElasticSearch
+
+7. 🚀 Start Topcoder Challenge API
+
+   ```bash
+   npm start
+   ```
+   The Topcoder Challenge API will be served on `http://localhost:3000`
 
 ## Production deployment
 

Verification.md

@@ -1,10 +1,13 @@
 # TopCoder Challenge API Verification
 
-## Postman tests
-- clear the environment, run command `npm run init-db` and `npm run init-es force`
-- import Postman collection and environment in the docs folder to Postman
-- run tests from up to down in order
-- You need to run command `npm run sync-es` before you run `Challenges/get challenge` and `Challenges/search challenge` test case.
+## E2E Postman tests
+- Import Postman collection and environment in the docs folder to Postman
+- Set `token` variable in environment variables folder
+- Open Runner
+- Put E2E Test Folder inside Runner
+- Set `Delay` to 2000ms
+- Check `Save Responses`
+- Start Run
 
 ## DynamoDB Verification
 Run command `npm run view-data <ModelName>` to view table data, ModelName can be `Challenge`, `ChallengeType`, `AuditLog`, `Phase`, `TimelineTemplate`, `Attachment` or `ChallengeTimelineTemplate`

app-constants.js

@@ -1,11 +1,14 @@
+const config = require('config')
+
 /**
  * App constants
  */
 const UserRoles = {
   Admin: 'administrator',
   Copilot: 'copilot',
   Manager: 'Connect Manager',
-  User: 'Topcoder User'
+  User: 'Topcoder User',
+  SelfServiceCustomer: 'Self-Service Customer'
 }
 
 const prizeSetTypes = {
@@ -18,6 +21,7 @@ const prizeSetTypes = {
 const challengeStatuses = {
   New: 'New',
   Draft: 'Draft',
+  Approved: 'Approved',
   Cancelled: 'Cancelled',
   Active: 'Active',
   Completed: 'Completed',
@@ -28,7 +32,8 @@ const challengeStatuses = {
   CancelledWinnerUnresponsive: 'Cancelled - Winner Unresponsive',
   CancelledClientRequest: 'Cancelled - Client Request',
   CancelledRequirementsInfeasible: 'Cancelled - Requirements Infeasible',
-  CancelledZeroRegistrations: 'Cancelled - Zero Registrations'
+  CancelledZeroRegistrations: 'Cancelled - Zero Registrations',
+  CancelledPaymentFailed: 'Cancelled - Payment Failed'
 }
 
 const validChallengeParams = {
@@ -70,7 +75,9 @@ const Topics = {
   ChallengeTypeTimelineTemplateDeleted: 'test.new.bus.events', // 'challenge.action.type.timeline.template.deleted'
   ChallengeAttachmentCreated: 'test.new.bus.events', // 'challenge.action.attachment.created',
   ChallengeAttachmentUpdated: 'test.new.bus.events', // 'challenge.action.attachment.updated',
-  ChallengeAttachmentDeleted: 'test.new.bus.events' // 'challenge.action.attachment.deleted',
+  ChallengeAttachmentDeleted: 'test.new.bus.events', // 'challenge.action.attachment.deleted',
+  // Self Service topics
+  Notifications: 'notifications.action.create'
 }
 
 const challengeTracks = {
@@ -90,6 +97,32 @@ const reviewTypes = {
   Internal: 'INTERNAL'
 }
 
+const SelfServiceNotificationTypes = {
+  WORK_REQUEST_SUBMITTED: 'self-service.notifications.work-request-submitted',
+  WORK_REQUEST_STARTED: 'self-service.notifications.work-request-started',
+  WORK_REQUEST_REDIRECTED: 'self-service.notifications.work-request-redirected',
+  WORK_COMPLETED: 'self-service.notifications.work-completed'
+}
+
+const SelfServiceNotificationSettings = {
+  [SelfServiceNotificationTypes.WORK_REQUEST_SUBMITTED]: {
+    sendgridTemplateId: config.SENDGRID_TEMPLATES.WORK_REQUEST_SUBMITTED,
+    cc: []
+  },
+  [SelfServiceNotificationTypes.WORK_REQUEST_STARTED]: {
+    sendgridTemplateId: config.SENDGRID_TEMPLATES.WORK_REQUEST_STARTED,
+    cc: []
+  },
+  [SelfServiceNotificationTypes.WORK_REQUEST_REDIRECTED]: {
+    sendgridTemplateId: config.SENDGRID_TEMPLATES.WORK_REQUEST_REDIRECTED,
+    cc: [...config.SELF_SERVICE_EMAIL_CC_ACCOUNTS]
+  },
+  [SelfServiceNotificationTypes.WORK_COMPLETED]: {
+    sendgridTemplateId: config.SENDGRID_TEMPLATES.WORK_COMPLETED,
+    cc: []
+  }
+}
+
 module.exports = {
   UserRoles,
   prizeSetTypes,
@@ -101,5 +134,7 @@ module.exports = {
   challengeTracks,
   challengeTextSortField,
   DiscussionTypes,
-  reviewTypes
+  reviewTypes,
+  SelfServiceNotificationTypes,
+  SelfServiceNotificationSettings
 }

app-routes.js

@@ -50,6 +50,7 @@ module.exports = (app) => {
               next(new errors.ForbiddenError('You are not allowed to perform this action!'))
             } else {
               req.authUser.handle = config.M2M_AUDIT_HANDLE
+              req.userToken = req.headers.authorization.split(' ')[1]
               next()
             }
           } else {

config/default.js

@@ -1,7 +1,8 @@
 /**
  * The configuration file.
  */
-
+const _ = require('lodash')
+require('dotenv').config()
 module.exports = {
   READONLY: process.env.READONLY === 'true' || false,
   LOG_LEVEL: process.env.LOG_LEVEL || 'debug',
@@ -57,13 +58,15 @@ module.exports = {
   GROUPS_API_URL: process.env.GROUPS_API_URL || 'http://localhost:4000/v5/groups',
   PROJECTS_API_URL: process.env.PROJECTS_API_URL || 'http://localhost:4000/v5/projects',
   TERMS_API_URL: process.env.TERMS_API_URL || 'http://localhost:4000/v5/terms',
+  CUSTOMER_PAYMENTS_URL: process.env.CUSTOMER_PAYMENTS_URL || 'https://api.topcoder-dev.com/v5/customer-payments',
   // copilot resource role ids allowed to upload attachment
   COPILOT_RESOURCE_ROLE_IDS: process.env.COPILOT_RESOURCE_ROLE_IDS
     ? process.env.COPILOT_RESOURCE_ROLE_IDS.split(',') : ['10ba038e-48da-487b-96e8-8d3b99b6d18b'],
   SUBMITTER_ROLE_ID: process.env.SUBMITTER_ROLE_ID || '732339e7-8e30-49d7-9198-cccf9451e221',
 
   MANAGER_ROLE_ID: process.env.MANAGER_ROLE_ID || '0e9c6879-39e4-4eb6-b8df-92407890faf1',
   OBSERVER_ROLE_ID: process.env.OBSERVER_ROLE_ID || '2a4dc376-a31c-4d00-b173-13934d89e286',
+  CLIENT_MANAGER_ROLE_ID: process.env.OBSERVER_ROLE_ID || '9b2f1905-8128-42da-85df-ed64410f4781',
 
   // health check timeout in milliseconds
   HEALTH_CHECK_TIMEOUT: process.env.HEALTH_CHECK_TIMEOUT || 3000,
@@ -80,5 +83,24 @@ module.exports = {
 
   M2M_AUDIT_HANDLE: process.env.M2M_AUDIT_HANDLE || 'tcwebservice',
 
-  FORUM_TITLE_LENGTH_LIMIT: process.env.FORUM_TITLE_LENGTH_LIMIT || 90
+  FORUM_TITLE_LENGTH_LIMIT: process.env.FORUM_TITLE_LENGTH_LIMIT || 90,
+
+  NEW_SELF_SERVICE_PROJECT_TYPE: process.env.NEW_SELF_SERVICE_PROJECT_TYPE || 'self-service',
+
+  SENDGRID_TEMPLATES: {
+    WORK_REQUEST_SUBMITTED: process.env.WORK_REQUEST_SUBMITTED || '',
+    WORK_REQUEST_STARTED: process.env.WORK_REQUEST_STARTED || '',
+    WORK_REQUEST_REDIRECTED: process.env.WORK_REQUEST_REDIRECTED || '',
+    WORK_COMPLETED: process.env.WORK_COMPLETED || ''
+  },
+
+  EMAIL_FROM: process.env.EMAIL_FROM || 'no-reply@topcoder.com',
+  SELF_SERVICE_EMAIL_CC_ACCOUNTS: process.env.SELF_SERVICE_EMAIL_CC_ACCOUNTS ? _.map(process.env.SELF_SERVICE_EMAIL_CC_ACCOUNTS.split(','), email => ({ email })) : ['sathya.jayabal@gmail.com'],
+  SELF_SERVICE_WHITELIST_HANDLES: process.env.SELF_SERVICE_WHITELIST_HANDLES ? process.env.SELF_SERVICE_WHITELIST_HANDLES.split(',') : ['TCConnCopilot', 'sstestcopilot'],
+  SELF_SERVICE_APP_URL: process.env.SELF_SERVICE_APP_URL || 'https://platform.topcoder-dev.com/self-service',
+
+  ZENDESK_API_TOKEN: process.env.ZENDESK_API_TOKEN || '',
+  ZENDESK_API_URL: process.env.ZENDESK_API_URL || '',
+  ZENDESK_CUSTOM_FIELD_TAG_ID: process.env.ZENDESK_CUSTOM_FIELD_TAG_ID,
+  ZENDESK_DEFAULT_PRIORITY: process.env.ZENDESK_DEFAULT_PRIORITY || 'high'
 }