Skip to content

Commit e298cb4

Browse files
russellwheatleyrussellwheatley
authored
fix(database, web): clean up stream handlers on "hot restart" (#12915)
1 parent 5d5ffa3 commit e298cb4

File tree

5 files changed

+131
-54
lines changed

5 files changed

+131
-54
lines changed

‎packages/firebase_database/firebase_database_web/lib/firebase_database_web.dart‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,13 @@ library firebase_database_web;
66

77
import 'dart:async';
88
import 'dart:js_interop';
9-
9+
import 'package:collection/collection.dart';
1010
import 'package:firebase_core/firebase_core.dart';
1111
import 'package:firebase_core_web/firebase_core_web.dart';
1212
import 'package:firebase_core_web/firebase_core_web_interop.dart'
1313
as core_interop;
1414
import 'package:firebase_database_platform_interface/firebase_database_platform_interface.dart';
15+
import 'package:flutter/foundation.dart';
1516
import 'package:flutter_web_plugins/flutter_web_plugins.dart';
1617

1718
import 'src/interop/database.dart' as database_interop;

‎packages/firebase_database/firebase_database_web/lib/src/interop/database.dart‎

Lines changed: 75 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -251,37 +251,64 @@ class Query<T extends database_interop.QueryJsImpl> extends JsObjectWrapper<T> {
251251
/// DatabaseReference to the Query's location.
252252
DatabaseReference get ref => DatabaseReference.getInstance(jsObject.ref);
253253

254-
late final Stream<QueryEvent> _onValue = _createStream('value');
254+
Stream<QueryEvent> _onValue(String appName, int hashCode) => _createStream(
255+
'value',
256+
appName,
257+
hashCode,
258+
);
255259

256260
/// Stream for a value event. Event is triggered once with the initial
257261
/// data stored at location, and then again each time the data changes.
258-
Stream<QueryEvent> get onValue => _onValue;
259-
260-
late final Stream<QueryEvent> _onChildAdded = _createStream('child_added');
262+
Stream<QueryEvent> onValue(String appName, int hashCode) =>
263+
_onValue(appName, hashCode);
264+
265+
Stream<QueryEvent> _onChildAdded(String appName, int hashCode) =>
266+
_createStream(
267+
'child_added',
268+
appName,
269+
hashCode,
270+
);
261271

262272
/// Stream for a child_added event. Event is triggered once for each
263273
/// initial child at location, and then again every time a new child is added.
264-
Stream<QueryEvent> get onChildAdded => _onChildAdded;
265-
266-
late final Stream<QueryEvent> _onChildRemoved =
267-
_createStream('child_removed');
274+
Stream<QueryEvent> onChildAdded(String appName, int hashCode) =>
275+
_onChildAdded(appName, hashCode);
276+
277+
Stream<QueryEvent> _onChildRemoved(String appName, int hashCode) =>
278+
_createStream(
279+
'child_removed',
280+
appName,
281+
hashCode,
282+
);
268283

269284
/// Stream for a child_removed event. Event is triggered once every time
270285
/// a child is removed.
271-
Stream<QueryEvent> get onChildRemoved => _onChildRemoved;
272-
273-
late final Stream<QueryEvent> _onChildChanged =
274-
_createStream('child_changed');
286+
Stream<QueryEvent> onChildRemoved(String appName, int hashCode) =>
287+
_onChildRemoved(appName, hashCode);
288+
289+
Stream<QueryEvent> _onChildChanged(String appName, int hashCode) =>
290+
_createStream(
291+
'child_changed',
292+
appName,
293+
hashCode,
294+
);
275295

276296
/// Stream for a child_changed event. Event is triggered when the data
277297
/// stored in a child (or any of its descendants) changes.
278298
/// Single child_changed event may represent multiple changes to the child.
279-
Stream<QueryEvent> get onChildChanged => _onChildChanged;
280-
late final Stream<QueryEvent> _onChildMoved = _createStream('child_moved');
299+
Stream<QueryEvent> onChildChanged(String appName, int hashCode) =>
300+
_onChildChanged(appName, hashCode);
301+
Stream<QueryEvent> _onChildMoved(String appName, int hashCode) =>
302+
_createStream(
303+
'child_moved',
304+
appName,
305+
hashCode,
306+
);
281307

282308
/// Stream for a child_moved event. Event is triggered when a child's priority
283309
/// changes such that its position relative to its siblings changes.
284-
Stream<QueryEvent> get onChildMoved => _onChildMoved;
310+
Stream<QueryEvent> onChildMoved(String appName, int hashCode) =>
311+
_onChildMoved(appName, hashCode);
285312

286313
/// Creates a new Query from a [jsObject].
287314
Query.fromJsObject(T jsObject) : super.fromJsObject(jsObject);
@@ -377,66 +404,86 @@ class Query<T extends database_interop.QueryJsImpl> extends JsObjectWrapper<T> {
377404
);
378405
}
379406

380-
Stream<QueryEvent> _createStream(String eventType) {
381-
late StreamController<QueryEvent> streamController;
407+
String _streamWindowsKey(String appName, String eventType, int hashCode) =>
408+
'flutterfire-${appName}_${eventType}_${hashCode}_snapshot';
382409

410+
Stream<QueryEvent> _createStream(
411+
String eventType,
412+
String appName,
413+
int hashCode,
414+
) {
415+
late StreamController<QueryEvent> streamController;
416+
unsubscribeWindowsListener(_streamWindowsKey(appName, eventType, hashCode));
383417
final callbackWrap = ((
384418
database_interop.DataSnapshotJsImpl data, [
385-
String? string,
419+
String? prevChild,
386420
]) {
387-
streamController.add(QueryEvent(DataSnapshot.getInstance(data), string));
421+
streamController
422+
.add(QueryEvent(DataSnapshot.getInstance(data), prevChild));
388423
});
389424

390425
final void Function(JSObject) cancelCallbackWrap = ((JSObject error) {
391426
streamController.addError(convertFirebaseDatabaseException(error));
392-
streamController.close();
393427
});
394428

429+
late JSFunction onUnsubscribe;
430+
395431
void startListen() {
396432
if (eventType == 'child_added') {
397-
database_interop.onChildAdded(
433+
onUnsubscribe = database_interop.onChildAdded(
398434
jsObject,
399435
callbackWrap.toJS,
400436
cancelCallbackWrap.toJS,
401437
);
402438
}
403439
if (eventType == 'value') {
404-
database_interop.onValue(
440+
onUnsubscribe = database_interop.onValue(
405441
jsObject,
406442
callbackWrap.toJS,
407443
cancelCallbackWrap.toJS,
408444
);
409445
}
410446
if (eventType == 'child_removed') {
411-
database_interop.onChildRemoved(
447+
onUnsubscribe = database_interop.onChildRemoved(
412448
jsObject,
413449
callbackWrap.toJS,
414450
cancelCallbackWrap.toJS,
415451
);
416452
}
417453
if (eventType == 'child_changed') {
418-
database_interop.onChildChanged(
454+
onUnsubscribe = database_interop.onChildChanged(
419455
jsObject,
420456
callbackWrap.toJS,
421457
cancelCallbackWrap.toJS,
422458
);
423459
}
424460
if (eventType == 'child_moved') {
425-
database_interop.onChildMoved(
461+
onUnsubscribe = database_interop.onChildMoved(
426462
jsObject,
427463
callbackWrap.toJS,
428464
cancelCallbackWrap.toJS,
429465
);
430466
}
467+
setWindowsListener(
468+
_streamWindowsKey(appName, eventType, hashCode),
469+
onUnsubscribe,
470+
);
431471
}
432472

433473
void stopListen() {
434-
database_interop.off(jsObject, eventType.toJS, callbackWrap.toJS);
474+
onUnsubscribe.callAsFunction();
475+
streamController.close();
476+
removeWindowsListener(_streamWindowsKey(
477+
appName,
478+
eventType,
479+
hashCode,
480+
));
435481
}
436482

437483
streamController = StreamController<QueryEvent>.broadcast(
438484
onListen: startListen,
439485
onCancel: stopListen,
486+
sync: true,
440487
);
441488
return streamController.stream;
442489
}
@@ -447,8 +494,8 @@ class Query<T extends database_interop.QueryJsImpl> extends JsObjectWrapper<T> {
447494

448495
database_interop.onValue(
449496
jsObject,
450-
((database_interop.DataSnapshotJsImpl snapshot, [String? string]) {
451-
c.complete(QueryEvent(DataSnapshot.getInstance(snapshot), string));
497+
((database_interop.DataSnapshotJsImpl snapshot, [String? prevChild]) {
498+
c.complete(QueryEvent(DataSnapshot.getInstance(snapshot), prevChild));
452499
}).toJS,
453500
((JSAny error) {
454501
c.completeError(convertFirebaseDatabaseException(error));

‎packages/firebase_database/firebase_database_web/lib/src/interop/database_interop.dart‎

Lines changed: 13 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -70,16 +70,7 @@ external JSAny increment(JSNumber delta);
7070

7171
@JS()
7272
@staticInterop
73-
external void off([
74-
QueryJsImpl query,
75-
JSString eventType,
76-
JSFunction callback,
77-
/*JSAny Function(DataSnapshotJsImpl, [JSString previousChildName]) callback*/
78-
]);
79-
80-
@JS()
81-
@staticInterop
82-
external QueryConstraintJsImpl onChildAdded(
73+
external JSFunction onChildAdded(
8374
QueryJsImpl query,
8475
JSFunction callback,
8576
// JSAny Function(DataSnapshotJsImpl, [JSString previousChildName]) callback,
@@ -89,7 +80,7 @@ external QueryConstraintJsImpl onChildAdded(
8980

9081
@JS()
9182
@staticInterop
92-
external QueryConstraintJsImpl onChildChanged(
83+
external JSFunction onChildChanged(
9384
QueryJsImpl query,
9485
JSFunction callback,
9586
// JSAny Function(DataSnapshotJsImpl, [JSString previousChildName]) callback,
@@ -99,7 +90,7 @@ external QueryConstraintJsImpl onChildChanged(
9990

10091
@JS()
10192
@staticInterop
102-
external QueryConstraintJsImpl onChildMoved(
93+
external JSFunction onChildMoved(
10394
QueryJsImpl query,
10495
JSFunction callback,
10596
// JSAny Function(DataSnapshotJsImpl, [JSString previousChildName]) callback,
@@ -109,7 +100,7 @@ external QueryConstraintJsImpl onChildMoved(
109100

110101
@JS()
111102
@staticInterop
112-
external QueryConstraintJsImpl onChildRemoved(
103+
external JSFunction onChildRemoved(
113104
QueryJsImpl query,
114105
JSFunction callback,
115106
// JSAny Function(DataSnapshotJsImpl, [JSString previousChildName]) callback,
@@ -123,13 +114,15 @@ external OnDisconnectJsImpl onDisconnect(ReferenceJsImpl ref);
123114

124115
@JS()
125116
@staticInterop
126-
external void onValue(
127-
QueryJsImpl query,
128-
JSFunction callback,
129-
// JSAny Function(DataSnapshotJsImpl, [JSString previousChildName]) callback,
130-
JSFunction cancelCallback,
131-
// JSAny Function(FirebaseError error) cancelCallback,
132-
[ListenOptions options]);
117+
external JSFunction onValue(
118+
QueryJsImpl query,
119+
JSFunction callback,
120+
// JSAny Function(DataSnapshotJsImpl, [JSString previousChildName]) callback,
121+
JSFunction cancelCallback,
122+
// JSAny Function(FirebaseError error) cancelCallback,
123+
[
124+
ListenOptions options,
125+
]);
133126

134127
@JS()
135128
@staticInterop

‎packages/firebase_database/firebase_database_web/lib/src/query_web.dart‎

Lines changed: 40 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -94,29 +94,64 @@ class QueryWeb extends QueryPlatform {
9494
QueryModifiers modifiers, DatabaseEventType eventType) {
9595
database_interop.Query instance = _getQueryDelegateInstance(modifiers);
9696

97+
int hashCode = 0;
98+
final appName =
99+
_database.app != null ? _database.app!.name : Firebase.app().name;
100+
if (kDebugMode) {
101+
// Purely for unsubscribing purposes in debug mode on "hot restart"
102+
// if not running in debug mode, hashCode won't be used
103+
hashCode = Object.hashAll([
104+
appName,
105+
path,
106+
...modifiers
107+
.toList()
108+
.map((e) => const DeepCollectionEquality().hash(e))
109+
.toList(),
110+
eventType.index,
111+
]);
112+
}
113+
97114
switch (eventType) {
98115
case DatabaseEventType.childAdded:
99116
return _webStreamToPlatformStream(
100117
eventType,
101-
instance.onChildAdded,
118+
instance.onChildAdded(
119+
appName,
120+
hashCode,
121+
),
102122
);
103123
case DatabaseEventType.childChanged:
104124
return _webStreamToPlatformStream(
105125
eventType,
106-
instance.onChildChanged,
126+
instance.onChildChanged(
127+
appName,
128+
hashCode,
129+
),
107130
);
108131
case DatabaseEventType.childMoved:
109132
return _webStreamToPlatformStream(
110133
eventType,
111-
instance.onChildMoved,
134+
instance.onChildMoved(
135+
appName,
136+
hashCode,
137+
),
112138
);
113139
case DatabaseEventType.childRemoved:
114140
return _webStreamToPlatformStream(
115141
eventType,
116-
instance.onChildRemoved,
142+
instance.onChildRemoved(
143+
appName,
144+
hashCode,
145+
),
117146
);
118147
case DatabaseEventType.value:
119-
return _webStreamToPlatformStream(eventType, instance.onValue);
148+
return _webStreamToPlatformStream(
149+
eventType,
150+
instance.onValue(
151+
appName,
152+
hashCode,
153+
),
154+
);
120155
default:
121156
throw Exception("Invalid event type: $eventType");
122157
}

‎packages/firebase_database/firebase_database_web/pubspec.yaml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ environment:
88
flutter: '>=3.3.0'
99

1010
dependencies:
11+
collection: ^1.18.0
1112
firebase_core: ^3.0.0
1213
firebase_core_web: ^2.17.1
1314
firebase_database_platform_interface: ^0.2.5+36

0 commit comments

Comments
 (0)