Merge branch 'feature/challenge-filters-refactoring' into merge

Author: birdofpreyru

config/default.json

@@ -51,6 +51,7 @@
     "ONLINE_REVIEW": "https://software.topcoder-dev.com",
     "STUDIO": "https://studio.topcoder-dev.com",
     "TCO": "https://www.topcoder.com/tco",
+    "USER_SETTINGS": "https://lc1-user-settings-service.herokuapp.com",
     "WIPRO": "https://wipro.topcoder.com"
   },
   "DOMAIN": "topcoder-dev.com",

docs/how-to-add-a-new-topcoder-community.md

@@ -10,8 +10,9 @@ To add a new community with the name **demo**, we should follow the following pr
       "authorizedGroupIds": [
         "12345"
       ],
-      "challengeGroupId": "12345",
-      "challengeFilterTag": "",
+      "challengeFilter": {
+        "groupIds": ["12345"]
+      },
       "communityId": "demo",
       "communitySelector": [{
         "label": "Demo Community",
@@ -25,6 +26,7 @@ To add a new community with the name **demo**, we should follow the following pr
         "redirect": "https://ios.topcoder.com/",
         "value": "3"
       }],
+      "groupId": "12345",
       "leaderboardApiUrl": "https://api.topcoder.com/v4/looks/0/run/json/",
       "logos": [
         "/themes/demo/logo_topcoder_with_name.svg"
@@ -49,10 +51,28 @@ To add a new community with the name **demo**, we should follow the following pr
     ```
     Its fields serve the following purposes:
     -   `authorizedGroupIds` - *String Array* - Optional. Array of group IDs. If specified, access to the community will be restricted only to authenticated visitors, included into, at least, one of the groups listed in this array. If undefined, community will be accessible to any visitors (including non-authenticated ones).
-    -   `challengeGroupId` - *String* - Optional. ID of the group holding challenges related to this community. If undefined, challenge listing in this community will show all public challenges.
-    -   `challengeFilterTag` - *String* - Optional. If specified, and not an empty string, only challenges having this technology tag will be shown inside the community (it acts as an additional filter after the group-based filtering).
+    -   `challengeFilter` - *Object* - Challenge filter matching challenges related to the community. This object can include any options known to the `/src/utils/challenge-listing/filter.js` module, though in many cases you want to use just one of these:
+        ```js
+        /* Matches challenges belonging to any of the groups listed by ID. */
+        {
+          "groupIds": ["12345"]
+        }
+
+        /* Matches challenges tagged with at least one of the tags. */
+        {
+          "tags": ["JavaScript"]
+        }
+
+        /* Matches challenges belonging to any of the groups AND tagged with
+         * at least one of the tags. */
+        {
+          "groupIds": ["12345"],
+          "tags": ["JavaScript"]
+        }
+        ```
     -   `communityId` - *String* - Unique ID of this community.
     -   `communitySelector` - *Object Array* - Specifies data for the community selection dropdown inside the community header. Each object MUST HAVE `label` and `value` string fields, and MAY HAVE `redirect` field. If `redirect` field is specified, a click on that option in the dropdown will redirect user to the specified URL.
+    -   `groupId` - *String* - This value of group ID is now used to fetch community statistics. Probably, it makes sense to use this value everywhere where `authorizedGroupIds` array is used, however, at the moment, these two are independent.
     -   `leaderboardApiUrl` - *String* - Endpoint from where the leaderboard data should be loaded.
     -   `logo` - *String Array* - Array of image URLs to insert as logos into the left corner of community's header.
     -   `menuItems` - *Object Array* - Specifies options for the community navigation menu (both in the header and footer). Each object MUST HAVE `title` and `url` fields. For now, `url` field should be a relative link inside the community, within the same path segment.

src/server/tc-communities/community-2/metadata.json

@@ -2,8 +2,9 @@
   "authorizedGroupIds": [
     "20000002"
   ],
-  "challengeGroupId": "20000002",
-  "challengeFilterTag": "",
+  "challengeFilter": {
+    "groupIds": ["20000002"]
+  },
   "communityId": "community-2",
   "communityName": "Community 2",
   "communitySelector": [{
@@ -18,6 +19,7 @@
     "redirect": "https://ios.topcoder.com/",
     "value": "3"
   }],
+  "groupId": "20000002",
   "leaderboardApiUrl": "https://api.topcoder.com/v4/looks/458/run/json/",
   "logos": [
     "/themes/community-2/wipro-logo.png",

src/server/tc-communities/demo-expert/metadata.json

@@ -1,6 +1,8 @@
 {
-  "challengeGroupId": "1001",
-  "challengeFilterTag": ".NET",
+  "challengeFilter": {
+    "groupIds": ["1001"],
+    "tags": [".NET"]
+  },
   "communityId": "demo-expert",
   "communityName": "Demo Expert Community",
   "communitySelector": [{
@@ -15,6 +17,7 @@
     "redirect": "https://ios.topcoder.com/",
     "value": "3"
   }],
+  "groupId": "1001",
   "logos": [
     "/themes/demo-expert/logo_topcoder_with_name.svg"
   ],

src/server/tc-communities/example-theme-default/metadata.json

@@ -1,4 +1,5 @@
 {
+  "authorizedGroupIds": [],
   "communityId": "example-theme-default",
   "communityName": "Example Community",
   "logos": ["http://predix.topcoder.com/wp-content/uploads/sites/7/2016/11/topcoder-hat-logo.png"],

src/server/tc-communities/example-theme-green/metadata.json

@@ -1,4 +1,5 @@
 {
+  "authorizedGroupIds": [],
   "communityId": "example-theme-green",
   "communityName": "Example Community",
   "logos": ["http://predix.topcoder.com/wp-content/uploads/sites/7/2016/11/topcoder-hat-logo.png"],

src/server/tc-communities/example-theme-red/metadata.json

@@ -1,4 +1,5 @@
 {
+  "authorizedGroupIds": [],
   "communityId": "example-theme-red",
   "communityName": "Example Community",
   "logos": ["http://predix.topcoder.com/wp-content/uploads/sites/7/2016/11/topcoder-hat-logo.png"],

src/server/tc-communities/index.js

@@ -2,11 +2,43 @@
  * Routes for demo API of tc-communities
  */
 
+import _ from 'lodash';
 import express from 'express';
+import fs from 'fs';
 import { getCommunitiesMetadata } from 'utils/tc';
 
 const router = express.Router();
 
+/**
+ * GET challenge filters for public and specified private communities.
+ * As of now, it expects that array of IDs of groups a user has access to
+ * will be passed in the query. It uses these IDs to determine which communities
+ * should be included into the response.
+ */
+router.get('/', (req, res) => {
+  const filters = [];
+  const groups = new Set(req.query.groups || []);
+  const communities = fs.readdirSync(__dirname);
+  communities.forEach((community) => {
+    try {
+      const path = `${__dirname}/${community}/metadata.json`;
+      const data = JSON.parse(fs.readFileSync(path, 'utf8'));
+      if (!data.authorizedGroupIds
+      || data.authorizedGroupIds.some(id => groups.has(id))) {
+        filters.push({
+          filter: data.challengeFilter || {},
+          id: data.communityId,
+          name: data.communityName,
+        });
+      }
+    } catch (e) {
+      _.noop();
+    }
+  });
+  filters.sort((a, b) => a.name.localeCompare(b.name));
+  res.json(filters);
+});
+
 /**
  * Endpoint for community meta data
  */

src/server/tc-communities/tc-prod-dev/metadata.json

@@ -1,6 +1,7 @@
 {
-  "challengeGroupId": "20000001",
-  "challengeFilterTag": "",
+  "challengeFilter": {
+    "groupIds": ["20000001"]
+  },
   "communityId": "tc-prod-dev",
   "communityName": "Topcoder Product Development",
   "communitySelector": [{
@@ -15,6 +16,7 @@
     "redirect": "https://ios.topcoder.com/",
     "value": "3"
   }],
+  "groupId": "20000001",
   "logos": [
     "/themes/wipro/logo_topcoder_with_name.svg"
   ],

src/server/tc-communities/wipro/metadata.json

@@ -2,8 +2,9 @@
   "authorizedGroupIds": [
     "20000000"
   ],
-  "challengeGroupId": "20000000",
-  "challengeFilterTag": "",
+  "challengeFilter": {
+    "groupIds": ["20000000"]
+  },
   "communityId": "wipro",
   "communityName": "Wipro Hybrid Crowd",
   "communitySelector": [{
@@ -18,6 +19,7 @@
     "redirect": "https://ios.topcoder.com/",
     "value": "3"
   }],
+  "groupId": "20000000",
   "leaderboardApiUrl": "https://api.topcoder.com/v4/looks/458/run/json/",
   "logos": [
     "/themes/wipro/wipro-logo.png",