Fix code quality issues from V4 changes

Author: ThomasKranitsas

.eslintrc

@@ -1,39 +1,3 @@
 {
-  "extends": "./node_modules/topcoder-react-utils/config/eslint/default.json",
-  "rules": {
-    "jsx-a11y/label-has-for": [
-      2,
-      {
-        "components": [
-          "Label"
-        ],
-        "required": {
-          "some": [
-            "nesting",
-            "id"
-          ]
-        },
-        "allowChildren": false
-      }
-    ],
-    "jsx-a11y/label-has-associated-control": [
-      2,
-      {
-        "labelComponents": [
-          "CustomLabel"
-        ],
-        "labelAttributes": [
-          "inputLabel"
-        ],
-        "controlComponents": [
-          "CustomInput"
-        ],
-        "depth": 3
-      }
-    ],
-    "no-unused-vars": 0,
-    "no-undef": 0,
-    "react/jsx-no-undef": 0,
-    "react/require-default-props": 0
-  }
+  "extends": "./node_modules/topcoder-react-utils/config/eslint/default.json"
 }

__tests__/__snapshots__/index.js.snap

@@ -309,8 +309,8 @@ Object {
       "Iterative Review": "Iterative Review",
       "Spec Review": "Specification Review",
     },
-    "getApiResponsePayloadV3": [Function],
-    "getApiResponsePayloadV4": [Function],
+    "getApiResponsePayload": [Function],
+    "getLookerApiResponsePayload": [Function],
   },
   "time": Object {
     "default": undefined,

docs/tc.md

@@ -10,18 +10,18 @@ Collection of small Topcoder-related functions.
 
 * [tc](#module_tc)
     * [.REVIEW_OPPORTUNITY_TYPES](#module_tc.REVIEW_OPPORTUNITY_TYPES)
-    * [.getApiResponsePayloadV3(res)](#module_tc.getApiResponsePayloadV3) ⇒ <code>Promise</code>
+    * [.getApiResponsePayload(res)](#module_tc.getApiResponsePayload) ⇒ <code>Promise</code>
 
 <a name="module_tc.REVIEW_OPPORTUNITY_TYPES"></a>
 
 ### tc.REVIEW_OPPORTUNITY_TYPES
 Review Opportunity types
 
 **Kind**: static constant of [<code>tc</code>](#module_tc)  
-<a name="module_tc.getApiResponsePayloadV3"></a>
+<a name="module_tc.getApiResponsePayload"></a>
 
-### tc.getApiResponsePayloadV3(res) ⇒ <code>Promise</code>
-Gets payload from a standard success response from TC API v3; or throws
+### tc.getApiResponsePayload(res) ⇒ <code>Promise</code>
+Gets payload from a standard success response from TC API; or throws
 an error in case of a failure response.
 
 **Kind**: static method of [<code>tc</code>](#module_tc)  

src/services/api.js

@@ -9,8 +9,6 @@ import { config, isomorphy } from 'topcoder-react-utils';
 import { delay } from '../utils/time';
 import { setErrorIcon, ERROR_ICON_TYPES } from '../utils/errors';
 
-// config.API.V4 = 'https://api.topcoder.com/v4';
-
 /* The minimal delay [ms] between API calls. To avoid problems with the requests
  * rate limits configured in Topcoder APIs, we throttle requests rate at the
  * client side, and at server-side, in dev mode (which is meant to be used for

src/services/challenges.js

@@ -10,8 +10,8 @@ import qs from 'qs';
 import { decodeToken } from 'tc-accounts';
 import logger from '../utils/logger';
 import { setErrorIcon, ERROR_ICON_TYPES } from '../utils/errors';
-import { COMPETITION_TRACKS, getApiResponsePayloadV3 } from '../utils/tc';
-import { getApiV2, getApiV3, getApiV4 } from './api';
+import { COMPETITION_TRACKS, getApiResponsePayload } from '../utils/tc';
+import { getApiV2, getApiV4 } from './api';
 
 export const ORDER_BY = {
   SUBMISSION_END_DATE: 'submissionEndDate',
@@ -86,7 +86,7 @@ export function normalizeChallengeDetails(v4, v4Filtered, v4User, username) {
     registrants: v4.registrants || [],
   };
 
-  // v4 Winners have different field names, needs to be normalized to match v4 filtered and v3
+  // v4 Winners have different field names, needs to be normalized to match v4 filtered and v4
   challenge.winners = _.map(
     v4.winners,
     (winner, index) => ({
@@ -117,22 +117,22 @@ export function normalizeChallengeDetails(v4, v4Filtered, v4User, username) {
       componentId: v4Filtered.componentId,
       contestId: v4Filtered.contestId,
 
-      submissionEndDate: v4Filtered.submissionEndDate, // Dates are not correct in v3
-      submissionEndTimestamp: v4Filtered.submissionEndDate, // Dates are not correct in v3
+      submissionEndDate: v4Filtered.submissionEndDate, // Dates are not correct in v4
+      submissionEndTimestamp: v4Filtered.submissionEndDate, // Dates are not correct in v4
 
-      /* Taking phases from v3_filtered, because dates are not correct in v3 */
+      /* Taking phases from v4_filtered, because dates are not correct in v4 */
       allPhases: v4Filtered.allPhases || [],
 
-      /* Taking phases from v3_filtered, because dates are not correct in v3 */
+      /* Taking phases from v4_filtered, because dates are not correct in v4 */
       currentPhases: v4Filtered.currentPhases || [],
 
-      /* v3 returns incorrect value for numberOfSubmissions for some reason */
+      /* v4 returns incorrect value for numberOfSubmissions for some reason */
       numSubmissions: v4Filtered.numSubmissions,
       groups,
     });
   }
 
-  // Fill missing data from v3_user
+  // Fill missing data from v4_user
   if (v4User) {
     _.defaults(challenge, {
       userDetails: v4User.userDetails,
@@ -168,7 +168,7 @@ export function normalizeChallengeDetails(v4, v4Filtered, v4User, username) {
  * Normalizes a regular challenge object received from the backend.
  * NOTE: This function is copied from the existing code in the challenge listing
  * component. It is possible, that this normalization is not necessary after we
- * have moved to Topcoder API v3, but it is kept for now to minimize a risk of
+ * have moved to Topcoder API v4, but it is kept for now to minimize a risk of
  * breaking anything.
  * @todo Should be used only internally!
  * @param {Object} challenge Challenge object received from the backend.
@@ -251,7 +251,7 @@ class ChallengesService {
         ...params,
       };
       const url = `${endpoint}?${qs.stringify(query)}`;
-      const res = await this.private.apiV4.get(url).then(checkError);
+      const res = await this.private.api.get(url).then(checkError);
       return {
         challenges: res.content || [],
         totalCount: res.metadata.totalCount,
@@ -261,7 +261,6 @@ class ChallengesService {
     this.private = {
       api: getApiV4(tokenV3),
       apiV2: getApiV2(tokenV2),
-      apiV4: getApiV4(tokenV3),
       getChallenges,
       tokenV2,
       tokenV3,
@@ -359,14 +358,14 @@ class ChallengesService {
 
   /**
    * Gets challenge details from Topcoder API v4.
-   * NOTE: This function also uses API v2 and other v3 endpoints for now, due
+   * NOTE: This function also uses API v2 and other v4 endpoints for now, due
    * to some information is missing or
-   * incorrect in the main v3 endpoint. This may change in the future.
+   * incorrect in the main v4 endpoint. This may change in the future.
    * @param {Number|String} challengeId
    * @return {Promise} Resolves to the challenge object.
    */
   async getChallengeDetails(challengeId) {
-    const challengeV4 = await this.private.apiV4.get(`/challenges/${challengeId}`)
+    const challengeV4 = await this.private.api.get(`/challenges/${challengeId}`)
       .then(checkError).then(res => res.content);
 
     const challengeV4Filtered = await this.private.getChallenges('/challenges/', { id: challengeId })
@@ -437,7 +436,7 @@ class ChallengesService {
    */
   async getSrms(params) {
     const res = await this.private.api.get(`/srms/?${qs.stringify(params)}`);
-    return getApiResponsePayloadV3(res);
+    return getApiResponsePayload(res);
   }
 
   /**
@@ -466,7 +465,7 @@ class ChallengesService {
   async getUserSrms(handle, params) {
     const url = `/members/${handle}/srms/?${qs.stringify(params)}`;
     const res = await this.private.api.get(url);
-    return getApiResponsePayloadV3(res);
+    return getApiResponsePayload(res);
   }
 
   /**
@@ -476,7 +475,7 @@ class ChallengesService {
    */
   async register(challengeId) {
     const endpoint = `/challenges/${challengeId}/register`;
-    const res = await this.private.apiV4.postJson(endpoint);
+    const res = await this.private.api.postJson(endpoint);
     if (!res.ok) throw new Error(res.statusText);
     return res.json();
   }
@@ -488,7 +487,7 @@ class ChallengesService {
    */
   async unregister(challengeId) {
     const endpoint = `/challenges/${challengeId}/unregister`;
-    const res = await this.private.apiV4.post(endpoint);
+    const res = await this.private.api.post(endpoint);
     if (!res.ok) throw new Error(res.statusText);
     return res.json();
   }

src/services/looker.js

@@ -3,7 +3,7 @@
  * @desc  This module provides a service to get look data json
  * via API V4.
  */
-import { getApiResponsePayloadV4 } from '../utils/tc';
+import { getLookerApiResponsePayload } from '../utils/tc';
 import { getApiV4 } from './api';
 
 /**
@@ -27,7 +27,7 @@ class LookerService {
    */
   async getLooker(lookerId) {
     const res = await this.private.api.get(`/looks/${lookerId}/run/json`);
-    return getApiResponsePayloadV4(res);
+    return getLookerApiResponsePayload(res);
   }
 }
 

src/services/lookup.js

@@ -4,7 +4,7 @@
  * via API V3.
  */
 import qs from 'qs';
-import { getApiResponsePayloadV3 } from '../utils/tc';
+import { getApiResponsePayload } from '../utils/tc';
 import { getApiV3 } from './api';
 
 class LookupService {
@@ -25,7 +25,7 @@ class LookupService {
    */
   async getTags(params) {
     const res = await this.private.api.get(`/tags/?${qs.stringify(params)}`);
-    return getApiResponsePayloadV3(res);
+    return getApiResponsePayload(res);
   }
 }
 

src/services/members.js

@@ -8,7 +8,7 @@
 import _ from 'lodash';
 import qs from 'qs';
 import logger from '../utils/logger';
-import { getApiResponsePayloadV3 } from '../utils/tc';
+import { getApiResponsePayload } from '../utils/tc';
 import { getApiV3 } from './api';
 
 /**
@@ -32,7 +32,7 @@ class MembersService {
    */
   async getMemberFinances(handle) {
     const res = await this.private.api.get(`/members/${handle}/financial`);
-    return getApiResponsePayloadV3(res);
+    return getApiResponsePayload(res);
   }
 
   /**
@@ -45,7 +45,7 @@ class MembersService {
    */
   async getMemberInfo(handle) {
     const res = await this.private.api.get(`/members/${handle}`);
-    return getApiResponsePayloadV3(res);
+    return getApiResponsePayload(res);
   }
 
   /**
@@ -55,7 +55,7 @@ class MembersService {
    */
   async getExternalAccounts(handle) {
     const res = await this.private.api.get(`/members/${handle}/externalAccounts`);
-    return getApiResponsePayloadV3(res);
+    return getApiResponsePayload(res);
   }
 
   /**
@@ -65,7 +65,7 @@ class MembersService {
    */
   async getExternalLinks(handle) {
     const res = await this.private.api.get(`/members/${handle}/externalLinks`);
-    return getApiResponsePayloadV3(res);
+    return getApiResponsePayload(res);
   }
 
   /**
@@ -75,7 +75,7 @@ class MembersService {
    */
   async getSkills(handle) {
     const res = await this.private.api.get(`/members/${handle}/skills`);
-    return getApiResponsePayloadV3(res);
+    return getApiResponsePayload(res);
   }
 
   /**
@@ -85,7 +85,7 @@ class MembersService {
    */
   async getStats(handle) {
     const res = await this.private.api.get(`/members/${handle}/stats`);
-    return getApiResponsePayloadV3(res);
+    return getApiResponsePayload(res);
   }
 
   /**
@@ -95,7 +95,7 @@ class MembersService {
    */
   async getStatsHistory(handle) {
     const res = await this.private.api.get(`/members/${handle}/stats/history`);
-    return getApiResponsePayloadV3(res);
+    return getApiResponsePayload(res);
   }
 
   /**
@@ -110,7 +110,7 @@ class MembersService {
       track,
       subTrack,
     }))}`);
-    return getApiResponsePayloadV3(res);
+    return getApiResponsePayload(res);
   }
 
   /**
@@ -123,7 +123,7 @@ class MembersService {
    */
   async getMemberSuggestions(keyword) {
     const res = await this.private.api.get(`/members/_suggest/${keyword}`);
-    return getApiResponsePayloadV3(res);
+    return getApiResponsePayload(res);
   }
 
   /**
@@ -134,7 +134,7 @@ class MembersService {
    */
   async addWebLink(userHandle, webLink) {
     const res = await this.private.api.postJson(`/members/${userHandle}/externalLinks`, { param: { url: webLink } });
-    return getApiResponsePayloadV3(res);
+    return getApiResponsePayload(res);
   }
 
   /**
@@ -150,7 +150,7 @@ class MembersService {
       },
     };
     const res = await this.private.api.delete(`/members/${userHandle}/externalLinks/${webLinkHandle}`, JSON.stringify(body));
-    return getApiResponsePayloadV3(res);
+    return getApiResponsePayload(res);
   }
 
   /**
@@ -170,7 +170,7 @@ class MembersService {
       },
     };
     const res = await this.private.api.patchJson(`/members/${handle}/skills`, body);
-    return getApiResponsePayloadV3(res);
+    return getApiResponsePayload(res);
   }
 
   /**
@@ -193,7 +193,7 @@ class MembersService {
       body: JSON.stringify(body),
       method: 'PATCH',
     });
-    return getApiResponsePayloadV3(res);
+    return getApiResponsePayload(res);
   }
 
   /**
@@ -203,7 +203,7 @@ class MembersService {
    */
   async updateMemberProfile(profile) {
     const res = await this.private.api.putJson(`/members/${profile.handle}`, { param: profile });
-    return getApiResponsePayloadV3(res);
+    return getApiResponsePayload(res);
   }
 
   /**
@@ -214,7 +214,7 @@ class MembersService {
    */
   async getPresignedUrl(userHandle, file) {
     const res = await this.private.api.postJson(`/members/${userHandle}/photoUploadUrl`, { param: { contentType: file.type } });
-    const payload = await getApiResponsePayloadV3(res);
+    const payload = await getApiResponsePayload(res);
 
     return {
       preSignedURL: payload.preSignedURL,
@@ -231,7 +231,7 @@ class MembersService {
    */
   async updateMemberPhoto(S3Response) {
     const res = await this.private.api.putJson(`/members/${S3Response.userHandle}/photo`, { param: S3Response.body });
-    return getApiResponsePayloadV3(res);
+    return getApiResponsePayload(res);
   }
 
   /**

src/services/user-traits.js

@@ -4,7 +4,7 @@
  * via API V3.
  */
 import toCapitalCase from 'to-capital-case';
-import { getApiResponsePayloadV3 } from '../utils/tc';
+import { getApiResponsePayload } from '../utils/tc';
 import { getApiV3 } from './api';
 
 /**
@@ -29,7 +29,7 @@ class UserTraitsService {
   async getAllUserTraits(handle) {
     // FIXME: Remove the .toLowerCase() when the API is fixed to ignore the case in the route params
     const res = await this.private.api.get(`/members/${handle.toLowerCase()}/traits`);
-    return getApiResponsePayloadV3(res);
+    return getApiResponsePayload(res);
   }
 
   /**
@@ -51,7 +51,7 @@ class UserTraitsService {
     };
 
     const res = await this.private.api.postJson(`/members/${handle}/traits`, body);
-    return getApiResponsePayloadV3(res);
+    return getApiResponsePayload(res);
   }
 
   /**
@@ -73,7 +73,7 @@ class UserTraitsService {
     };
 
     const res = await this.private.api.putJson(`/members/${handle}/traits`, body);
-    return getApiResponsePayloadV3(res);
+    return getApiResponsePayload(res);
   }
 
   /**
@@ -84,7 +84,7 @@ class UserTraitsService {
    */
   async deleteUserTrait(handle, traitId) {
     const res = await this.private.api.delete(`/members/${handle}/traits?traitIds=${traitId}`);
-    return getApiResponsePayloadV3(res);
+    return getApiResponsePayload(res);
   }
 }
 

src/services/user.js

@@ -6,7 +6,7 @@
 import { config, isomorphy } from 'topcoder-react-utils';
 
 import logger from '../utils/logger';
-import { getApiResponsePayloadV3 } from '../utils/tc';
+import { getApiResponsePayload } from '../utils/tc';
 import { getApiV2, getApiV3 } from './api';
 
 let auth0;
@@ -152,7 +152,7 @@ class User {
   async getUser(username) {
     const url = `/users?filter=handle%3D${username}`;
     const res = await this.private.api.get(url);
-    return (await getApiResponsePayloadV3(res))[0];
+    return (await getApiResponsePayload(res))[0];
   }
 
   /**
@@ -166,7 +166,7 @@ class User {
   async getEmailPreferences(userId) {
     const url = `/users/${userId}/preferences/email`;
     const res = await this.private.api.get(url);
-    return getApiResponsePayloadV3(res);
+    return getApiResponsePayload(res);
   }
 
   /**
@@ -193,7 +193,7 @@ class User {
     const url = `/users/${userId}/preferences/email`;
 
     const res = await this.private.api.putJson(url, { param: settings });
-    return getApiResponsePayloadV3(res);
+    return getApiResponsePayload(res);
   }
 
   /**
@@ -207,7 +207,7 @@ class User {
   async getCredential(userId) {
     const url = `/users/${userId}?fields=credential`;
     const res = await this.private.api.get(url);
-    return getApiResponsePayloadV3(res);
+    return getApiResponsePayload(res);
   }
 
   /**
@@ -228,7 +228,7 @@ class User {
 
     const url = `/users/${userId}`;
     const res = await this.private.api.patchJson(url, { param: { credential } });
-    return getApiResponsePayloadV3(res);
+    return getApiResponsePayload(res);
   }
 
   /**
@@ -242,7 +242,7 @@ class User {
   async getLinkedAccounts(userId) {
     const url = `/users/${userId}?fields=profiles`;
     const res = await this.private.api.get(url);
-    return getApiResponsePayloadV3(res);
+    return getApiResponsePayload(res);
   }
 
   /**
@@ -254,7 +254,7 @@ class User {
   async unlinkExternalAccount(userId, provider) {
     const url = `/users/${userId}/profiles/${provider}`;
     const res = await this.private.api.delete(url);
-    return getApiResponsePayloadV3(res);
+    return getApiResponsePayload(res);
   }
 
   /**
@@ -299,7 +299,7 @@ class User {
           }
           logger.debug(`link API postdata: ${JSON.stringify(postData)}`);
           this.private.api.postJson(`/users/${userId}/profiles`, { param: postData })
-            .then(resp => getApiResponsePayloadV3(resp).then((result) => {
+            .then(resp => getApiResponsePayload(resp).then((result) => {
               logger.debug(`Succesfully linked account: ${JSON.stringify(result)}`);
               resolve(postData);
             }))

src/utils/tc.js

@@ -26,12 +26,12 @@ export const REVIEW_OPPORTUNITY_TYPES = {
 };
 
 /**
- * Gets payload from a standard success response from TC API v3; or throws
+ * Gets payload from a standard success response from TC API; or throws
  * an error in case of a failure response.
  * @param {Object} res
  * @return {Promise} Resolves to the payload.
  */
-export async function getApiResponsePayloadV3(res) {
+export async function getApiResponsePayload(res) {
   if (!res.ok) throw new Error(res.statusText);
   const x = (await res.json()).result;
   if (!x.success) throw new Error(x.content);
@@ -40,12 +40,12 @@ export async function getApiResponsePayloadV3(res) {
 
 
 /**
- * Gets payload from a standard success response from TC API v4; or throws
+ * Gets payload from a standard success response from TC LOOKER API; or throws
  * an error in case of a failure response.
  * @param {Object} res
  * @return {Promise} Resolves to the payload.
  */
-export async function getApiResponsePayloadV4(res) {
+export async function getLookerApiResponsePayload(res) {
   const resJson = await res.json();
   if (Array.isArray(resJson)) {
     return {