Merge branch 'develop' into feature/bulk-milestone-updates

Author: Maksym Mykhailenko

.eslintignore

@@ -1,7 +1,7 @@
 config/local.js
 config/mock.local.js
 config/m2m.local.js
-local/seed/
+scripts/import-from-api/
 node_modules
 dist
 .ebextensions

README.md

@@ -2,5 +2,8 @@
   "pubsubQueueName": "dev.project.service",
   "pubsubExchangeName": "dev.projects",
   "attachmentsS3Bucket": "topcoder-dev-media",
-  "connectProjectsUrl": "https://connect.topcoder-dev.com/projects/"
+  "connectProjectsUrl": "https://connect.topcoder-dev.com/projects/",
+  "fileServiceEndpoint": "https://api.topcoder-dev.com/v3/files/",
+  "connectProjectsUrl": "https://connect.topcoder-dev.com/projects/",
+  "memberServiceEndpoint": "https://api.topcoder-dev.com/v3/members"
 }

config/development.json

@@ -73,4 +73,4 @@ payload: {
     "updatedBy": 1,
   },
 }
-```
+```

docs/guides/architercture/architecture.md

@@ -0,0 +1,76 @@
+# Permissions Guide
+
+What kind of permissions we have, how they work and how to use them.
+
+- [Overview](#overview)
+  - [Topcoder Roles](#topcoder-roles)
+  - [Project Role](#project-role)
+- [How to Use](#how-to-use)
+- [References](#references)
+
+## Overview
+
+Every user may have 2 kind of roles: **Topcoder Roles** and **Project Role**.
+
+### Topcoder Roles
+
+These roles are assigned to user accounts. User may have several **Topcoder Roles**. See [the list of all Topcoder Roles](https://github.com/topcoder-platform/tc-project-service/blob/develop/src/constants.js#L55-L69) which we use in Topcoder Project Service.
+
+<img src="./images/topcoder-roles.png" width="689">
+
+By default every user has one role `Topcoder User`, generally this means that such a user is either **customer** or **community member** (freelancer).
+
+### Project Role
+
+When user joins some project and become a member of the project, such a user has one **Project Role** inside that project. One user may have different **Project Role** in different projects. See [the list of all Project Roles](https://github.com/topcoder-platform/tc-project-service/blob/develop/src/constants.js#L23-L33) which we use in Topcoder Project Service.
+
+<img src="./images/project-roles.png" width="411">
+
+## How to Use
+
+Let's say you would like to add a new place in code where you want to check user roles/permissions. Please, follow the next guide:
+
+1. Check if we already have defined permission for your case in the [permissions list](https://htmlpreview.github.io/?https://github.com/topcoder-platform/tc-project-service/blob/develop/docs/permissions.html).
+
+2. If you cannot find the permission you need, add new permission to the file https://github.com/topcoder-platform/tc-project-service/blob/develop/src/permissions/constants.js.
+
+   - Follow the guides on how to add a new permission in the header of this file.
+
+3. After you add a new permission, regenerate [permissions list](https://htmlpreview.github.io/?https://github.com/topcoder-platform/tc-project-service/blob/develop/docs/permissions.html) by running `npm run generate:doc:permissions`.
+
+4. There are 2 places where you would usually check permissions:
+   1. Check if user can call some endpoint (https://github.com/topcoder-platform/tc-project-service/blob/develop/src/permissions/index.js):
+
+      ```js
+      Authorizer.setPolicy('projectMember.view', generalPermission(PERMISSION.READ_PROJECT_MEMBER));
+      ```
+
+      or
+
+      ```js
+      Authorizer.setPolicy('projectMember.edit', generalPermission([
+         PERMISSION.UPDATE_PROJECT_MEMBER_CUSTOMER,
+         PERMISSION.UPDATE_PROJECT_MEMBER_NON_CUSTOMER,
+      ]));
+      ```
+
+   2. Inside some endpoint code:
+
+      ```js
+      import util from '../util';
+      import { PERMISSION } from '../permissions/constants';
+
+      (req, res, next) => {
+         ...
+         if (hasPermissionByReq(permission, req)) {
+            ...
+         }
+         ...
+      }
+      ```
+
+## References
+
+- [Permissions list](https://htmlpreview.github.io/?https://github.com/topcoder-platform/tc-project-service/blob/develop/docs/permissions.html)
+
+- [Permissions list source](https://github.com/topcoder-platform/tc-project-service/blob/develop/src/permissions/constants.js)

docs/guides/permissions-guide/images/project-roles.png

@@ -1,23 +1,28 @@
 version: "2"
 services:
   jsonserver:
-    extends:
-      file: ../docker-compose.yml
-      service: jsonserver
+    build: "../mock-services"
+    ports:
+      - "3001:3001"
   db:
-    extends:
-      file: ../docker-compose.yml
-      service: db
+    build: "../postgres-db"
+    ports:
+      - "5432:5432"
     environment:
+      - POSTGRES_PASSWORD=mysecretpassword
+      - POSTGRES_USER=coder
       - POSTGRES_MULTIPLE_DATABASES=projectsdb,projectsdb_test,tc_notifications
   esearch:
-    extends:
-      file: ../docker-compose.yml
-      service: esearch
+    image: "elasticsearch:2.3"
+    ports:
+      - "9200:9200"
+      - "9300:9300"
   queue:
-    extends:
-      file: ../docker-compose.yml
-      service: queue
+    image: "rabbitmq:3-management"
+    restart: always
+    ports:
+      - "5672:5672"
+      - "15672:15672"
   zookeeper:
     image: wurstmeister/zookeeper
     ports:

docs/guides/permissions-guide/images/topcoder-roles.png

@@ -0,0 +1,23 @@
+version: "2"
+services:
+  jsonserver:
+    extends:
+      file: ../full/docker-compose.yml
+      service: jsonserver
+
+  db:
+    extends:
+      file: ../full/docker-compose.yml
+      service: db
+    environment:
+      - POSTGRES_MULTIPLE_DATABASES=projectsdb,projectsdb_test
+
+  esearch:
+    extends:
+      file: ../full/docker-compose.yml
+      service: esearch
+
+  queue:
+    extends:
+      file: ../full/docker-compose.yml
+      service: queue

docs/guides/permissions-guide/permissions-guide.md

@@ -7,32 +7,30 @@
     "node": ">=12"
   },
   "scripts": {
-    "lint": "./node_modules/.bin/eslint .",
-    "lint:fix": "./node_modules/.bin/eslint . --fix || true",
+    "lint": "eslint .",
+    "lint:fix": "eslint . --fix || true",
     "build": "babel src -d dist --presets es2015 --copy-files",
-    "sync:all": "NODE_ENV=development npm run sync:db && NODE_ENV=development npm run sync:es",
-    "sync:db": "./node_modules/.bin/babel-node migrations/sync.js",
-    "sync:es": "./node_modules/.bin/babel-node migrations/elasticsearch_sync.js",
-    "sync:es:metadata": "./node_modules/.bin/babel-node migrations/elasticsearch_sync.js --index-name metadata",
-    "migrate:es": "./node_modules/.bin/babel-node migrations/seedElasticsearchIndex.js",
-    "migrate:es:metadata": "./node_modules/.bin/babel-node migrations/helpers/indexMetadataDirectly.js",
-    "migrate:bookmarks": "./node_modules/.bin/babel-node migrations/bookmarks/migrateBookmarksToLinks.js",
-    "migrate:bookmarks:revert": "./node_modules/.bin/babel-node migrations/bookmarks/migrateLinksToBookmarks.js",
     "prestart": "npm run -s build",
     "start": "node dist",
-    "start:dev": "NODE_ENV=development PORT=8001 nodemon -w src --exec \"node --require dotenv/config --require babel-core/register src\" | ./node_modules/.bin/bunyan",
+    "start:dev": "cross-env NODE_ENV=development PORT=8001 nodemon -w src --exec \"npm run babel-node-script -- src\" | bunyan",
     "startKafkaConsumers": "npm run -s build && node dist/index-kafka.js",
-    "startKafkaConsumers:dev": "NODE_ENV=development nodemon -w src --exec \"babel-node src/index-kafka.js --presets es2015\" | ./node_modules/.bin/bunyan",
-    "test": "NODE_ENV=test npm run lint && NODE_ENV=test npm run sync:es && NODE_ENV=test npm run sync:db && NODE_ENV=test ./node_modules/.bin/istanbul cover ./node_modules/mocha/bin/_mocha -- --timeout 10000 --require babel-core/register $(find src -path '*spec.js*') --exit",
-    "test:watch": "NODE_ENV=test ./node_modules/.bin/mocha -w --require babel-core/register $(find src -path '*spec.js*')",
-    "demo-data": "babel-node local/seed",
-    "es-db-compare": "babel-node scripts/es-db-compare",
-    "data:export": "NODE_ENV=development LOG_LEVEL=info node --require dotenv/config --require babel-core/register scripts/data/export",
-    "data:import": "NODE_ENV=development LOG_LEVEL=info node --require dotenv/config --require babel-core/register scripts/data/import",
-    "local:run-docker": "docker-compose -f ./local/full/docker-compose.yml up -d",
-    "local:init": "npm run sync:all && npm run data:import",
-    "generate:doc:permissions": "babel-node scripts/permissions-doc",
-    "generate:doc:permissions:dev": "nodemon --watch scripts/permissions-doc --watch src --ext js,jsx,hbs --exec babel-node scripts/permissions-doc"
+    "startKafkaConsumers:dev": "cross-env NODE_ENV=development nodemon -w src --exec \"npm run babel-node-script src/index-kafka.js\" | bunyan",
+    "test": "cross-env NODE_ENV=test npm run lint && cross-env NODE_ENV=test npm run reset:all && cross-env NODE_ENV=test istanbul cover node_modules/mocha/bin/_mocha -- --timeout 10000 --require babel-core/register \"./src/**/*.spec.js*\" --exit",
+    "test:watch": "cross-env NODE_ENV=test mocha -w --require babel-core/register \"./src/**/*.spec.js*\" ",
+    "reset:all": "npm run reset:db && npm run reset:es",
+    "reset:db": "npm run babel-node-script -- migrations/sync.js",
+    "reset:es": "npm run babel-node-script -- migrations/elasticsearch_sync.js",
+    "import-from-api": "npm run babel-node-script -- scripts/import-from-api",
+    "es-db-compare": "npm run babel-node-script -- scripts/es-db-compare",
+    "data:export": "cross-env NODE_ENV=development LOG_LEVEL=info npm run babel-node-script -- scripts/data/export",
+    "data:import": "cross-env NODE_ENV=development LOG_LEVEL=info npm run babel-node-script -- scripts/data/import",
+    "services:up": "docker-compose -f ./local/full/docker-compose.yml up -d",
+    "services:down": "docker-compose -f ./local/full/docker-compose.yml down",
+    "services:logs": "docker-compose -f ./local/full/docker-compose.yml logs",
+    "local:init": "npm run reset:all && npm run data:import",
+    "babel-node-script": "node --require dotenv/config --require babel-core/register",
+    "generate:doc:permissions": "npm run babel-node-script -- scripts/permissions-doc",
+    "generate:doc:permissions:dev": "nodemon --watch scripts/permissions-doc --watch src --ext js,jsx,hbs --exec --exec \"npm run babel-node-script scripts/permissions-doc\""
   },
   "repository": {
     "type": "git",
@@ -93,6 +91,7 @@
     "bunyan": "^1.8.12",
     "chai": "^3.5.0",
     "chai-as-promised": "^7.1.1",
+    "cross-env": "^7.0.2",
     "eslint": "^6.8.0",
     "eslint-config-airbnb-base": "^11.1.0",
     "eslint-plugin-import": "^2.2.0",