wp-calypso/client/data/marketplace/use-es-query.ts

import languages, { LanguageSlug } from '@automattic/languages';
import {
	UseQueryResult,
	UseQueryOptions,
	useInfiniteQuery,
	InfiniteData,
	QueryKey,
	QueryFunction,
	useQuery,
} from '@tanstack/react-query';
import { decodeEntities } from 'calypso/lib/formatting';
import {
	extractSearchInformation,
	getPreinstalledPremiumPluginsVariations,
	mapStarRatingToPercent,
} from 'calypso/lib/plugins/utils';
import { useSelector } from 'calypso/state';
import { getCurrentUserLocale } from 'calypso/state/current-user/selectors';
import { DEFAULT_PAGE_SIZE } from './constants';
import { search, searchBySlug } from './search-api';
import { getPluginsListKey } from './utils';
import type { ESHits, ESResponse, Plugin, PluginQueryOptions } from './types';

const getIconUrl = ( pluginSlug: string, icon: string ): string => {
	try {
		const url = new URL( icon || '' );
		return url.toString();
	} catch ( _ ) {}

	return buildDefaultIconUrl( pluginSlug );
};

function buildDefaultIconUrl( pluginSlug: string ) {
	return `https://s.w.org/plugins/geopattern-icon/${ pluginSlug }.svg`;
}

const mapIndexResultsToPluginData = ( results: ESHits ): Plugin[] => {
	if ( ! results ) {
		return [];
	}
	return results.map( ( { fields: hit, railcar } ) => {
		const plugin: Plugin = {
			name: decodeEntities( hit.plugin?.title ), // TODO: add localization
			slug: decodeEntities( hit.slug ),
			software_slug: hit.plugin?.software_slug,
			org_slug: hit.plugin?.org_slug,
			version: hit[ 'plugin.stable_tag' ],
			author: hit.author,
			author_name: hit.plugin?.author,
			author_profile: '', // TODO: get author profile URL
			tested: hit[ 'plugin.tested' ],
			rating: mapStarRatingToPercent( hit.plugin?.rating ),
			num_ratings: hit.plugin?.num_ratings,
			support_threads: hit[ 'plugin.support_threads' ],
			support_threads_resolved: hit[ 'plugin.support_threads_resolved' ],
			active_installs: hit.plugin?.active_installs,
			last_updated: hit.modified,
			short_description: decodeEntities( hit.plugin?.excerpt ), // TODO: add localization
			icon: getIconUrl( hit.slug, hit.plugin?.icons ),
			premium_slug: decodeEntities( hit.plugin?.premium_slug ),
			variations: {
				monthly: { product_id: hit.plugin?.store_product_monthly_id },
				yearly: { product_id: hit.plugin?.store_product_yearly_id },
			},
			railcar,
		};
		plugin.variations = getPreinstalledPremiumPluginsVariations( plugin );

		return plugin;
	} );
};

const getWpLocaleBySlug = ( slug: LanguageSlug ) => {
	const defaultLanguage = 'en';

	// the wpLocale for `en` would be `en_US`, but the server uses `en` too
	if ( defaultLanguage === slug ) {
		return slug;
	}

	return languages.find( ( l ) => l.langSlug === slug )?.wpLocale || defaultLanguage;
};

export const getESPluginQueryParams = (
	slug: string,
	locale: string,
	fields?: Array< string >
): {
	queryKey: QueryKey;
	queryFn: QueryFunction< { plugins: Plugin[]; pagination: { page: number } }, QueryKey >;
} => {
	const queryKey = [ 'es-plugin', slug ];
	const queryFn = () =>
		searchBySlug( slug, locale, { fields } )
			.then( ( { data }: { data: { results: ESHits } } ) =>
				mapIndexResultsToPluginData( data.results )
			)
			.then( ( plugins: Plugin[] ) => plugins?.[ 0 ] || null );
	return { queryKey, queryFn };
};

const ONE_DAY_IN_MS = 1000 * 60 * 60 * 24;
export const useESPlugin = (
	slug: string,
	fields?: Array< string >,
	{
		enabled = true,
		staleTime = ONE_DAY_IN_MS,
		refetchOnMount = true,
	}: Omit< UseQueryOptions< any >, 'queryKey' > = {}
): UseQueryResult => {
	const locale = useSelector( getCurrentUserLocale );

	return useQuery( {
		...getESPluginQueryParams( slug, locale, fields ),
		enabled,
		staleTime,
		refetchOnMount,
	} );
};

type PageParam = string | number;

export const getESPluginsInfiniteQueryParams = (
	options: PluginQueryOptions,
	locale: string
): {
	queryKey: QueryKey;
	queryFn: QueryFunction< ESResponse, QueryKey, PageParam >;
	initialPageParam: PageParam;
} => {
	const [ searchTerm, author ] = extractSearchInformation( options.searchTerm );
	const pageSize = options.pageSize ?? DEFAULT_PAGE_SIZE;
	const queryKey = getPluginsListKey( [ 'DEBUG-new-site-seach' ], options, true );
	const groupId = options.category !== 'popular' ? 'marketplace' : 'wporg';
	const queryFn: QueryFunction< ESResponse, QueryKey, PageParam > = ( { pageParam } ) =>
		search( {
			query: searchTerm,
			author,
			groupId,
			category: options.category,
			pageHandle: pageParam + '',
			pageSize,
			locale: getWpLocaleBySlug( ( options.locale || locale ) as LanguageSlug ),
			slugs: options.slugs,
		} );
	return { queryKey, queryFn, initialPageParam: 1 };
};

export const useESPluginsInfinite = (
	options: PluginQueryOptions,
	{
		enabled = true,
		staleTime = 10000,
		refetchOnMount = true,
	}: Omit< UseQueryOptions< any >, 'queryKey' > = {}
) => {
	const locale = useSelector( getCurrentUserLocale );

	const { queryKey, queryFn, initialPageParam } = getESPluginsInfiniteQueryParams(
		options,
		locale
	);

	return useInfiniteQuery( {
		queryKey,
		queryFn,
		select: ( data: InfiniteData< ESResponse > ) => {
			return {
				...data,
				plugins: mapIndexResultsToPluginData( data.pages.flatMap( ( p ) => p.data.results ) ),
				pagination: {
					results: data.pages[ 0 ]?.data?.total,
					pages: data?.pages || [],
					page: data?.pageParams?.length || 0,
				},
			};
		},
		initialPageParam,
		getNextPageParam: ( lastPage ) => {
			return lastPage?.data?.page_handle || undefined;
		},
		enabled,
		staleTime,
		refetchOnMount,
	} );
};