You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
fix(pwa): precache the files of injectManifestConfig.globPatterns - #13019
This never worked: the user globPatterns were ignored, and these files were never available offline.
Since the plugin was created in #2205, the code merged injectManifest.globPatterns (a property of the Workbox injectManifest() function, always undefined) instead of injectManifestConfig.globPatterns. The TypeScript migration in #5941 then hid the type error with // @ts-expect-error: internal API?.
This PR moves the glob patterns to a small getGlobPatterns() function, merging the user option, with unit tests.
PWA builds continue to include common static assets and any configured custom patterns in the precache list. No change to service-worker build behavior.
Tests
Added coverage for the default asset patterns and for appending custom patterns.
The plugin read the globPatterns property of the Workbox injectManifest
function, always undefined, instead of the user option.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
No actionable comments were generated in the recent review.
Walkthrough
The PWA plugin now uses getGlobPatterns to combine built-in static asset patterns with optional configured patterns for injectManifest. Tests cover the built-in patterns and appending a supplied pattern.
Changes: PWA glob pattern configuration
Layer / File(s)
Summary
Build and apply glob patterns packages/docusaurus-plugin-pwa/src/globPatterns.ts, packages/docusaurus-plugin-pwa/src/index.ts, packages/docusaurus-plugin-pwa/src/__tests__/globPatterns.test.ts
getGlobPatterns returns built-in asset patterns and appends configured patterns. The plugin passes its result to injectManifest. Tests check the defaults and a supplied PDF pattern.
This change makes user-configured globPatterns in the PWA plugin take effect for offline precaching, as the documentation describes. No actionable merge risk was found.
Pre-merge checks: 4
Check name
Status
Explanation
Title check
The title names the fix and its scope: the PWA plugin will precache files matched by injectManifestConfig.globPatterns. The raw summary says getGlobPatterns now appends user patterns, and index.ts use…
Linked Issues check
Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check
Check skipped because no linked issues were found for this pull request.
Description Check
Check skipped - CodeRabbit’s high-level summary is enabled.
Full details: Title check
Explanation
The title names the fix and its scope: the PWA plugin will precache files matched by injectManifestConfig.globPatterns. The raw summary says getGlobPatterns now appends user patterns, and index.ts uses it in place of the old inline logic. The objectives say the old code read Workbox's injectManifest.globPatterns, which is always undefined, so the user option was ignored. The title matches the main change and needs no further remediation.
Finishing Touches
Generate unit tests (beta)
Commit to this branch
Create a new PR
Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.
Included review availability: This review used your included allowance. Your plan provides up to 10 included reviews per hour; 7 remain after this review.
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
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.
Motivation
The
injectManifestConfigdocs say that we precache the regular static assets, and that you can add more files withglobPatterns:This never worked: the user
globPatternswere ignored, and these files were never available offline.Since the plugin was created in #2205, the code merged
injectManifest.globPatterns(a property of the WorkboxinjectManifest()function, alwaysundefined) instead ofinjectManifestConfig.globPatterns. The TypeScript migration in #5941 then hid the type error with// @ts-expect-error: internal API?.This PR moves the glob patterns to a small
getGlobPatterns()function, merging the user option, with unit tests.Test Plan
Unit tests for
getGlobPatterns().Test links
Deploy preview: https://deploy-preview-13019--docusaurus-2.netlify.app/
Related issues/PRs
🤖 Generated with Claude Code
Summary by CodeRabbit