fix: name of the returned object & name of the function

Signed-off-by: Sai Sankeerth <[email protected]>
rudderlabs · Nov 9, 2023 · a825926 · a825926
1 parent 5bdc2c6
commit a825926
Show file tree

Hide file tree

Showing 3 changed files with 23 additions and 19 deletions.
diff --git a/src/helpers/geoLocation.ts b/src/helpers/geoLocation.ts
@@ -7,24 +7,28 @@ import * as GenericFieldMappingJson from '../v0/util/data/GenericFieldMapping.js
 
 export default class GeoLocationHelper {
   public static getAddressKeyAndValue(message: Record<string, FixMe>): {
-    addressKey: string;
-    address: Record<string, FixMe>;
+    key: string;
+    value: Record<string, FixMe>;
   } {
-    const { value: address, key: foundKey } =
-      getFirstMatchingKeyAndValue(message, GenericFieldMappingJson.address) || {};
+    const { value, key: foundKey } = getFirstMatchingKeyAndValue(
+      message,
+      GenericFieldMappingJson.address,
+    );
     const { key: traitsKey } = getFirstMatchingKeyAndValue(message, GenericFieldMappingJson.traits);
     const addressKey =
       foundKey || (traitsKey ? `${traitsKey}.address` : GenericFieldMappingJson.address[0]);
-    return { addressKey, address };
+    return { key: addressKey, value };
   }
 
-  public static getGeoLocationData(message: Record<string, FixMe>): Record<string, FixMe> {
+  public static getMessageWithGeoLocationData(
+    message: Record<string, FixMe>,
+  ): Record<string, FixMe> {
     const msg = cloneDeep(message || {});
     if (isEmpty(msg?.context?.geo || {})) {
       // geo-location data was not sent
       return {};
     }
-    const { address, addressKey } = GeoLocationHelper.getAddressKeyAndValue(message);
+    const { value: address, key: addressKey } = GeoLocationHelper.getAddressKeyAndValue(message);
     const addressFieldMapping = {
       city: 'city',
       country: 'country',

diff --git a/src/middlewares/enricher.ts b/src/middlewares/enricher.ts
@@ -13,7 +13,7 @@ export default class Enricher {
     data: RouterTransformationRequestData[],
   ): RouterTransformationRequestData[] {
     return data.map((inpEv) => {
-      const geoEnrichedMessage = GeoLocationHelper.getGeoLocationData(inpEv.message);
+      const geoEnrichedMessage = GeoLocationHelper.getMessageWithGeoLocationData(inpEv.message);
       return {
         ...inpEv,
         message: {

diff --git a/test/helper/helper.test.ts b/test/helper/helper.test.ts
@@ -59,7 +59,7 @@ describe('GeoLocationHelper tests', () => {
       userId: 'abcd-124',
     };
 
-    const enhancedMsg = GeoLocationHelper.getGeoLocationData(msg);
+    const enhancedMsg = GeoLocationHelper.getMessageWithGeoLocationData(msg);
 
     expect(enhancedMsg.context.traits.address).not.toBe(undefined);
     expect(enhancedMsg.context.traits.address).toEqual({
@@ -126,7 +126,7 @@ describe('GeoLocationHelper tests', () => {
       userId: 'abcd-124',
     };
 
-    const enhancedMsg = GeoLocationHelper.getGeoLocationData(msg);
+    const enhancedMsg = GeoLocationHelper.getMessageWithGeoLocationData(msg);
 
     expect(enhancedMsg.context.traits.address).not.toBe(undefined);
     expect(enhancedMsg.context.traits.address).toEqual({
@@ -199,7 +199,7 @@ describe('GeoLocationHelper tests', () => {
       userId: 'abcd-124',
     };
 
-    const enhancedMsg = GeoLocationHelper.getGeoLocationData(msg);
+    const enhancedMsg = GeoLocationHelper.getMessageWithGeoLocationData(msg);
 
     expect(enhancedMsg.traits.address).not.toBe(undefined);
     expect(enhancedMsg.traits.address).toEqual({
@@ -276,7 +276,7 @@ describe('GeoLocationHelper tests', () => {
       userId: 'abcd-124',
     };
 
-    const enhancedMsg = GeoLocationHelper.getGeoLocationData(msg);
+    const enhancedMsg = GeoLocationHelper.getMessageWithGeoLocationData(msg);
 
     expect(enhancedMsg.traits.address).not.toBe(undefined);
     expect(enhancedMsg.traits.address).toEqual({
@@ -351,7 +351,7 @@ describe('GeoLocationHelper tests', () => {
       userId: 'abcd-124',
     };
 
-    const enhancedMsg = GeoLocationHelper.getGeoLocationData(msg);
+    const enhancedMsg = GeoLocationHelper.getMessageWithGeoLocationData(msg);
 
     expect(enhancedMsg.traits.address).not.toBe(undefined);
     expect(enhancedMsg.traits.address).toEqual({
@@ -408,15 +408,15 @@ describe('GeoLocationHelper tests', () => {
       userId: 'abcd-124',
     };
 
-    const enhancedMsg = GeoLocationHelper.getGeoLocationData(msg);
+    const enhancedMsg = GeoLocationHelper.getMessageWithGeoLocationData(msg);
 
     expect(enhancedMsg).toEqual({});
   });
 });
 
 describe('get addressKey & address tests', () => {
   test('addressKey should be "traits.address", when address is not present but traits object is present', () => {
-    const { addressKey } = GeoLocationHelper.getAddressKeyAndValue({
+    const { key: addressKey } = GeoLocationHelper.getAddressKeyAndValue({
       traits: {
         name: 'Bruce Wayne',
         age: 35,
@@ -427,7 +427,7 @@ describe('get addressKey & address tests', () => {
   });
 
   test('addressKey should be "context.traits.address", when address is not present but traits object is present', () => {
-    const { addressKey } = GeoLocationHelper.getAddressKeyAndValue({
+    const { key: addressKey } = GeoLocationHelper.getAddressKeyAndValue({
       context: {
         traits: {
           name: 'Bruce Wayne',
@@ -440,7 +440,7 @@ describe('get addressKey & address tests', () => {
   });
 
   test('addressKey should be "traits.address", when traits object is not present at all', () => {
-    const { addressKey } = GeoLocationHelper.getAddressKeyAndValue({
+    const { key: addressKey } = GeoLocationHelper.getAddressKeyAndValue({
       anonymousId: '129893-2idi9292',
       originalTimestamp: '2020-04-17T14:42:44.722Z',
       receivedAt: '2020-04-17T20:12:44.758+05:30',
@@ -465,7 +465,7 @@ describe('get addressKey & address tests', () => {
   });
 
   test('addressKey should be "context.traits.address", when address is present in context.traits & address is not present in traits', () => {
-    const { addressKey } = GeoLocationHelper.getAddressKeyAndValue({
+    const { key: addressKey } = GeoLocationHelper.getAddressKeyAndValue({
       anonymousId: '129893-2idi9292',
       originalTimestamp: '2020-04-17T14:42:44.722Z',
       receivedAt: '2020-04-17T20:12:44.758+05:30',
@@ -499,7 +499,7 @@ describe('get addressKey & address tests', () => {
   });
 
   test('addressKey should be "traits.address", when empty payload is sent', () => {
-    const { addressKey } = GeoLocationHelper.getAddressKeyAndValue({});
+    const { key: addressKey } = GeoLocationHelper.getAddressKeyAndValue({});
     expect(addressKey).toEqual('traits.address');
   });
 });