From 974defe18b6b07f5e2e6c5eca296a3796e6a7e72 Mon Sep 17 00:00:00 2001 From: Sandeep Date: Thu, 12 Aug 2021 09:55:41 +0530 Subject: [PATCH 1/3] enrich disintigration --- config/default.js | 4 ++-- docs/swagger.yaml | 48 +++++++++++++++++++++---------------- src/common/helper.js | 29 ++++++++++++++-------- src/services/TeamService.js | 16 ++++++------- 4 files changed, 56 insertions(+), 41 deletions(-) diff --git a/config/default.js b/config/default.js index cb589290..492331df 100644 --- a/config/default.js +++ b/config/default.js @@ -35,8 +35,8 @@ module.exports = { TC_API: process.env.TC_API || 'https://api.topcoder-dev.com/v5', // the organization id ORG_ID: process.env.ORG_ID || '36ed815b-3da1-49f1-a043-aaed0a4e81ad', - // the referenced skill provider id - TOPCODER_SKILL_PROVIDER_ID: process.env.TOPCODER_SKILL_PROVIDER_ID || '9cc0795a-6e12-4c84-9744-15858dba1861', + // the referenced taxonomy id + TOPCODER_TAXONOMY_ID: process.env.TOPCODER_TAXONOMY_ID || '7637ae1a-3b7c-44eb-a5ed-10ea02f1885d', TOPCODER_USERS_API: process.env.TOPCODER_USERS_API || 'https://api.topcoder-dev.com/v3/users', // the api to find topcoder members diff --git a/docs/swagger.yaml b/docs/swagger.yaml index 65d420f1..6a19225f 100644 --- a/docs/swagger.yaml +++ b/docs/swagger.yaml @@ -3157,7 +3157,7 @@ paths: schema: type: array items: - $ref: "#/components/schemas/UbahnSkill" + $ref: "#/components/schemas/SkillInSkillsAPI" headers: X-Next-Page: schema: @@ -5319,17 +5319,25 @@ components: type: string example: "React" description: The skill name. - UbahnSkill: - type: object + SkillInSkillsAPI: + required: + - "id" + - "name" + - "taxonomyId" + - "taxonomyName" + - "metadata" properties: id: type: "string" format: "UUID" description: "The skill id" - skillProviderId: + taxonomyId: type: "string" format: "UUID" - description: "The referenced skill provider id" + description: "The referenced taxonomy id" + taxonomyName: + type: "string" + description: "The referenced taxonomy name" name: type: "string" description: "The name of the skill" @@ -5339,22 +5347,20 @@ components: uri: type: "string" description: "The uri for the skill" - created: - type: "string" - format: "date-time" - description: "When the entity was created." - updated: - type: "string" - format: "date-time" - description: "When the entity was updated." - createdBy: - type: "string" - format: "UUID" - description: "Creator of the entity." - updatedBy: - type: "string" - format: "UUID" - description: "User that last updated the entity." + metadata: + type: "object" + description: "The metadata for the skill" + properties: + updated: + type: "string" + format: "date-time" + description: "The last updated timestamp of the skill" + challengeProminence: + type: "string" + description: "The challenge prominence ranging from [0, 1]" + memberProminence: + type: "string" + description: "The member prominence ranging from [0, 1]" JobForTeam: properties: id: diff --git a/src/common/helper.js b/src/common/helper.js index 7f9625be..140e21e4 100644 --- a/src/common/helper.js +++ b/src/common/helper.js @@ -940,7 +940,15 @@ async function listUsersByExternalId (externalId) { context: 'listUserByExternalId', message: `response body: ${JSON.stringify(res.body)}` }) - return res.body + + const users = res.body + // populate skill data for each user skill + await Promise.all(users.map(user => Promise.all(user.skills.map(async userSkill => { + const skill = await getSkillById(userSkill.skillId) + userSkill.skill = skill + })))) + + return users } /** @@ -1082,9 +1090,10 @@ async function getUserById (userId, enrich) { const user = _.pick(res.body, ['id', 'handle', 'firstName', 'lastName']) if (enrich) { - user.skills = (res.body.skills || []).map((skillObj) => - _.pick(skillObj.skill, ['id', 'name']) - ) + user.skills = await Promise.all((res.body.skills || []).map(async (userSkill) => { + const skill = await getSkillById(userSkill.skillId) + return _.pick(skill, ['id', 'name']) + })) const attributes = _.get(res, 'body.attributes', []) user.attributes = _.map(attributes, (attr) => _.pick(attr, ['id', 'value', 'attribute.id', 'attribute.name']) @@ -1201,18 +1210,18 @@ async function getProjectById (currentUser, id) { /** * Function to search skills from v5/skills - * - only returns skills from Topcoder Skills Provider defined by `TOPCODER_SKILL_PROVIDER_ID` + * - only returns skills from Topcoder Skills API defined by `TOPCODER_TAXONOMY_ID` * * @param {Object} criteria the search criteria * @returns the request result */ async function getTopcoderSkills (criteria) { - const token = await getM2MUbahnToken() + const token = await getM2MToken() try { const res = await request .get(`${config.TC_API}/skills`) .query({ - skillProviderId: config.TOPCODER_SKILL_PROVIDER_ID, + taxonomyId: config.TOPCODER_TAXONOMY_ID, ...criteria }) .set('Authorization', `Bearer ${token}`) @@ -1238,7 +1247,7 @@ async function getTopcoderSkills (criteria) { /** * Function to search and retrive all skills from v5/skills - * - only returns skills from Topcoder Skills Provider defined by `TOPCODER_SKILL_PROVIDER_ID` + * - only returns skills from Topcoder Skills API defined by `TOPCODER_TAXONOMY_ID` * * @param {Object} criteria the search criteria * @returns the request result @@ -1260,7 +1269,7 @@ async function getAllTopcoderSkills (criteria) { * @returns the request result */ async function getSkillById (skillId) { - const token = await getM2MUbahnToken() + const token = await getM2MToken() const res = await request .get(`${config.TC_API}/skills/${skillId}`) .set('Authorization', `Bearer ${token}`) @@ -1270,7 +1279,7 @@ async function getSkillById (skillId) { context: 'getSkillById', message: `response body: ${JSON.stringify(res.body)}` }) - return _.pick(res.body, ['id', 'name']) + return res.body } /** diff --git a/src/services/TeamService.js b/src/services/TeamService.js index 3d1f390b..e7a8bfc3 100644 --- a/src/services/TeamService.js +++ b/src/services/TeamService.js @@ -337,16 +337,13 @@ async function getTeam (currentUser, id) { const teamDetail = result[0] // add job skills for result - let jobSkills = [] if (teamDetail && teamDetail.jobs) { for (const job of teamDetail.jobs) { if (job.skills) { - const usersPromises = [] - _.map(job.skills, (skillId) => { - usersPromises.push(helper.getSkillById(skillId)) - }) - jobSkills = await Promise.all(usersPromises) - job.skills = jobSkills + job.skills = await Promise.all(job.skills.map(async (skillId) => { + const skill = await helper.getSkillById(skillId) + return _.pick(skill, ['id', 'name']) + })) } } } @@ -385,7 +382,10 @@ async function getTeamJob (currentUser, id, jobId) { if (job.skills) { result.skills = await Promise.all( - _.map(job.skills, (skillId) => helper.getSkillById(skillId)) + _.map(job.skills, async (skillId) => { + const skill = await helper.getSkillById(skillId) + return _.pick(skill, ['id', 'name']) + }) ) } From 303277adfa24eaab5bfd9c692bd2aa03a8d07329 Mon Sep 17 00:00:00 2001 From: Vikas Agarwal Date: Fri, 13 Aug 2021 14:21:15 +0530 Subject: [PATCH 2/3] Implementing the review suggestions: - Moved field pick logic back to the service instead of repeating at every calling code (reverted all changes from TeamService because of this) - Renamed getM2MToken back to getM2MUbahnToken to keep the changes minimal --- src/common/helper.js | 11 ++++------- src/services/TeamService.js | 16 ++++++++-------- 2 files changed, 12 insertions(+), 15 deletions(-) diff --git a/src/common/helper.js b/src/common/helper.js index 19a13054..ec6595d9 100644 --- a/src/common/helper.js +++ b/src/common/helper.js @@ -1100,10 +1100,7 @@ async function getUserById (userId, enrich) { const user = _.pick(res.body, ['id', 'handle', 'firstName', 'lastName']) if (enrich) { - user.skills = await Promise.all((res.body.skills || []).map(async (userSkill) => { - const skill = await getSkillById(userSkill.skillId) - return _.pick(skill, ['id', 'name']) - })) + user.skills = await Promise.all((res.body.skills || []).map(async (userSkill) => getSkillById(userSkill.skillId))) const attributes = _.get(res, 'body.attributes', []) user.attributes = _.map(attributes, (attr) => _.pick(attr, ['id', 'value', 'attribute.id', 'attribute.name']) @@ -1226,7 +1223,7 @@ async function getProjectById (currentUser, id) { * @returns the request result */ async function getTopcoderSkills (criteria) { - const token = await getM2MToken() + const token = await getM2MUbahnToken() try { const res = await request .get(`${config.TC_API}/skills`) @@ -1279,7 +1276,7 @@ async function getAllTopcoderSkills (criteria) { * @returns the request result */ async function getSkillById (skillId) { - const token = await getM2MToken() + const token = await getM2MUbahnToken() const res = await request .get(`${config.TC_API}/skills/${skillId}`) .set('Authorization', `Bearer ${token}`) @@ -1289,7 +1286,7 @@ async function getSkillById (skillId) { context: 'getSkillById', message: `response body: ${JSON.stringify(res.body)}` }) - return res.body + return _.pick(res.body, ['id', 'name']) } /** diff --git a/src/services/TeamService.js b/src/services/TeamService.js index 93dc963c..25d511b3 100644 --- a/src/services/TeamService.js +++ b/src/services/TeamService.js @@ -328,13 +328,16 @@ async function getTeam (currentUser, id) { const teamDetail = result[0] // add job skills for result + let jobSkills = [] if (teamDetail && teamDetail.jobs) { for (const job of teamDetail.jobs) { if (job.skills) { - job.skills = await Promise.all(job.skills.map(async (skillId) => { - const skill = await helper.getSkillById(skillId) - return _.pick(skill, ['id', 'name']) - })) + const usersPromises = [] + _.map(job.skills, (skillId) => { + usersPromises.push(helper.getSkillById(skillId)) + }) + jobSkills = await Promise.all(usersPromises) + job.skills = jobSkills } } } @@ -373,10 +376,7 @@ async function getTeamJob (currentUser, id, jobId) { if (job.skills) { result.skills = await Promise.all( - _.map(job.skills, async (skillId) => { - const skill = await helper.getSkillById(skillId) - return _.pick(skill, ['id', 'name']) - }) + _.map(job.skills, (skillId) => helper.getSkillById(skillId)) ) } From 8348a23787c5610c5a7605f7504abac85529cf8a Mon Sep 17 00:00:00 2001 From: Vikas Agarwal Date: Mon, 16 Aug 2021 11:27:52 +0530 Subject: [PATCH 3/3] fix: skills-api-shape-up : added env variable for the 5.1 api --- config/default.js | 2 ++ src/common/helper.js | 4 ++-- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/config/default.js b/config/default.js index 58ff1782..b4ff40d7 100644 --- a/config/default.js +++ b/config/default.js @@ -33,6 +33,8 @@ module.exports = { // the Topcoder v5 url TC_API: process.env.TC_API || 'https://api.topcoder-dev.com/v5', + // the Topcoder Beta API url currently v5.1 + TC_BETA_API: process.env.TC_BETA_API || 'https://api.topcoder-dev.com/v5.1', // the organization id ORG_ID: process.env.ORG_ID || '36ed815b-3da1-49f1-a043-aaed0a4e81ad', // the referenced taxonomy id diff --git a/src/common/helper.js b/src/common/helper.js index ec6595d9..05785428 100644 --- a/src/common/helper.js +++ b/src/common/helper.js @@ -1226,7 +1226,7 @@ async function getTopcoderSkills (criteria) { const token = await getM2MUbahnToken() try { const res = await request - .get(`${config.TC_API}/skills`) + .get(`${config.TC_BETA_API}/skills`) .query({ taxonomyId: config.TOPCODER_TAXONOMY_ID, ...criteria @@ -1278,7 +1278,7 @@ async function getAllTopcoderSkills (criteria) { async function getSkillById (skillId) { const token = await getM2MUbahnToken() const res = await request - .get(`${config.TC_API}/skills/${skillId}`) + .get(`${config.TC_BETA_API}/skills/${skillId}`) .set('Authorization', `Bearer ${token}`) .set('Content-Type', 'application/json') .set('Accept', 'application/json')