Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[MOB-9652] support for nested JSON array #459

Merged
merged 6 commits into from
Oct 7, 2024
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 37 additions & 12 deletions src/anonymousUserTracking/criteriaCompletionChecker.ts
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
}

class CriteriaCompletionChecker {
private localStoredEventList: any[];

Check warning on line 39 in src/anonymousUserTracking/criteriaCompletionChecker.ts

View workflow job for this annotation

GitHub Actions / build

Unexpected any. Specify a different type

constructor(localStoredEventList: string) {
this.localStoredEventList = JSON.parse(localStoredEventList);
Expand Down Expand Up @@ -72,8 +72,8 @@
return matchingCriteria ? matchingCriteria.criteriaId : null;
}

private prepareEventsToProcess(): any[] {

Check warning on line 75 in src/anonymousUserTracking/criteriaCompletionChecker.ts

View workflow job for this annotation

GitHub Actions / build

Unexpected any. Specify a different type
const eventsToProcess: any[] = this.getEventsWithCartItems();

Check warning on line 76 in src/anonymousUserTracking/criteriaCompletionChecker.ts

View workflow job for this annotation

GitHub Actions / build

Unexpected any. Specify a different type
const nonPurchaseEvents: any[] = this.getNonCartEvents();

nonPurchaseEvents.forEach((event) => {
Expand Down Expand Up @@ -350,16 +350,41 @@
);

if (field.includes('.')) {
const fields = field.split('.');
const firstElement = eventData?.[fields[0]];
if (Array.isArray(firstElement)) {
return firstElement?.some((item: any) => {
const data = {
...eventData,
[fields[0]]: item
};
return this.evaluateFieldLogic(searchQueries, data);
});
const splitedField = field.split('.') as string[];
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
const splitedField = field.split('.') as string[];
const splitField = field.split('.') as string[];

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changes are done in recent commit

const fields =
eventData?.eventType === TRACK_EVENT &&
eventData?.eventName === splitedField[0]
? splitedField.slice(1)
: splitedField;

let fieldValue = eventData;
let isSubFieldArray = false;
let isSubMatch = false;

fields.forEach((subField) => {
const subFieldValue = fieldValue[subField];
if (Array.isArray(subFieldValue)) {
isSubFieldArray = true;
isSubMatch = subFieldValue.some((item: any) => {
const data = fields.reduceRight((acc: any, key) => {
if (key === subField) {
return { [key]: item };
}
return { [key]: acc };
}, {});

return this.evaluateFieldLogic(searchQueries, {
...eventData,
...data
});
});
} else {
fieldValue = subFieldValue;
}
});

if (isSubFieldArray) {
return isSubMatch;
}

const valueFromObj = this.getFieldValue(eventData, field);
Expand All @@ -383,9 +408,9 @@
}

private getFieldValue(data: any, field: string): any {
let fields = field.split('.');
const fields: string[] = field.split('.');
if (data?.eventType === TRACK_EVENT && data?.eventName === fields[0]) {
fields = [fields[fields.length - 1]];
fields.shift();
}
return fields.reduce(
(value, currentField) =>
Expand Down
80 changes: 80 additions & 0 deletions src/anonymousUserTracking/tests/constants.ts
Original file line number Diff line number Diff line change
Expand Up @@ -834,6 +834,86 @@ export const NESTED_CRITERIA = {
]
};

export const NESTED_CRITERIA_MULTI_LEVEL = {
count: 1,
criteriaSets: [
{
criteriaId: '425',
name: 'Multi level Nested field criteria',
createdAt: 1721251169153,
updatedAt: 1723488175352,
searchQuery: {
combinator: 'And',
searchQueries: [
{
combinator: 'And',
searchQueries: [
{
dataType: 'customEvent',
searchCombo: {
combinator: 'And',
searchQueries: [
{
dataType: 'customEvent',
field: 'button-clicked.browserVisit.website.domain',
comparatorType: 'Equals',
value: 'https://mybrand.com/socks',
fieldType: 'string'
}
]
}
}
]
}
]
}
}
]
};

export const NESTED_CRITERIA_MULTI_LEVEL_ARRAY = {
count: 1,
criteriaSets: [
{
criteriaId: '436',
name: 'Criteria 2.1 - 09252024 Bug Bash',
createdAt: 1727286807360,
updatedAt: 1727445082036,
searchQuery: {
combinator: 'And',
searchQueries: [
{
combinator: 'And',
searchQueries: [
{
dataType: 'user',
searchCombo: {
combinator: 'And',
searchQueries: [
{
dataType: 'user',
field: 'furniture.material.type',
comparatorType: 'Contains',
value: 'table',
fieldType: 'string'
},
{
dataType: 'user',
field: 'furniture.material.color',
comparatorType: 'Equals',
values: ['black']
}
]
}
}
]
}
]
}
}
]
};

export const IS_ONE_OF_CRITERIA = {
count: 1,
criteriaSets: [
Expand Down
201 changes: 199 additions & 2 deletions src/anonymousUserTracking/tests/nestedTesting.test.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
import { SHARED_PREFS_EVENT_LIST_KEY } from '../../constants';
import CriteriaCompletionChecker from '../criteriaCompletionChecker';
import { NESTED_CRITERIA } from './constants';
import {
NESTED_CRITERIA,
NESTED_CRITERIA_MULTI_LEVEL,
NESTED_CRITERIA_MULTI_LEVEL_ARRAY
} from './constants';

const localStorageMock = {
getItem: jest.fn(),
Expand Down Expand Up @@ -53,7 +57,7 @@ describe('nestedTesting', () => {
expect(result).toEqual('168');
});

it('should return criteriaId 168 (nested field - No match)', () => {
it('should return criteriaId null (nested field - No match)', () => {
(localStorage.getItem as jest.Mock).mockImplementation((key) => {
if (key === SHARED_PREFS_EVENT_LIST_KEY) {
return JSON.stringify([
Expand Down Expand Up @@ -92,4 +96,197 @@ describe('nestedTesting', () => {
const result = checker.getMatchedCriteria(JSON.stringify(NESTED_CRITERIA));
expect(result).toEqual(null);
});

it('should return criteriaId 425 (Multi level Nested field criteria)', () => {
(localStorage.getItem as jest.Mock).mockImplementation((key) => {
if (key === SHARED_PREFS_EVENT_LIST_KEY) {
return JSON.stringify([
{
eventName: 'button-clicked',
dataFields: {
browserVisit: { website: { domain: 'https://mybrand.com/socks' } }
},
eventType: 'customEvent'
}
]);
}
return null;
});

const localStoredEventList = localStorage.getItem(
SHARED_PREFS_EVENT_LIST_KEY
);

const checker = new CriteriaCompletionChecker(
localStoredEventList === null ? '' : localStoredEventList
);
const result = checker.getMatchedCriteria(
JSON.stringify(NESTED_CRITERIA_MULTI_LEVEL)
);
expect(result).toEqual('425');
});

it('should return criteriaId 425 (Multi level Nested field criteria - No match)', () => {
(localStorage.getItem as jest.Mock).mockImplementation((key) => {
if (key === SHARED_PREFS_EVENT_LIST_KEY) {
return JSON.stringify([
{
eventName: 'button-clicked',
dataFields: {
'button-clicked': {
browserVisit: {
website: { domain: 'https://mybrand.com/socks' }
}
}
},
eventType: 'customEvent'
}
]);
}
return null;
});

const localStoredEventList = localStorage.getItem(
SHARED_PREFS_EVENT_LIST_KEY
);

const checker = new CriteriaCompletionChecker(
localStoredEventList === null ? '' : localStoredEventList
);
const result = checker.getMatchedCriteria(
JSON.stringify(NESTED_CRITERIA_MULTI_LEVEL)
);
expect(result).toEqual(null);
});

it('should return criteriaId null (Multi level Nested field criteria - No match)', () => {
(localStorage.getItem as jest.Mock).mockImplementation((key) => {
if (key === SHARED_PREFS_EVENT_LIST_KEY) {
return JSON.stringify([
{
eventName: 'button-clicked',
dataFields: {
'browserVisit.website.domain': 'https://mybrand.com/socks'
},
eventType: 'customEvent'
}
]);
}
return null;
});

const localStoredEventList = localStorage.getItem(
SHARED_PREFS_EVENT_LIST_KEY
);

const checker = new CriteriaCompletionChecker(
localStoredEventList === null ? '' : localStoredEventList
);
const result = checker.getMatchedCriteria(
JSON.stringify(NESTED_CRITERIA_MULTI_LEVEL)
);
expect(result).toEqual(null);
});

it('should return criteriaId null (Multi level Nested field criteria - No match)', () => {
(localStorage.getItem as jest.Mock).mockImplementation((key) => {
if (key === SHARED_PREFS_EVENT_LIST_KEY) {
return JSON.stringify([
{
eventName: 'button-clicked',
dataFields: {
browserVisit: { website: { domain: 'https://mybrand.com' } }
},
eventType: 'customEvent'
}
]);
}
return null;
});

const localStoredEventList = localStorage.getItem(
SHARED_PREFS_EVENT_LIST_KEY
);

const checker = new CriteriaCompletionChecker(
localStoredEventList === null ? '' : localStoredEventList
);
const result = checker.getMatchedCriteria(
JSON.stringify(NESTED_CRITERIA_MULTI_LEVEL)
);
expect(result).toEqual(null);
});

it('should return criteriaId null (Multi level Nested field criteria - No match)', () => {
(localStorage.getItem as jest.Mock).mockImplementation((key) => {
if (key === SHARED_PREFS_EVENT_LIST_KEY) {
return JSON.stringify([
{
eventName: 'button-clicked',
dataFields: {
quantity: 11,
domain: 'https://mybrand.com/socks'
},
eventType: 'customEvent'
}
]);
}
return null;
});

const localStoredEventList = localStorage.getItem(
SHARED_PREFS_EVENT_LIST_KEY
);

const checker = new CriteriaCompletionChecker(
localStoredEventList === null ? '' : localStoredEventList
);
const result = checker.getMatchedCriteria(
JSON.stringify(NESTED_CRITERIA_MULTI_LEVEL)
);
expect(result).toEqual(null);
});

it('should return criteriaId 436 (Multi level Nested field criteria)', () => {
(localStorage.getItem as jest.Mock).mockImplementation((key) => {
if (key === SHARED_PREFS_EVENT_LIST_KEY) {
return JSON.stringify([
{
dataFields: {
furniture: {
material: [
{
type: 'table',
color: 'black',
lengthInches: 40,
widthInches: 60
},
{
type: 'Sofa',
color: 'Gray',
lengthInches: 20,
widthInches: 30
}
]
}
},
eventType: 'user'
}
]);
}
return null;
});

const localStoredEventList = localStorage.getItem(
SHARED_PREFS_EVENT_LIST_KEY
);

const checker = new CriteriaCompletionChecker(
localStoredEventList === null ? '' : localStoredEventList
);
const result = checker.getMatchedCriteria(
JSON.stringify(NESTED_CRITERIA_MULTI_LEVEL_ARRAY)
);
expect(result).toEqual('436');
});
});
Loading