Update helper script to account for nested data types

Author: callmekatootie

README.md

@@ -25,7 +25,7 @@ The following parameters can be set in config files or in env variables:
 - UBAHN_DELETE_TOPIC: the delete ubahn entity Kafka message topic, default value is 'u-bahn.action.delete'
 - ES.HOST: Elasticsearch host, default value is 'localhost:9200'
 - ES.AWS_REGION: The Amazon region to use when using AWS Elasticsearch service, default value is 'us-east-1'
-- ES.API_VERSION: Elasticsearch API version, default value is '6.8'
+- ES.API_VERSION: Elasticsearch API version, default value is '7.4'
 - ES.ACHIEVEMENT_PROVIDER_INDEX: Elasticsearch index name for achievement provider, default value is 'achievement_provider'
 - ES.ACHIEVEMENT_PROVIDER_TYPE: Elasticsearch index type for achievement provider, default value is '_doc'
 - ES.ATTRIBUTE_INDEX: Elasticsearch index name for attribute, default value is 'attribute'

config/default.js

@@ -21,7 +21,7 @@ module.exports = {
   ES: {
     HOST: process.env.ES_HOST || 'localhost:9200',
     AWS_REGION: process.env.AWS_REGION || 'us-east-1', // AWS Region to be used if we use AWS ES
-    API_VERSION: process.env.ES_API_VERSION || '6.8',
+    API_VERSION: process.env.ES_API_VERSION || '7.4',
     ACHIEVEMENT_PROVIDER_INDEX: process.env.ACHIEVEMENT_PROVIDER_INDEX || 'achievement_provider',
     ACHIEVEMENT_PROVIDER_TYPE: process.env.ACHIEVEMENT_PROVIDER_TYPE || '_doc',
     ATTRIBUTE_INDEX: process.env.ATTRIBUTE_INDEX || 'attribute',

src/common/constants.js

@@ -55,7 +55,8 @@ const userResources = {
   userattribute: {
     propertyName: config.get('ES.USER_ATTRIBUTE_PROPERTY_NAME'),
     relateKey: 'attributeId',
-    validate: payload => validProperties(payload, ['userId', 'attributeId'])
+    validate: payload => validProperties(payload, ['userId', 'attributeId']),
+    isNested: true // For ES index creation
   },
   userrole: {
     propertyName: config.get('ES.USER_ROLE_PROPERTY_NAME'),

test/common/init-es.js

@@ -9,10 +9,12 @@
 
 const logger = require('../../src/common/logger')
 const helper = require('../../src/common/helper')
-const { topResources } = require('../../src/common/constants')
+const { topResources, userResources } = require('../../src/common/constants')
 
 let client
 
+let needsNestedTypes = ['user']
+
 /**
  * Initialize elastic search index
  * @param {Boolean} isForce boolean flag indicate it is forced operation
@@ -31,6 +33,25 @@ const init = async (isForce) => {
     } else {
       logger.info(`The index ${topResources[key].index} will be created.`)
       await client.indices.create({ index: topResources[key].index })
+
+      if (needsNestedTypes.includes(topResources[key] === 'user')) {
+        for (const childKey in userResources) {
+          if (userResources[key].isNested) {
+            await client.indices.putMapping({
+              index: topResources[key].index,
+              type: topResources[key].type,
+              include_type_name: true,
+              body: {
+                properties: {
+                  [userResources[childKey].propertyName]: {
+                    type: 'nested'
+                  }
+                }
+              }
+            })
+          }
+        }
+      }
     }
   }
 }