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

fix(algolia): upgrade algoliasearch to v5 #6660

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

millotp
Copy link

@millotp millotp commented Jan 21, 2025

What's the problem this PR addresses?

Algolia has released a new major of the algoliasearch package, used by the typescript and interactive-tools plugin.
The v5 has been released for 6 month and should be stable enough now to migrate, docsearch and docusaurus already supports it.

...

How did you fix it?

Upgraded all the packages that rely on algoliasearch, to make sure that the final yarn.lock resolves to algoliasearch > 5.

...

Checklist

  • I have set the packages that need to be released for my changes to be effective.
  • I will check that all automated PR checks pass before the PR gets reviewed.

@arcanis
Copy link
Member

arcanis commented Feb 14, 2025

The build is failing with a seemingly related error:

6:11:40 PM:           [cause]: TypeError: internal.useDocsVersion is not a function
6:11:40 PM:               at VersionBanner (/opt/build/repo/packages/docusaurus/build/__server/assets/js/e53d8cb1.ad27c151.js:138:48)
6:11:40 PM:               at Uc (server.bundle.js:14535:44)
6:11:40 PM:               at Xc (server.bundle.js:14537:253)
6:11:40 PM:               at Z (server.bundle.js:14543:89)

@millotp
Copy link
Author

millotp commented Feb 18, 2025

Hello @arcanis, thanks for checking the PR !
How do you get the error locally ? when I try to build the website I get other errors like

Module build failed: ReferenceError: window is not defined
    at call (webpack://xterm/src/common/TaskQueue.ts:145:67)
    at i (webpack://xterm/webpack/bootstrap:19:32)
    at call (webpack://xterm/src/common/buffer/Buffer.ts:7:1)
    at i (webpack://xterm/webpack/bootstrap:19:32)
    at call (webpack://xterm/src/common/buffer/BufferSet.ts:9:1)
    at i (webpack://xterm/webpack/bootstrap:19:32)
    at call (webpack://xterm/src/common/services/BufferService.ts:9:1)
    at i (webpack://xterm/webpack/bootstrap:19:32)
    at call (webpack://xterm/src/common/CoreTerminal.ts:28:1)
    at i (webpack://xterm/webpack/bootstrap:19:32)

but the search bar seems to work fine.

Also do I have to include all the .yarn/cache in my PR ?

@millotp
Copy link
Author

millotp commented Feb 18, 2025

I had to update the package docusaurus-plugin-typedoc-api to 4.4.0 because the internal package in docusaurus doesn't exists anymore, but I kept the applied patch on it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants