migrate to universal_web, refactor GlobalKey and add GlobalStateKey a…

…nd GlobalNodeKey
schultek · Jan 5, 2025 · d7e2cb1 · d7e2cb1
1 parent 5d01056
commit d7e2cb1
Show file tree

Hide file tree

Showing 21 changed files with 332 additions and 104 deletions.
diff --git a/packages/jaspr/lib/jaspr.dart b/packages/jaspr/lib/jaspr.dart
@@ -13,7 +13,7 @@ export 'src/foundation/basic_types.dart';
 export 'src/foundation/binding.dart';
 export 'src/foundation/change_notifier.dart';
 export 'src/foundation/constants.dart';
-export 'src/foundation/events/events.dart';
+export 'src/foundation/events.dart';
 export 'src/foundation/object.dart';
 export 'src/foundation/options.dart';
 export 'src/foundation/scheduler.dart';

diff --git a/packages/jaspr/lib/src/browser/dom_render_object.dart b/packages/jaspr/lib/src/browser/dom_render_object.dart
@@ -1,10 +1,10 @@
 import 'dart:async';
 import 'dart:js_interop';
 
-import 'package:web/web.dart' as web;
+import 'package:universal_web/web.dart' as web;
 
 import '../foundation/constants.dart';
-import '../foundation/events/events.dart';
+import '../foundation/events.dart';
 import '../framework/framework.dart';
 import 'utils.dart';
 
@@ -15,7 +15,9 @@ const xmlns = {
 };
 
 class DomRenderObject extends RenderObject {
+  @override
   web.Node? node;
+
   List<web.Node> toHydrate = [];
 
   Map<String, EventBinding>? events;

diff --git a/packages/jaspr/lib/src/components/document/document_server.dart b/packages/jaspr/lib/src/components/document/document_server.dart
@@ -111,8 +111,12 @@ abstract class Document implements Component {
   }) = AttachDocument.body;
 }
 
-// only allow a single document
-const _documentKey = GlobalKey();
+// Only allow a single Document.
+const _documentKey = _DocumentKey();
+
+class _DocumentKey extends GlobalKey {
+  const _DocumentKey() : super.constructor();
+}
 
 class BaseDocument extends StatelessComponent implements Document {
   const BaseDocument({

diff --git a/packages/jaspr/lib/src/components/html/html.dart b/packages/jaspr/lib/src/components/html/html.dart
@@ -1,5 +1,5 @@
 import '../../foundation/basic_types.dart';
-import '../../foundation/events/events.dart';
+import '../../foundation/events.dart';
 import '../../foundation/styles/styles.dart';
 import '../../framework/framework.dart';
 import '../raw_text/raw_text.dart';

diff --git a/...spr/lib/src/foundation/events/events.dart → ...ages/jaspr/lib/src/foundation/events.dart b/...spr/lib/src/foundation/events/events.dart → ...ages/jaspr/lib/src/foundation/events.dart
@@ -1,8 +1,8 @@
-import '../../components/html/html.dart';
-import '../basic_types.dart';
-import 'web.dart' if (dart.library.io) 'web_stub.dart' as web;
+import 'package:universal_web/js_interop.dart';
+import 'package:universal_web/web.dart' as web;
 
-export 'web.dart' if (dart.library.io) 'web_stub.dart' show Event;
+import '../components/html/html.dart';
+import 'basic_types.dart';
 
 typedef EventCallback = void Function(web.Event event);
 typedef EventCallbacks = Map<String, EventCallback>;

diff --git a/packages/jaspr/lib/src/foundation/events/web.dart b/packages/jaspr/lib/src/foundation/events/web.dart
diff --git a/packages/jaspr/lib/src/foundation/events/web_stub.dart b/packages/jaspr/lib/src/foundation/events/web_stub.dart
diff --git a/packages/jaspr/lib/src/foundation/object.dart b/packages/jaspr/lib/src/foundation/object.dart
@@ -16,3 +16,20 @@ String objectRuntimeType(Object? object, String optimizedValue) {
   }());
   return optimizedValue;
 }
+
+/// Returns a 5 character long hexadecimal string generated from
+/// [Object.hashCode]'s 20 least-significant bits.
+String shortHash(Object? object) {
+  return object.hashCode.toUnsigned(20).toRadixString(16).padLeft(5, '0');
+}
+
+/// Returns a summary of the runtime type and hash code of `object`.
+///
+/// See also:
+///
+///  * [Object.hashCode], a value used when placing an object in a [Map] or
+///    other similar data structure, and which is also used in debug output to
+///    distinguish instances of the same class (hash collisions are
+///    possible, but rare enough that its use in debug output is useful).
+///  * [Object.runtimeType], the [Type] of an object.
+String describeIdentity(Object? object) => '${objectRuntimeType(object, '<optimized out>')}#${shortHash(object)}';
diff --git a/packages/jaspr/lib/src/framework/framework.dart b/packages/jaspr/lib/src/framework/framework.dart
@@ -8,10 +8,11 @@ import 'dart:async';
 import 'dart:collection';
 
 import 'package:meta/meta.dart';
+import 'package:universal_web/web.dart' as web;
 
 import '../foundation/basic_types.dart';
 import '../foundation/binding.dart';
-import '../foundation/events/events.dart';
+import '../foundation/events.dart';
 import '../foundation/object.dart';
 import '../foundation/styles/styles.dart';