1
0
mirror of https://github.com/dart-lang/sdk synced 2024-07-05 09:20:04 +00:00

Reland "[dart:js_interop] Remove Object.toJS and JSNumber.toDart"

This is a reland of commit 16fcfe7eae

Original change's description:
> [dart:js_interop] Remove Object.toJS and JSNumber.toDart
>
> Modifies JSBoxedDartObject reified type on JS backends and also
> modifies JSBoxedDartObject.toDart now that a proper box is introduced.
> Also uses a JS symbol in JSBoxedDartObject.toDart for a property
> check so that different Dart apps don't accidentally share Dart
> objects. It's now an error to call this function on non-boxed objects.
>
> Fixes a type issue where creating a new object literal with the JS
> foreign function was resulting in dart2js thinking toJSBox would
> always throw. Changing the typeDescription to PlainJavaScriptObject
> instead of =Object fixes that issue.
>
> CoreLibraryReviewExempt: Backend-specific library.
> Change-Id: I5cfb1f32ff4328fafdf9831b0d8da806c39391d9
> Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/309082
> Reviewed-by: Joshua Litt <joshualitt@google.com>
> Commit-Queue: Srujan Gaddam <srujzs@google.com>

CoreLibraryReviewExempt: Reland.
Change-Id: If6b190f12bdf840b0259c5739f50d9bdcd27fd47
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/313600
Reviewed-by: Joshua Litt <joshualitt@google.com>
Commit-Queue: Srujan Gaddam <srujzs@google.com>
This commit is contained in:
Srujan Gaddam 2023-07-17 21:16:07 +00:00 committed by Commit Queue
parent 87c49d9848
commit 18b7dd771b
10 changed files with 57 additions and 61 deletions

View File

@ -1,3 +1,22 @@
## 3.2.0
### Language
### Libraries
#### `dart:js_interop`
- **JSNumber.toDart and Object.toJS**:
`JSNumber.toDart` is removed in favor of `toDartDouble` and `toDartInt` to
make the type explicit. `Object.toJS` is also removed in favor of
`Object.toJSBox`. Previously, this function would allow Dart objects to flow
into JS unwrapped on the JS backends. Now, there's an explicit wrapper that is
added and unwrapped via `JSBoxedDartObject.toDart`. Similarly,
`JSExportedDartObject` is renamed to `JSBoxedDartObject` and the extensions
`ObjectToJSExportedDartObject` and `JSExportedDartObjectToObject` are renamed
to `ObjectToJSBoxedDartObject` and `JSBoxedDartObjectToObject` in order to
avoid confusion with `@JSExport`.
## 3.1.0 ## 3.1.0
### Language ### Language

View File

@ -46,9 +46,8 @@ InterfaceType eraseStaticInteropTypesForJSCompilers(
typeArguments = [coreTypes.objectNullableRawType]; typeArguments = [coreTypes.objectNullableRawType];
break; break;
case 'JSBoxedDartObject': case 'JSBoxedDartObject':
// TODO(srujzs): This should be JavaScriptObject once we migrate Flutter erasedClass =
// off of using `Object.toJS`. coreTypes.index.getClass('dart:_interceptors', 'JSObject');
erasedClass = coreTypes.objectClass;
break; break;
case 'JSArrayBuffer': case 'JSArrayBuffer':
erasedClass = coreTypes.index.getClass('dart:typed_data', 'ByteBuffer'); erasedClass = coreTypes.index.getClass('dart:typed_data', 'ByteBuffer');

View File

@ -72,7 +72,13 @@ extension FunctionToJSExportedDartFunction on Function {
js_util.allowInterop(this) as JSExportedDartFunction; js_util.allowInterop(this) as JSExportedDartFunction;
} }
const _jsBoxedDartObjectProperty = "'_\$jsBoxedDartObject'"; /// Embedded global property for wrapped Dart objects passed via JS interop.
///
/// This is a Symbol so that different Dart applications don't share Dart
/// objects from different Dart runtimes. We expect all [JSBoxedDartObject]s to
/// have this Symbol.
final Object _jsBoxedDartObjectProperty =
foreign_helper.JS('', 'Symbol("jsBoxedDartObjectProperty")');
/// [JSBoxedDartObject] <-> [Object] /// [JSBoxedDartObject] <-> [Object]
@patch @patch
@ -80,37 +86,25 @@ extension JSBoxedDartObjectToObject on JSBoxedDartObject {
@patch @patch
@pragma('dart2js:prefer-inline') @pragma('dart2js:prefer-inline')
Object get toDart { Object get toDart {
if (this is JavaScriptObject) { final val = js_util.getProperty(this, _jsBoxedDartObjectProperty);
final val = foreign_helper.JS( if (val == null) {
'Object|Null', '#[$_jsBoxedDartObjectProperty]', this); throw 'Expected a wrapped Dart object, but got a JS object or a wrapped '
if (val == null) { 'Dart object from a separate runtime instead.';
throw 'Expected a wrapped Dart object, but got a JS object instead.';
}
return val as Object;
} }
// TODO(srujzs): Currently we have to still support Dart objects being return val as Object;
// returned from JS until `Object.toJS` is removed. Once that is removed,
// and the runtime type of this type is changed, we can get rid of this and
// the type check above.
return this;
} }
} }
@patch @patch
extension ObjectToJSBoxedDartObject on Object { extension ObjectToJSBoxedDartObject on Object {
// TODO(srujzs): Remove.
@patch
@pragma('dart2js:prefer-inline')
JSBoxedDartObject get toJS => this as JSBoxedDartObject;
@patch @patch
@pragma('dart2js:prefer-inline') @pragma('dart2js:prefer-inline')
JSBoxedDartObject get toJSBox { JSBoxedDartObject get toJSBox {
if (this is JavaScriptObject) { if (this is JavaScriptObject) {
throw 'Attempting to box non-Dart object.'; throw 'Attempting to box non-Dart object.';
} }
final box = final box = js_util.newObject();
foreign_helper.JS('=Object', '{$_jsBoxedDartObjectProperty: #}', this); js_util.setProperty(box, _jsBoxedDartObjectProperty, this);
return box as JSBoxedDartObject; return box as JSBoxedDartObject;
} }
} }
@ -306,11 +300,6 @@ extension ListToJSArray on List<JSAny?> {
/// [JSNumber] -> [double] or [int]. /// [JSNumber] -> [double] or [int].
@patch @patch
extension JSNumberToNumber on JSNumber { extension JSNumberToNumber on JSNumber {
// TODO(srujzs): Remove.
@patch
@pragma('dart2js:prefer-inline')
double get toDart => this as double;
@patch @patch
@pragma('dart2js:prefer-inline') @pragma('dart2js:prefer-inline')
double get toDartDouble => this as double; double get toDartDouble => this as double;

View File

@ -67,7 +67,7 @@ dynamic jsify(Object? object) {
Object get globalThis => JS('', 'globalThis'); Object get globalThis => JS('', 'globalThis');
@patch @patch
T newObject<T>() => JS('=Object', '{}'); T newObject<T>() => JS('PlainJavaScriptObject', '{}');
@patch @patch
bool hasProperty(Object o, Object name) => JS('bool', '# in #', name, o); bool hasProperty(Object o, Object name) => JS('bool', '# in #', name, o);

View File

@ -112,7 +112,7 @@ class JSArrayIteratorAdapter<T> implements Iterator<T> {
@override @override
bool moveNext() { bool moveNext() {
index++; index++;
int length = array.length.toDart.toInt(); int length = array.length.toDartInt;
if (index > length) { if (index > length) {
throw 'Iterator out of bounds'; throw 'Iterator out of bounds';
} }
@ -134,7 +134,7 @@ class JSArrayIterableAdapter<T> extends EfficientLengthIterable<T> {
Iterator<T> get iterator => JSArrayIteratorAdapter<T>(array); Iterator<T> get iterator => JSArrayIteratorAdapter<T>(array);
@override @override
int get length => array.length.toDart.toInt(); int get length => array.length.toDartInt;
} }
// Convert to double to avoid converting to [BigInt] in the case of int64. // Convert to double to avoid converting to [BigInt] in the case of int64.

View File

@ -88,11 +88,6 @@ extension JSBoxedDartObjectToObject on JSBoxedDartObject {
@patch @patch
extension ObjectToJSBoxedDartObject on Object { extension ObjectToJSBoxedDartObject on Object {
// TODO(srujzs): Remove.
@patch
JSBoxedDartObject get toJS =>
_box<JSBoxedDartObject>(jsObjectFromDartObject(this));
@patch @patch
JSBoxedDartObject get toJSBox { JSBoxedDartObject get toJSBox {
if (this is JSValue) { if (this is JSValue) {
@ -348,10 +343,6 @@ extension ListToJSArray on List<JSAny?> {
/// [JSNumber] -> [double] or [int]. /// [JSNumber] -> [double] or [int].
@patch @patch
extension JSNumberToNumber on JSNumber { extension JSNumberToNumber on JSNumber {
// TODO(srujzs): Remove.
@patch
double get toDart => toDartDouble;
@patch @patch
double get toDartDouble => toDartNumber(toExternRef); double get toDartDouble => toDartNumber(toExternRef);

View File

@ -176,12 +176,12 @@ class _MatchImplementation implements RegExpMatch {
String get input => _match.input.toDart; String get input => _match.input.toDart;
int get start => _match.index.toDart.toInt(); int get start => _match.index.toDartInt;
int get end => (start + (_match[0.toJS].toString()).length); int get end => (start + (_match[0.toJS].toString()).length);
String? group(int index) { String? group(int index) {
if (index < 0 || index >= _match.length.toDart.toInt()) { if (index < 0 || index >= _match.length.toDartInt) {
throw RangeError("Index $index is out of range ${_match.length}"); throw RangeError("Index $index is out of range ${_match.length}");
} }
return _match[index.toJS]?.toString(); return _match[index.toJS]?.toString();
@ -189,7 +189,7 @@ class _MatchImplementation implements RegExpMatch {
String? operator [](int index) => group(index); String? operator [](int index) => group(index);
int get groupCount => _match.length.toDart.toInt() - 1; int get groupCount => _match.length.toDartInt - 1;
List<String?> groups(List<int> groups) { List<String?> groups(List<int> groups) {
List<String?> out = []; List<String?> out = [];
@ -311,7 +311,7 @@ int regExpCaptureCount(JSSyntaxRegExp regexp) {
final match = nativeAnchoredRegExp.exec(''.toJS)!; final match = nativeAnchoredRegExp.exec(''.toJS)!;
// The native-anchored regexp always have one capture more than the original, // The native-anchored regexp always have one capture more than the original,
// and always matches the empty string. // and always matches the empty string.
return match.length.toDart.toInt() - 2; return match.length.toDartInt - 2;
} }
/// Find the first match of [regExp] in [string] at or after [start]. /// Find the first match of [regExp] in [string] at or after [start].

View File

@ -197,9 +197,6 @@ extension JSBoxedDartObjectToObject on JSBoxedDartObject {
} }
extension ObjectToJSBoxedDartObject on Object { extension ObjectToJSBoxedDartObject on Object {
// TODO(srujzs): Remove. Prefer toJSBox.
external JSBoxedDartObject get toJS;
external JSBoxedDartObject get toJSBox; external JSBoxedDartObject get toJSBox;
} }
@ -321,9 +318,6 @@ extension ListToJSArray on List<JSAny?> {
/// [JSNumber] -> [double] or [int]. /// [JSNumber] -> [double] or [int].
extension JSNumberToNumber on JSNumber { extension JSNumberToNumber on JSNumber {
// TODO(srujzs): Remove. Prefer toDartDouble or toDartInt.
external double get toDart;
/// Returns a Dart [double] for the given [JSNumber]. /// Returns a Dart [double] for the given [JSNumber].
external double get toDartDouble; external double get toDartDouble;

View File

@ -41,7 +41,7 @@ String jsString(String s) => s.toJS.toDart;
extension ListJSAnyExtension on List<JSAny?> { extension ListJSAnyExtension on List<JSAny?> {
List<double?> get toListDouble => List<double?> get toListDouble =>
this.map((a) => (a as JSNumber?)?.toDart).toList(); this.map((a) => (a as JSNumber?)?.toDartDouble).toList();
} }
extension ListNumExtension on List<num?> { extension ListNumExtension on List<num?> {
@ -55,11 +55,11 @@ extension ListStringExtension on List<String?> {
} }
extension NullableJSAnyExtension on JSAny? { extension NullableJSAnyExtension on JSAny? {
double? get toDouble => (this as JSNumber?)?.toDart; double? get toDouble => (this as JSNumber?)?.toDartDouble;
} }
extension JSAnyExtension on JSAny { extension JSAnyExtension on JSAny {
double get toDouble => (this as JSNumber).toDart; double get toDouble => (this as JSNumber).toDartDouble;
} }
void modedTests(TestMode mode) { void modedTests(TestMode mode) {
@ -345,7 +345,7 @@ void nonModedTests() {
(list.reduce((a, b) => (list.reduce((a, b) =>
((a as JSNumber).toDouble + (b as JSNumber).toDouble).toJS) ((a as JSNumber).toDouble + (b as JSNumber).toDouble).toJS)
as JSNumber) as JSNumber)
.toDart); .toDartDouble);
// fold // fold
Expect.equals( Expect.equals(
@ -353,32 +353,34 @@ void nonModedTests() {
// firstWhere // firstWhere
Expect.equals( Expect.equals(
1, list.firstWhere((a) => (a as JSNumber).toDart == 1).toDouble); 1, list.firstWhere((a) => (a as JSNumber).toDartDouble == 1).toDouble);
Expect.equals( Expect.equals(
45, 45,
list list
.firstWhere((a) => (a as JSNumber).toDart == 4, orElse: () => 45.toJS) .firstWhere((a) => (a as JSNumber).toDartDouble == 4,
orElse: () => 45.toJS)
.toDouble); .toDouble);
// lastWhere // lastWhere
list = [1, 2, 3, 4].toJSListJSAny; list = [1, 2, 3, 4].toJSListJSAny;
Expect.equals( Expect.equals(
4, list.lastWhere((a) => (a as JSNumber).toDart % 2 == 0).toDouble); 4, list.lastWhere((a) => (a as JSNumber).toDartDouble % 2 == 0).toDouble);
Expect.equals( Expect.equals(
45, 45,
list list
.lastWhere((a) => (a as JSNumber).toDart == 5, orElse: () => 45.toJS) .lastWhere((a) => (a as JSNumber).toDartDouble == 5,
orElse: () => 45.toJS)
.toDouble); .toDouble);
// singleWhere // singleWhere
Expect.equals( Expect.equals(
1, list.singleWhere((a) => (a as JSNumber).toDart == 1).toDouble); 1, list.singleWhere((a) => (a as JSNumber).toDartDouble == 1).toDouble);
Expect.throwsStateError( Expect.throwsStateError(
() => list.singleWhere((a) => (a as JSNumber).toDart % 2 == 0)); () => list.singleWhere((a) => (a as JSNumber).toDartDouble % 2 == 0));
Expect.equals( Expect.equals(
45, 45,
list list
.singleWhere((a) => (a as JSNumber).toDart == 5, .singleWhere((a) => (a as JSNumber).toDartDouble == 5,
orElse: () => 45.toJS) orElse: () => 45.toJS)
.toDouble); .toDouble);

View File

@ -138,6 +138,8 @@ void syncTests() {
edo = DartObject().toJSBox; edo = DartObject().toJSBox;
expect(edo is JSBoxedDartObject, true); expect(edo is JSBoxedDartObject, true);
expect(((edo as JSBoxedDartObject).toDart as DartObject).foo, 'bar'); expect(((edo as JSBoxedDartObject).toDart as DartObject).foo, 'bar');
// Should not box a non Dart-object.
Expect.throws(() => edo.toJSBox);
// [JSArray] <-> [List<JSAny?>] // [JSArray] <-> [List<JSAny?>]
arr = [1.0.toJS, 'foo'.toJS].toJS; arr = [1.0.toJS, 'foo'.toJS].toJS;