feat(theme-algolia): add option.replaceSearchResultPathname to process/replaceAll search result urls by mellson · Pull Request #8428 · facebook/docusaurus

mellson · 2022-12-12T14:46:11Z

Implemented solution

replaceSearchResultPathname added - doc: https://deploy-preview-8428--docusaurus-2.netlify.app/docs/search/#connecting-algolia

{
  // Optional: Replace parts of the item URLs from Algolia. Useful when using the same search index for multiple deployments using a different baseUrl. You can use regexp or string in the `from` param. For example: localhost:3000 vs myCompany.com/docs
  replaceSearchResultPathname: {
    from: '/docs/', // or as RegExp: /\/docs\//
    to: '/',
    },
}

Pre-flight checklist

I have read the Contributing Guidelines on pull requests.
If this is a code change: I have written unit tests and/or added dogfooding pages to fully verify the new behavior.
If this is a new API or substantial change: the PR has an accompanying issue (closes #0000) and the maintainers have approved on my working plan.

Motivation

We have an upcoming documentation site we're building at https://stately.ai/docs/. So we've set our baseUrl in the config to /docs/. However when we do our preview deploys, these are served from root /.

This setup makes it hard to use the search on the preview deploys because it indexes based on the site with a different baseUrl.

This PR adds the option to replace the item's URL that Algolia returns. So in our case we would like to replace /docs/ with /.

Test Plan

Test links

Deploy preview: https://deploy-preview-8428--docusaurus-2.netlify.app/

Related issues/PRs

netlify · 2022-12-12T14:50:01Z

✅ [V2]

Name	Link
🔨 Latest commit	`7847734`
🔍 Latest deploy log	https://app.netlify.com/sites/docusaurus-2/deploys/63a48a09e7b3280008e3ecaf
😎 Deploy Preview	https://deploy-preview-8428--docusaurus-2.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

github-actions · 2022-12-12T14:50:41Z

⚡️ Lighthouse report for the deploy preview of this PR

URL	Performance	Accessibility	Best Practices	SEO	PWA	Report
/	🟢 94	🟢 97	🟢 100	🟢 100	🟢 90	Report
/docs/installation	🟠 76	🟢 100	🟢 100	🟢 100	🟢 90	Report

slorber

👍 Agree this feature could be useful, and I would probably use it myself

Not 100% fan of the API as it's not very flexible and the naming doesn't feel right

If we can make it better how let's do this. Otherwise I won't block this PR too much because it's a useful but quite niche feature and we can do breaking changes later if needed.

packages/docusaurus-theme-search-algolia/src/theme/SearchBar/index.tsx

packages/docusaurus-theme-search-algolia/src/validateThemeConfig.ts

website/docs/search.md

mellson · 2022-12-15T21:08:21Z

👍 Agree this feature could be useful, and I would probably use it myself

Not 100% fan of the API as it's not very flexible and the naming doesn't feel right

If we can make it better how let's do this. Otherwise I won't block this PR too much because it's a useful but quite niche feature and we can do breaking changes later if needed.

Thank you for your feedback, I agree with all your suggestions and have implemented them in the latest commit.

slorber

LGTM 👍

Can you add this to our localhost + deploypreview? That would make sure that we use our own new feature and we could be sure it works end 2 end with the preview.

Example search result:

I guess this should work: {from: "/docs/next", to: "/docs"}

website/versioned_docs/version-2.0.1/search.md

mellson · 2022-12-16T13:59:21Z

LGTM 👍

Can you add this to our localhost + deploypreview? That would make sure that we use our own new feature and we could be sure it works end 2 end with the preview.

Example search result:

https://deploy-preview-8428--docusaurus-2.netlify.app/docs/next/docusaurus-core/
=>

https://deploy-preview-8428--docusaurus-2.netlify.app/docs/docusaurus-core/

I guess this should work: {from: "/docs/next", to: "/docs"}

That makes sense 👍🏻 I've updated the config to use this in dev- and preview mode. And made it possible to provide a regexp or a string in the from param.

slorber

Not super fan of the getRegexpOrString.

I'd prefer either a better solution or to have it removed and just support regexp strings.

I'm a bit afraid this might lead to confusing behaviors when using special chars in from including [({&+... I'd rather let the user decide explicitly if they want to use a RexExp or a simple string replacement

slorber · 2022-12-16T14:15:32Z

packages/docusaurus-theme-common/src/utils/configUtils.ts

+ * @param possibleRegexp string that is possibly a regex
+ * @returns a Regex if possible, otherwise the string
+ */
+export function getRegexpOrString(possibleRegexp: string): RegExp | string {


🤔 I don't really like this implementation and would prefer to just support regexp. Adding unit tests would likely reveal the problematic cases.

My idea was more:

config accepts both string + RegExp

config validation normalizes this as a serializable RegExp string

client-side always use new RexExp()

The config normalization can be something like:

if (from instanceof string) { return escapeRegexp(from); } else if (from instanceof RegExp) { return from.source; } else { throw new Error('unexpected") }

=> always return a valid Regexp string source

Does it make sense?

That makes sense; I wasn't terribly happy with getRegexpOrString either. I've tried to address your suggestions in the latest commit, hope I got it right this time 😅

slorber · 2022-12-22T15:09:59Z

I'm going to push some little refactors in the PR before merging so please don't commit 🤪

- handling of pathname replacement - handling of external urls

slorber

Thanks 👍

Looks like it works fine on both the search bar and search page, on localhost + deploy preview

…s/replaceAll search result urls #8428

Make it possible to replace in the item URL

b3f8f19

mellson requested review from Josh-Cena, lex111 and slorber as code owners December 12, 2022 14:46

facebook-github-bot added the CLA Signed Signed Facebook CLA label Dec 12, 2022

mellson changed the title ~~Make it possible to replace in the item URL~~ Make it possible to replace in the returned Algolia item URL Dec 12, 2022

mellson changed the title ~~Make it possible to replace in the returned Algolia item URL~~ Make it possible to replace parts of the returned Algolia item URL Dec 13, 2022

slorber requested changes Dec 15, 2022

View reviewed changes

packages/docusaurus-theme-search-algolia/src/theme/SearchBar/index.tsx Outdated Show resolved Hide resolved

packages/docusaurus-theme-search-algolia/src/validateThemeConfig.ts Outdated Show resolved Hide resolved

website/docs/search.md Outdated Show resolved Hide resolved

slorber added pr: new feature This PR adds a new API or behavior. to backport This PR is planned to be backported to a stable version of Docusaurus labels Dec 15, 2022

Implement suggestions

598be66

slorber requested changes Dec 16, 2022

View reviewed changes

website/versioned_docs/version-2.0.1/search.md Outdated Show resolved Hide resolved

Make it possible to provide regexp or string

d418b39

slorber requested changes Dec 16, 2022

View reviewed changes

mellson added 2 commits December 17, 2022 12:16

Implemented suggested improvements

5df658b

fix test

0709d69

slorber added 6 commits December 22, 2022 16:11

factorize usage of escapeRegexp lib

682fae2

better replaceSearchResultPathname tests

8fb0dae

memoize withBaseUrl

a8f680d

factorize code across SearchBar & SearchPage

e08762c

- handling of pathname replacement - handling of external urls

improve regexp docs + remove versioned docs

f5244a1

rename to useSearchResultUrlProcessor

7847734

slorber mentioned this pull request Dec 22, 2022

fix(search-algolia): pass custom transformItems function to SearchBar #8462

Merged

3 tasks

slorber changed the title ~~Make it possible to replace parts of the returned Algolia item URL~~ feat(theme-algolia): add option.replaceSearchResultPathname to process/replaceAll search result urls Dec 22, 2022

slorber approved these changes Dec 22, 2022

View reviewed changes

slorber merged commit 19ba0ff into facebook:main Dec 22, 2022

mellson deleted the mellson/add-replace-in-item-url-option branch December 22, 2022 17:42

slorber added a commit that referenced this pull request Jan 26, 2023

feat(theme-algolia): add option.replaceSearchResultPathname to proces…

deb376e

…s/replaceAll search result urls #8428

slorber added backported This PR has been backported to a stable version of Docusaurus and removed to backport This PR is planned to be backported to a stable version of Docusaurus labels Jan 27, 2023

mellson mentioned this pull request Jan 28, 2023

Remove /docs from the search result in a preview deploy statelyai/docs#46

Merged

slorber mentioned this pull request Oct 19, 2023

chore: v3.0.0-rc.0 release #9418

Merged

Uh oh!

Comments

Conversation

mellson commented Dec 12, 2022 • edited by slorber Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Implemented solution

Pre-flight checklist

Motivation

Test Plan

Test links

Related issues/PRs

Uh oh!

netlify bot commented Dec 12, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ [V2]

Uh oh!

github-actions bot commented Dec 12, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

⚡️ Lighthouse report for the deploy preview of this PR

Uh oh!

slorber left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

mellson commented Dec 15, 2022

Uh oh!

slorber left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

mellson commented Dec 16, 2022

Uh oh!

slorber left a comment

Choose a reason for hiding this comment

Uh oh!

slorber Dec 16, 2022

Choose a reason for hiding this comment

Uh oh!

mellson Dec 17, 2022

Choose a reason for hiding this comment

Uh oh!

slorber commented Dec 22, 2022

Uh oh!

slorber left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

mellson commented Dec 12, 2022 •

edited by slorber

Loading

netlify bot commented Dec 12, 2022 •

edited

Loading

github-actions bot commented Dec 12, 2022 •

edited

Loading