.circleci/config.yml

@@ -1,24 +1,26 @@
-version: 2
+version: 2.1
 defaults: &defaults
-    docker:
-      - image: circleci/python:stretch-browsers
+  docker:
+    - image: cimg/python:3.13.2-browsers
 install_dependency: &install_dependency
     name: Installation of build and deployment dependencies.
     command: |
-      sudo apt install jq
-      sudo pip3 install awscli --upgrade
-      sudo pip3 install docker-compose      
+        sudo apt update
+        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.
-          command: |
-            git clone --branch v1.4.1 https://github.com/topcoder-platform/tc-deploy-scripts ../buildscript
-            cp ./../buildscript/master_deploy.sh .
-            cp ./../buildscript/buildenv.sh .
-            cp ./../buildscript/awsconfiguration.sh .
+  name: Installation of install_deploysuite.
+  command: |
+    git clone --branch v1.4.17 https://github.com/topcoder-platform/tc-deploy-scripts ../buildscript
+    cp ./../buildscript/master_deploy.sh .
+    cp ./../buildscript/buildenv.sh .
+    cp ./../buildscript/awsconfiguration.sh .
 run_build: &run_build
-          name: Installation of build dependencies.
-          command: ./build.sh
+  name: Installation of build dependencies.
+  command: ./build.sh
 
 jobs:
   # Build & Deploy against development backend
@@ -38,7 +40,7 @@ jobs:
             source awsenvconf
             ./buildenv.sh -e DEV -b dev-submissions-api-deployvar
             source buildenvvar
-            ./master_deploy.sh -d ECS -e DEV -t latest -s dev-global-appvar,dev-submissions-api-appvar -i submissions-api
+            ./master_deploy.sh -d ECS -e DEV -t latest -s dev-global-appvar,dev-submissions-api-appvar -i submissions-api -p FARGATE
 
   "build-prod":
     <<: *defaults
@@ -56,20 +58,22 @@ jobs:
             source awsenvconf
             ./buildenv.sh -e PROD -b prod-submissions-api-deployvar
             source buildenvvar
-            ./master_deploy.sh -d ECS -e PROD -t latest -s prod-global-appvar,prod-submissions-api-appvar -i submissions-api
+            ./master_deploy.sh -d ECS -e PROD -t latest -s prod-global-appvar,prod-submissions-api-appvar -i submissions-api -p FARGATE
 
 workflows:
   version: 2
   build:
     jobs:
       # Development builds are executed on "develop" branch only.
       - "build-dev":
-          context : org-global
+          context: org-global
           filters:
             branches:
-              only: ['develop']
+              only: ["develop", "PM-809_artifact-endpoint-update"]
       - "build-prod":
-          context : org-global
+          context: org-global
           filters:
             branches:
-              only: master
+              only:
+                - master
+                - hotfix/inc-15

.eslintrc.yml

@@ -0,0 +1,8 @@
+env:
+  browser: true
+  commonjs: true
+  es2021: true
+extends: standard
+parserOptions:
+  ecmaVersion: latest
+rules: {}

README.md

@@ -1,5 +1,26 @@
 # Topcoder Submission API
 
+Topcoder's API that deals with submissions, reviews, review summations and review types on the Topcoder platform
+
+## Devlopment status
+
+[![Total alerts](https://img.shields.io/lgtm/alerts/g/topcoder-platform/submissions-api.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/topcoder-platform/submissions-api/alerts/)[![Language grade: JavaScript](https://img.shields.io/lgtm/grade/javascript/g/topcoder-platform/submissions-api.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/topcoder-platform/submissions-api/context:javascript)
+
+### Deployment status
+
+Dev: [![CircleCI](https://circleci.com/gh/topcoder-platform/submissions-api/tree/develop.svg?style=svg)](https://circleci.com/gh/topcoder-platform/submissions-api/tree/develop) Prod: [![CircleCI](https://circleci.com/gh/topcoder-platform/submissions-api/tree/master.svg?style=svg)](https://circleci.com/gh/topcoder-platform/submissions-api/tree/master)
+
+## Swagger definition
+
+- [Swagger](https://api.topcoder.com/v5/submissions/docs)
+
+## Intended use
+
+- Production API
+
+## Related repos
+
+- [ES Processor](https://github.com/topcoder-platform/submission-processor-es) - Updates data in Opensearch
 
 ## Pre-requisites
 
@@ -50,7 +71,7 @@ e.g.
 
 ```
 export AWS_REGION="<AWS Region>"
-export S3_BUCKET="<S3 Bucket Name>"
+export DMZ_BUCKET="<S3 Bucket Name>"
 export ARTIFACT_BUCKET="<Artifact S3 Bucket Name>"
 export ES_HOST="<ES Endpoint>"
 export AUTH0_URL="<Auth0 URL>"
@@ -94,6 +115,84 @@ This script will load the data from `scripts/data` directory into ES
 npm run start
 ```
 
+### 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 `submissions-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
+     # AWS related config
+     AWS_ACCESS_KEY_ID=
+     AWS_SECRET_ACCESS_KEY=
+     AWS_REGION=
+     DMZ_BUCKET=
+     ARTIFACT_BUCKET=
+
+     # Auth0 config
+     AUTH0_URL=
+     AUTH0_PROXY_SERVER_URL=
+     TOKEN_CACHE_TIME=
+     AUTH0_AUDIENCE=
+     AUTH0_CLIENT_ID=
+     AUTH0_CLIENT_SECRET=
+
+     # Locally deployed services (via docker-compose)
+     ES_HOST=localhost:9200
+     ```
+
+   - 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 Submissions API locally
+
+   ```bash
+   npm run services:up
+   ```
+   - `npm run services:down` can be used to shutdown the docker services
+   - `npm run services:logs` can be used to view the logs from the docker services
+
+4. ♻ Create tables.
+
+   ```bash
+   npm run create-tables
+   ```
+5. ♻ Create ES index.
+
+   ```bash
+   npm run create-index
+   ```
+
+6. ♻ Init DB, ES
+
+   ```bash
+   npm run local:init
+   ```
+
+   This command will do 2 things:
+   - Import the data to the database and index it to OpenSearch
+   - Note, to migrate the existing data from DynamoDB to OS, run the following script
+      ```
+      npm run db-to-es
+      ```
+
+7. 🚀 Start Topcoder Submissions API
+
+   ```bash
+   npm run start
+   ```
+   The Topcoder Submissions API will be served on `http://localhost:3000`
+
+
 #### Linting JS files
 
 ```
@@ -191,10 +290,6 @@ and then run the following script
 npm run update-to-v5-challengeId
 ```
 
-#### Swagger UI
-
-Swagger UI will be served at `http://localhost:3000/docs`
-
 ## Postman verification
 
 1. Open Postman
@@ -220,3 +315,5 @@ Swagger UI will be served at `http://localhost:3000/docs`
 2. There are 3 tokens provided in the environment collection representing each role - Topcoder User, Copilot, Administrator
 
 3. DynamoDB performance seems to be slower in my testing
+
+Token Commit.

app.js

@@ -10,15 +10,14 @@ const cors = require('cors')
 const bodyParser = require('body-parser')
 const httpStatus = require('http-status')
 const _ = require('lodash')
-const winston = require('winston')
+const logger = require('./src/common/logger')
 const helper = require('./src/common/helper')
 const errorMiddleware = require('./src/common/ErrorMiddleware')
 const routes = require('./src/routes')
 const swaggerUi = require('swagger-ui-express')
 const YAML = require('yamljs')
 const authenticator = require('tc-core-library-js').middleware.jwtAuthenticator
 const fileUpload = require('express-fileupload')
-const memwatch = require('memwatch-next')
 
 const swaggerDocument = YAML.load('./docs/swagger.yaml')
 const app = express()
@@ -29,20 +28,9 @@ app.set('port', config.WEB_SERVER_PORT)
 app.use(bodyParser.json({ limit: '50mb' }))
 app.use(bodyParser.urlencoded({ limit: '50mb', extended: true }))
 app.use(cors())
-app.use(fileUpload())
-
-memwatch.on('leak', function (info) {
-  winston.info(`Memory leak detected, details:  ${info}`)
-  const reqBody = {
-    topic: 'common.error.reporting',
-    originator: 'submission-api',
-    timestamp: (new Date()).toISOString(), // time when submission was created
-    'mime-type': 'application/json',
-    payload: info
-  }
-
-  helper.postToBusApi(reqBody)
-})
+app.use(fileUpload({
+  limits: { fileSize: 150 * 1024 * 1024 }
+}))
 
 const apiRouter = express.Router()
 
@@ -77,7 +65,6 @@ function checkIfExists (source, term) {
   return false
 }
 
-/* eslint-disable no-param-reassign */
 _.each(routes, (verbs, url) => {
   _.each(verbs, (def, verb) => {
     let actions = [
@@ -86,7 +73,7 @@ _.each(routes, (verbs, url) => {
         next()
       }
     ]
-    const method = require(`./src/controllers/${def.controller}`)[ def.method ]; // eslint-disable-line
+    const method = require(`./src/controllers/${def.controller}`)[def.method]
 
     if (!method) {
       throw new Error(`${def.method} is undefined, for controller ${def.controller}`)
@@ -127,19 +114,32 @@ _.each(routes, (verbs, url) => {
       })
     }
 
+    if (def.blockByIp) {
+      actions.push((req, res, next) => {
+        req.authUser.blockIP = _.find(req.authUser, (value, key) => {
+          return (key.indexOf('blockIP') !== -1)
+        })
+        if (req.authUser.blockIP) {
+          throw new errors.HttpStatusError(403, 'Access denied')
+        } else {
+          next()
+        }
+      })
+    }
+
     actions.push(method)
-    winston.info(`API : ${verb.toLocaleUpperCase()} ${config.API_VERSION}${url}`)
+    logger.info(`API : ${verb.toLocaleUpperCase()} ${config.API_VERSION}${url}`)
     apiRouter[verb](`${config.API_VERSION}${url}`, helper.autoWrapExpress(actions))
   })
 })
 /* eslint-enable no-param-reassign */
 
+app.use('/v5/submissions/docs', swaggerUi.serve, swaggerUi.setup(swaggerDocument))
 app.use('/', apiRouter)
 app.use(errorMiddleware())
 // Serve Swagger Docs after setting host and base path
 swaggerDocument.host = config.HOST
 swaggerDocument.basePath = config.API_VERSION
-app.use('/docs', swaggerUi.serve, swaggerUi.setup(swaggerDocument))
 
 // Check if the route is not found or HTTP method is not supported
 app.use('*', (req, res) => {
@@ -153,7 +153,7 @@ app.use('*', (req, res) => {
 })
 
 http.listen(app.get('port'), () => {
-  winston.info(`Express server listening on port ${app.get('port')}`)
+  logger.info(`Express server listening on port ${app.get('port')}`)
 })
 
 module.exports = app

build.sh

@@ -10,5 +10,20 @@ set -eo pipefail
 #sed -i='' "s|submissions-api:latest|$TAG|" docker/docker-compose.yml
 echo "" > docker/api.env
 docker-compose -f docker/docker-compose.yml build submissions-api
-docker images
+#docker images
+docker create --name app submissions-api:latest
+if [ -d node_modules ]
+then
+  mv package-lock.json old-package-lock.json
+  docker cp app:/submissions-api/package-lock.json package-lock.json
+  set +eo pipefail
+  UPDATE_CACHE=$(cmp package-lock.json old-package-lock.json)
+  set -eo pipefail
+else
+  UPDATE_CACHE=1
+fi
 
+if [ "$UPDATE_CACHE" == 1 ]
+then
+  docker cp app:/submissions-api/node_modules .
+fi