refactor: use Vite official API for building sw.js #20894

vursen · 2025-01-22T14:50:39Z

Description

Updates the service worker plugin to use the Vite official API for building sw.js.

Fixes #20808

Type of change

Bugfix

github-actions · 2025-01-22T15:06:16Z

Test Results

1 165 files ± 0 1 165 suites ±0 1h 27m 29s ⏱️ - 7m 45s
7 625 tests ± 0 7 569 ✅ ± 0 56 💤 ±0 0 ❌ ±0
7 863 runs - 21 7 798 ✅ - 20 65 💤 - 1 0 ❌ ±0

Results for commit 860b5e2. ± Comparison against base commit 711a36c.

♻️ This comment has been updated with latest results.

Artur-

Seems to produce the same output as before with only some variable rename changed and umd headers. Using umd is a bit odd but apparently it is what you need to use..

vursen · 2025-01-23T14:20:49Z

We can use 'es', but that prevents whitespace minification. However, this is probably not a big issue since sw.js should be primarily distributed in gzipped format.

flow-server/src/main/resources/vite.generated.ts

vursen · 2025-01-23T15:14:30Z

flow-server/src/main/resources/vite.generated.ts

@@ -106,7 +106,7 @@ function injectManifestToSWPlugin(): rollup.Plugin {
        const { manifestEntries } = await getManifest({
          globDirectory: buildOutputFolder,
          globPatterns: ['**/*'],
-          globIgnores: ['**/*.br', 'pwa-icons/**'],
+          globIgnores: ['**/*.br', 'pwa-icons/**', 'sw.js'],


note: Added this line to prevent sw.js from being included in the manifest when the production bundle is built after the development bundle. Previously, this didn't happen because sw.js existed only virtually in dev mode.

If sw.js is now written to the file system, does it reintroduce

[Vite] A server restart occurs on every successful service worker build #13123?

Oh, just confirmed that it does. Thanks for noting this.

PR with a fix: #20909

vursen · 2025-01-23T15:28:27Z

flow-server/src/main/resources/vite.generated.ts

+            output: {
+              exports: 'none',
+              entryFileNames: 'sw.js',
+              inlineDynamicImports: true,


note: This option is untested, but that can be addressed separately since it's coming from the previous config.

vursen · 2025-01-23T15:28:33Z

flow-server/src/main/resources/vite.generated.ts

+              sw: settings.clientServiceWorkerSource
+            },
+            output: {
+              exports: 'none',


note: This option is untested, but that can be addressed separately since it's coming from the previous config.

vursen · 2025-01-24T05:37:04Z

Seems to produce the same output as before with only some variable rename changed and umd headers.

I've happened to find a different approach that avoids umd and preserves minification. The PR uses it now.

sonarqubecloud · 2025-01-24T07:27:13Z

Quality Gate passed

Issues
1428 New issues
9 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

* fix: fix service worker build * fix PwaTestIT * exclude sw.js from manifest * generate service worker at closeBundle stage * clean up service worker build config * generate service worker at different stages depending on mode * do not use lib mode to allow for minification in es format * clean up plugin code * add inlineDynamicImports: true option * revert some changes to minimize diff * add exports option for backward compatibility --------- Co-authored-by: Teppo Kurki <[email protected]>

vaadin-bot · 2025-01-24T12:09:32Z

Hi @vursen and @tepi, when i performed cherry-pick to this commit to 24.5, i have encountered the following issue. Can you take a look and pick it manually?
Error Message:
Error: Command failed: git cherry-pick 9f4eceb
error: could not apply 9f4eceb... refactor: use Vite official API for building sw.js (#20894)
hint: After resolving the conflicts, mark them with
hint: "git add/rm ", then run
hint: "git cherry-pick --continue".
hint: You can instead skip this commit with "git cherry-pick --skip".
hint: To abort and get back to the state before "git cherry-pick",
hint: run "git cherry-pick --abort".

* fix: fix service worker build * fix PwaTestIT * exclude sw.js from manifest * generate service worker at closeBundle stage * clean up service worker build config * generate service worker at different stages depending on mode * do not use lib mode to allow for minification in es format * clean up plugin code * add inlineDynamicImports: true option * revert some changes to minimize diff * add exports option for backward compatibility --------- Co-authored-by: Sergey Vinogradov <[email protected]> Co-authored-by: Teppo Kurki <[email protected]>

* fix: fix service worker build * fix PwaTestIT * exclude sw.js from manifest * generate service worker at closeBundle stage * clean up service worker build config * generate service worker at different stages depending on mode * do not use lib mode to allow for minification in es format * clean up plugin code * add inlineDynamicImports: true option * revert some changes to minimize diff * add exports option for backward compatibility --------- Co-authored-by: Teppo Kurki <[email protected]>

#20916) * refactor: use Vite official API for building sw.js (#20894) * fix: fix service worker build * fix PwaTestIT * exclude sw.js from manifest * generate service worker at closeBundle stage * clean up service worker build config * generate service worker at different stages depending on mode * do not use lib mode to allow for minification in es format * clean up plugin code * add inlineDynamicImports: true option * revert some changes to minimize diff * add exports option for backward compatibility --------- Co-authored-by: Teppo Kurki <[email protected]> * Update vite.generated.ts --------- Co-authored-by: Sergey Vinogradov <[email protected]>

vaadin-bot · 2025-01-27T13:27:16Z

This ticket/PR has been released with Vaadin 24.7.0.alpha6 and is also targeting the upcoming stable 24.7.0 version.

vaadin-bot added the +1.0.0 label Jan 22, 2025

vursen force-pushed the fix-service-worker-build branch from 40db9a5 to 0776317 Compare January 22, 2025 15:51

vursen changed the title ~~fix: fix service worker build~~ fix: use Vite official API for building sw.js Jan 23, 2025

vursen force-pushed the fix-service-worker-build branch from 1fb1442 to 574ba0c Compare January 23, 2025 10:51

vursen changed the base branch from Artur--patch-14 to main January 23, 2025 10:51

vaadin-bot added +0.0.1 and removed +1.0.0 labels Jan 23, 2025

vursen added 6 commits January 23, 2025 14:59

fix: fix service worker build

4687227

fix PwaTestIT

2e72c30

exclude sw.js from manifest

94b5a42

generate service worker at closeBundle stage

c568ab3

clean up service worker build config

0bcc85c

generate service worker at different stages depending on mode

f2882af

vursen force-pushed the fix-service-worker-build branch from 574ba0c to f2882af Compare January 23, 2025 11:00

vursen marked this pull request as ready for review January 23, 2025 13:09

vursen changed the title ~~fix: use Vite official API for building sw.js~~ refactor: use Vite official API for building sw.js Jan 23, 2025

vursen requested review from Artur- and tepi January 23, 2025 13:11

Artur- previously approved these changes Jan 23, 2025

View reviewed changes

vursen commented Jan 23, 2025

View reviewed changes

flow-server/src/main/resources/vite.generated.ts Outdated Show resolved Hide resolved

do not use lib mode to allow for minification in es format

bef6e12

vursen dismissed Artur-’s stale review via bef6e12 January 23, 2025 14:41

vursen added 2 commits January 23, 2025 18:56

clean up plugin code

9406727

add inlineDynamicImports: true option

dbbda36

vursen force-pushed the fix-service-worker-build branch from be63677 to 86ade55 Compare January 23, 2025 15:10

revert some changes to minimize diff

cd1eb06

vursen force-pushed the fix-service-worker-build branch from 86ade55 to cd1eb06 Compare January 23, 2025 15:11

vursen commented Jan 23, 2025

View reviewed changes

add exports option for backward compatibility

2ab63d1

vursen commented Jan 23, 2025

View reviewed changes

Merge branch 'main' into fix-service-worker-build

860b5e2

Artur- approved these changes Jan 24, 2025

View reviewed changes

tepi merged commit 9f4eceb into main Jan 24, 2025
26 checks passed

tepi deleted the fix-service-worker-build branch January 24, 2025 10:55

vursen mentioned this pull request Jan 24, 2025

fix: build service worker without writing it to FS #20909

Merged

1 task

Artur- added target/24.5 target/24.6 labels Jan 24, 2025

vaadin-bot added the cherry-picked-24.6 label Jan 24, 2025

vaadin-bot added the need to pick manually 24.5 label Jan 24, 2025

vaadin-bot added prerelease version for Vaadin 24.7.0 Released with Vaadin 24.7.0.alpha6 labels Jan 27, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor: use Vite official API for building sw.js #20894

refactor: use Vite official API for building sw.js #20894

vursen commented Jan 22, 2025 •

edited

Loading

github-actions bot commented Jan 22, 2025 •

edited

Loading

Artur- left a comment

vursen commented Jan 23, 2025 •

edited

Loading

vursen Jan 23, 2025 •

edited

Loading

Artur- Jan 24, 2025

vursen Jan 24, 2025 •

edited

Loading

vursen Jan 24, 2025

vursen Jan 23, 2025 •

edited

Loading

vursen Jan 23, 2025 •

edited

Loading

vursen commented Jan 24, 2025 •

edited

Loading

sonarqubecloud bot commented Jan 24, 2025

vaadin-bot commented Jan 24, 2025

vaadin-bot commented Jan 27, 2025

refactor: use Vite official API for building sw.js #20894

refactor: use Vite official API for building sw.js #20894

Conversation

vursen commented Jan 22, 2025 • edited Loading

Description

Type of change

github-actions bot commented Jan 22, 2025 • edited Loading

Test Results

Artur- left a comment

Choose a reason for hiding this comment

vursen commented Jan 23, 2025 • edited Loading

vursen Jan 23, 2025 • edited Loading

Choose a reason for hiding this comment

Artur- Jan 24, 2025

Choose a reason for hiding this comment

vursen Jan 24, 2025 • edited Loading

Choose a reason for hiding this comment

vursen Jan 24, 2025

Choose a reason for hiding this comment

vursen Jan 23, 2025 • edited Loading

Choose a reason for hiding this comment

vursen Jan 23, 2025 • edited Loading

Choose a reason for hiding this comment

vursen commented Jan 24, 2025 • edited Loading

sonarqubecloud bot commented Jan 24, 2025

Quality Gate passed

vaadin-bot commented Jan 24, 2025

vaadin-bot commented Jan 27, 2025

vursen commented Jan 22, 2025 •

edited

Loading

github-actions bot commented Jan 22, 2025 •

edited

Loading

vursen commented Jan 23, 2025 •

edited

Loading

vursen Jan 23, 2025 •

edited

Loading

vursen Jan 24, 2025 •

edited

Loading

vursen Jan 23, 2025 •

edited

Loading

vursen Jan 23, 2025 •

edited

Loading

vursen commented Jan 24, 2025 •

edited

Loading