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.

Sign up for GitHub

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

feat(insights): annotate events with algoliaSource #5580

Merged
merged 2 commits into from
Apr 6, 2023
Merged

feat(insights): annotate events with algoliaSource #5580

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
84f2708
feat(insights): annotate events with algoliaSource
Haroenv Apr 5, 2023
bb4ee1a
chore: bundlesize
Haroenv Apr 6, 2023
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
12 changes: 6 additions & 6 deletions bundlesize.config.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@
"files": [
{
"path": "./packages/instantsearch.js/dist/instantsearch.production.min.js",
"maxSize": "74 kB"
"maxSize": "74.25 kB"
},
{
"path": "./packages/instantsearch.js/dist/instantsearch.development.js",
"maxSize": "160 kB"
"maxSize": "165 kB"
},
{
"path": "packages/react-instantsearch/dist/umd/Core.min.js",
Expand All @@ -26,11 +26,11 @@
},
{
"path": "packages/react-instantsearch-hooks/dist/umd/ReactInstantSearchHooks.min.js",
"maxSize": "43.50 kB"
"maxSize": "44.50 kB"
},
{
"path": "packages/react-instantsearch-hooks-web/dist/umd/ReactInstantSearchHooksDOM.min.js",
"maxSize": "52.75 kB"
"maxSize": "53.50 kB"
},
{
"path": "packages/react-instantsearch-dom/dist/umd/ReactInstantSearchDOM.min.js",
Expand All @@ -42,11 +42,11 @@
},
{
"path": "packages/vue-instantsearch/vue2/umd/index.js",
"maxSize": "61.75 kB"
"maxSize": "62 kB"
},
{
"path": "packages/vue-instantsearch/vue3/umd/index.js",
"maxSize": "62 kB"
"maxSize": "62.25 kB"
},
{
"path": "packages/vue-instantsearch/vue2/cjs/index.js",
Expand Down
2 changes: 2 additions & 0 deletions packages/instantsearch.js/src/connectors/autocomplete/__tests__/connectAutocomplete-test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -778,6 +778,7 @@ search.addWidgets([
expect(sendEventToInsights).toHaveBeenCalledTimes(2);
expect(sendEventToInsights.mock.calls[0][0]).toEqual({
eventType: 'view',
eventModifier: 'internal',
hits: [
{
__position: 0,
Expand All @@ -796,6 +797,7 @@ search.addWidgets([
});
expect(sendEventToInsights.mock.calls[1][0]).toEqual({
eventType: 'view',
eventModifier: 'internal',
hits: [
{
__position: 0,
Expand Down
2 changes: 1 addition & 1 deletion packages/instantsearch.js/src/connectors/autocomplete/connectAutocomplete.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,7 @@ search.addWidgets([
const renderState = this.getWidgetRenderState(renderOptions);

renderState.indices.forEach(({ sendEvent, hits }) => {
sendEvent('view', hits);
sendEvent('view:internal', hits);
});

renderFn(
Expand Down
1 change: 1 addition & 0 deletions packages/instantsearch.js/src/connectors/geo-search/__tests__/connectGeoSearch-test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1668,6 +1668,7 @@ See documentation: https://www.algolia.com/doc/api-reference/widgets/geo-search/
);
expect(instantSearchInstance.sendEventToInsights).toHaveBeenCalledWith({
eventType: 'view',
eventModifier: 'internal',
hits: [
{
__position: 0,
Expand Down
2 changes: 1 addition & 1 deletion packages/instantsearch.js/src/connectors/geo-search/connectGeoSearch.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -316,7 +316,7 @@ const connectGeoSearch: GeoSearchConnector = (renderFn, unmountFn = noop) => {

const widgetRenderState = this.getWidgetRenderState(renderArgs);

sendEvent('view', widgetRenderState.items);
sendEvent('view:internal', widgetRenderState.items);

renderFn(
{
Expand Down
2 changes: 2 additions & 0 deletions ...stantsearch.js/src/connectors/hierarchical-menu/__tests__/connectHierarchicalMenu-test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1812,6 +1812,7 @@ See documentation: https://www.algolia.com/doc/api-reference/widgets/hierarchica
);
expect(instantSearchInstance.sendEventToInsights).toHaveBeenCalledWith({
attribute: 'category',
eventModifier: 'internal',
eventType: 'click',
insightsMethod: 'clickedFilters',
payload: {
Expand All @@ -1832,6 +1833,7 @@ See documentation: https://www.algolia.com/doc/api-reference/widgets/hierarchica
).toHaveBeenLastCalledWith({
attribute: 'sub_category',
eventType: 'click',
eventModifier: 'internal',
insightsMethod: 'clickedFilters',
payload: {
eventName: 'Filter Applied',
Expand Down
2 changes: 1 addition & 1 deletion packages/instantsearch.js/src/connectors/hierarchical-menu/connectHierarchicalMenu.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -339,7 +339,7 @@ const connectHierarchicalMenu: HierarchicalMenuConnector =

if (!_refine) {
_refine = function (facetValue) {
sendEvent('click', facetValue);
sendEvent('click:internal', facetValue);
helper
.toggleFacetRefinement(hierarchicalFacetName, facetValue)
.search();
Expand Down
1 change: 1 addition & 0 deletions packages/instantsearch.js/src/connectors/hits/__tests__/connectHits-test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -809,6 +809,7 @@ See documentation: https://www.algolia.com/doc/api-reference/widgets/hits/js/#co
instantSearchInstance.sendEventToInsights
).toHaveBeenCalledWith({
eventType: 'view',
eventModifier: 'internal',
hits: [
{
__position: 0,
Expand Down
2 changes: 1 addition & 1 deletion packages/instantsearch.js/src/connectors/hits/connectHits.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ const connectHits: HitsConnector = function connectHits(
false
);

renderState.sendEvent('view', renderState.hits);
renderState.sendEvent('view:internal', renderState.hits);
},

getRenderState(renderState, renderOptions) {
Expand Down
1 change: 1 addition & 0 deletions packages/instantsearch.js/src/connectors/infinite-hits/__tests__/connectInfiniteHits-test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1399,6 +1399,7 @@ See documentation: https://www.algolia.com/doc/api-reference/widgets/infinite-hi
instantSearchInstance.sendEventToInsights
).toHaveBeenCalledWith({
eventType: 'view',
eventModifier: 'internal',
hits: [
{
__position: 0,
Expand Down
2 changes: 1 addition & 1 deletion packages/instantsearch.js/src/connectors/infinite-hits/connectInfiniteHits.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -288,7 +288,7 @@ const connectInfiniteHits: InfiniteHitsConnector = function connectInfiniteHits(
false
);

sendEvent('view', widgetRenderState.currentPageHits);
sendEvent('view:internal', widgetRenderState.currentPageHits);
},

getRenderState(renderState, renderOptions) {
Expand Down
1 change: 1 addition & 0 deletions packages/instantsearch.js/src/connectors/menu/__tests__/connectMenu-test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1668,6 +1668,7 @@ See documentation: https://www.algolia.com/doc/api-reference/widgets/menu/js/#co
expect(instantSearchInstance.sendEventToInsights).toHaveBeenCalledWith({
attribute: 'category',
eventType: 'click',
eventModifier: 'internal',
insightsMethod: 'clickedFilters',
payload: {
eventName: 'Filter Applied',
Expand Down
2 changes: 1 addition & 1 deletion packages/instantsearch.js/src/connectors/menu/connectMenu.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -274,7 +274,7 @@ const connectMenu: MenuConnector = function connectMenu(
_refine = function (facetValue: string) {
const [refinedItem] =
helper.getHierarchicalFacetBreadcrumb(attribute);
sendEvent!('click', facetValue ? facetValue : refinedItem);
sendEvent!('click:internal', facetValue ? facetValue : refinedItem);
helper
.toggleFacetRefinement(
attribute,
Expand Down
2 changes: 1 addition & 1 deletion packages/instantsearch.js/src/connectors/numeric-menu/connectNumericMenu.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -309,7 +309,7 @@ const connectNumericMenu: NumericMenuConnector = function connectNumericMenu(
attribute,
facetValue
);
connectorState.sendEvent!('click', facetValue);
connectorState.sendEvent!('click:internal', facetValue);
helper.setState(refinedState).search();
};
}
Expand Down
2 changes: 2 additions & 0 deletions packages/instantsearch.js/src/connectors/rating-menu/__tests__/connectRatingMenu-test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -980,6 +980,7 @@ See documentation: https://www.algolia.com/doc/api-reference/widgets/rating-menu
expect(instantSearchInstance.sendEventToInsights).toHaveBeenCalledWith({
attribute: 'swag',
eventType: 'click',
eventModifier: 'internal',
insightsMethod: 'clickedFilters',
payload: {
eventName: 'Filter Applied',
Expand Down Expand Up @@ -1013,6 +1014,7 @@ See documentation: https://www.algolia.com/doc/api-reference/widgets/rating-menu
expect(instantSearchInstance.sendEventToInsights).toHaveBeenCalledWith({
attribute: 'swag',
eventType: 'click',
eventModifier: 'internal',
insightsMethod: 'clickedFilters',
payload: {
eventName: 'Filter Applied',
Expand Down
6 changes: 4 additions & 2 deletions packages/instantsearch.js/src/connectors/rating-menu/connectRatingMenu.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,8 @@ const createSendEvent: CreateSendEvent =
instantSearchInstance.sendEventToInsights(args[0]);
return;
}
const [eventType, facetValue, eventName = 'Filter Applied'] = args;
const [, facetValue, eventName = 'Filter Applied'] = args;
const [eventType, eventModifier] = args[0].split(':');
if (eventType !== 'click') {
return;
}
Expand All @@ -55,6 +56,7 @@ const createSendEvent: CreateSendEvent =
insightsMethod: 'clickedFilters',
widgetType: $$type,
eventType,
eventModifier,
payload: {
eventName,
index: helper.getIndex(),
Expand Down Expand Up @@ -264,7 +266,7 @@ const connectRatingMenu: RatingMenuConnector = function connectRatingMenu(
helper: AlgoliaSearchHelper,
facetValue: string
) => {
sendEvent('click', facetValue);
sendEvent('click:internal', facetValue);
helper.setState(getRefinedState(helper.state, facetValue)).search();
};

Expand Down
1 change: 1 addition & 0 deletions ...s/instantsearch.js/src/connectors/refinement-list/__tests__/connectRefinementList-test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3274,6 +3274,7 @@ See documentation: https://www.algolia.com/doc/api-reference/widgets/refinement-
expect(instantSearchInstance.sendEventToInsights).toHaveBeenCalledWith({
attribute: 'category',
eventType: 'click',
eventModifier: 'internal',
insightsMethod: 'clickedFilters',
payload: {
eventName: 'Filter Applied',
Expand Down
2 changes: 1 addition & 1 deletion packages/instantsearch.js/src/connectors/refinement-list/connectRefinementList.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -381,7 +381,7 @@ const connectRefinementList: RefinementListConnector =
});

triggerRefine = (facetValue) => {
sendEvent!('click', facetValue);
sendEvent!('click:internal', facetValue);
helper.toggleFacetRefinement(attribute, facetValue).search();
};

Expand Down
1 change: 1 addition & 0 deletions ...stantsearch.js/src/connectors/toggle-refinement/__tests__/connectToggleRefinement-test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1398,6 +1398,7 @@ See documentation: https://www.algolia.com/doc/api-reference/widgets/toggle-refi
expect(instantSearchInstance.sendEventToInsights).toHaveBeenCalledWith({
attribute: 'isShippingFree',
eventType: 'click',
eventModifier: 'internal',
insightsMethod: 'clickedFilters',
payload: {
eventName: 'Filter Applied',
Expand Down
6 changes: 4 additions & 2 deletions packages/instantsearch.js/src/connectors/toggle-refinement/connectToggleRefinement.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,8 @@ const createSendEvent = ({
instantSearchInstance.sendEventToInsights(args[0]);
return;
}
const [eventType, isRefined, eventName = 'Filter Applied'] = args;
const [, isRefined, eventName = 'Filter Applied'] = args;
const [eventType, eventModifier] = args[0].split(':');
if (eventType !== 'click' || on === undefined) {
return;
}
Expand All @@ -65,6 +66,7 @@ const createSendEvent = ({
insightsMethod: 'clickedFilters',
widgetType: $$type,
eventType,
eventModifier,
payload: {
eventName,
index: helper.getIndex(),
Expand Down Expand Up @@ -210,7 +212,7 @@ const connectToggleRefinement: ToggleRefinementConnector =
} = { isRefined: false }
) => {
if (!isRefined) {
sendEvent('click', isRefined);
sendEvent('click:internal', isRefined);
if (hasAnOffValue) {
off!.forEach((v) =>
helper.removeDisjunctiveFacetRefinement(attribute, v)
Expand Down
2 changes: 1 addition & 1 deletion packages/instantsearch.js/src/lib/__tests__/InstantSearch-test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -524,7 +524,7 @@ See https://www.algolia.com/doc/api-reference/widgets/configure/js/`);
expect(insightsClient).toHaveBeenCalledTimes(1);
expect(insightsClient).toHaveBeenCalledWith(
'clickedObjectIDsAfterSearch',
{ eventName: 'Add to cart' },
{ eventName: 'Add to cart', algoliaSource: ['instantsearch'] },
{
headers: {
'X-Algolia-API-Key': 'apiKey',
Expand Down
20 changes: 20 additions & 0 deletions packages/instantsearch.js/src/lib/utils/__tests__/createSendEventForFacet-test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,26 @@ If you want to send a custom payload, you can pass one object: sendEvent(customP
});
});

it('sends with internal eventName', () => {
const { sendEvent, instantSearchInstance } = createTestEnvironment();
sendEvent('click:internal', 'value');
expect(instantSearchInstance.sendEventToInsights).toHaveBeenCalledTimes(
1
);
expect(instantSearchInstance.sendEventToInsights).toHaveBeenCalledWith({
attribute: 'category',
eventType: 'click',
eventModifier: 'internal',
insightsMethod: 'clickedFilters',
payload: {
eventName: 'Filter Applied',
filters: ['category:value'],
index: '',
},
widgetType: 'ais.customWidget',
});
});

it('sends with custom eventName', () => {
const { sendEvent, instantSearchInstance } = createTestEnvironment();
sendEvent('click', 'value', 'Category Clicked');
Expand Down
75 changes: 75 additions & 0 deletions packages/instantsearch.js/src/lib/utils/__tests__/createSendEventForHits-test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,30 @@ describe('createSendEventForHits', () => {
});
});

it('sends internal view event with default eventName', () => {
const { sendEvent, instantSearchInstance, hits } = createTestEnvironment();
sendEvent('view:internal', hits[0]);
expect(instantSearchInstance.sendEventToInsights).toHaveBeenCalledTimes(1);
expect(instantSearchInstance.sendEventToInsights).toHaveBeenCalledWith({
eventType: 'view',
eventModifier: 'internal',
hits: [
{
__position: 0,
__queryID: 'test-query-id',
objectID: 'obj0',
},
],
insightsMethod: 'viewedObjectIDs',
payload: {
eventName: 'Hits Viewed',
index: 'testIndex',
objectIDs: ['obj0'],
},
widgetType: 'ais.testWidget',
});
});

it('sends view event with custom eventName', () => {
const { sendEvent, instantSearchInstance, hits } = createTestEnvironment();
sendEvent('view', hits[0], 'Products Displayed');
Expand Down Expand Up @@ -247,6 +271,32 @@ describe('createSendEventForHits', () => {
});
});

it('sends internal click event', () => {
const { sendEvent, instantSearchInstance, hits } = createTestEnvironment();
sendEvent('click:internal', hits[0], 'Product Clicked');
expect(instantSearchInstance.sendEventToInsights).toHaveBeenCalledTimes(1);
expect(instantSearchInstance.sendEventToInsights).toHaveBeenCalledWith({
eventType: 'click',
eventModifier: 'internal',
hits: [
{
__position: 0,
__queryID: 'test-query-id',
objectID: 'obj0',
},
],
insightsMethod: 'clickedObjectIDsAfterSearch',
payload: {
eventName: 'Product Clicked',
index: 'testIndex',
objectIDs: ['obj0'],
positions: [0],
queryID: 'test-query-id',
},
widgetType: 'ais.testWidget',
});
});

it('sends click event with more than 20 hits', () => {
const { sendEvent, instantSearchInstance, hits } = createTestEnvironment({
nbHits: 21,
Expand Down Expand Up @@ -317,6 +367,31 @@ describe('createSendEventForHits', () => {
});
});

it('sends internal conversion event', () => {
const { sendEvent, instantSearchInstance, hits } = createTestEnvironment();
sendEvent('conversion:internal', hits[0], 'Product Ordered');
expect(instantSearchInstance.sendEventToInsights).toHaveBeenCalledTimes(1);
expect(instantSearchInstance.sendEventToInsights).toHaveBeenCalledWith({
eventType: 'conversion',
eventModifier: 'internal',
hits: [
{
__position: 0,
__queryID: 'test-query-id',
objectID: 'obj0',
},
],
insightsMethod: 'convertedObjectIDsAfterSearch',
payload: {
eventName: 'Product Ordered',
index: 'testIndex',
objectIDs: ['obj0'],
queryID: 'test-query-id',
},
widgetType: 'ais.testWidget',
});
});

it('sends conversion event with more than 20 hits', () => {
const { sendEvent, instantSearchInstance, hits } = createTestEnvironment({
nbHits: 21,
Expand Down
Loading