Skip to content

Comments

fix(core): broken links optimization behaves differently than non-optimized logic#9791

Merged
slorber merged 2 commits intomainfrom
slorber/broken-link-checker-optim-exact-strict-fix
Jan 25, 2024
Merged

fix(core): broken links optimization behaves differently than non-optimized logic#9791
slorber merged 2 commits intomainfrom
slorber/broken-link-checker-optim-exact-strict-fix

Conversation

@slorber
Copy link
Collaborator

@slorber slorber commented Jan 25, 2024

Motivation

My broken link checker optimization in #9778 applied a wrong heuristic to optimize the algorithm, assuming a route always matches exactly and strictly, which is not the case in practice (we don't use strict matching on our core plugins).

As a result, users reported bug related to urls with trailing slashes being reported:

The goal of this PR is to keep the existing optimization, and fix it so that the behavior is the same, and correct, with/without optimization.

Test Plan

unit tests

@slorber slorber added pr: bug fix This PR fixes a bug in a past release. to backport This PR is planned to be backported to a stable version of Docusaurus labels Jan 25, 2024
@facebook-github-bot facebook-github-bot added the CLA Signed Signed Facebook CLA label Jan 25, 2024
@netlify
Copy link

netlify bot commented Jan 25, 2024

[V2]

Name Link
🔨 Latest commit cc83b82
🔍 Latest deploy log https://app.netlify.com/sites/docusaurus-2/deploys/65b2a92d84e24c0008c32c3f
😎 Deploy Preview https://deploy-preview-9791--docusaurus-2.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

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

@github-actions
Copy link

⚡️ Lighthouse report for the deploy preview of this PR

URL Performance Accessibility Best Practices SEO PWA Report
/ 🟠 75 🟢 98 🟢 100 🟢 100 🟠 89 Report
/docs/installation 🟠 87 🟢 98 🟢 100 🟢 100 🟠 89 Report
/docs/category/getting-started 🟠 76 🟢 100 🟢 100 🟢 90 🟠 89 Report
/blog 🟠 70 🟢 100 🟢 100 🟢 90 🟠 89 Report
/blog/preparing-your-site-for-docusaurus-v3 🟠 63 🟢 97 🟢 100 🟢 100 🟠 89 Report
/blog/tags/release 🟠 70 🟢 100 🟢 100 🟠 80 🟠 89 Report
/blog/tags 🟠 78 🟢 100 🟢 100 🟢 90 🟠 89 Report

@github-actions
Copy link

Size Change: 0 B

Total Size: 986 kB

ℹ️ View Unchanged
Filename Size
website/.docusaurus/globalData.json 75.1 kB
website/build/assets/css/styles.********.css 114 kB
website/build/assets/js/main.********.js 759 kB
website/build/index.html 37.9 kB

compressed-size-action

@slorber slorber merged commit d3142c5 into main Jan 25, 2024
@slorber slorber deleted the slorber/broken-link-checker-optim-exact-strict-fix branch January 25, 2024 18:49
slorber added a commit that referenced this pull request Jan 26, 2024
slorber added a commit that referenced this pull request Jan 26, 2024
Co-authored-by: Joshua Chen <[email protected]>
Co-authored-by: Joey Clover <[email protected]>
Co-authored-by: reece-white <[email protected]>
Co-authored-by: Shreesh Nautiyal <[email protected]>
Co-authored-by: Nick Gerleman <[email protected]>
Co-authored-by: Chongyi Zheng <[email protected]>
Co-authored-by: MCR Studio <[email protected]>
Co-authored-by: sebastienlorber <[email protected]>
Co-authored-by: Sébastien Lorber <[email protected]>
Co-authored-by: Ivan Mar (sOkam!) <[email protected]>
Co-authored-by: c0h1b4 <[email protected]>
Co-authored-by: Janessa Garrow <[email protected]>
Co-authored-by: ozaki <[email protected]>
Co-authored-by: axmmisaka <[email protected]>
Co-authored-by: Tatsunori Uchino <[email protected]>
Co-authored-by: Simen Bekkhus <[email protected]>
Co-authored-by: Sanjaiyan Parthipan <[email protected]>
Co-authored-by: Jack Robson <[email protected]>
Co-authored-by: dawei-wang <[email protected]>
Co-authored-by: eitsupi <[email protected]>
fix(create-docusaurus): fix readme docusaurus 2 ref (#9487)
fix(theme): fix firefox CSS :has() support bug (#9530)
fix(theme): docs html sidebar items should always be visible (#9531)
fix: v3 admonitions should support v2 title syntax for nested admonitions (#9535)
fix(theme-classic): fixed wrong cursor on dropdown menu in navbar, when window is small (#9398)
fix(theme): upgrade prism-react-renderer, fix html script and style tag highlighting (#9567)
fix: add v2 retrocompatible support for quoted admonitions (#9570)
fix(i18n): complete translations for theme-common.json Brazilian Portuguese (pt-BR) (#9477)
fix(content-blog): add baseUrl for author.image_url (#9581)
fix(type-aliases): add `title` prop for imported inline SVG React components (#9612)
fix(utils): Markdown link replacement with <> but no spaces (#9617)
fix(live-codeblock): stabilize react-live transformCode callback, fix editor/preview desync (#9631)
fix(cli): output help when no conventional config + no subcommand (#9648)
fix CI job (#9604)
fix Lint Autofix workflow (#9632)
fix(pwa-plugin): upgrade workbox (#9668)
fix(create-docusaurus): fix init template code blocks, and little improvements (#9696)
fix(theme): allow empty code blocks and live playgrounds (#9704)
fix(core): various broken anchor link fixes (#9732)
fix: remove old useless mdx typedefs (#9733)
fix(theme-common): fix missing code block MagicComments style in Visual Basic (.NET) 16 (#9727)
fix(core): conditionally include `hostname` parameter when using… (#9407)
fix(create-docusaurus): fix typo in init template sample docs (#9783)
fix(mdx-loader): allow spaces before `mdx-code-block` info string (#9776)
fix(core): links with target "_blank" should no be checked by the broken link checker (#9788)
fix(core): broken links optimization behaves differently than non-optimized logic (#9791)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CLA Signed Signed Facebook CLA pr: bug fix This PR fixes a bug in a past release. to backport This PR is planned to be backported to a stable version of Docusaurus

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants