2021-02-16 - Translations - Functions

Service - Translations

Lambda Functions

GetTranslation

/**
 * Finds a matching translation from an ordered list of language preferences, or return the defaultTranslatesTo translation
 * @param {string} subjectVertexId
 * @param {string} translationLabel
 * @param {string[]} languageCodes - is an array of languageCodes, ordered by preference
 *
 * @returns {string} translation
 */

HdrApi

Validator: (standard)

handler logic

(standard)

logic

1. const graphServiceName = {from Config table: TranslationsGraphServiceName}
2. const foundTranslation = null
3. for each languageCodes
   1. let translatesToEdgeId = #createTranslatesToEdgeId
      1. subjectVertexId
      2. translationLabel
      3. languageCode
   2. let translateVertex = invoke NPM module - izara-shared#neptuneGraphSharedLib.getObjectVertexByEdgeId
      1. edgeId: translatesToEdgeId
   3. if translateVertex != null
      1. foundTranslation = translateVertex.translation
      2. break
4. if foundTranslation == null (no translations found for array of languageCodes
   1. let defaultTranslatesToEdgeId = #createDefaultTranslatesToEdgeId
      1. subjectVertexId
      2. translationLabel
   2. let translateVertex = invoke NPM module - izara-shared#neptuneGraphSharedLib.getObjectVertexByEdgeId
      1. edgeId: defaultTranslatesToEdgeId
   3. if translateVertex != null
      1. foundTranslation = translateVertex.translation
   4. else
      1. foundTranslation = (or could use a filler string - should never happen)
5. return foundTranslation

ListTranslationsOneLanguage

/**
 * Finds all possible translations for one subject and language
 * @param {string} subjectVertexId
 * @param {string[]} languageCode
 *
 * @returns {object[]} array of translation objects (maybe edges as well)
 */

HdrApi

Validator: (standard)

handler logic

(standard)

logic

1. const graphServiceName = {from Config table: TranslationsGraphServiceName}
2. const translations = NPM module - izara-shared#neptuneGraphSharedLib.getVertexOutEdgesAndVertices
   1. graphServiceName: graphServiceName
   2. subjectVertexId: subjectVertexId
   3. edgeLabel: 'possiblyTranslatesTo'
   4. edgeProperties: {languageCode: languageCode}
3. return translations

CreateSubjectVertex

/**
 * Create a new vertex for the subject of translations
 * @param {string} vertexId
 * @param {string} vertexLabel
 * @param {object} [vertexProperties]
 *
 */

HdrSqs

Triggered from MsgIn queue, msgTag: "CreateSubjectVertex"

Validator: (standard)

handler logic

(standard)

logic

1. const graphServiceName = {from Config table: TranslationsGraphServiceName}
2. publish to graphServiceName MsgIn queue (msgTag: 'CreateVertex'):
   1. vertexId: vertexId
   2. vertexLabel: vertexLabel
   3. vertexProperties: vertexProperties

CreateTranslationVertex

/**
 * Create a new vertex for a translation
 * @param {string} vertexId
 * @param {string} vertexLabel
 * @param {string} translation
 *
 */

HdrSqs

Triggered from MsgIn queue, msgTag: "CreateTranslationVertex"

Validator: (standard)

handler logic

(standard)

logic

1. create vertex by publish message to Service - Graph Handler MsgIn queue (msgTag: 'CreateVertex'):
   1. vertexId: vertexId
   2. vertexLabel: vertexLabel
   3. vertexProperties: {translation: translation}

CreateTranslation

/**
 * Create a new translation for a source object
 * @param {string} subjectVertexId
 * @param {string} translationLabel
 * @param {string} languageCode
 * @param {string} translation
 * @param {string} userId
 *
 * @returns {Object[]} ?translation vertex id?
 */

HdrSqs

Triggered from MsgIn queue, msgTag: "CreateTranslation"

Validator: (standard)

handler logic

(standard)

HdrApi

Validator: (standard)

Authorizer

AppLevel

handler logic

(standard)

logic

Expects subject vertex to already exist

1. const graphServiceName = {from Config table: TranslationsGraphServiceName}
2. const translationVertexId = NPM module - izara-shared#neptuneGraphSharedLib.createVertexId
   1. vertexTag: 'translation'
   2. uniqueId: {random uuid}
3. const existingVertices = NPM module - izara-shared#neptuneGraphSharedLib.getVertexOutEdgesAndVertices
   1. subjectId: subjectVertexId
   2. edgeLabel: 'possiblyTranslatesTo'
4. let hasExistingSameLanguage = false
5. iterate existingVertices
   1. if any match this languageCode and translation can return, no additional work to be done
   2. if any match this languageCode set hasExistingSameLanguage = true

1. publish message to own MsgIn queue (msgTag: 'CreateTranslationVertex'):
   1. vertexId: translationVertexId
   2. vertexLabel: translationLabel + 'Translation'
   3. translation: translation
2. create edgeId for possiblyTranslatesTo edge:
   1. const possiblyTranslatesToEdgeId = subjectVertexId + '_Possible_' + translationLabel + '_' + languageCode + '_' + translationVertexId
3. create possiblyTranslatesTo edge by publish message to Service - Graph Handler MsgIn queue (msgTag: 'CreateEdge'):
   1. subjectId: subjectVertexId
   2. edgeLabel: 'possiblyTranslatesTo'
   3. edgeId: possiblyTranslatesToEdgeId
   4. objectId: translationVertexId
   5. edgeProperties:
      1. languageCode: languageCode
4. if hasExistingSameLanguage == false
   1. const translatesToEdgeId = #createTranslatesToEdgeId
      1. subjectVertexId
      2. translationLabel
      3. languageCode
   2. create translatesTo edge by publish message to Service - Graph Handler MsgIn queue (msgTag: 'CreateEdge'):
      1. subjectId: subjectVertexId
      2. edgeLabel: 'translatesTo'
      3. edgeId: translatesToEdgeId
      4. objectId: translationVertexId
      5. edgeProperties:
         1. languageCode: languageCode
5. if existingVertices.length == 0 (no existing possible translations)
   1. const defaultTranslatesToEdgeId = #createDefaultTranslatesToEdgeId
      1. subjectVertexId
      2. translationLabel
   2. create defaultTranslatesTo edge by publish message to Service - Graph Handler MsgIn queue (msgTag: 'CreateEdge'):
      1. subjectId: subjectVertexId
      2. edgeLabel: 'defaultTranslatesTo'
      3. edgeId: defaultTranslatesToEdgeId
      4. objectId: translationVertexId
6. const userVertexId = NPM module - izara-shared#neptuneGraphSharedLib.createVertexId
   1. vertexTag: 'user'
   2. uniqueId: userId
7. const createdByEdgeId = NPM module - izara-shared#neptuneGraphSharedLib.createCreatedByEdgeId
   1. vertexId: translationVertexId
8. create createdBy edge by publish message to Service - Graph Handler MsgIn queue (msgTag: 'CreateEdge'):
   1. subjectId: translationVertexId
   2. edgeLabel: 'createdBy'
   3. edgeId: createdByEdgeId
   4. objectId: userVertexId
   5. edgeProperties:
      1. timestamp: {current timestamp}

Functions

createTranslatesToEdgeId

/**
 * @param {string} subjectVertexId
 * @param {string} translationLabel
 * @param {string} languageCode
 *
 * @returns {string} translatesToEdgeId or null if none found
 */

logic

1. return subjectVertexId + '_' + translationLabel + '_' + languageCode

createDefaultTranslatesToEdgeId

/**
 * @param {string} subjectVertexId
 * @param {string} translationLabel
 *
 * @returns {string} defaultTranslatesToEdgeId or null if none found
 */

logic

1. return subjectVertexId + '_Default_' + translationLabel