Skip to content

Change HMR API to work with several libraries bundled in one module #1765

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Aug 17, 2018
Merged

Change HMR API to work with several libraries bundled in one module #1765

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4518a76
Change HMR API to work with several libraries bundled in one module
samogot Aug 15, 2018
66203f3
Fix lint
samogot Aug 15, 2018
90a481c
Add more docs
samogot Aug 16, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 27 additions & 21 deletions build_runner/lib/src/server/hot_reload_client/client.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ import 'dart:html';
import 'package:js/js.dart';
import 'package:js/js_util.dart';

import 'module.dart';
import 'reload_handler.dart';
import 'reloading_manager.dart';

Expand All @@ -20,7 +21,7 @@ final _buildUpdatesProtocol = r'$livereload';

@anonymous
@JS()
abstract class HotReloadableModule {
abstract class HotReloadableLibrary {
/// Implement this function with any code to release resources before destroy.
///
/// Any object returned from this function will be passed to update hooks. Use
Expand Down Expand Up @@ -59,14 +60,14 @@ abstract class HotReloadableModule {
/// This function will be called on old version of module current after child
/// reloading.
@JS()
external bool hot$onChildUpdate(String childId, HotReloadableModule child,
external bool hot$onChildUpdate(String childId, HotReloadableLibrary child,
[Object data]);
}

class ModuleWrapper implements Module {
final HotReloadableModule _internal;
class LibraryWrapper implements Library {
final HotReloadableLibrary _internal;

ModuleWrapper(this._internal);
LibraryWrapper(this._internal);

@override
Object onDestroy() {
Expand All @@ -86,10 +87,10 @@ class ModuleWrapper implements Module {
}

@override
bool onChildUpdate(String childId, Module child, [Object data]) {
bool onChildUpdate(String childId, Library child, [Object data]) {
if (_internal != null && hasProperty(_internal, r'hot$onChildUpdate')) {
return _internal.hot$onChildUpdate(
childId, (child as ModuleWrapper)._internal, data);
childId, (child as LibraryWrapper)._internal, data);
}
// ignore: avoid_returning_null
return null;
Expand Down Expand Up @@ -124,16 +125,12 @@ class DartLoader {
external JsMap<String, List<String>> get moduleParentsGraph;

@JS()
external void forceLoadModule(
String moduleId,
void Function(HotReloadableModule module) callback,
void Function(JsError e) onError);
external void forceLoadModule(String moduleId,
void Function(Object module) callback, void Function(JsError e) onError);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can we provide a more explicit type than Object for the callback parameter here and below?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we can't. We know that there is a raw JS object there, but as its keys might be any, we can create @JS annotated type for it


@JS()
external void loadModule(
String moduleId,
void Function(HotReloadableModule module) callback,
void Function(JsError e) onError);
external void loadModule(String moduleId,
void Function(Object module) callback, void Function(JsError e) onError);
}

@JS(r'$dartLoader')
Expand All @@ -142,21 +139,30 @@ external DartLoader get dartLoader;
@JS('Array.from')
external List _jsArrayFrom(Object any);

@JS('Object.keys')
external List _jsObjectKeys(Object any);

@JS('Object.values')
external List _jsObjectValues(Object any);

List<K> keys<K, V>(JsMap<K, V> map) {
return List.from(_jsArrayFrom(map.keys()));
}

Future<Module> Function(String) _futurifyLoaderFunction(
void Function(String, void Function(HotReloadableModule),
void Function(JsError))
void Function(String, void Function(Object), void Function(JsError))
loaderFunction) =>
(moduleId) {
var completer = Completer<Module>();
var stackTrace = StackTrace.current;
loaderFunction(
moduleId,
allowInterop((HotReloadableModule module) =>
completer.complete(ModuleWrapper(module))),
loaderFunction(moduleId, allowInterop((Object moduleObj) {
var moduleKeys = List<String>.from(_jsObjectKeys(moduleObj));
var moduleValues =
List<HotReloadableLibrary>.from(_jsObjectValues(moduleObj));
var moduleLibraries = moduleValues.map((x) => LibraryWrapper(x));
var module = Module(Map.fromIterables(moduleKeys, moduleLibraries));
completer.complete(module);
}),
allowInterop((e) => completer.completeError(
HotReloadFailedException(e.message), stackTrace)));
return completer.future;
Expand Down
Loading