17986846418

Committed 24 Sep 2025 07:05PM UTC coverage: 87.704% (-0.6%) from 88.287%

Build # 17986846418

Build Type

Pull #508

github

Committed by

web-flow

Commit Message

Merge d9b1f2121 into f4c07d723

Pull Request Pull Request #508: ksearch: upgrade to Events API

Run Details

817 of 1029 branches covered (79.4%)

Branch coverage included in aggregate %.

40 of 67 new or added lines in 8 files covered. (59.7%)

3 existing lines in 3 files now uncovered.

2086 of 2281 relevant lines covered (91.45%)

134.74 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

57.14

/src/components/AnalyticsProvider.tsx

import React, {PropsWithChildren} from 'react';
import {analytics, AnalyticsConfig} from '@yext/analytics';
import {AnalyticsContext} from '../hooks/useAnalytics';
import {CloudRegion, Environment} from "@yext/search-core";
import {SearchAnalyticsEventServiceImpl} from "../models/SearchAnalyticsEventServiceImpl";

/**
 * A higher-order component which provides analytics for its children.
 *
 * @public
 *
 * @param props - The configuration for the analytics service
 * @returns A React element that provides analytics context
 */
export function AnalyticsProvider(props: PropsWithChildren<SearchAnalyticsConfig>): JSX.Element {
  const {children, ...searchAnalyticsConfig} = props;
  const analyticsReporter =
      new SearchAnalyticsEventServiceImpl(searchAnalyticsConfig)

  return (
      <AnalyticsContext.Provider value={analyticsReporter}>
        {children}
      </AnalyticsContext.Provider>
  );
}

/**
 * An interface representing the configuration for search analytics reporting.
 *
 * @public
 */
export interface SearchAnalyticsConfig {
  /** The apiKey of the App with Events SDK access. */
  apiKey: string
  /** The Yext environment to send requests to. Defaults to 'PRODUCTION'. */
  environment?: Environment
  /** The region to send requests to. Defaults to 'US'. */
  cloudRegion?: CloudRegion;
  /** Whether to enable session tracking for analytics events. */
  sessionTrackingEnabled?: boolean;
}

1	import React, {PropsWithChildren} from 'react';	5✔
2	import {analytics, AnalyticsConfig} from '@yext/analytics';
3	import {AnalyticsContext} from '../hooks/useAnalytics';	5✔
4	import {CloudRegion, Environment} from "@yext/search-core";
5	import {SearchAnalyticsEventServiceImpl} from "../models/SearchAnalyticsEventServiceImpl";	5✔
6
7	/**
8	* A higher-order component which provides analytics for its children.
9	*
10	* @public
11	*
12	* @param props - The configuration for the analytics service
13	* @returns A React element that provides analytics context
14	*/
15	export function AnalyticsProvider(props: PropsWithChildren<SearchAnalyticsConfig>): JSX.Element {	5✔
NEW 16	const {children, ...searchAnalyticsConfig} = props;	×
17	const analyticsReporter =
NEW 18	new SearchAnalyticsEventServiceImpl(searchAnalyticsConfig)	×
19
20	return (	×
21	<AnalyticsContext.Provider value={analyticsReporter}>
22	{children}
23	</AnalyticsContext.Provider>
24	);
25	}
26
27	/**
28	* An interface representing the configuration for search analytics reporting.
29	*
30	* @public
31	*/
32	export interface SearchAnalyticsConfig {
33	/** The apiKey of the App with Events SDK access. */
34	apiKey: string
35	/** The Yext environment to send requests to. Defaults to 'PRODUCTION'. */
36	environment?: Environment
37	/** The region to send requests to. Defaults to 'US'. */
38	cloudRegion?: CloudRegion;
39	/** Whether to enable session tracking for analytics events. */
40	sessionTrackingEnabled?: boolean;
41	}

yext / search-ui-react / 17986846418

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous