Release 0.74.0

packages/snap-controller/src/Autocomplete/AutocompleteController.ts

@@ -21,7 +21,7 @@ import type {
 	ClickthroughResultsInner,
 	ClickthroughBannersInner,
 	BannersInner,
-} from '@searchspring/beacon';
+} from '@athoscommerce/beacon';
 import { CLICK_DUPLICATION_TIMEOUT, isClickWithinProductLink } from '../utils/isClickWithinProductLink';
 import { isClickWithinBannerLink } from '../utils/isClickWithinBannerLink';
 
@@ -37,6 +37,9 @@ const defaultConfig: AutocompleteControllerConfig = {
 	selector: '',
 	action: '',
 	globals: {},
+	beacon: {
+		enabled: true,
+	},
 	settings: {
 		integratedSpellCorrection: false,
 		initializeFromUrl: true,
@@ -77,7 +80,6 @@ export class AutocompleteController extends AbstractController {
 	declare store: AutocompleteStore;
 	declare config: AutocompleteControllerConfig;
 	public storage: StorageStore;
-	private lastSearchQuery: string | undefined;
 
 	private events: {
 		[responseId: string]: {
@@ -123,16 +125,6 @@ export class AutocompleteController extends AbstractController {
 			key: `ss-controller-${this.config.id}`,
 		});
 
-		this.eventManager.on('afterStore', async (search: AfterStoreObj, next: Next): Promise<void | boolean> => {
-			await next();
-			const controller = search.controller as AutocompleteController;
-			const responseId = search.response.tracking.responseId;
-			if (controller.store.loaded && !controller.store.error) {
-				const data: RenderSchemaData = { responseId };
-				this.tracker.events.autocomplete.render({ data, siteId: this.config.globals?.siteId });
-			}
-		});
-
 		// add 'afterSearch' middleware
 		this.eventManager.on('afterSearch', async (ac: AutocompleteAfterSearchObj, next: Next): Promise<void | boolean> => {
 			await next();
@@ -175,6 +167,10 @@ export class AutocompleteController extends AbstractController {
 	track: AutocompleteTrackMethods = {
 		banner: {
 			impression: (_banner): void => {
+				if (!_banner) {
+					this.log.warn('No banner provided to track.banner.impression');
+					return;
+				}
 				const { responseId, uid } = _banner;
 				if (this.events[responseId]?.banner?.[uid]?.impression) {
 					return;
@@ -187,11 +183,15 @@ export class AutocompleteController extends AbstractController {
 					results: [],
 				};
 				this.eventManager.fire('track.banner.impression', { controller: this, product: { uid }, trackEvent: data });
-				this.tracker.events.autocomplete.impression({ data, siteId: this.config.globals?.siteId });
+				this.config.beacon?.enabled && this.tracker.events.autocomplete.impression({ data, siteId: this.config.globals?.siteId });
 				this.events[responseId].banner[uid] = this.events[responseId].banner[uid] || {};
 				this.events[responseId].banner[uid].impression = true;
 			},
 			click: (e: MouseEvent, banner: MerchandisingContentBanner): void => {
+				if (!banner) {
+					this.log.warn('No banner provided to track.banner.click');
+					return;
+				}
 				const { responseId, uid } = banner;
 				if (isClickWithinBannerLink(e)) {
 					if (this.events?.[responseId]?.banner[uid]?.clickThrough) {
@@ -206,13 +206,17 @@ export class AutocompleteController extends AbstractController {
 				}
 			},
 			clickThrough: (e: MouseEvent, { uid, responseId }): void => {
+				if (!uid) {
+					this.log.warn('No banner uid provided to track.banner.clickThrough');
+					return;
+				}
 				const banner: ClickthroughBannersInner = { uid };
 				const data: ClickthroughSchemaData = {
 					responseId,
 					banners: [banner],
 				};
 				this.eventManager.fire('track.banner.clickThrough', { controller: this, event: e, product: { uid }, trackEvent: data });
-				this.tracker.events.autocomplete.clickThrough({ data, siteId: this.config.globals?.siteId });
+				this.config.beacon?.enabled && this.tracker.events.autocomplete.clickThrough({ data, siteId: this.config.globals?.siteId });
 				this.events[responseId].banner[uid] = this.events[responseId].banner[uid] || {};
 				this.events[responseId].banner[uid].clickThrough = true;
 				setTimeout(() => {
@@ -222,22 +226,35 @@ export class AutocompleteController extends AbstractController {
 		},
 		product: {
 			clickThrough: (e: MouseEvent, result: Product | Banner): void => {
+				if (!result) {
+					this.log.warn('No result provided to track.product.clickThrough');
+					return;
+				}
 				const responseId = result.responseId;
+				const type = (['product', 'banner'].includes(result.type) ? result.type : 'product') as ResultProductType;
 				const item: ClickthroughResultsInner = {
-					type: result.type as ResultProductType,
-					uid: result.id,
-					parentId: result.id,
-					sku: result.mappings.core?.sku,
+					type,
+					uid: result.id ? '' + result.id : '',
+					...(type === 'product'
+						? {
+								parentId: result.id ? '' + result.id : '',
+								sku: result.mappings.core?.sku ? '' + result.mappings.core?.sku : undefined,
+						  }
+						: {}),
 				};
 
 				const data: ClickthroughSchemaData = {
 					responseId,
 					results: [item],
 				};
 				this.eventManager.fire('track.product.clickThrough', { controller: this, event: e, product: result, trackEvent: data });
-				this.tracker.events.autocomplete.clickThrough({ data, siteId: this.config.globals?.siteId });
+				this.config.beacon?.enabled && this.tracker.events.autocomplete.clickThrough({ data, siteId: this.config.globals?.siteId });
 			},
 			click: (e: MouseEvent, result: Product | Banner): void => {
+				if (!result) {
+					this.log.warn('No result provided to track.product.click');
+					return;
+				}
 				const responseId = result.responseId;
 
 				if (result.type === 'banner' && isClickWithinBannerLink(e)) {
@@ -263,27 +280,40 @@ export class AutocompleteController extends AbstractController {
 				}
 			},
 			impression: (result: Product | Banner): void => {
+				if (!result) {
+					this.log.warn('No result provided to track.product.impression');
+					return;
+				}
 				const responseId = result.responseId;
 				if (this.events?.[responseId]?.product[result.id]?.impression) {
 					return;
 				}
+				const type = (['product', 'banner'].includes(result.type) ? result.type : 'product') as ResultProductType;
 				const item: ResultsInner = {
-					type: result.type as ResultProductType,
-					uid: result.id,
-					parentId: result.id,
-					sku: result.mappings.core?.sku,
+					type,
+					uid: result.id ? '' + result.id : '',
+					...(type === 'product'
+						? {
+								parentId: result.id ? '' + result.id : '',
+								sku: result.mappings.core?.sku ? '' + result.mappings.core?.sku : undefined,
+						  }
+						: {}),
 				};
 				const data: ImpressionSchemaData = {
 					responseId,
 					results: [item],
 					banners: [],
 				};
 				this.eventManager.fire('track.product.impression', { controller: this, product: result, trackEvent: data });
-				this.tracker.events.autocomplete.impression({ data, siteId: this.config.globals?.siteId });
+				this.config.beacon?.enabled && this.tracker.events.autocomplete.impression({ data, siteId: this.config.globals?.siteId });
 				this.events[responseId].product[result.id] = this.events[responseId].product[result.id] || {};
 				this.events[responseId].product[result.id].impression = true;
 			},
 			addToCart: (result: Product): void => {
+				if (!result) {
+					this.log.warn('No result provided to track.product.addToCart');
+					return;
+				}
 				const responseId = result.responseId;
 				const product: BeaconProduct = {
 					parentId: result.id,
@@ -297,16 +327,20 @@ export class AutocompleteController extends AbstractController {
 					results: [product],
 				};
 				this.eventManager.fire('track.product.addToCart', { controller: this, product: result, trackEvent: data });
-				this.tracker.events.autocomplete.addToCart({ data, siteId: this.config.globals?.siteId });
+				this.config.beacon?.enabled && this.tracker.events.autocomplete.addToCart({ data, siteId: this.config.globals?.siteId });
 			},
 		},
 		redirect: ({ redirectURL, responseId }): void => {
+			if (!redirectURL) {
+				this.log.warn('No redirectURL provided to track.redirect');
+				return;
+			}
 			const data: RedirectSchemaData = {
 				responseId,
 				redirect: redirectURL,
 			};
 			this.eventManager.fire('track.redirect', { controller: this, redirectURL, trackEvent: data });
-			this.tracker.events.autocomplete.redirect({ data, siteId: this.config.globals?.siteId });
+			this.config.beacon?.enabled && this.tracker.events.autocomplete.redirect({ data, siteId: this.config.globals?.siteId });
 		},
 	};
 
@@ -774,7 +808,8 @@ export class AutocompleteController extends AbstractController {
 			const responseId = response.tracking.responseId;
 			this.events[responseId] = this.events[responseId] || { product: {}, banner: {} };
 
-			if (response.search?.query === this.lastSearchQuery) {
+			const previousResponseId = this.store.results[0]?.responseId;
+			if (previousResponseId && previousResponseId === responseId) {
 				const impressedResultIds = Object.keys(this.events[responseId].product || {}).filter(
 					(resultId) => this.events[responseId].product?.[resultId]?.impression
 				);
@@ -787,7 +822,6 @@ export class AutocompleteController extends AbstractController {
 				};
 			} else {
 				this.events[responseId] = { product: {}, banner: {} };
-				this.lastSearchQuery = response.search?.query;
 			}
 
 			const afterSearchProfile = this.profiler.create({ type: 'event', name: 'afterSearch', context: params }).start();
@@ -815,6 +849,9 @@ export class AutocompleteController extends AbstractController {
 			// update the store
 			this.store.update(response);
 
+			const data: RenderSchemaData = { responseId };
+			this.config.beacon?.enabled && this.tracker.events.autocomplete.render({ data, siteId: this.config.globals?.siteId });
+
 			const afterStoreProfile = this.profiler.create({ type: 'event', name: 'afterStore', context: params }).start();
 
 			try {
@@ -884,7 +921,11 @@ export class AutocompleteController extends AbstractController {
 	};
 
 	addToCart = async (_products: Product[] | Product): Promise<void> => {
-		const products = typeof (_products as Product[]).slice == 'function' ? (_products as Product[]).slice() : [_products];
+		const products = typeof (_products as Product[])?.slice == 'function' ? (_products as Product[]).slice() : [_products];
+		if (!_products || products.length === 0) {
+			this.log.warn('No products provided to autocomplete controller.addToCart');
+			return;
+		}
 		(products as Product[]).forEach((product) => {
 			this.track.product.addToCart(product);
 		});

packages/snap-controller/src/Finder/FinderController.ts

@@ -11,6 +11,9 @@ import type { FinderControllerConfig, FinderAfterSearchObj, ControllerServices,
 
 const defaultConfig: FinderControllerConfig = {
 	id: 'finder',
+	beacon: {
+		enabled: true,
+	},
 	globals: {
 		pagination: {
 			pageSize: 0,