Merge pull request #10 from topcoder-platform/develop

dev to master

Author: Gunasekar-K

.circleci/config.yml

@@ -0,0 +1,78 @@
+version: 2
+defaults: &defaults
+  docker:
+  - image: cimg/python:3.12.1-browsers
+install_dependency: &install_dependency
+  name: Installation of build and deployment dependencies.
+  command: |
+    pip3 install awscli --upgrade
+install_deploysuite: &install_deploysuite
+  name: Installation of install_deploysuite.
+  command: |
+    git clone --branch v1.4.19 https://github.com/topcoder-platform/tc-deploy-scripts ../buildscript
+    cp ./../buildscript/master_deploy.sh .
+    cp ./../buildscript/buildenv.sh .
+    cp ./../buildscript/awsconfiguration.sh .
+    cp ./../buildscript/psvar-processor.sh .
+restore_cache_settings_for_build: &restore_cache_settings_for_build
+  key: docker-node-modules-v6-{{ checksum "yarn.lock" }}
+
+save_cache_settings: &save_cache_settings
+  key: docker-node-modules-v6-{{ checksum "yarn.lock" }}
+  paths:
+  - node_modules
+
+builddeploy_steps: &builddeploy_steps
+- checkout
+- setup_remote_docker
+- run: *install_dependency
+- run: *install_deploysuite
+- run: ./build.sh ${APPNAME}
+- run:
+    name: Running MasterScript.
+    command: |
+      ./awsconfiguration.sh $DEPLOY_ENV
+      source awsenvconf
+      ./psvar-processor.sh -t appenv -p /config/${APPNAME}/deployvar
+      source deployvar_env
+      ./master_deploy.sh -d ECS -e $DEPLOY_ENV -t latest -j /config/${APPNAME}/appvar,/config/common/global-appvar -i ${APPNAME} -p FARGATE
+      
+
+jobs:
+  # Build & Deploy against development backend
+  "build-dev":
+    !!merge <<: *defaults
+    environment:
+      DEPLOY_ENV: "DEV"
+      LOGICAL_ENV: "dev"
+      APPNAME: "member-api-v6"
+    steps: *builddeploy_steps
+
+  "build-prod":
+    !!merge <<: *defaults
+    environment:
+      DEPLOY_ENV: "PROD"
+      LOGICAL_ENV: "prod"
+      APPNAME: "member-api-v6"
+    steps: *builddeploy_steps
+
+workflows:
+  version: 2
+  build:
+    jobs:
+    # Development builds are executed on "develop" branch only.
+    - "build-dev":
+        context: org-global
+        filters:
+          branches:
+            only:
+            - develop
+            
+    # Production builds are exectuted only on tagged commits to the
+    # master branch.
+    - "build-prod":
+        context: org-global
+        filters:
+          branches:
+            only:
+            - master

.github/workflows/code_reviewer.yml

@@ -0,0 +1,22 @@
+name: AI PR Reviewer
+
+on:
+    pull_request:
+        types:
+            - opened
+            - synchronize
+permissions:
+    pull-requests: write
+jobs:
+    tc-ai-pr-review:
+        runs-on: ubuntu-latest
+        steps:
+            - name: Checkout Repo
+              uses: actions/checkout@v3
+
+            - name: TC AI PR Reviewer
+              uses: topcoder-platform/tc-ai-pr-reviewer@master
+              with:
+                  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # The GITHUB_TOKEN is there by default so you just need to keep it like it is and not necessarily need to add it as secret as it will throw an error. [More Details](https://docs.github.com/en/actions/security-guides/automatic-token-authentication#about-the-github_token-secret)
+                  LAB45_API_KEY: ${{ secrets.LAB45_API_KEY }}
+                  exclude: '**/*.json, **/*.md, **/*.jpg, **/*.png, **/*.jpeg, **/*.bmp, **/*.webp' # Optional: exclude patterns separated by commas

.gitignore

@@ -0,0 +1,45 @@
+# can be used locally to config some env variables and after apply them using `source .env`
+.env
+### Node ###
+# Logs
+logs
+*.log
+npm-debug.log*
+.DS_Store
+.tern-port
+*#
+
+dist/
+
+# Runtime data
+pids
+*.pid
+*.seed
+AGENTS.md
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (http://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules
+jspm_packages
+
+# Optional npm cache directory
+.npm
+
+
+.DS_Store
+.idea
+.vscode/

.nvmrc

@@ -0,0 +1 @@
+21.6

ReadMe.md

@@ -20,11 +20,12 @@ docker run -d --name memberdb -p 5432:5432 \
 After that, please set db URL environment variables:
 ```bash
 export DATABASE_URL="postgresql://johndoe:mypassword@localhost:5432/memberdb"
+export SKILLS_DB_URL="postgresql://johndoe:mypassword@localhost:5432/skillsdb"
 ```
 
-This variable is important since it's required by prisma.
+These variables are important since they're required by Prisma clients.
 
-If you want to do anything with database, this variable is necessary.
+If you want to do anything with database, these variables are necessary.
 
 ## Database Scripts
 
@@ -33,6 +34,7 @@ Before running db scripts, please make sure you have setup db and config db url
 ```bash
 # set db url values
 export DATABASE_URL="postgresql://johndoe:mypassword@localhost:5432/memberdb"
+export SKILLS_DB_URL="postgresql://johndoe:mypassword@localhost:5432/skillsdb"
 
 # install dependencies
 npm install
@@ -61,7 +63,7 @@ I have created a script to download data from dev environment and a script to lo
 To use them, you should:
 - Make sure you have started db.
 - Check configs in `src/scripts/config.js`. Add some handle if you like.
-- Open a terminal and navigate to codebase folder. Set `DATABASE_URL` above.
+- Open a terminal and navigate to codebase folder. Set `DATABASE_URL` and `SKILLS_DB_URL` above.
 - Run `npm install`.
 - Use `node src/scripts/download.js` to download profile data.
 - Run `npm run clear-db` to clear db data first
@@ -86,7 +88,7 @@ The following parameters can be set in config files or in env variables:
 - BUSAPI_URL: Bus API URL
 - KAFKA_ERROR_TOPIC: Kafka error topic used by bus API wrapper
 - GROUPS_API_URL: Groups API URL
-- AMAZON.AWS_ACCESS_KEY_ID: The Amazon certificate key to use when connecting. 
+- AMAZON.AWS_ACCESS_KEY_ID: The Amazon certificate key to use when connecting.
 - AMAZON.AWS_SECRET_ACCESS_KEY: The Amazon certificate access key to use when connecting.
 - AMAZON.AWS.SESSION_TOKEN: The user session token, used when developing locally against the TC dev AWS services
 - AMAZON.AWS_REGION: The Amazon certificate region to use when connecting.
@@ -138,6 +140,8 @@ To make local development easier, I create a mock server at `mock`.
 
 You can start it with `node mock/mock-api.js` and it will listen to port `4000`
 
+This mock service will simulate request and responses for other APIs like auth0 and event bus API.
+
 ## Local Configs
 
 Please run following commands to set necessary configs:
@@ -147,13 +151,11 @@ export AUTH0_URL="http://localhost:4000/v5/auth0"
 export BUSAPI_URL="http://localhost:4000/v5"
 export AUTH0_CLIENT_ID=xyz
 export AUTH0_CLIENT_SECRET=xyz
-export LOOKER_API_BASE_URL="http://localhost:4000/v5/looker"
-export LOOKER_API_CLIENT_ID=xyz
-export LOOKER_API_CLIENT_SECRET=xyz
 export USERFLOW_PRIVATE_KEY=mysecret
+export GROUPS_API_URL="http://localhost:4000/v5/groups"
 ```
 
-These commands will set auth0, event bus pi and looker api to local mock server.
+These commands will set auth0 and event bus api to local mock server.
 
 ## Local Deployment
 
@@ -167,12 +169,11 @@ These commands will set auth0, event bus pi and looker api to local mock server.
 ## Tests
 
 
-Make sure you have followed above steps to 
+Make sure you have followed above steps to
 - setup db and config db url
 - setup local mock api and set local configs
   - it will really call service and mock api
 
-Unit tests use `aws-sdk-mock` to mock S3 operations. So you can safely run tests without S3 configs.
 
 Then you can run:
 ```bash

Verification.md

@@ -54,6 +54,7 @@ Just be careful about the schemas used for different kind of trait.
 There are some changes to prisma schema.
 
 - Add memberTraits.hobby
+- Update memberSkill.displayMode to optional
 - Remove displayMode.memberSkills @ignore
 - Add stats fields as discussed in forum
 

app-bootstrap.js

@@ -8,3 +8,4 @@ Joi.page = () => Joi.number().integer().min(1).default(1)
 Joi.perPage = () => Joi.number().integer().min(1).max(100).default(50)
 Joi.size = () => Joi.number().integer().min(1).max(1000).default(500)
 Joi.sort = () => Joi.string().default('asc')
+Joi.positive = () => Joi.number().integer().min(0)

app-constants.js

@@ -2,7 +2,7 @@
  * App constants
  */
 const ADMIN_ROLES = ['administrator', 'admin']
-const SEARCH_BY_EMAIL_ROLES = ADMIN_ROLES.concat('tgadmin');
+const SEARCH_BY_EMAIL_ROLES = ADMIN_ROLES.concat('tgadmin')
 const AUTOCOMPLETE_ROLES = ['copilot', 'administrator', 'admin', 'Connect Copilot', 'Connect Account Manager', 'Connect Admin', 'Account Executive']
 
 const EVENT_ORIGINATOR = 'topcoder-member-api'

app.js

@@ -13,6 +13,9 @@ const HttpStatus = require('http-status-codes')
 const logger = require('./src/common/logger')
 const interceptor = require('express-interceptor')
 const fileUpload = require('express-fileupload')
+const path = require('path')
+const swaggerUi = require('swagger-ui-express')
+const YAML = require('yamljs')
 
 // setup express app
 const app = express()
@@ -35,6 +38,18 @@ app.use(bodyParser.json())
 app.use(bodyParser.urlencoded({ extended: true }))
 app.set('port', config.PORT)
 
+// Swagger / OpenAPI documentation
+const swaggerDocument = YAML.load(path.join(__dirname, 'docs', 'swagger.yaml'))
+swaggerDocument.basePath = `/${config.API_VERSION}`
+const docsRoute = `/${config.API_VERSION}/members/api-docs`
+app.use(docsRoute, swaggerUi.serve, swaggerUi.setup(swaggerDocument, {
+  swaggerOptions: { docExpansion: 'list' },
+  customSiteTitle: 'Topcoder Member API v6 Documentation'
+}))
+app.get(`${docsRoute}.json`, (req, res) => {
+  res.json(swaggerDocument)
+})
+
 // intercept the response body from jwtAuthenticator
 app.use(interceptor((req, res) => {
   return {

build.sh

@@ -0,0 +1,23 @@
+#!/bin/bash
+set -eo pipefail
+APP_NAME=$1
+UPDATE_CACHE=""
+#docker-compose -f docker/docker-compose.yml build $APP_NAME
+docker build -f docker/Dockerfile -t $APP_NAME:latest .
+docker create --name app $APP_NAME:latest
+
+if [ -d node_modules ]
+then
+  mv package-lock.json old-package-lock.json
+  docker cp app:/$APP_NAME/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:/$APP_NAME/node_modules .
+fi