π fix(pdf): upgrade pdfjs-dist and react-pdf to v5.x#11686
Conversation
Resolves: LOBE-2658 - Upgrade pdfjs-dist from 4.x to 5.4.530 - Upgrade react-pdf from 9.x to 10.3.0 - Fix PDF worker loading using import.meta.url pattern - Add @napi-rs/canvas dependency for react-pdf renderer - Fix typo: ResouceManagerMode β ResourceManagerMode - Clean up meaningless comments in ListItem component - Simplify next config by removing unused isDesktop logic
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Reviewer's GuideUpgrades the PDF rendering stack to pdfjs-dist 5.4.530 and react-pdf 10.3.0, switches PDF worker loading from a CDN URL to a local import.meta.url-based URL for reliability/offline support, aligns configs and overrides for the new versions, adds the canvas dependency required by @react-pdf/renderer, cleans up ResourceManager typing and comments, and simplifies Next.js config around standalone/PWA behavior. Sequence diagram for PDF viewing with local pdfjs worker loadingsequenceDiagram
actor User
participant Browser
participant ReactApp
participant PDFViewer
participant pdfjs
participant WebpackBundler
User->>Browser: Open ResourceManager and select PDF
Browser->>ReactApp: Load application bundle
ReactApp->>PDFViewer: Mount PDFViewer component with url and fileId
PDFViewer->>pdfjs: Configure GlobalWorkerOptions.workerSrc
pdfjs-->>PDFViewer: Read workerSrc from new URL(import.meta.url)
PDFViewer->>WebpackBundler: Request pdfjs-dist/build/pdf.worker.min.mjs (resolved at build time)
WebpackBundler-->>Browser: Serve bundled worker script
Browser->>pdfjs: Spawn PDF worker from local script
PDFViewer->>pdfjs: Load document from url
pdfjs-->>PDFViewer: Return document with numPages
PDFViewer->>PDFViewer: onDocumentLoadSuccess(document)
PDFViewer->>PDFViewer: setNumPages(document.numPages)
PDFViewer-->>ReactApp: Render PDF pages in viewer
ReactApp-->>User: Display PDF content and enable interactions
Updated class diagram for ResourceManager mode state and actionsclassDiagram
class ResourceManagerMode {
<<type alias>>
editor
explorer
page
}
class ResourceFeaturesState {
+string currentViewItemId
+ResourceManagerMode mode
+string[] selectedFileIds
+string[] pinnedFileIds
+string[] expandedFolderIds
+string[] openTabs
+string sortType
+string viewMode
}
class ResourceFeaturesAction {
+setMode(mode ResourceManagerMode) void
+setPendingRenameItemId(id string) void
+setSelectedFileIds(ids string[]) void
}
class ResourceState {
+string currentViewItemId
+ResourceManagerMode mode
+string[] selectedFileIds
}
class ResourceAction {
+setMode(mode ResourceManagerMode) void
+setSelectedFileIds(ids string[]) void
}
ResourceManagerMode <.. ResourceFeaturesState : uses
ResourceManagerMode <.. ResourceState : uses
ResourceManagerMode <.. ResourceFeaturesAction : uses
ResourceManagerMode <.. ResourceAction : uses
Flow diagram for Next.js config wrapper selection with standalone and PWAflowchart TD
A[Process env variables]
A --> B[isProd = NODE_ENV === production]
A --> C[buildWithDocker = DOCKER === true]
A --> D[isStandaloneMode = buildWithDocker OR NEXT_BUILD_STANDALONE === 1]
subgraph StandaloneConfig
E[If isStandaloneMode] --> F[Apply standaloneConfig
output = standalone
experimental.outputFileTracingRoot = process.cwd]
end
subgraph PWAConfig
B --> G{isProd}
G -->|true| H[withPWA = withSerwistInit
register = false
swDest = public/sw.js
swSrc = src/app/sw.ts]
G -->|false| I[withPWA = noWrapper]
end
subgraph AnalyzerConfig
J[ANALYZE === true?]
J -->|true| K[withBundleAnalyzer = analyzer]
J -->|false| L[withBundleAnalyzer = noWrapper]
end
M[nextConfig base settings] --> N[Apply isStandaloneMode and standaloneConfig]
N --> O[Apply withPWA]
O --> P[Apply withBundleAnalyzer]
P --> Q[Export final Next.js config]
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
TestGru AssignmentSummary
Tip You can |
There was a problem hiding this comment.
Hey - I've found 2 issues, and left some high level feedback:
- In the PDF viewer,
onDocumentLoadSuccessnow takesunknownand casts to{ numPages: number }; it would be safer to import and use the correct type from the updatedreact-pdf/pdfjs-distAPIs (or a dedicated interface) instead of an unchecked cast. - You now set
pdfjs.GlobalWorkerOptions.workerSrcusingimport.meta.urlat module scope in both PDF entry points; consider guarding this so it never runs in non-browser contexts (e.g.,typeof window !== 'undefined') to avoid potential issues during SSR or Node-side builds. - The
pdfjs-distversion is specified both inpackage.jsonoverridesand inpnpm-workspace.yamloverrides; consolidating this into a single override location would reduce duplication and the risk of the versions drifting.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- In the PDF viewer, `onDocumentLoadSuccess` now takes `unknown` and casts to `{ numPages: number }`; it would be safer to import and use the correct type from the updated `react-pdf`/`pdfjs-dist` APIs (or a dedicated interface) instead of an unchecked cast.
- You now set `pdfjs.GlobalWorkerOptions.workerSrc` using `import.meta.url` at module scope in both PDF entry points; consider guarding this so it never runs in non-browser contexts (e.g., `typeof window !== 'undefined'`) to avoid potential issues during SSR or Node-side builds.
- The `pdfjs-dist` version is specified both in `package.json` `overrides` and in `pnpm-workspace.yaml` `overrides`; consolidating this into a single override location would reduce duplication and the risk of the versions drifting.
## Individual Comments
### Comment 1
<location> `src/libs/next/config/define-config.ts:27-30` </location>
<code_context>
- // if you need to proxy the api endpoint to remote server
-
- const isStandaloneMode = buildWithDocker || isDesktop;
+ const isStandaloneMode = buildWithDocker || process.env.NEXT_BUILD_STANDALONE === '1';
const standaloneConfig: NextConfig = {
</code_context>
<issue_to_address>
**question (bug_risk):** Revisiting standalone mode & PWA conditions for desktop/electron builds
This changes `isStandaloneMode` from including the desktop flag (`NEXT_PUBLIC_IS_DESKTOP_APP === '1'`) to depending only on `NEXT_BUILD_STANDALONE`, and also enables PWA for all production builds.
Implications to confirm:
1) `build:electron` currently only sets `NEXT_PUBLIC_IS_DESKTOP_APP=1`, so it will no longer get `output: 'standalone'` unless `NEXT_BUILD_STANDALONE` is also set. If the Electron packaging flow expects standalone output, this may break desktop builds.
2) Desktop/Electron builds will now get the service worker in production, which was previously avoided and can be problematic (caching/offline behavior, debugging).
If this is intentional, we should: (a) wire `NEXT_BUILD_STANDALONE` into the Electron build scripts, and (b) decide explicitly whether desktop should opt out of PWA, e.g. via an `ENABLE_PWA` flag or by including `NEXT_PUBLIC_IS_DESKTOP_APP` in the PWA condition.
</issue_to_address>
### Comment 2
<location> `src/features/FileViewer/Renderer/PDF/index.tsx:50-51` </location>
<code_context>
- const onDocumentLoadSuccess = ({ numPages: nextNumPages }: PDFDocumentProxy) => {
- setNumPages(nextNumPages);
+ const onDocumentLoadSuccess = (document: unknown) => {
+ setNumPages((document as { numPages: number }).numPages);
setIsLoaded(true);
};
</code_context>
<issue_to_address>
**issue (bug_risk):** Avoid using `unknown` plus a loose cast for the PDF document load callback
The previous callback used `PDFDocumentProxy` destructuring, which enforced the expected shape at compile time. The new `(document: unknown)` + `as { numPages: number }` cast disables that checking and will only fail at runtime if the payload changes.
Prefer a strongly typed parameter instead of `unknown` + cast, either by importing the appropriate type / callback signature from `react-pdf` or by defining a small local type, for example:
```ts
interface LoadedDocument { numPages: number }
const onDocumentLoadSuccess = (doc: LoadedDocument) => {
setNumPages(doc.numPages);
setIsLoaded(true);
};
```
This keeps the handler safe and self-documenting while remaining compatible with the updated library types.
</issue_to_address>Help me be more useful! Please click π or π on each comment and I'll use the feedback to improve your reviews.
Signed-off-by: Innei <tukon479@gmail.com>
Codecov Reportβ Patch coverage is Additional details and impacted files@@ Coverage Diff @@
## next #11686 +/- ##
==========================================
+ Coverage 72.52% 74.04% +1.52%
==========================================
Files 1155 1187 +32
Lines 87510 94545 +7035
Branches 11538 12859 +1321
==========================================
+ Hits 63463 70010 +6547
- Misses 23957 24445 +488
Partials 90 90
Flags with carried forward coverage won't be shown. Click here to find out more.
π New features to boost your workflow:
|
- Updated pdfVersion in PDF loader snapshots to reflect the new version 5.4.530. Signed-off-by: Innei <tukon479@gmail.com>
- Refactored file loader imports to use dynamic loading, improving performance by preventing heavy dependencies from being loaded until needed. - Introduced `getFileLoader` function to manage loader retrieval based on file type. - Updated logging and fallback mechanisms for unsupported file types. This change enhances the efficiency of file loading operations. Signed-off-by: Innei <tukon479@gmail.com>
- Updated `nextConfig` to include `@napi-rs/canvas` and `pdfjs-dist` in `serverExternalPackages` to address bundling issues with Turbopack. - Removed unused `isDesktop` logic and simplified the configuration structure. - Adjusted `transpilePackages` to exclude `pdfjs-dist`, reflecting recent upgrades. This change optimizes the configuration for better compatibility and performance. Signed-off-by: Innei <tukon479@gmail.com>
|
β€οΈ Great PR @Innei β€οΈ The growth of project is inseparable from user feedback and contribution, thanks for your contribution! If you are interesting with the lobehub developer community, please join our discord and then dm @arvinxx or @canisminor1990. They will invite you to our private developer channel. We are talking about the lobe-chat development or sharing ai newsletter around the world. |
## [Version 2.0.0-next.346](v2.0.0-next.345...v2.0.0-next.346) <sup>Released on **2026-01-23**</sup> #### π Bug Fixes - **pdf**: Upgrade pdfjs-dist and react-pdf to v5.x. <br/> <details> <summary><kbd>Improvements and Fixes</kbd></summary> #### What's fixed * **pdf**: Upgrade pdfjs-dist and react-pdf to v5.x, closes [#11686](#11686) ([2b620df](2b620df)) </details> <div align="right"> [](#readme-top) </div>
|
π This PR is included in version 2.0.0-next.346 π The release is available on: Your semantic-release bot π¦π |
## [Version 1.153.0](v1.152.0...v1.153.0) <sup>Released on **2026-01-23**</sup> #### β» Code Refactoring - **auth**: Remove NEXT_PUBLIC_AUTH_URL env variable. - **model-select**: Migrate FunctionCallingModelSelect to LobeSelect. - **ModelSwitchPanel**: Migrate from Popover to DropdownMenu with virtual scrolling. - **userMemories**: Removed un-used code. - **misc**: Improve memory data with experience and identity, move vercel-react-best-practices skills to .agents directory. #### β¨ Features - **database**: Added user memory activity. - **desktop**: Add legacy local database detection and migration guidance. - **misc**: Add platform-aware download client menu option, add server version check for desktop app, remove Clerk authentication code, skill setting page and skill store, support agent group unpublish agents, support client tasks mode, update the sandbox preinstall libs in sys role. #### π Bug Fixes - **copilot**: Pass correct scope when creating new session in PageEditor. - **desktop**: Gracefully handle missing update manifest 404 errors. - **model-runtime**: Filter unsupported image types (SVG) before sending to vision models. - **pdf**: Upgrade pdfjs-dist and react-pdf to v5.x. - **sidebar-drawer**: Fix drawer positioning and title style. - **misc**: Fix group broadcast trigger tool use, fix local system tools, fix memory schema, fix multi agent tasks issue, fix multi tasks no summary issue, fix scope issue, fix tool argument scape and improve multi task run, fixed the sandbox tools call when error should use right callback, improve e2e server and complete i18n resources, slove the agent group editor not focus in editdata area, slove the agents header switch agents the lobeAI not show problem, sloved the old removeSessionTopics not work, TypewriterEffect not refreshing on language change, updata cron job ui & fixed commnuity pagenation goto error, update the agentbuilder tools not always use humanIntervention. #### π Styles - **misc**: Improve auto scroll and group profile, update og, update share style. <br/> <details> <summary><kbd>Improvements and Fixes</kbd></summary> #### Code refactoring * **auth**: Remove NEXT_PUBLIC_AUTH_URL env variable, closes [lobehub#11658](https://github.com/jaworldwideorg/OneJA-Bot/issues/11658) ([c0f9875](c0f9875)) * **model-select**: Migrate FunctionCallingModelSelect to LobeSelect, closes [lobehub#11664](https://github.com/jaworldwideorg/OneJA-Bot/issues/11664) ([ad51305](ad51305)) * **ModelSwitchPanel**: Migrate from Popover to DropdownMenu with virtual scrolling, closes [lobehub#11663](https://github.com/jaworldwideorg/OneJA-Bot/issues/11663) ([c9d9dff](c9d9dff)) * **userMemories**: Removed un-used code, closes [lobehub#11713](https://github.com/jaworldwideorg/OneJA-Bot/issues/11713) ([89750fc](89750fc)) * **misc**: Improve memory data with experience and identity, closes [lobehub#11717](https://github.com/jaworldwideorg/OneJA-Bot/issues/11717) ([bdb3eb4](bdb3eb4)) * **misc**: Move vercel-react-best-practices skills to .agents directory, closes [lobehub#11703](https://github.com/jaworldwideorg/OneJA-Bot/issues/11703) ([6df7731](6df7731)) #### What's improved * **database**: Added user memory activity, closes [lobehub#11680](https://github.com/jaworldwideorg/OneJA-Bot/issues/11680) ([0160fbd](0160fbd)) * **desktop**: Add legacy local database detection and migration guidance, closes [lobehub#11682](https://github.com/jaworldwideorg/OneJA-Bot/issues/11682) ([5664b84](5664b84)) * **misc**: Add platform-aware download client menu option, closes [lobehub#11676](https://github.com/jaworldwideorg/OneJA-Bot/issues/11676) ([55abddc](55abddc)) * **misc**: Add server version check for desktop app, closes [lobehub#11710](https://github.com/jaworldwideorg/OneJA-Bot/issues/11710) ([0cf2723](0cf2723)) * **misc**: Remove Clerk authentication code, closes [lobehub#11711](https://github.com/jaworldwideorg/OneJA-Bot/issues/11711) ([395595a](395595a)) * **misc**: Skill setting page and skill store, closes [lobehub#11665](https://github.com/jaworldwideorg/OneJA-Bot/issues/11665) ([d8c0c26](d8c0c26)) * **misc**: Support agent group unpublish agents, closes [lobehub#11687](https://github.com/jaworldwideorg/OneJA-Bot/issues/11687) ([4e060be](4e060be)) * **misc**: Support client tasks mode, closes [lobehub#11666](https://github.com/jaworldwideorg/OneJA-Bot/issues/11666) ([98cf57b](98cf57b)) * **misc**: Update the sandbox preinstall libs in sys role, closes [lobehub#11688](https://github.com/jaworldwideorg/OneJA-Bot/issues/11688) ([404c577](404c577)) #### What's fixed * **copilot**: Pass correct scope when creating new session in PageEditor, closes [lobehub#11714](https://github.com/jaworldwideorg/OneJA-Bot/issues/11714) ([0259270](0259270)) * **desktop**: Gracefully handle missing update manifest 404 errors, closes [lobehub#11625](https://github.com/jaworldwideorg/OneJA-Bot/issues/11625) ([13e95b9](13e95b9)) * **model-runtime**: Filter unsupported image types (SVG) before sending to vision models, closes [lobehub#11698](https://github.com/jaworldwideorg/OneJA-Bot/issues/11698) ([c0c99a7](c0c99a7)) * **pdf**: Upgrade pdfjs-dist and react-pdf to v5.x, closes [lobehub#11686](https://github.com/jaworldwideorg/OneJA-Bot/issues/11686) ([2b620df](2b620df)) * **sidebar-drawer**: Fix drawer positioning and title style, closes [lobehub#11655](https://github.com/jaworldwideorg/OneJA-Bot/issues/11655) ([cf5320e](cf5320e)) * **misc**: Fix group broadcast trigger tool use, closes [lobehub#11646](https://github.com/jaworldwideorg/OneJA-Bot/issues/11646) ([831a9b3](831a9b3)) * **misc**: Fix local system tools, closes [lobehub#11702](https://github.com/jaworldwideorg/OneJA-Bot/issues/11702) ([6548fc7](6548fc7)) * **misc**: Fix memory schema, closes [lobehub#11645](https://github.com/jaworldwideorg/OneJA-Bot/issues/11645) ([3baf780](3baf780)) * **misc**: Fix multi agent tasks issue, closes [lobehub#11672](https://github.com/jaworldwideorg/OneJA-Bot/issues/11672) ([9de773b](9de773b)) * **misc**: Fix multi tasks no summary issue, closes [lobehub#11685](https://github.com/jaworldwideorg/OneJA-Bot/issues/11685) ([26ce317](26ce317)) * **misc**: Fix scope issue, closes [lobehub#11719](https://github.com/jaworldwideorg/OneJA-Bot/issues/11719) ([17adde8](17adde8)) * **misc**: Fix tool argument scape and improve multi task run, closes [lobehub#11691](https://github.com/jaworldwideorg/OneJA-Bot/issues/11691) ([b13bb8a](b13bb8a)) * **misc**: Fixed the sandbox tools call when error should use right callback, closes [lobehub#11721](https://github.com/jaworldwideorg/OneJA-Bot/issues/11721) ([e8fce68](e8fce68)) * **misc**: Improve e2e server and complete i18n resources, closes [lobehub#11678](https://github.com/jaworldwideorg/OneJA-Bot/issues/11678) ([d450dd9](d450dd9)) * **misc**: Slove the agent group editor not focus in editdata area, closes [lobehub#11677](https://github.com/jaworldwideorg/OneJA-Bot/issues/11677) ([9ac84e6](9ac84e6)) * **misc**: Slove the agents header switch agents the lobeAI not show problem, closes [lobehub#11726](https://github.com/jaworldwideorg/OneJA-Bot/issues/11726) ([f45f508](f45f508)) * **misc**: Sloved the old removeSessionTopics not work, closes [lobehub#11671](https://github.com/jaworldwideorg/OneJA-Bot/issues/11671) ([06d41e5](06d41e5)) * **misc**: TypewriterEffect not refreshing on language change, closes [lobehub#11657](https://github.com/jaworldwideorg/OneJA-Bot/issues/11657) ([ba30f46](ba30f46)) * **misc**: Updata cron job ui & fixed commnuity pagenation goto error, closes [lobehub#11700](https://github.com/jaworldwideorg/OneJA-Bot/issues/11700) ([42ad2a0](42ad2a0)) * **misc**: Update the agentbuilder tools not always use humanIntervention, closes [lobehub#11696](https://github.com/jaworldwideorg/OneJA-Bot/issues/11696) ([0d3017b](0d3017b)) #### Styles * **misc**: Improve auto scroll and group profile, closes [lobehub#11725](https://github.com/jaworldwideorg/OneJA-Bot/issues/11725) ([550acc2](550acc2)) * **misc**: Update og, closes [lobehub#11709](https://github.com/jaworldwideorg/OneJA-Bot/issues/11709) ([01cf4e4](01cf4e4)) * **misc**: Update share style, closes [lobehub#11716](https://github.com/jaworldwideorg/OneJA-Bot/issues/11716) ([3c70dfa](3c70dfa)) </details> <div align="right"> [](#readme-top) </div>
π» Change Type
π Related Issue
#11711
Resolves LOBE-2658
π Description of Change
Upgrade PDF dependencies:
pdfjs-dist: 4.x β 5.4.530react-pdf: 9.x β 10.3.0Fix PDF worker loading: Changed from CDN URL to
import.meta.urlpattern for better reliability and offline supportAdd required dependency:
@napi-rs/canvasfor@react-pdf/rendererCode cleanup:
ResouceManagerModeβResourceManagerModedefine-config.tsby removing unusedisDesktoplogicπ§ͺ How to Test
π Additional Information
The new PDF worker loading method uses webpack's
import.meta.urlto resolve the worker path at build time, which is more reliable than fetching from a CDN.Summary by Sourcery
Upgrade PDF rendering stack and clean up related configuration and resource manager code.
Bug Fixes:
Enhancements:
Build:
Chores: