Service worker removal by salemiranloye · Pull Request #170918 · flutter/flutter

salemiranloye · 2025-06-20T16:03:21Z

Creating a service worker to remove the old cached service worker then unregister itself since flutters service worker is not being maintained so now it is being deprecated

Related Issue: #156910 (comment)

If you had to change anything in the flutter/tests repo, include a link to the migration guide as per the breaking change policy.

Pre-launch Checklist

I read the Contributor Guide and followed the process outlined there for submitting PRs.
I read the Tree Hygiene wiki page, which explains my responsibilities.
I read and followed the Flutter Style Guide, including Features we expect every widget to implement.
I signed the CLA.
I listed at least one issue that this PR fixes in the description above.
I updated/added relevant documentation (doc comments with ///).
I added new tests to check the change I am making, or this PR is test-exempt.
I followed the breaking change policy and added Data Driven Fixes where supported.
All existing and new tests are passing.

If you need help, consider asking for advice on the #hackers-new channel on Discord.

salemiranloye · 2025-06-20T16:04:23Z

@ditman

bkonyi

Drive by review.

bkonyi · 2025-06-23T14:38:41Z

    });
  }
-}
+}


These .js files need a trailing newline at the end of the file.

bkonyi · 2025-06-23T14:44:00Z

+
+    print('Waiting for cleanup worker to execute...');
+    // The cleanup worker will force another reload. We wait for it to settle.
+    await Future<void>.delayed(const Duration(seconds: 5));


Is there any other way to wait for the page to settle (e.g., a log message)? This is a rather long delay and we try to avoid using timers in tests as they can result in flaky behavior.

I shortened it to 100 milliseconds. Here is the pr: #173609. Did you have another idea in mind?

bkonyi · 2025-06-23T14:45:09Z

+    );
+  } finally {
+    await server?.stop();
+    if (await cleanupWorkerFile.exists()) {


Nit: use the *Sync() file system APIs if you're only performing individual file operations. The asynchronous versions are actually slower unless you're doing a lot of operations in parallel.

bkonyi · 2025-06-23T14:45:54Z

  ]);
 }

-/// A drop-in replacement for `package:test` expect that can run outside the


I think this comment is still valid.

Added it back

bkonyi · 2025-06-23T14:46:30Z

  foundError(<String>[buffer.toString(), StackTrace.current.toString()]);
 }

-/// Returns a pretty-printed representation of [value].


These docs are still valid (_prettyPrint and _indent).

Kept these in

mdebbar

This test is failing and needs to be updated (or deleted):

flutter/packages/flutter_tools/test/general.shard/build_system/targets/web_test.dart

Lines 1371 to 1380 in 4fb1042

    
           // Contains the same file hash for both `/` and the root index.html file. 
        
           const String rootIndexHash = 'd41d8cd98f00b204e9800998ecf8427e'; 
        
           expect( 
        
             environment.outputDir.childFile('flutter_service_worker.js').readAsStringSync(), 
        
             contains('"/": "$rootIndexHash"'), 
        
           ); 
        
           expect( 
        
             environment.outputDir.childFile('flutter_service_worker.js').readAsStringSync(), 
        
             contains('"index.html": "$rootIndexHash"'), 
        
           );

mdebbar · 2025-06-23T19:11:27Z

-   * @returns {Promise<ServiceWorker>}
+   * This method is no longer called by loadServiceWorker.
   */
  async _getNewServiceWorker(serviceWorkerRegistration, serviceWorkerVersion) {


This function isn't used anymore. Can we delete it?

mdebbar · 2025-06-23T19:11:34Z

-   * @returns {Promise<void>}
-   */
+
  async _waitForServiceWorkerActivation(serviceWorker) {


mdebbar · 2025-06-23T19:15:41Z

+        const deletePromises = OLD_CACHE_NAMES.map((key) => self.caches.delete(key));
+        await Promise.all(deletePromises);
+      } catch (e) {
+        console.warn('Failed to delete old caches:', e);


Suggested change

console.warn('Failed to delete old caches:', e);

console.warn('Failed to delete old service worker caches:', e);

done! thank you!

mdebbar · 2025-06-23T19:17:10Z

-    })
+        }
+      } catch (e) {
+        console.warn('Failed to navigate clients:', e);


Suggested change

console.warn('Failed to navigate clients:', e);

console.warn('Failed to navigate service worker clients:', e);

done thank you!

mdebbar · 2025-06-23T19:50:18Z

+
+        for (const client of clients) {
+          if (client.url && 'navigate' in client) {
+            client.navigate(client.url);


I don't really understand what this does. Could you please explain what this does?

mdebbar · 2025-06-23T19:51:47Z

-      () => runWebServiceWorkerTestWithGeneratedEntrypoint(headless: true),
-      () => runWebServiceWorkerTestWithBlockedServiceWorkers(headless: true),
-      () => runWebServiceWorkerTestWithCustomServiceWorkerVersion(headless: true),
+      () => runCleanupVerificationTest(headless: true),


Let's spell out "service worker":

Suggested change

() => runCleanupVerificationTest(headless: true),

() => runServiceWorkerCleanupTest(headless: true),

flutter-dashboard · 2025-07-20T14:10:32Z

This pull request executed golden file tests, but it has not been updated in a while (20+ days). Test results from Gold expire after as many days, so this pull request will need to be updated with a fresh commit in order to get results from Gold.

For more guidance, visit Writing a golden file test for package:flutter.

Reviewers: Read the Tree Hygiene page and make sure this patch meets those guidelines before LGTMing.

bkonyi · 2025-07-25T15:43:51Z

Hey @salemiranloye! Is this still something you're planning on landing?

ditman · 2025-07-28T19:05:51Z

@SydneyBao should be working on landing this!

bkonyi · 2025-08-11T14:02:25Z

@mdebbar should we consider this abandoned and close or take some time to clean this up and land it?

SydneyBao · 2025-08-11T18:43:44Z

I was waiting for Salem to push his local changes, but he never did. I will submit a new pr soon. Sorry about the delay.

SydneyBao · 2025-08-12T07:56:50Z

Sorry for the delay. Here is my updated pr: #173609

mdebbar · 2025-08-14T14:34:33Z

Superseded by #173609

Introduce a self-cleaning service worker to replace the old one. Previous attempts (#170918, #173609) had (accidentally?) disabled the loading of the service worker in `flutter.js`. This PR preserves the logic for loading the service worker, and it prints a deprecation warning. Towards #156910 Closes #106225

Introduce a self-cleaning service worker to replace the old one. Previous attempts (flutter#170918, flutter#173609) had (accidentally?) disabled the loading of the service worker in `flutter.js`. This PR preserves the logic for loading the service worker, and it prints a deprecation warning. Towards flutter#156910 Closes flutter#106225

Introduce a self-cleaning service worker to replace the old one. Previous attempts (flutter/flutter#170918, flutter/flutter#173609) had (accidentally?) disabled the loading of the service worker in `flutter.js`. This PR preserves the logic for loading the service worker, and it prints a deprecation warning. Towards flutter/flutter#156910 Closes flutter/flutter#106225

salemiranloye and others added 2 commits June 20, 2025 06:50

Remove service worker and tests

40ce91b

clean up service worker tests

a3aaff8

salemiranloye requested a review from matanlurey as a code owner June 20, 2025 16:03

github-actions Bot added tool Affects the "flutter" command-line tool. See also t: labels. engine flutter/engine related. See also e: labels. platform-web Web applications specifically labels Jun 20, 2025

salemiranloye added 2 commits June 20, 2025 10:14

remove old tests and run sigular test

244a0fa

Formatting

653cce7

bkonyi requested a review from mdebbar June 23, 2025 14:38

bkonyi reviewed Jun 23, 2025

View reviewed changes

matanlurey removed their request for review June 23, 2025 15:55

Remove using wait and use sync

987750f

mdebbar mentioned this pull request Jun 23, 2025

Linux web_long_running_tests_{1,5}_5 are flaky #171025

Closed

mdebbar reviewed Jun 23, 2025

View reviewed changes

bkonyi approved these changes Jun 30, 2025

View reviewed changes

mdebbar mentioned this pull request Aug 7, 2025

Inconsistent behavior of external requests on Flutter for web due to issue in service worker #155451

Open

mdebbar closed this Aug 14, 2025

mdebbar mentioned this pull request Oct 10, 2025

[web] Self-cleaning service worker #176834

Merged

                   });
                 }
-              }
+              }

                
                    No newline at end of file

	// Contains the same file hash for both `/` and the root index.html file.
	const String rootIndexHash = 'd41d8cd98f00b204e9800998ecf8427e';
	expect(
	environment.outputDir.childFile('flutter_service_worker.js').readAsStringSync(),
	contains('"/": "$rootIndexHash"'),
	);
	expect(
	environment.outputDir.childFile('flutter_service_worker.js').readAsStringSync(),
	contains('"index.html": "$rootIndexHash"'),
	);

	console.warn('Failed to delete old caches:', e);
	console.warn('Failed to delete old service worker caches:', e);

	console.warn('Failed to navigate clients:', e);
	console.warn('Failed to navigate service worker clients:', e);

	() => runCleanupVerificationTest(headless: true),
	() => runServiceWorkerCleanupTest(headless: true),

Conversation

salemiranloye commented Jun 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pre-launch Checklist

Uh oh!

salemiranloye commented Jun 20, 2025

Uh oh!

bkonyi left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mdebbar left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

flutter-dashboard Bot commented Jul 20, 2025

Uh oh!

bkonyi commented Jul 25, 2025

Uh oh!

ditman commented Jul 28, 2025

Uh oh!

bkonyi commented Aug 11, 2025

Uh oh!

SydneyBao commented Aug 11, 2025

Uh oh!

SydneyBao commented Aug 12, 2025

Uh oh!

mdebbar commented Aug 14, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

salemiranloye commented Jun 20, 2025 •

edited

Loading