Skip to content

Commit 90d83e3

Browse files
author
Jonah Williams
authored
[flutter_tools] register service worker after first frame event (#66082)
Registering the service worker immediately after the documented has loaded may cause SW initialization to compete with framework initialization. It was recommended to us that we defer the service worker setup until after the framework is done with setup, which should be sometime after the first frame. To implement this, I augmented the binding setup to dispatch an event on the document after the binding has initialized. I don't see any obvious risks with this setup. Fixes #66066
1 parent 9bfab77 commit 90d83e3

5 files changed

Lines changed: 50 additions & 3 deletions

File tree

‎dev/integration_tests/flutter_gallery/web/index.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
https://developers.google.com/web/fundamentals/primers/service-workers -->
2525
<script>
2626
if ('serviceWorker' in navigator) {
27-
window.addEventListener('load', function () {
27+
window.addEventListener('flutter-first-frame', function () {
2828
navigator.serviceWorker.register('flutter_service_worker.js');
2929
});
3030
}

‎packages/flutter/lib/src/rendering/binding.dart‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,9 @@ mixin RendererBinding on BindingBase, ServicesBinding, SchedulerBinding, Gesture
4444
assert(renderView != null);
4545
addPersistentFrameCallback(_handlePersistentFrameCallback);
4646
initMouseTracker();
47+
if (kIsWeb) {
48+
addPostFrameCallback(_handleWebFirstFrame);
49+
}
4750
}
4851

4952
/// The current [RendererBinding], if one has been created.
@@ -281,6 +284,12 @@ mixin RendererBinding on BindingBase, ServicesBinding, SchedulerBinding, Gesture
281284
}
282285
}
283286

287+
void _handleWebFirstFrame(Duration _) {
288+
assert(kIsWeb);
289+
const MethodChannel methodChannel = MethodChannel('flutter/service_worker');
290+
methodChannel.invokeMethod<void>('first-frame');
291+
}
292+
284293
void _handleSemanticsAction(int id, SemanticsAction action, ByteData? args) {
285294
_pipelineOwner.semanticsOwner?.performAction(
286295
id,
Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
// Copyright 2014 The Flutter Authors. All rights reserved.
2+
// Use of this source code is governed by a BSD-style license that can be
3+
// found in the LICENSE file.
4+
5+
// @dart = 2.8
6+
7+
import 'dart:async';
8+
9+
import 'package:flutter/foundation.dart';
10+
import 'package:flutter/gestures.dart';
11+
import 'package:flutter/rendering.dart';
12+
import 'package:flutter/scheduler.dart';
13+
import 'package:flutter/services.dart';
14+
15+
import '../flutter_test_alternative.dart';
16+
17+
void main() {
18+
test('Flutter dispatches first frame event on the web only', () async {
19+
final Completer<void> completer = Completer<void>();
20+
final TestRenderBinding binding = TestRenderBinding();
21+
const MethodChannel firstFrameChannel = MethodChannel('flutter/service_worker');
22+
firstFrameChannel.setMockMethodCallHandler((MethodCall methodCall) async {
23+
completer.complete();
24+
});
25+
26+
binding.handleBeginFrame(Duration.zero);
27+
binding.handleDrawFrame();
28+
29+
await expectLater(completer.future, completes);
30+
}, skip: !kIsWeb);
31+
}
32+
33+
class TestRenderBinding extends BindingBase with SchedulerBinding, ServicesBinding, GestureBinding, SemanticsBinding, RendererBinding {
34+
@override
35+
void initInstances() {
36+
super.initInstances();
37+
}
38+
}

‎packages/flutter/test/rendering/mouse_tracking_test_utils.dart‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ class TestMouseTrackerFlutterBinding extends BindingBase
5656
_overridePhase = lastPhase;
5757
}
5858

59-
List<void Function(Duration)> postFrameCallbacks;
59+
List<void Function(Duration)> postFrameCallbacks = <void Function(Duration)>[];
6060

6161
// Proxy post-frame callbacks.
6262
@override

‎packages/flutter_tools/templates/app/web/index.html.tmpl‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
https://developers.google.com/web/fundamentals/primers/service-workers -->
2424
<script>
2525
if ('serviceWorker' in navigator) {
26-
window.addEventListener('load', function () {
26+
window.addEventListener('flutter-first-frame', function () {
2727
navigator.serviceWorker.register('flutter_service_worker.js');
2828
});
2929
}

0 commit comments

Comments
 (0)