Repository navigation
perf: Load the Kapa.ai widget on demand - #20278
Merged
Merged
Conversation
The widget bundle is ~600 KiB and pulls reCAPTCHA Enterprise in behind it. Together they accounted for roughly 1.3 MB of JavaScript and ~1.08s of script bootup on every page load, even though almost nobody opens Ask AI. It was already strategy="lazyOnload", which only defers it past window load; it still ran on every visit. Replace the eager <Script> with an on-demand loader. Each Ask AI entry point now fetches the widget on first use and pre-warms on hover/focus, so the click still feels instant. This also removes two latent races. The ?askAI=true deep link previously waited a fixed 300ms and silently did nothing if the widget wasn't ready; the search results AI entry was guarded by `if (window.Kapa?.open)` and was a no-op in the same case. Both now await the loader. Verified in headless Chrome: zero kapa/reCAPTCHA requests on load, and all four entry points (header, search bar, search results with query passthrough, and the ?askAI=true deep link) open the modal correctly on desktop and mobile. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
|
Services awaiting deployment · Rollout details
Mention |
![cursor[bot]](https://avatars.githubusercontent.com/in/1210556?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Cursor Bugbot has reviewed your changes and found 1 potential issue.
❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.
Want reviews to match your repository better? Bugbot Learning can learn team-specific rules from PR activity. A team admin can enable Learning in the Cursor dashboard.
Reviewed by Cursor Bugbot for commit 18e8779. Configure here.
The ?askAI=true effect called openKapa with no cancellation. Since the widget can take seconds to load, leaving the homepage mid-load would pop the modal over the next page. openKapa now takes an AbortSignal and skips the open once aborted, while still letting the load finish so the next click stays fast. The Ask AI Referrer event now fires only after the modal actually opens, as it did before the lazy-load change. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Contributor
|
Rollouts can't watch this change after it deploys: every data source for this team needs to be signed in again, so a check has no telemetry to read. Sign in to your data sources, or ask a team admin to. |
sentry-junior Bot
added a commit
that referenced
this pull request
Nov 3, 2026
Resolve the import conflict in src/components/search/index.tsx: keep isDeveloperDocs from sentry-docs/docsSite.mjs and the new Kapa imports from #20278. Co-Authored-By: Sergiy Dybskiy <3760543+sergical@users.noreply.github.com>
This was referenced Nov 4, 2026
This branch was successfully deployed
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
DESCRIBE YOUR PR
Preview on: https://sentry-docs-git-coolguyzone-perfdefer-kapa.sentry.dev/
In preview the mobile Lighthouse performance score went from 55 to 88.
The Kapa.ai widget was loading on every page view. The bundle is ~600 KiB and pulls reCAPTCHA Enterprise in behind it — together roughly 1.3 MB of JavaScript and ~1.08s of script bootup on every visit, for a feature almost nobody opens. It was already
strategy="lazyOnload", but that only defers pastwindow.load; it still ran every time.This replaces the eager
<Script>inapp/layout.tsxwith an on-demand loader (src/lib/kapa.ts). The widget is fetched the first time someone reaches for Ask AI, and pre-warmed on hover/focus so the click still feels instant.There are four Ask AI entry points, and all four needed rewiring. The first two previously worked through Kapa's own
data-modal-override-open-class="kapa-ai-class"delegation, which can't fire if the widget was never loaded — so that class is gone and every entry point now callsopenKapa()directly:header.tsx)search/index.tsx)#ai-list-entryrow in the search results, which passes{query, submit: true}(search/index.tsx)?askAI=truedeep link (askAiSearchParams.tsx)This also fixes two latent bugs. The deep link waited a fixed 300ms and then silently did nothing if the widget wasn't ready yet; the search-results entry was wrapped in
if (window.Kapa?.open)and was a no-op in the same situation. Both now await the loader, so neither races a timeout.Verification
Tested in headless Chrome against a local dev server, all four paths confirmed with screenshots:
window.Kapaundefined, 0 console errorswindow.Kapabecomes available<script src*="kapa">in the DOM, so no duplicate injectionMeasured on
masterunder identical local conditions, page load pulled 9 third-party requests / 764 KiB (6 of them reCAPTCHA, 730 KiB). On this branch that is zero until someone opens Ask AI.pnpm lint:ts, ESLint and Prettier are clean, and all 517 tests pass.Notes for reviewers
?askAI=trueand the "Ask Sentry about …" row in search results — those two are the ones a quick smoke test would miss.https://proxy.kapa.ai/returns 404 on localhost. It is not a regression from this change — onmasterit fires on page load, here it only fires after Ask AI opens, and production doesn't 404 at all. It's Kapa's origin whitelist not covering localhost.IS YOUR CHANGE URGENT?
Help us prioritize incoming PRs by letting us know when the change needs to go live.
Select exactly one option. For deadlines, replace
YYYY-MM-DDwith the due date. You can update this information later by editing the PR description.SLA
Thanks in advance for your help!
PRE-MERGE CHECKLIST
Make sure you've checked the following before merging your changes:
EXTRA RESOURCES
🤖 Generated with Claude Code