Merge pull request #38 from topcoder-platform/develop

Release v1.1.0

Author: vikasrohit

config/default.js

@@ -21,7 +21,7 @@ module.exports = {
   NDA_TERMS_ID: process.env.NDA_TERMS_ID || '0dedac8f-5a1a-4fe7-002f-e1d04dc65b7d',
 
   // The name of the field which corresponds to country value in the message generated by update profile event
-  PROFILE_UPDATE_EVENT_COUNTRY_FIELD_NAME: process.env.PROFILE_UPDATE_EVENT_COUNTRY_FIELD_NAME || 'payload.competitionCountryCode',
+  PROFILE_UPDATE_EVENT_COUNTRY_FIELD_NAME: process.env.PROFILE_UPDATE_EVENT_COUNTRY_FIELD_NAME || 'homeCountryCode',
 
   topics: {
     // The Kafka topic to which to listen to user terms agreement events

src/common/helper.js

@@ -56,6 +56,25 @@ async function getHandleByUserId (userId) {
   }
 }
 
+/**
+ * This function retrieves the details of the user identified by the given handle
+ *
+ * @param {String} handle The handle of the user for whom to get the details
+ * @returns The details of the user
+ *
+ */
+async function getMemberByHandle (handle) {
+  logger.debug({ component: 'helper', context: 'getMemberByHandle', message: `handle: ${handle}` })
+
+  const token = await getM2MToken()
+
+  const { body: user } = await request
+    .get(`${config.MEMBER_API_URL}/${handle}`)
+    .set('Authorization', `Bearer ${token}`)
+
+  return user
+}
+
 /**
  * Gets the member traits for the given trait id and member handle
  *
@@ -168,5 +187,6 @@ module.exports = {
   getMemberTraits,
   saveMemberTraits,
   executeQueryAsync,
-  hasUserEnteredSkills
+  hasUserEnteredSkills,
+  getMemberByHandle
 }

src/services/IdVerificationProcessorService.js

@@ -92,7 +92,7 @@ async function saveIdVerificationTrait (idVerification) {
   const traitsData = {
     status: constants.CHECKLIST_STATUS.COMPLETED,
     message: constants.CHECKLIST_MESSAGE.SUCCESS,
-    date: idVerification.verification_date,
+    date: new Date(idVerification.verification_date).getTime(),
     metadata: {
       matched_on: idVerification.matched_on,
       verification_mode: idVerification.verification_mode

src/services/ProfileCompletionProcessorService.js

@@ -13,7 +13,7 @@ const config = require('config')
 /**
  * This array contains the list of profile completion metadata object keys that affect the status update
  */
-const METADATA_KEYS_FOR_STATUS_UPDATE = ['profile_picture', 'bio', 'skills', 'education', 'work', 'language']
+const METADATA_KEYS_FOR_STATUS_UPDATE = ['profile_picture', 'bio', 'skills', 'education', 'work', 'language', 'country']
 
 // The component name to be used when logging messages
 const component = 'ProfileCompletionProcessorService'
@@ -27,7 +27,7 @@ async function processProfileUpdateMessage (message) {
   // The eventually updated metadata items by the current event message
   const updatedMetadataItems = {
     bio: !_.isEmpty(_.get(message, 'payload.description')),
-    country: !_.isEmpty(_.get(message, config.PROFILE_UPDATE_EVENT_COUNTRY_FIELD_NAME))
+    country: !_.isEmpty(_.get(message, `payload.${config.PROFILE_UPDATE_EVENT_COUNTRY_FIELD_NAME}`))
   }
 
   await handleUpdatedProfileCompletionMetadata(message, updatedMetadataItems)
@@ -147,22 +147,11 @@ processProfileTraitRemovalMessage.schema = {
  *
  * @param {Object} oldChecklist The old checklist object
  * @param {Object} updatedMetadataItems The updated metadata objects
- * @param {String} handle The user handle
  * @returns The new checklist
  */
-async function getNewChecklist (oldChecklist, updatedMetadataItems, handle) {
+async function getNewChecklist (oldChecklist, updatedMetadataItems) {
   // Initialize the aggregated updatedMetadata object
-  let updatedMetadata
-  if (!_.get(oldChecklist, 'metadata.skills')) {
-    // The skills trait was not previously set, we need to re-check from member-api if it is done and update the metadata accordingly
-    updatedMetadata = _.assign({},
-      oldChecklist.metadata,
-      updatedMetadataItems,
-      { skills: await helper.hasUserEnteredSkills(handle) })
-  } else {
-    // The skills trait was previously set, no need to make the call to member-api for checking again
-    updatedMetadata = _.assign({}, oldChecklist.metadata, updatedMetadataItems)
-  }
+  const updatedMetadata = _.assign({}, oldChecklist.metadata, updatedMetadataItems)
 
   if (_.isEqual(oldChecklist.metadata, updatedMetadata)) {
     // Nothing has changed in the metadata, return the result with 'updated' flag set to false
@@ -202,23 +191,14 @@ async function getNewChecklist (oldChecklist, updatedMetadataItems, handle) {
  * This function generates the initial structure of the profile completion checklist
  *
  * @param {Object} metadata The metadata to put in the checklist
- * @param {String} handle the user handle
  * @returns The initial checklist structure with the the given metadata
  */
-async function getInitialChecklist (metadata, handle) {
+async function getInitialChecklist (metadata) {
   return {
     status: CHECKLIST_STATUS.PENDING_AT_USER,
     message: CHECKLIST_MESSAGE.PROFILE_IS_INCOMPLETE,
     date: new Date().getTime(),
-    metadata: _.assign({}, {
-      profile_picture: false,
-      bio: false,
-      skills: await helper.hasUserEnteredSkills(handle),
-      education: false,
-      work: false,
-      language: false,
-      country: false
-    }, metadata)
+    metadata: _.assign({}, metadata)
   }
 }
 
@@ -232,13 +212,16 @@ async function handleUpdatedProfileCompletionMetadata (message, updatedMetadataI
   // Get the user handle from members api
   const handle = await helper.getHandleByUserId(_.get(message, 'payload.userId'))
 
+  // Check for other updates in user profile and profile traits
+  const fullyUpdatedMetadata = await getFullyUpdatedMetadata(handle, updatedMetadataItems)
+
   // context used for logging
   const context = 'handleUpdatedProfileCompletionMetadata'
 
   logger.debug({
     component,
     context,
-    message: `Process profile completion trait: { user: '${handle}', updatedMetadata: ${JSON.stringify(updatedMetadataItems)}}`
+    message: `Process profile completion trait: { user: '${handle}', updatedMetadata: ${JSON.stringify(fullyUpdatedMetadata)}}`
   })
 
   // Get the member Onboarding Checklist traits
@@ -258,7 +241,7 @@ async function handleUpdatedProfileCompletionMetadata (message, updatedMetadataI
     isCreate = true
     // The member does not have any onboarding checklist trait, we initialize it
     body[0].traits.data.push({
-      [PROFILE_COMPLETION_TRAIT_PROPERTY_NAME]: await getInitialChecklist(updatedMetadataItems, handle)
+      [PROFILE_COMPLETION_TRAIT_PROPERTY_NAME]: await getInitialChecklist(fullyUpdatedMetadata)
     })
   } else {
     isCreate = false
@@ -271,11 +254,11 @@ async function handleUpdatedProfileCompletionMetadata (message, updatedMetadataI
     if (_.isUndefined(body[0].traits.data[0][PROFILE_COMPLETION_TRAIT_PROPERTY_NAME])) {
       // There were no traits data for profile completion checklist
       // We initialize a new one with the updated metadata by the current event message
-      body[0].traits.data[0][PROFILE_COMPLETION_TRAIT_PROPERTY_NAME] = await getInitialChecklist(updatedMetadataItems, handle)
+      body[0].traits.data[0][PROFILE_COMPLETION_TRAIT_PROPERTY_NAME] = await getInitialChecklist(fullyUpdatedMetadata)
     } else {
       // traits data for profile completion checklist is already there for the user
       // We update it based on old checklist data and updated metadata by the current event message
-      const newChecklist = await getNewChecklist(body[0].traits.data[0][PROFILE_COMPLETION_TRAIT_PROPERTY_NAME], updatedMetadataItems, handle)
+      const newChecklist = await getNewChecklist(body[0].traits.data[0][PROFILE_COMPLETION_TRAIT_PROPERTY_NAME], fullyUpdatedMetadata)
 
       if (!newChecklist.isUpdated) {
         // The checklist was not updated, there is no need to call member-api
@@ -296,7 +279,7 @@ async function handleUpdatedProfileCompletionMetadata (message, updatedMetadataI
   logger.debug({
     component,
     context,
-    message: `Successfully processed profile completion trait { user: '${handle}', updatedMetadata: ${JSON.stringify(updatedMetadataItems)}}`
+    message: `Successfully processed profile completion trait { user: '${handle}', updatedMetadata: ${JSON.stringify(fullyUpdatedMetadata)}}`
   })
 }
 
@@ -330,6 +313,31 @@ processProfilePictureUploadMessage.schema = {
     }).required()
 }
 
+/**
+ * This function retrieves the fully updated metadata items for the member.
+ * It gets the traits from the member traits API and returns the fully updated metadata with the updated flags
+ *
+ * @param {String} handle The member handle
+ * @param {Object} updatedMetadataItems The updated metadata generated as a result of the event
+ */
+async function getFullyUpdatedMetadata (handle, updatedMetadataItems) {
+  const member = await helper.getMemberByHandle(handle)
+  const existingTraits = await helper.getMemberTraits(handle, _.join(_.keys(TRAITS_TO_PROFILE_COMPLETION_CHECKLIST_METADATA_MAP), ','))
+  const updateTraitsMetadata = {}
+
+  for (const key of _.keys(TRAITS_TO_PROFILE_COMPLETION_CHECKLIST_METADATA_MAP)) {
+    const trait = _.find(existingTraits, { traitId: key })
+    updateTraitsMetadata[TRAITS_TO_PROFILE_COMPLETION_CHECKLIST_METADATA_MAP[key]] = _.get(trait, 'traits.data', []).length > 0
+  }
+
+  return _.assign({}, {
+    profile_picture: !_.isEmpty(_.get(member, 'photoURL')),
+    bio: !_.isEmpty(_.get(member, 'description')),
+    skills: await helper.hasUserEnteredSkills(handle),
+    country: !_.isEmpty(_.get(member, config.PROFILE_UPDATE_EVENT_COUNTRY_FIELD_NAME))
+  }, updateTraitsMetadata, updatedMetadataItems)
+}
+
 module.exports = {
   processProfileUpdateMessage,
   processCreateOrUpdateProfileTraitMessage,

src/services/TermsAgreementProcessorService.js

@@ -102,10 +102,8 @@ processMessage.schema = {
       payload: Joi.object()
         .keys({
           userId: Joi.positiveId().required(),
-          termsOfUseId: Joi.string().uuid().required(),
-          legacyId: Joi.positiveId(),
-          created: Joi.date()
-        })
+          termsOfUseId: Joi.string().uuid().required()
+        }).unknown(true)
         .required()
     })
     .required()

test/common/idVerificationTestData.js

@@ -66,7 +66,7 @@ const idVerificationExistingTraits = [
       'data': [
         {
           'id_verification': {
-            'date': '2021-07-21',
+            'date': new Date('2021-07-21').getTime(),
             'message': 'success',
             'status': 'completed',
             'metadata': {

test/common/profileCompletionTestData.js

@@ -279,9 +279,99 @@ const saarixxExistingTraits = [
     'updatedAt': 1631785852398,
     'createdBy': 'XKMy68LCDT7mwKaUtl17Pgf5u2A7dXYo@clients',
     'updatedBy': 'XKMy68LCDT7mwKaUtl17Pgf5u2A7dXYo@clients'
+  },
+  {
+    'userId': saarixxUserId,
+    'traitId': 'education',
+    'traits': {
+      'traitId': 'education',
+      'data': [
+        {
+          'University': 'Kyiv Polytechnic'
+        }
+      ]
+    }
+  },
+  {
+    'userId': saarixxUserId,
+    'traitId': 'work',
+    'traits': {
+      'traitId': 'work',
+      'data': [
+        {
+          'Topcoder': 'Software Designer'
+        }
+      ]
+    }
   }
 ]
 
+const memberDetails = {
+  'userId': 40154303,
+  'handle': 'upbeat',
+  'handleLower': 'upbeat',
+  'firstName': 'Atif Ali',
+  'lastName': 'Siddiqui 12345',
+  'tracks': [
+    'DESIGN',
+    'DEVELOP'
+  ],
+  'status': 'ACTIVE',
+  'addresses': [
+    {
+      'zip': '560110',
+      'streetAddr1': 'GM INFINITE ECITY TOWN',
+      'city': 'Bangalore',
+      'stateCode': 'Karnataka',
+      'type': 'HOME'
+    }
+  ],
+  'description': 'What goes around comes around',
+  'email': '[email protected]',
+  'homeCountryCode': 'IRL',
+  'competitionCountryCode': 'IRL',
+  'photoURL': 'https://topcoder-dev-media.s3.amazonaws.com/member/profile/upbeat-1575621848253.png',
+  'maxRating': {
+    'rating': 0,
+    'track': 'DATA_SCIENCE',
+    'subTrack': [
+      'SRM'
+    ],
+    'ratingColor': '#9D9FA0'
+  },
+  'createdAt': 1515982240000,
+  'createdBy': '40154303',
+  'updatedAt': 1629632394246,
+  'updatedBy': '40029484'
+}
+
+const saarixxSkills = {
+  'userId': 123,
+  'handle': 'skills',
+  'handleLower': 'postmane2e-denis',
+  'skills': {
+    '286': {
+      'hidden': false,
+      'score': 1888,
+      'sources': [
+        'source1',
+        'source2'
+      ],
+      'tagName': 'Java'
+    },
+    '311': {
+      'hidden': false,
+      'tagName': 'Python',
+      'sources': [
+        'USER_ENTERED'
+      ],
+      'score': 90
+    }
+  },
+  'createdAt': 1621895619502,
+  'updatedAt': 1621895619502
+}
+
 module.exports = {
   testMethods,
   denisSkills,
@@ -290,5 +380,7 @@ module.exports = {
   thomasUserId,
   thomasExistingTraits,
   saarixxExistingTraits,
-  saarixxUserId
+  saarixxUserId,
+  memberDetails,
+  saarixxSkills
 }

test/common/testData.js

@@ -61,9 +61,9 @@ const stringFields = ['topic', 'originator', 'mime-type']
 
 const guidFields = ['payload.termsOfUseId']
 
-const positiveIntegerFields = ['payload.userId', 'payload.legacyId']
+const positiveIntegerFields = ['payload.userId']
 
-const dateFields = ['timestamp', 'payload.created']
+const dateFields = ['timestamp']
 
 const nonExistingUserId = 111111
 

test/unit/IdVerificationProcessorService.test.js

@@ -88,7 +88,6 @@ describe('Topcoder Onboarding Checklist - Id Verification Processor Service Unit
     await service.processIdVerification()
 
     assertInfoMessage('Processing id verification')
-    assertInfoMessage('Successfully Processed id verification')
     for (const handle of ['denis', 'upbeat']) {
       assertDebugMessage(`Saving id verification member trait for user '${handle}'`)
       assertDebugMessage(`Successfully completed saving id verification member trait for user '${handle}'`)
@@ -103,7 +102,6 @@ describe('Topcoder Onboarding Checklist - Id Verification Processor Service Unit
     await service.processIdVerification()
 
     assertInfoMessage('Processing id verification')
-    assertInfoMessage('Successfully Processed id verification')
     should.equal(stub.callCount, 1)
     assertDebugMessage(`Id verification trait is already set for user 'idVerification', Skipping...!`)
   })