Maintain referential integrity of proxy instances in dart:js

sdk/lib/js/dart2js/js_dart2js.dart

 // Copyright (c) 2013, the Dart project authors.  Please see the AUTHORS file
 // for details. All rights reserved. Use of this source code is governed by a
 // BSD-style license that can be found in the LICENSE file.
 
 library dart.js;
 
-import 'dart:_foreign_helper' show JS;
+import 'dart:_foreign_helper' show JS, DART_CLOSURE_TO_JS;
 import 'dart:_js_helper' show Primitives, convertDartClosureToJS;
 
 final JsObject context = new JsObject._fromJs(Primitives.computeGlobalThis());
 
 JsObject jsify(dynamic data) => data == null ? null : new JsObject._json(data);
 
 class Callback implements Serializable<JsFunction> {
   final Function _f; // here to allow capture in closure
   final bool _withThis; // here to allow capture in closure
   dynamic _jsFunction;
@@ skipping 14 matching lines @@
   _call(thisArg, List args) {
     final arguments = new List.from(args);
     if (_withThis) arguments.insert(0, thisArg);
     final dartArgs = arguments.map(_convertToDart).toList();
     return _convertToJS(Function.apply(_f, dartArgs));
   }
 
   JsFunction toJs() => new JsFunction._fromJs(_jsFunction);
 }
 
+/*
+ * TODO(justinfagnani): make public when we remove Callback.
+ *
+ * Returns a [JsFunction] that captures its 'this' binding and calls [f]
+ * with the value of this passed as the first argument.
+ */
+JsFunction _captureThis(Function f) => 
+  new JsFunction._fromJs(_convertDartFunction(f, captureThis: true));
+
+_convertDartFunction(Function f, {bool captureThis: false}) {
+  return JS('',
+    'function(_call, f, captureThis) {'
+      'return function() {'
+        'return _call(f, captureThis, this, '
+            'Array.prototype.slice.apply(arguments));'
+      '}'
+    '}(#, #, #)', DART_CLOSURE_TO_JS(_callDartFunction), f, _captureThis);

[alexandre.ardhuin, 2013/10/08 08:36:44]

"captureThis" instead of "_captureThis"

[justinfagnani, 2013/10/10 23:00:07]

Done.

+}
+
+_callDartFunction(callback, bool captureThis, self, List arguments) {
+  if (captureThis) {
+    arguments = [self]..addAll(arguments);
+  }
+  var dartArgs = arguments.map(_convertToDart).toList(growable: false);
+  return _convertToJS(Function.apply(callback, dartArgs));
+}
+
+
 class JsObject implements Serializable<JsObject> {
   final dynamic _jsObject;
 
   JsObject._fromJs(this._jsObject);
 
   // TODO(vsm): Type constructor as Serializable<JsFunction> when
   // dartbug.com/11854 is fixed.
   factory JsObject(var constructor, [List arguments]) {
     final constr = _convertToJS(constructor);
     if (arguments == null) {
@@ skipping 107 matching lines @@
   apply(thisArg, [List args]) =>
       _convertToDart(JS('=Object', '#.apply(#, #)', _convertToJS(this),
           _convertToJS(thisArg),
           args == null ? null : args.map(_convertToJS).toList()));
 }
 
 abstract class Serializable<T> {
   T toJs();
 }
 
+// property added to a Dart object referencing its JS-side DartObject proxy
+const _DART_OBJECT_PROPERTY_NAME = r'_$dart_dartObject';
+const _DART_CLOSURE_PROPERTY_NAME = r'_$dart_dartClosure';
+
+// property added to a JS object referencing its Dart-side JsObject proxy
+const _JS_OBJECT_PROPERTY_NAME = r'_$dart_jsObject';
+const _JS_FUNCTION_PROPERTY_NAME = r'$dart_jsFunction';
+
 dynamic _convertToJS(dynamic o) {
   if (o == null) {
     return null;
   } else if (o is String || o is num || o is bool) {
     return o;
   } else if (o is JsObject) {
     return o._jsObject;
   } else if (o is Serializable) {
     return _convertToJS(o.toJs());
   } else if (o is Function) {
-    return _convertToJS(new Callback(o));
+    var jsFunction = JS('', '#[#]', o, _JS_FUNCTION_PROPERTY_NAME);

[alexandre.ardhuin, 2013/10/08 08:36:44]

1. Use _getDartProxy ?
2. _DART_CLOSURE_PROPERTY_NAME instead of _JS_FUNCTION_PROPERTY_NAME.

[justinfagnani, 2013/10/10 23:00:07]

_getDartProxy could maybe work if we used the same property names for
referencing a dart proxy from a JS object as  for referencing a dart object from
a JS proxy. I like the separation right now. Also, this block is setting both
the JS->dart reference and the dart->JS reference. For objects we don't set the
dart->JS reference because DartObject already has it.

_JS_FUNCTION_PROPERTY_NAME is used because it's referencing the JS function
proxy from the dart closure

+    if (jsFunction == null) {
+      jsFunction = _convertDartFunction(o);
+      // set a property on the JS closure referencing the Dart closure
+      JS('void', 'Object.defineProperty(#, #, { value: #})', jsFunction,

[alexandre.ardhuin, 2013/10/08 08:36:44]

_JS_FUNCTION_PROPERTY_NAME instead of _DART_CLOSURE_PROPERTY_NAME

[justinfagnani, 2013/10/10 23:00:07]

same response/reasoning as above

+          _DART_CLOSURE_PROPERTY_NAME, o);
+      // set a property on the Dart closure referencing the JS closure
+      JS('', '#[#] = #', o, _JS_FUNCTION_PROPERTY_NAME, jsFunction);

[alexandre.ardhuin, 2013/10/08 08:36:44]

1. Use Object.defineProperty.
2. _DART_CLOSURE_PROPERTY_NAME instead of _JS_FUNCTION_PROPERTY_NAME.

[justinfagnani, 2013/10/10 23:00:07]

Done for defineProperty

+    }
+    return jsFunction;
   } else {
-    return JS('=Object', 'new DartProxy(#)', o);
+    var jsProxy = JS('', '#[#]', o, _DART_OBJECT_PROPERTY_NAME);

[alexandre.ardhuin, 2013/10/08 08:36:44]

Use _getDartProxy ?

[justinfagnani, 2013/10/10 23:00:07]

used _getJsProxy

+    if (jsProxy == null) {
+      jsProxy = JS('', 'new DartObject(#)', o);
+      JS('', '#[#] = #', o, _DART_OBJECT_PROPERTY_NAME, jsProxy);

[alexandre.ardhuin, 2013/10/08 08:36:44]

Use Object.defineProperty.

[justinfagnani, 2013/10/10 23:00:07]

Done.

+    }
+    return jsProxy;
   }
 }
 
+// converts a Dart object to a reference to a native JS object
+// which might be a DartObject JS->Dart proxy
 dynamic _convertToDart(dynamic o) {
   if (JS('bool', '# == null', o)) {
     return null;
   } else if (JS('bool', 'typeof # == "string" || # instanceof String', o, o) ||
       JS('bool', 'typeof # == "number" || # instanceof Number', o, o) ||
       JS('bool', 'typeof # == "boolean" || # instanceof Boolean', o, o)) {
     return o;
   } else if (JS('bool', '# instanceof Function', o)) {
-    return new JsFunction._fromJs(JS('=Object', '#', o));
-  } else if (JS('bool', '# instanceof DartProxy', o)) {
+    return _getDartProxy(o, _JS_FUNCTION_PROPERTY_NAME,
+        (o) => new JsFunction._fromJs(o));
+  } else if (JS('bool', '# instanceof DartObject', o)) {
     return JS('var', '#.o', o);
   } else {
-    return new JsObject._fromJs(JS('=Object', '#', o));
+    return _getDartProxy(o, _JS_OBJECT_PROPERTY_NAME,
+        (o) => new JsObject._fromJs(o));
   }
-}
+}
+
+dynamic _getDartProxy(o, String propertyName, createProxy(o)) {
+  var dartProxy = JS('', '#[#]', o, propertyName);
+  if (dartProxy == null) {
+    dartProxy = createProxy(JS('=Object', '#', o));
+    JS('void', 'Object.defineProperty(#, #, { value: #})', o, propertyName,
+        dartProxy);
+  }
+  return dartProxy;
+}