StreamlitMarkdown - module level plugin cache
#13152
Merged
+1,000
−116
Conversation
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
mayagbarnes
added
security-assessment-completed
Contributor
✅ Snyk checks have passed. No issues have been found so far.
💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse. |
Contributor
✅ PR preview is ready!
|
Contributor
📈 Frontend coverage change detectedThe frontend unit test (vitest) coverage has increased by 0.0700%
🎉 Great job on improving test coverage! |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR refactors the lazy loading mechanism for markdown plugins in StreamlitMarkdown to use module-level caching instead of component-level state. The changes improve React StrictMode compatibility, reduce redundant plugin loads across component instances, and consolidate duplicate loading logic into a reusable hook.
Key Changes
- Module-level plugin caching: Plugins are now cached at module scope and shared across all component instances, preventing redundant loads
- Custom
useLazyPluginhook: Consolidates three nearly-identicaluseEffectblocks into a single reusable hook with proper cleanup and shared in-flight promise handling - Extraction to
utils.ts: Moves all plugin-related logic (types, loaders, cache, helpers, hook) to a dedicated utilities file with comprehensive test coverage
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 7 comments.
| File | Description |
|---|---|
frontend/lib/src/components/shared/StreamlitMarkdown/utils.ts |
New file containing plugin loading infrastructure: module-level caches, lazy loaders for katex/raw/emoji plugins, plugin extraction logic, error-handling wrappers, and the useLazyPlugin hook |
frontend/lib/src/components/shared/StreamlitMarkdown/utils.test.ts |
Comprehensive test suite for the new utilities covering plugin extraction, wrapper functions, lazy loading hook behavior, cleanup, and error scenarios |
frontend/lib/src/components/shared/StreamlitMarkdown/StreamlitMarkdown.tsx |
Refactored to use useLazyPlugin hook instead of three separate useEffect blocks, with wrapped plugins for better error handling |
frontend/lib/src/components/shared/StreamlitMarkdown/StreamlitMarkdown.tsx
Outdated
Show resolved
Hide resolved
frontend/lib/src/components/shared/StreamlitMarkdown/utils.test.ts
Outdated
Show resolved
Hide resolved
frontend/lib/src/components/shared/StreamlitMarkdown/utils.test.ts
Outdated
Show resolved
Hide resolved
![graphite-app[bot]](https://avatars.githubusercontent.com/in/158384?s=60&v=4){kind=small}
sfc-gh-mbarnes
force-pushed
the
fix-lazy-markdown
branch
from
5014008 to
1ae1a8c
Compare
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 changes
React's
StrictModeexposed some opportunities to improve the recently added lazy loading forStreamlitMarkdown's plugins:rehype-katex,rehype-raw, &remark-emojiComponent is now StrictMode compatible, with improved performance (plugins load once per app, not per component instance), and better handle plugin load failure (render as plain text).
This PR better makes the following changes:
useLazyPluginhook: Consolidated three nearly-identical useEffect blocks into a single reusable hook with proper cleanup handlingutils.ts: Moved all plugin-related logic (types, loaders, cache, helpers, hook) to a dedicated fileTesting Plan