Skip to content

Commit 78ca392

Browse files
authored
[flutter_tools] Safely remove web loading indicator on dart-app-ready (flutter#192233)
Fixes flutter#192226 ### Problem In `packages/flutter_tools/lib/src/web/bootstrap.dart`, when compiling the web bootstrap script (`main.dart.js`), an event listener was added to `window` for `dart-app-ready` that executed: ```javascript loader.parentNode.removeChild(loader); ``` On initial load, this removes the loader from the DOM, setting `loader.parentNode` to `null`. When DWDS reconnects or re-dispatches `dart-app-ready` (e.g. following a WebSocket disconnect/reconnect), this listener was invoked again. Attempting to call `.removeChild` on a `null` `parentNode` threw: ``` TypeError: Cannot read properties of null (reading 'removeChild') ``` ### Solution 1. Use `loader.remove()` and `styleSheet.remove()` instead of `parentNode.removeChild()`. 2. Configure the event listener with `{ once: true }` so it is automatically removed after firing once. ### Tests Added regression unit tests to `packages/flutter_tools/test/general.shard/web/bootstrap_test.dart` verifying that `{ once: true }` and `.remove()` are used in generated web bootstrap code.
1 parent 45f4e3d commit 78ca392

2 files changed

Lines changed: 37 additions & 3 deletions

File tree

‎packages/flutter_tools/lib/src/web/bootstrap.dart‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -348,9 +348,9 @@ indeterminate.className = "indeterminate";
348348
loader.appendChild(indeterminate);
349349
350350
document.addEventListener('dart-app-ready', function (e) {
351-
loader.parentNode.removeChild(loader);
352-
styleSheet.parentNode.removeChild(styleSheet);
353-
});
351+
loader.remove();
352+
styleSheet.remove();
353+
}, { once: true });
354354
''';
355355
}
356356

‎packages/flutter_tools/test/general.shard/web/bootstrap_test.dart‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,22 @@ void main() {
5858
expect(result, matches(regex), reason: '.flutter-loader must have overflow: hidden');
5959
});
6060

61+
// https://github.com/flutter/flutter/issues/192226
62+
test('generateBootstrapScript loading indicator listener is removed after first event and safely removes elements', () {
63+
final String result = generateBootstrapScript(
64+
requireUrl: 'require.js',
65+
mapperUrl: 'mapper.js',
66+
generateLoadingIndicator: true,
67+
);
68+
69+
expect(result, contains("document.addEventListener('dart-app-ready', function (e) {"));
70+
expect(result, contains('loader.remove();'));
71+
expect(result, contains('styleSheet.remove();'));
72+
expect(result, contains('}, { once: true });'));
73+
expect(result, isNot(contains('loader.parentNode.removeChild')));
74+
expect(result, isNot(contains('styleSheet.parentNode.removeChild')));
75+
});
76+
6177
// https://github.com/flutter/flutter/issues/82524
6278
test('generateMainModule removes timeout from requireJS', () {
6379
final String result = generateMainModule(
@@ -249,6 +265,24 @@ void main() {
249265
expect(result, matches(regex), reason: '.flutter-loader must have overflow: hidden');
250266
});
251267

268+
// https://github.com/flutter/flutter/issues/192226
269+
test('bootstrap script loading indicator listener is removed after first event and safely removes elements', () {
270+
final String result = generateDDCLibraryBundleBootstrapScript(
271+
entrypoint: 'foo/bar/main.js',
272+
ddcModuleLoaderUrl: 'ddc_module_loader.js',
273+
mapperUrl: 'mapper.js',
274+
generateLoadingIndicator: true,
275+
isWindows: false,
276+
);
277+
278+
expect(result, contains("document.addEventListener('dart-app-ready', function (e) {"));
279+
expect(result, contains('loader.remove();'));
280+
expect(result, contains('styleSheet.remove();'));
281+
expect(result, contains('}, { once: true });'));
282+
expect(result, isNot(contains('loader.parentNode.removeChild')));
283+
expect(result, isNot(contains('styleSheet.parentNode.removeChild')));
284+
});
285+
252286
test('generateDDCLibraryBundleMainModule embeds the entrypoint correctly', () {
253287
final String result = generateDDCLibraryBundleMainModule(
254288
entrypoint: 'main.js',

0 commit comments

Comments
 (0)