ksearch: upgrade to Events API #508

Fondryext · 2025-04-07T16:55:37Z

This PR upgrades our analytics calls to the next major version, also called the Events API. As part of this work, analytics calls have changed shape, and some deprecated properties have been dropped.
J=WAT-4651
TEST=auto,manual

Updated auto tests. Ran test site locally and saw events all the way to snowflake.

This PR upgrades our analytics calls to the next major version, also called the Events API. As part of this work, analytics calls have changed shape, and some deprecated properties have been dropped. J=WAT-4651 TEST=auto,manual Updated auto tests. Ran test site locally and saw events all the way to snowflake.

…y notices check

github-actions · 2025-04-07T16:59:14Z

Current unit coverage is 91.4992993928071%
Current visual coverage is 77.20391807658059%
Current combined coverage is 92.01680672268908%

Fondryext · 2025-04-07T16:59:31Z

src/components/AnalyticsProvider.tsx

@@ -1,5 +1,5 @@
 import React, { PropsWithChildren } from 'react';
-import { provideAnalytics, AnalyticsConfig } from '@yext/analytics';


This AnalyticsConfig has changed shape in the new analytics, the old one was actually very search specific and had properties like experienceKey - the new one is very high level and only requires an auth type and an auth key. I think because of this alone this is breaking.

Fondryext · 2025-04-07T17:00:52Z

src/hooks/useCardAnalytics.ts

-      queryId,
-      verticalKey: verticalKey || '',
-      url,
-      fieldName,


we drop 'searcher' and 'fieldName'

Fondryext · 2025-04-07T17:01:18Z

src/hooks/usePaginationAnalytics.ts

-      verticalKey: verticalKey,
-      newPage,
-      currentPage,
-      totalPageCount


We drop all three of these page-related values.

Fondryext · 2025-04-07T17:01:33Z

src/hooks/usePaginationAnalytics.ts

-  currentPage: number,
-  totalPageCount: number
-) => void {
+export function usePaginationAnalytics(): () => void {


This function changes signature

Fondryext · 2025-04-07T17:02:16Z

src/hooks/useSearchBarAnalytics.ts

-    analytics?.report({
-      type: 'AUTO_COMPLETE_SELECTION',
-      ...(queryId && { queryId }),
-      suggestedSearchText


We drop suggestedSearchText

That's interesting, seems like it'd be a pretty relevant piece of data for this

How do you mean? Interesting that analytics dropped it from their new system, or that I followed it?

Interesting that analytics dropped it. We should ofc follow whatever their system supports / expects

coveralls · 2025-04-07T20:14:50Z

coverage: 86.688% (-0.5%) from 87.142%
when pulling 6ae8d8e on dev/events-api
into 055c51d on main.

k-gerner · 2025-04-10T16:18:23Z

src/components/sections/SectionHeader.tsx

@@ -90,10 +93,19 @@ export function SectionHeader(props: SectionHeaderProps): JSX.Element {
      console.error('Unable to report a vertical view all event. Missing field: queryId.');
      return;
    }
+    if (!experienceKey) {


Do we need a check for locale or searchId? Or are those automatically set

locale can be unset in the event payload so passing it possible undefined is ok. For searchId we could also add error handling if the searchId is not present.

Hm as I think about it, our analytics are all based off query id now right? Probably not necessary to require the search id if we don't see that changing

Actually trying to send an analytics event without search id crashes out, as I recall. My understanding was that the events are based on the first search id of a query, which is the same as the query id.

Got it, so it seems necessary, but also that it should be automatically set elsewhere correct? Therefore not requiring any extra check here?

I agree a check would be nice, and I will add it. Could you elaborate the second comment? What should be set, the searchId? Isn't that pulled from the meta state? I'm not sure we have any guarantees about that.

Sorry maybe I was misunderstanding your prior comment. The way I read it was that the search id was being set as the query id by default somewhere up the chain in the SDK somewhere. Feel free to disregard. I agree adding a check is good then

src/hooks/useCardAnalytics.ts

k-gerner · 2025-04-10T16:27:46Z

src/hooks/useSearchBarAnalytics.ts

-    analytics?.report({
-      type: 'AUTO_COMPLETE_SELECTION',
-      ...(queryId && { queryId }),
-      suggestedSearchText


That's interesting, seems like it'd be a pretty relevant piece of data for this

src/hooks/useSearchBarAnalytics.ts

k-gerner · 2025-04-14T17:06:38Z

package.json

@@ -1,6 +1,6 @@
 {
  "name": "@yext/search-ui-react",
-  "version": "1.8.2",
+  "version": "1.8.3",


My debounce change is 1.8.3 so this will have to change - I assume to 2.0.0 since this has breaking changes

Yes, this change is a draft.

k-gerner · 2025-04-14T17:08:29Z

src/components/sections/SectionHeader.tsx

@@ -90,10 +93,19 @@ export function SectionHeader(props: SectionHeaderProps): JSX.Element {
      console.error('Unable to report a vertical view all event. Missing field: queryId.');
      return;
    }
+    if (!experienceKey) {


Got it, so it seems necessary, but also that it should be automatically set elsewhere correct? Therefore not requiring any extra check here?

Fondryext and others added 2 commits April 7, 2025 12:53

Automated update to THIRD-PARTY-NOTICES from github action's 3rd part…

08ef2ae

…y notices check

Fondryext commented Apr 7, 2025

View reviewed changes

k-gerner reviewed Apr 10, 2025

View reviewed changes

Fondryext added 2 commits April 10, 2025 14:22

Cleanup, renamings, and fixing error messages

92cd4b0

fix tests

6ae8d8e

k-gerner reviewed Apr 14, 2025

View reviewed changes

		@@ -1,5 +1,5 @@
		import React, { PropsWithChildren } from 'react';
		import { provideAnalytics, AnalyticsConfig } from '@yext/analytics';

ksearch: upgrade to Events API #508

Are you sure you want to change the base?

ksearch: upgrade to Events API #508

Uh oh!

Conversation

Fondryext commented Apr 7, 2025

Uh oh!

github-actions bot commented Apr 7, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Fondryext Apr 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

coveralls commented Apr 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Fondryext Apr 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Fondryext Apr 10, 2025 •

edited

Loading

coveralls commented Apr 7, 2025 •

edited

Loading

Fondryext Apr 14, 2025 •

edited

Loading