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.

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

DOP-4065 frontend #937

Merged
merged 6 commits into from
Nov 1, 2023
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
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
3 changes: 2 additions & 1 deletion src/components/SearchResults/Facets/FacetTags.js
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ import Tag, { searchTagStyle } from '../../Tag';
import SearchContext from '../SearchContext';
import useFacets from './useFacets';
seungpark marked this conversation as resolved.
Show resolved Hide resolved
import { initChecked } from './FacetValue';
import { getFacetTagVariant } from './utils';

// util to get all current facets, derived from search params
const getActiveFacets = (facetOptions, searchParams) => {
Expand Down Expand Up @@ -97,7 +98,7 @@ const FacetTag = ({ facet: { name, key, id, facets } }) => {
}, [facets, handleFacetChange, id, key]);

return (
<StyledTag onClick={onClick}>
<StyledTag variant={getFacetTagVariant({ key, id })} onClick={onClick}>
{name}
<Icon glyph="X" />
</StyledTag>
Expand Down
6 changes: 3 additions & 3 deletions src/components/SearchResults/Facets/Facets.js
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
import React from 'react';
import useFacets from './useFacets';
import React, { useContext } from 'react';
import SearchContext from '../SearchContext';
import FacetGroup from './FacetGroup';

const Facets = () => {
const facets = useFacets();
const { facets } = useContext(SearchContext);

return (
<div data-testid="facets-container">
Expand Down
13 changes: 13 additions & 0 deletions src/components/SearchResults/Facets/utils.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
/**
*
* @param {obj} facet - contains key and id properties as returned by /v2/status ie.
* https://docs-search-transport.mongodb.com/v2/status
*
* @returns {str} blue | green
*/
export const getFacetTagVariant = (facet, type = 'facet-option') => {
seungpark marked this conversation as resolved.
Show resolved Hide resolved
if (facet.key === 'target_product') {
return 'green';
}
return 'blue';
};
44 changes: 43 additions & 1 deletion src/components/SearchResults/SearchContext.js
Original file line number Diff line number Diff line change
@@ -1,11 +1,38 @@
import { createContext, useCallback, useState } from 'react';
import { createContext, useCallback, useMemo, useState } from 'react';
import { useLocation } from '@gatsbyjs/reach-router';
import { navigate } from 'gatsby';
import { useMarianManifests } from '../../hooks/use-marian-manifests';
import useFacets from './Facets/useFacets';

export const FACETS_KEY_PREFIX = 'facets.';
export const FACETS_LEVEL_KEY = '>';

const combineKeyAndId = (facet) => `${facet.key}${FACETS_LEVEL_KEY}${facet.id}`;

const constructFacetNamesByKey = (facets) => {
const res = {};

function extractKeyIdName(facets) {
for (const facet of facets) {
res[combineKeyAndId(facet)] = facet.name;
if (facet?.facets?.length) {
traverseFacetGroup(facet.facets);
}
}
}

function traverseFacetGroup(facetGroup) {
for (const facet of facetGroup) {
res[combineKeyAndId(facet)] = facet.name;
extractKeyIdName(facet.options);
}
}

traverseFacetGroup(facets);

return res;
};

// Simple context to pass search results, ref, and filters to children
const SearchContext = createContext({
filters: {},
Expand All @@ -24,11 +51,23 @@ const SearchContext = createContext({
shouldAutofocus: false,
showFacets: false,
searchParams: {},
facets: [],
facetNamesByKeyId: {},
getFacetName: () => {},
});

const SearchContextProvider = ({ children, showFacets = false }) => {
const { search } = useLocation();
const { filters, searchPropertyMapping } = useMarianManifests();
const facets = useFacets();
const facetNamesByKeyId = useMemo(() => constructFacetNamesByKey(facets), [facets]);

const getFacetName = useCallback(
(facet) => {
return facetNamesByKeyId?.[combineKeyAndId(facet)];
},
[facetNamesByKeyId]
);
// get vars from URL
// state management for Search is within URL.
const [searchParams, setSearchParams] = useState(new URLSearchParams(search));
Expand Down Expand Up @@ -122,6 +161,9 @@ const SearchContextProvider = ({ children, showFacets = false }) => {
setShowMobileFilters,
showFacets,
searchParams,
facets,
facetNamesByKeyId,
getFacetName,
}}
>
{children}
Expand Down
27 changes: 20 additions & 7 deletions src/components/SearchResults/SearchResult.js
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,9 @@ import styled from '@emotion/styled';
import { palette } from '@leafygreen-ui/palette';
import { Body } from '@leafygreen-ui/typography';
import { theme } from '../../theme/docsTheme';
import Tag, { searchTagStyle } from '../Tag';
import Tag, { searchTagStyle, tagHeightStyle } from '../Tag';
import SearchContext from './SearchContext';
import { getFacetTagVariant } from './Facets/utils';

const LINK_COLOR = '#494747';
// Use string for match styles due to replace/innerHTML
Expand Down Expand Up @@ -95,6 +96,8 @@ const StyledTag = styled(Tag)`
const StylingTagContainer = styled('div')`
bottom: 0;
margin-bottom: ${theme.size.medium};
overflow: hidden;
${tagHeightStyle};
`;

const escapeRegExp = (string) => string.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
Expand Down Expand Up @@ -132,9 +135,10 @@ const SearchResult = React.memo(
title,
searchProperty,
url,
facets,
...props
}) => {
const { searchPropertyMapping, searchTerm } = useContext(SearchContext);
const { searchPropertyMapping, searchTerm, getFacetName, showFacets } = useContext(SearchContext);
const highlightedPreviewText = highlightSearchTerm(preview, searchTerm);
const resultLinkRef = useRef(null);
const category = searchPropertyMapping?.[searchProperty]?.['categoryTitle'];
Expand All @@ -155,11 +159,20 @@ const SearchResult = React.memo(
__html: sanitizePreviewHtml(highlightedPreviewText),
}}
/>
<StylingTagContainer>
{!!category && <StyledTag variant="green">{category}</StyledTag>}
{!!version && <StyledTag variant="blue">{version}</StyledTag>}
{url.includes('/api/') && <StyledTag variant="purple">{'API'}</StyledTag>}
</StylingTagContainer>
{!showFacets && (
<StylingTagContainer>
{!!category && <StyledTag variant="green">{category}</StyledTag>}
{!!version && <StyledTag variant="blue">{version}</StyledTag>}
{url.includes('/api/') && <StyledTag variant="purple">{'API'}</StyledTag>}
</StylingTagContainer>
)}
{showFacets && facets?.filter(getFacetName)?.length > 0 && (
<StylingTagContainer>
{facets.filter(getFacetName).map((facet) => (
seungpark marked this conversation as resolved.
Show resolved Hide resolved
<StyledTag variant={getFacetTagVariant(facet)}>{getFacetName(facet)}</StyledTag>
seungpark marked this conversation as resolved.
Show resolved Hide resolved
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(No change needed; more for discussion) I noticed that in the designs, the parent target product is typically the leftmost facet tag in the search result, but this might not be true with the current implementation. Is this something that we should have docs-search-transport handle?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i agree with the suggestion. the front end should not be responsible for sorting (re discussion of taxonomy order in https://jira.mongodb.org/browse/DOP-4109)

))}
</StylingTagContainer>
)}
{learnMoreLink && (
<MobileFooterContainer>
<LearnMoreLink href={url}>
Expand Down
5 changes: 3 additions & 2 deletions src/components/SearchResults/SearchResults.js
Original file line number Diff line number Diff line change
Expand Up @@ -359,7 +359,7 @@ const SearchResults = () => {
const submitNewSearch = (event) => {
const newValue = event.target[0]?.value;
const { page } = queryString.parse(search);
if (newValue === searchTerm && parseInt(page) === 1) return;
if (!newValue || (newValue === searchTerm && parseInt(page) === 1)) return;

setSearchTerm(newValue);
};
Expand Down Expand Up @@ -460,7 +460,7 @@ const SearchResults = () => {
{!!searchTerm && !!searchFinished && !!searchResults.length && (
<>
<StyledSearchResults>
{searchResults.map(({ title, preview, url, searchProperty }, index) => (
{searchResults.map(({ title, preview, url, searchProperty, facets }, index) => (
<StyledSearchResult
key={`${url}${index}`}
onClick={() =>
Expand All @@ -471,6 +471,7 @@ const SearchResults = () => {
url={url}
useLargeTitle
searchProperty={searchProperty?.[0]}
facets={facets}
/>
))}
{
Expand Down
6 changes: 5 additions & 1 deletion src/components/Tag.js
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,13 @@ const baseStyle = css`
padding: ${theme.size.tiny} ${theme.size.small};
`;

export const tagHeightStyle = css`
height: 26px;
`;

export const searchTagStyle = css`
cursor: pointer;
height: 26px;
${tagHeightStyle};
padding: 4px 11px 4px 11px;
border-radius: 12px;
font-size: ${theme.fontSize.tiny};
Expand Down
4 changes: 4 additions & 0 deletions tests/unit/__snapshots__/SearchResults.test.js.snap
Original file line number Diff line number Diff line change
Expand Up @@ -1536,6 +1536,8 @@ exports[`Search Results Page considers a given search filter query param and dis
.emotion-36 {
bottom: 0;
margin-bottom: 24px;
overflow: hidden;
height: 26px;
}

.emotion-42 {
Expand Down Expand Up @@ -8347,6 +8349,8 @@ exports[`Search Results Page renders results from a given search term query para
.emotion-32 {
bottom: 0;
margin-bottom: 24px;
overflow: hidden;
height: 26px;
}

.emotion-35 {
Expand Down