fix: search page for non latest doc versions #205

Cyriuz · 2022-05-30T10:58:44Z

fixes #203

Sorry for taking a while with this. I figured out the way to use the actual selected version as the useActiveVersion only works on doc pages (internally it just compares the path). However, this causes the test webpage to crash... so I spent yesterday trying to figure out why. After asking for help on the docusaurus discord it turns out that it is somehow because of the pnp build step:

[11:49] Josh-Cena: I have a feeling this has something to do with PnP
[11:49] Josh-Cena: Could you try with node-modules linker?
[11:50] Josh-Cena: I can't remember who was the last to bring it up, but there's a problem with PnP + contexts
[11:52] Josh-Cena: More specifically, theme-common fails to be deduplicated, so the context provider of theme-classic and the context consumer in the search theme are actually two instances, so they fail to pair up

After this I tried it in my own non pnp setup and it did indeed work. I tried changing some things to see if I could get it to work but I feel I'm a bit out of my depth here and may need some help. package dependencies seems like a pretty complicated field in its own...

fixes easyops-cn#203

netlify · 2022-05-30T10:58:49Z

✅ Deploy Preview for easyops-cn-docusaurus-search-local ready!

Name	Link
🔨 Latest commit	`f29ec2d`
🔍 Latest deploy log	https://app.netlify.com/sites/easyops-cn-docusaurus-search-local/deploys/62b149c82d1d120009a4d2a0
😎 Deploy Preview	https://deploy-preview-205--easyops-cn-docusaurus-search-local.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.

weareoutman · 2022-05-30T13:00:51Z

@Cyriuz No sorry is needed at all, you helped a lot 👍. I'll look into it later, too, once I got time. If we couldn't find a solution with P'n'P, it's ok to use node-modules linker instead. But before that, give it some time for investigation.

weareoutman · 2022-05-31T02:17:29Z

I figured out that if we put the @docusaurus/theme-common into the peerDependencies of our theme (also add it to the devDependencies), will make it work with P'n'P. At the same time, we also need to explicitly add @docusaurus/theme-common into the dependencies of the example website.

I am wondering if it's the correct way, since our users may must manually add @docusaurus/theme-common into their website dependencies as we did here.

weareoutman · 2022-05-31T02:40:23Z

I figured out that if we put the @docusaurus/theme-common into the peerDependencies of our theme (also add it to the devDependencies), will make it work with P'n'P. At the same time, we also need to explicitly add @docusaurus/theme-common to the dependencies of the example website.

I am wondering if it's the correct way, since our users may must manually add @docusaurus/theme-common to their website dependencies as we did here.

Maybe using peer dependencies is just the correct way, since our users may run into the same issue of duplicate instances of theme-common, if they didn't dedupe correctly.

In npm 7+ (shipped with node 15), npm will install peer dependencies automatically, so I think there will be no troubles these users will encounter. For others (npm <=6, yarn), I will first try to release an alpha version to test if it does work. If it requires an explicit dependencies of theme-common, we should add notice about it in installation section of our docs.

Cyriuz · 2022-05-31T06:17:44Z

Awesome, yeah that sounds good! :D

Fixes easyops-cn#211

weareoutman · 2022-06-13T01:30:09Z

This may take a little longer, I got very limit time on this project these days, :(

weareoutman · 2022-06-21T01:21:45Z

docusaurus-search-local/src/client/theme/SearchBar/SearchBar.tsx

-  const activeVersion = useActiveVersion();
-  if (activeVersion && !activeVersion.isLast) {
-    baseUrl = activeVersion.path + "/";
+  const { pluginId } = useActivePlugin({failfast: true})!;


Building the example website will fail due to this change.

➤ YN0000: [website]: Error: Can't find active docs plugin for "/docusaurus-search-local/404" pathname, while it was expected to be found. Maybe you tried to use a docs feature that can only be used on a docs-related page? Existing docs plugin paths are: /docusaurus-search-local/docs ➤ YN0000: [website]: Error: Can't find active docs plugin for "/docusaurus-search-local/blog" pathname, while it was expected to be found. Maybe you tried to use a docs feature that can only be used on a docs-related page? Existing docs plugin paths are: /docusaurus-search-local/docs ➤ YN0000: [website]: Error: Can't find active docs plugin for "/docusaurus-search-local/blog/archive" pathname, while it was expected to be found. Maybe you tried to use a docs feature that can only be used on a docs-related page? Existing docs plugin paths are: /docusaurus-search-local/docs ➤ YN0000: [website]: Error: Can't find active docs plugin for "/docusaurus-search-local/blog/hello-world" pathname, while it was expected to be found. Maybe you tried to use a docs feature that can only be used on a docs-related page? Existing docs plugin paths are: /docusaurus-search-local/docs ➤ YN0000: [website]: Error: Can't find active docs plugin for "/docusaurus-search-local/blog/hola" pathname, while it was expected to be found. Maybe you tried to use a docs feature that can only be used on a docs-related page? Existing docs plugin paths are: /docusaurus-search-local/docs ➤ YN0000: [website]: Error: Can't find active docs plugin for "/docusaurus-search-local/blog/tags" pathname, while it was expected to be found. Maybe you tried to use a docs feature that can only be used on a docs-related page? Existing docs plugin paths are: /docusaurus-search-local/docs ➤ YN0000: [website]: Error: Can't find active docs plugin for "/docusaurus-search-local/blog/tags/docusaurus" pathname, while it was expected to be found. Maybe you tried to use a docs feature that can only be used on a docs-related page? Existing docs plugin paths are: /docusaurus-search-local/docs ➤ YN0000: [website]: Error: Can't find active docs plugin for "/docusaurus-search-local/blog/tags/facebook" pathname, while it was expected to be found. Maybe you tried to use a docs feature that can only be used on a docs-related page? Existing docs plugin paths are: /docusaurus-search-local/docs ➤ YN0000: [website]: Error: Can't find active docs plugin for "/docusaurus-search-local/blog/tags/hello" pathname, while it was expected to be found. Maybe you tried to use a docs feature that can only be used on a docs-related page? Existing docs plugin paths are: /docusaurus-search-local/docs ➤ YN0000: [website]: Error: Can't find active docs plugin for "/docusaurus-search-local/blog/tags/hola" pathname, while it was expected to be found. Maybe you tried to use a docs feature that can only be used on a docs-related page? Existing docs plugin paths are: /docusaurus-search-local/docs ➤ YN0000: [website]: Error: Can't find active docs plugin for "/docusaurus-search-local/blog/welcome" pathname, while it was expected to be found. Maybe you tried to use a docs feature that can only be used on a docs-related page? Existing docs plugin paths are: /docusaurus-search-local/docs ➤ YN0000: [website]: Error: Can't find active docs plugin for "/docusaurus-search-local/blog/writing-good-unit-tests" pathname, while it was expected to be found. Maybe you tried to use a docs feature that can only be used on a docs-related page? Existing docs plugin paths are: /docusaurus-search-local/docs ➤ YN0000: [website]: Error: Can't find active docs plugin for "/docusaurus-search-local/search" pathname, while it was expected to be found. Maybe you tried to use a docs feature that can only be used on a docs-related page? Existing docs plugin paths are: /docusaurus-search-local/docs ➤ YN0000: [website]: Error: Can't find active docs plugin for "/docusaurus-search-local/" pathname, while it was expected to be found. Maybe you tried to use a docs feature that can only be used on a docs-related page? Existing docs plugin paths are: /docusaurus-search-local/docs

Fixed that. However, I think we didn't fix #211

weareoutman · 2022-06-21T04:35:24Z

Tests passed, I think we're ready to go

slorber · 2022-07-06T12:32:50Z

Not sure why yet but it looks like this code makes Docusaurus fail on latest canary (but works on latest beta.21).

facebook/docusaurus#7686 (comment)

Currently investigating

Edit: finally it's not a problem in this package, see also: facebook/docusaurus#7728

slorber · 2022-07-06T12:58:00Z

docusaurus-search-local/src/client/theme/SearchBar/SearchBar.tsx

@@ -10,7 +10,8 @@ import useDocusaurusContext from "@docusaurus/useDocusaurusContext";
 import ExecutionEnvironment from "@docusaurus/ExecutionEnvironment";
 import { useHistory, useLocation } from "@docusaurus/router";
 import { translate } from "@docusaurus/Translate";
-import { useActiveVersion } from '@docusaurus/plugin-content-docs/client';
+import { useDocsPreferredVersion } from "@docusaurus/theme-common";


We have moved this export to an internal entrypoint

import { useDocsPreferredVersion, } from '@docusaurus/theme-common/internal';

This also means that technically we are not 100% ready to consider this API to be part of our public API surface and make no breaking changes on it 😅

But this can be discussed if you don't have a better choice than using it, and in practice we may not break it

I couldn't find any other way to do it so it is either that or if you know of any other, supported, way of getting the selected version?

Will move useDocsPreferredVersion to our public api

Even though we may do a breaking change later, it will be clearly highlighted in a major release blog post

facebook/docusaurus#7729

fix: search page for non latest doc versions

15f6161

fixes easyops-cn#203

fix: use the active plugin id when getting the current docs version

824e134

Fixes easyops-cn#211

Cyriuz mentioned this pull request Jun 12, 2022

Docusaurus Build fails when all @docusaurus/plugin-content-docs instances have custom ids #211

Closed

weareoutman reviewed Jun 21, 2022

View reviewed changes

weareoutman added 3 commits June 21, 2022 12:20

fix: fix active plugin may be undefined

0bfbbb2

fix: make @docusaurus/theme-common as peer

68dc812

Merge remote-tracking branch 'origin/master' into versioned-search-page

f29ec2d

weareoutman marked this pull request as ready for review June 21, 2022 04:34

weareoutman approved these changes Jun 21, 2022

View reviewed changes

weareoutman merged commit 91d82b1 into easyops-cn:master Jun 21, 2022

slorber mentioned this pull request Jul 6, 2022

Upgrade to DS beta.21 breaks SSR builds with useDocsVersion error facebook/docusaurus#7686

Closed

7 tasks

slorber reviewed Jul 6, 2022

View reviewed changes

slorber mentioned this pull request Jul 6, 2022

refactor(theme-common): move useDocsPreferredVersion() to public api facebook/docusaurus#7729

Merged

3 tasks

Josh-Cena mentioned this pull request Aug 2, 2022

theme-common doesn't deduplicate if site using pnpm/PnP installs it facebook/docusaurus#7880

Open

7 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: search page for non latest doc versions #205

fix: search page for non latest doc versions #205

Cyriuz commented May 30, 2022

netlify bot commented May 30, 2022 •

edited

Loading

weareoutman commented May 30, 2022

weareoutman commented May 31, 2022 •

edited

Loading

weareoutman commented May 31, 2022

Cyriuz commented May 31, 2022

weareoutman commented Jun 13, 2022 •

edited

Loading

weareoutman Jun 21, 2022

weareoutman Jun 21, 2022 •

edited

Loading

weareoutman commented Jun 21, 2022 •

edited

Loading

slorber commented Jul 6, 2022 •

edited

Loading

slorber Jul 6, 2022

Cyriuz Jul 6, 2022

slorber Jul 6, 2022

slorber Jul 6, 2022

fix: search page for non latest doc versions #205

fix: search page for non latest doc versions #205

Conversation

Cyriuz commented May 30, 2022

netlify bot commented May 30, 2022 • edited Loading

✅ Deploy Preview for easyops-cn-docusaurus-search-local ready!

weareoutman commented May 30, 2022

weareoutman commented May 31, 2022 • edited Loading

weareoutman commented May 31, 2022

Cyriuz commented May 31, 2022

weareoutman commented Jun 13, 2022 • edited Loading

weareoutman Jun 21, 2022

Choose a reason for hiding this comment

weareoutman Jun 21, 2022 • edited Loading

Choose a reason for hiding this comment

weareoutman commented Jun 21, 2022 • edited Loading

slorber commented Jul 6, 2022 • edited Loading

slorber Jul 6, 2022

Choose a reason for hiding this comment

Cyriuz Jul 6, 2022

Choose a reason for hiding this comment

slorber Jul 6, 2022

Choose a reason for hiding this comment

slorber Jul 6, 2022

Choose a reason for hiding this comment

netlify bot commented May 30, 2022 •

edited

Loading

weareoutman commented May 31, 2022 •

edited

Loading

weareoutman commented Jun 13, 2022 •

edited

Loading

weareoutman Jun 21, 2022 •

edited

Loading

weareoutman commented Jun 21, 2022 •

edited

Loading

slorber commented Jul 6, 2022 •

edited

Loading