DEVXT-1941 GitHub Discussions Search #191
+1,737
−122
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,128 @@ | ||
| import React, { ReactNode } from 'react'; | ||
| import Box from '@material-ui/core/Box'; | ||
| import Chip from '@material-ui/core/Chip'; | ||
| import ListItemIcon from '@material-ui/core/ListItemIcon'; | ||
| import ListItemText from '@material-ui/core/ListItemText'; | ||
| import Typography from '@material-ui/core/Typography'; | ||
| import { makeStyles } from '@material-ui/core/styles'; | ||
| import { Link } from '@backstage/core-components'; | ||
| import { ResultHighlight } from '@backstage/plugin-search-common'; | ||
| import { HighlightedSearchResultText } from '@backstage/plugin-search-react'; | ||
| import { IndexableDocument } from '@backstage/plugin-search-common'; | ||
| import { EntityRefLink } from '@backstage/plugin-catalog-react'; | ||
|
|
||
| export interface GithubDiscussionsDocument extends IndexableDocument { | ||
| author: string; | ||
| category: string; | ||
| labels: { | ||
| name: string; | ||
| color: string; | ||
| }[]; | ||
| comments: { | ||
| author: string; | ||
| bodyText: string; | ||
| replies: { | ||
| author: string; | ||
| bodyText: string; | ||
| }[]; | ||
| }[]; | ||
| } | ||
|
|
||
| const useStyles = makeStyles(theme => ({ | ||
| item: { | ||
| display: 'flex', | ||
| }, | ||
| flexContainer: { | ||
| flexWrap: 'wrap', | ||
| }, | ||
| itemText: { | ||
| width: '100%', | ||
| wordBreak: 'break-all', | ||
| marginBottom: '1rem', | ||
| }, | ||
| user: { | ||
| display: 'inline-flex', | ||
| margin: theme.spacing(1), | ||
| }, | ||
| })); | ||
|
|
||
| /** | ||
| * Props for {@link GithubDiscussionsSearchResultListItem}. | ||
| * | ||
| * @public | ||
| */ | ||
| export interface GithubDiscussionsSearchResultListItemProps { | ||
| icon?: ReactNode; | ||
| result?: GithubDiscussionsDocument; | ||
| highlight?: ResultHighlight; | ||
| lineClamp?: number; | ||
| } | ||
|
|
||
| /** @public */ | ||
| export function GithubDiscussionsSearchResultListItem( | ||
| props: GithubDiscussionsSearchResultListItemProps, | ||
| ) { | ||
| const { result, highlight, icon } = props; | ||
| const classes = useStyles(); | ||
| if (!result) return null; | ||
|
|
||
| return ( | ||
| <div className={classes.item}> | ||
| {icon && <ListItemIcon>{icon}</ListItemIcon>} | ||
| <div className={classes.flexContainer}> | ||
| <ListItemText | ||
| className={classes.itemText} | ||
| primaryTypographyProps={{ variant: 'h6' }} | ||
| primary={ | ||
| <Link noTrack to={result.location}> | ||
| {highlight?.fields.title ? ( | ||
| <HighlightedSearchResultText | ||
| text={highlight.fields.title} | ||
| preTag={highlight.preTag} | ||
| postTag={highlight.postTag} | ||
| /> | ||
| ) : ( | ||
| result.title | ||
| )} | ||
| </Link> | ||
| } | ||
| secondary={ | ||
| <Typography | ||
| component="span" | ||
| style={{ | ||
| display: '-webkit-box', | ||
| WebkitBoxOrient: 'vertical', | ||
| WebkitLineClamp: props.lineClamp, | ||
|
There was a problem hiding this comment. Maybe add lineClamp as part of the props destructure above? |
||
| overflow: 'hidden', | ||
| }} | ||
| color="textSecondary" | ||
| variant="body2" | ||
| > | ||
| {highlight?.fields.text ? ( | ||
| <HighlightedSearchResultText | ||
| text={highlight.fields.text} | ||
| preTag={highlight.preTag} | ||
| postTag={highlight.postTag} | ||
| /> | ||
| ) : ( | ||
| result.text | ||
| )} | ||
| </Typography> | ||
| } | ||
| /> | ||
| <Box> | ||
| {result.author && ( | ||
| <div className={classes.user}> | ||
| <EntityRefLink entityRef={`user:default/${result.author}`} /> | ||
MonicaG marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| </div> | ||
| )} | ||
| {result.category && <Chip label={result.category} size="small" />} | ||
| {result.labels.length > 0 && | ||
| result.labels.map(({ name }) => { | ||
| return <Chip key={name} label={name} size="small" />; | ||
| })} | ||
| </Box> | ||
| </div> | ||
| </div> | ||
| ); | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,64 +1,81 @@ | ||
| import React from 'react'; | ||
|
|
||
| import { List } from '@material-ui/core'; | ||
| import { | ||
| SearchResult, | ||
| DefaultResultListItem, | ||
| } from '@backstage/plugin-search-react'; | ||
|
|
||
| import { CatalogSearchResultListItem } from '@backstage/plugin-catalog'; | ||
| import { | ||
| StackOverflowSearchResultListItem, | ||
| StackOverflowIcon, | ||
| } from '@backstage-community/plugin-stack-overflow'; | ||
| import { CatalogIcon, DocsIcon } from '@backstage/core-components'; | ||
| import { TechDocsSearchResultCustomListItem } from './TechDocsSearchResultCustomListItem'; | ||
| import { | ||
| GithubDiscussionsSearchResultListItem, | ||
| GithubDiscussionsDocument, | ||
| } from './GithubDiscussionsSearchResultListItem'; | ||
|
|
||
| const SearchResultCustomList = () => { | ||
| return ( | ||
| <SearchResult> | ||
| {({ results }) => ( | ||
| <List> | ||
| {results.map(({ type, document, highlight, rank }) => { | ||
| switch (type) { | ||
| case 'software-catalog': | ||
| return ( | ||
| <CatalogSearchResultListItem | ||
| key={document.location} | ||
| result={document} | ||
| highlight={highlight} | ||
| rank={rank} | ||
| icon={<CatalogIcon />} | ||
| /> | ||
| ); | ||
| case 'techdocs': | ||
| return ( | ||
| <TechDocsSearchResultCustomListItem | ||
| key={document.location} | ||
| result={document} | ||
| highlight={highlight} | ||
| rank={rank} | ||
| asListItem | ||
| icon={<DocsIcon />} | ||
| /> | ||
| ); | ||
| case 'stack-overflow': | ||
| return ( | ||
| <StackOverflowSearchResultListItem | ||
| key={document.location} | ||
| result={document} | ||
| icon={<StackOverflowIcon />} | ||
| /> | ||
| ); | ||
| case 'github-discussions': | ||
| return ( | ||
| <GithubDiscussionsSearchResultListItem | ||
| result={document as GithubDiscussionsDocument} | ||
| highlight={highlight} | ||
| /> | ||
| ); | ||
| default: | ||
| return ( | ||
| <DefaultResultListItem | ||
| key={document.location} | ||
| result={document} | ||
| highlight={highlight} | ||
| rank={rank} | ||
| /> | ||
| ); | ||
| } | ||
| })} | ||
| </List> | ||
| )} | ||
| </SearchResult> | ||
| ); | ||
| }; | ||
|
|
||
| export const searchResultCustomList = <SearchResultCustomList />; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Binary file not shown.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just curious about using IndexableDocument vs SearchDocument as per the documentation's comment about:
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That's a good catch; we should use
SearchDocument.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pushed the changes to use
SearchDocumentand also made the changes in my PR in community-plugins (see commit). So once that gets merged and the packages get published we'll be able to import the interface directly from the common package.