Handle private members in dart:mirrors

pkg/dev_compiler/tool/input_sdk/private/js_mirrors.dart

 // Copyright (c) 2015, 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_mirrors;
 
 import 'dart:mirrors';
 import 'dart:_foreign_helper' show JS;
 import 'dart:_internal' as _internal;
 
@@ skipping 55 matching lines @@
 dynamic _getGenericArgs(obj) {
   return JS('', '#.getGenericArgs(#)', _dart, obj);
 }
 
 dynamic _defaultConstructorType(type) {
   return JS('', '#.definiteFunctionType(#, [])', _dart, type);
 }
 
 typedef T _Lazy<T>();
 
+Map _toDartMap(data) {
+  if (data == null) return {};
+  Map m = JS('', '#.map(#)', _dart, data);

[Bob Nystrom, 2016/10/10 22:43:58]

The first argument to JS is the return type, right? Should this be used here
instead of typing the local?

Also, "m" -> "map", please. :)

https://www.dartlang.org/guides/language/effective-dart/documentation#avoid-a...

[vsm, 2016/10/10 22:56:19]

Done.

+  // Note: we recorded a map from fields/methods to their type and metadata.
+  // The key is a string name for public members but an ES6 symbol for private
+  // ones.  That's works nicely for dynamic operations, but dart:mirrors expects
+  // strings, so we convert back here.
+  var privateMembers = JS('', 'Object.getOwnPropertySymbols(#)', data);
+  for (var member in privateMembers) {
+    // Convert private JS symbol "Symbol(_foo)" to string "_foo".
+    var str = member.toString();
+    assert(str.startsWith('Symbol(') && str.endsWith(')'));
+    var name = str.substring(7, str.length - 1);
+    m[name] = JS('', '#[#]', data, member);
+  }
+  return m;
+}
+
 Map _getConstructors(obj) {
   List sig = JS('', '#.getConstructorSig(#)', _dart, obj);
-  if (sig == null) return {};
-  return JS('', '#.map(#)', _dart, sig);
+  return _toDartMap(sig);
 }
 
 Map _getFields(obj) {
   List sig = JS('', '#.getFieldSig(#)', _dart, obj);
-  if (sig == null) return {};
-  return JS('', '#.map(#)', _dart, sig);
+  return _toDartMap(sig);
 }
 
 Map _getMethods(obj) {
   List sig = JS('', '#.getMethodSig(#)', _dart, obj);
-  if (sig == null) return {};
-  return JS('', '#.map(#)', _dart, sig);
+  return _toDartMap(sig);
 }
 
 Map _getGetters(obj) {
   List sig = JS('', '#.getGetterSig(#)', _dart, obj);
-  if (sig == null) return {};
-  return JS('', '#.map(#)', _dart, sig);
+  return _toDartMap(sig);
 }
 
 Map _getSetters(obj) {
   List sig = JS('', '#.getSetterSig(#)', _dart, obj);
-  if (sig == null) return {};
-  return JS('', '#.map(#)', _dart, sig);
+  return _toDartMap(sig);
 }
 
 Map _getStaticFields(obj) {
   List sig = JS('', '#.getStaticFieldSig(#)', _dart, obj);
-  if (sig == null) return {};
-  return JS('', '#.map(#)', _dart, sig);
+  return _toDartMap(sig);
 }
 
 Map _getStatics(obj) {
   List sig = JS('', '#.getStaticSig(#)', _dart, obj);
-  if (sig == null) return {};
-  return JS('', '#.map(#)', _dart, sig);
+  return _toDartMap(sig);
 }
 
 Map _getStaticGetters(obj) {
   List sig = JS('', '#.getStaticGetterSig(#)', _dart, obj);
-  if (sig == null) return {};
-  return JS('', '#.map(#)', _dart, sig);
+  return _toDartMap(sig);
 }
 
 Map _getStaticSetters(obj) {
   List sig = JS('', '#.getStaticSetterSig(#)', _dart, obj);
-  if (sig == null) return {};
-  return JS('', '#.map(#)', _dart, sig);
+  return _toDartMap(sig);
 }
 
 // TODO(vsm): These methods need to validate whether we really have a
 // WrappedType or a raw type that should be wrapped (as opposed to a
 // function).
 dynamic _unwrap(obj) => JS('', '#.unwrapType(#)', _dart, obj);
 
 dynamic _wrap(obj) => JS('', '#.wrapType(#)', _dart, obj);
 
 _unimplemented(Type t, Invocation i) {
-  throw new UnimplementedError('$t.${i.memberName} unimplemented');
+  throw new UnimplementedError('$t.${getName(i.memberName)} unimplemented');
+}
+
+dynamic _toJsMap(Map<Symbol, dynamic> map) {
+  var obj = JS('', '{}');
+  map.forEach((Symbol key, value) {
+    JS('', '#[#] = #', obj, getName(key), value);
+  });
+  return obj;
 }
 
 class JsMirror implements Mirror {
   noSuchMethod(Invocation i) {
     _unimplemented(this.runtimeType, i);
   }
 }
 
 class JsCombinatorMirror extends JsMirror implements CombinatorMirror {
 }
@@ skipping 28 matching lines @@
   bool operator==(Object other) {
     return (other is JsInstanceMirror) && identical(reflectee, other.reflectee);
   }
 
   int get hashCode {
     // Avoid hash collisions with the reflectee. This constant is in Smi range
     // and happens to be the inner padding from RFC 2104.
     return identityHashCode(reflectee) ^ 0x36363636;
   }
 
+  // Returns a String for public members or an ES6 symbol for private members.
+  _getAccessor(dynamic reflectee, Symbol symbol, [List<dynamic> args,
+      Map<Symbol, dynamic> namedArgs]) {
+    var name = getName(symbol);
+    if (!name.startsWith('_')) return name;
+
+    // TODO(vsm): Ideally, we'd record ES6 symbols properly during codegen if
+    // mirrors is enabled.  Here, we're trying to recover it from the receiver
+    // instead.
+    //
+    // Get private fields and members.  Members are on proto.
+    var privateMembers = JS('', 'Object.getOwnPropertySymbols(#)', reflectee)
+      ..addAll(JS('', 'Object.getOwnPropertySymbols(#.__proto__)', reflectee));
+    for (var member in privateMembers) {
+      // Convert private JS symbol "Symbol(_foo)" to string "_foo".
+      var str = member.toString();
+      assert(str.startsWith('Symbol(') && str.endsWith(')'));
+      var privateName = str.substring(7, str.length - 1);

[Bob Nystrom, 2016/10/10 22:43:58]

You have the same logic above. Make a helper function?

[vsm, 2016/10/10 22:56:19]

Done.

+      if (name == privateName) return member;
+    }
+    return new NoSuchMethodError(reflectee, symbol, args, namedArgs);
+  }
+
   InstanceMirror getField(Symbol symbol) {
-    var name = getName(symbol);
+    var name = _getAccessor(reflectee, symbol);
     var field = _dload(reflectee, name);
     return reflect(field);
   }
 
   InstanceMirror setField(Symbol symbol, Object value) {
-    var name = getName(symbol);
+    var name = _getAccessor(reflectee, symbol);
     _dput(reflectee, name, value);
     return reflect(value);
   }
 
   InstanceMirror invoke(Symbol symbol, List<dynamic> args,
       [Map<Symbol, dynamic> namedArgs]) {
-    var name = getName(symbol);
+    var name = _getAccessor(reflectee, symbol, args, namedArgs);
     if (namedArgs != null) {
       args = new List.from(args);
       args.add(_toJsMap(namedArgs));
     }
     var result = _dsend(reflectee, name, args);
     return reflect(result);
   }
 
-  dynamic _toJsMap(Map<Symbol, dynamic> map) {
-    var obj = JS('', '{}');
-    map.forEach((Symbol key, value) {
-      JS('', '#[#] = #', obj, getName(key), value);
-    });
-    return obj;
-  }
+  String toString() => "InstanceMirror on '$reflectee'";
 }
 
 class JsClosureMirror extends JsInstanceMirror implements ClosureMirror {
   JsClosureMirror._(reflectee) : super._(reflectee);
 
   InstanceMirror apply(List<dynamic> args,
       [Map<Symbol, dynamic> namedArgs]) {
     if (namedArgs != null) {
       args = new List.from(args);
       args.add(_toJsMap(namedArgs));
@@ skipping 118 matching lines @@
       [Map<Symbol, dynamic> namedArgs]) {
     // TODO(vsm): Support factory constructors and named arguments.
     var name = getName(constructorName);
     assert(namedArgs == null || namedArgs.isEmpty);
     var instance = (name == 'new' || name == '')
       ? JS('', 'new #(...#)', _unwrap(_cls), args)
       : JS('', 'new (#.#)(...#)', _unwrap(_cls), name, args);
     return reflect(instance);
   }
 
+  // TODO(vsm): Need to check for NSM, types on accessors below.  Unlike the
+  // InstanceMirror case, there are no dynamic helper to delegate to - we never

[Bob Nystrom, 2016/10/10 22:43:58]

"are" -> "is".

[vsm, 2016/10/10 22:56:19]

Done.

+  // need a dload, etc. on a static.
+
+  InstanceMirror getField(Symbol symbol) {
+    var name = getName(symbol);
+    return reflect(JS('', '#[#]', _unwrap(_cls), name));
+  }
+
+  InstanceMirror setField(Symbol symbol, Object value) {
+    var name = getName(symbol);
+    JS('', '#[#] = #', _unwrap(_cls), name, value);
+    return reflect(value);
+  }
+
+  InstanceMirror invoke(Symbol symbol, List<dynamic> args,
+      [Map<Symbol, dynamic> namedArgs]) {
+    var name = getName(symbol);
+    if (namedArgs != null) {
+      args = new List.from(args);
+      args.add(_toJsMap(namedArgs));
+    }
+    var result = JS('', '#.#(...#)', _unwrap(_cls), name, args);
+    return reflect(result);
+  }
+
   List<ClassMirror> get superinterfaces {
     _Lazy<List<Type>> interfaceThunk = JS('', '#[dart.implements]', _unwrap(_cls));
     if (interfaceThunk == null) {
       return [];
     } else {
       List<Type> interfaces = interfaceThunk();
       return interfaces.map((t) => reflectType(t)).toList();
     }
   }
 
@@ skipping 13 matching lines @@
     throw new UnimplementedError("ClassMirror.originalDeclaration unimplemented");
   }
 
   ClassMirror get superclass {
     if (_cls == Object) {
       return null;
     } else {
       return reflectType(_wrap(JS('Type', '#.__proto__', _unwrap(_cls))));
     }
   }
+
+  String toString() => "ClassMirror on '$_cls'";
 }
 
 class JsVariableMirror extends JsMirror implements VariableMirror {
   final String _name;
   final TypeMirror type;
   final List<InstanceMirror> metadata;
 
   // TODO(vsm): Refactor this out.
   Symbol get simpleName => new Symbol(_name);
 
   // TODO(vsm): Fix this
   final bool isStatic = false;
   final bool isFinal = false;
 
   JsVariableMirror._(this._name, Type t, List annotations)
       : type = reflectType(t),
         metadata = new List<InstanceMirror>.unmodifiable(
             annotations.map((a) => reflect(a)));
+
+  String toString() => "VariableMirror on '$_name'";
 }
 
 class JsParameterMirror extends JsVariableMirror implements ParameterMirror {
   JsParameterMirror._(String name, Type t, List annotations)
       : super._(name, t, annotations);
+
+  String toString() => "ParameterMirror on '$_name'";
 }
 
 class JsMethodMirror extends JsMirror implements MethodMirror {
   // TODO(vsm): This could be a JS symbol for private methods
   final String _name;
   List<ParameterMirror> _params;
   List<InstanceMirror> _metadata;
   final bool isConstructor;
   final bool isStatic;
 
@@ skipping 57 matching lines @@
     for (var i = 0; i < opts.length; ++i) {
       var type = opts[i];
       var metadata = ftype.metadata[args.length + i];
       // TODO(vsm): Recover the param name.
       var param = new JsParameterMirror._('', _wrap(type), metadata);
       params[i + args.length] = param;
     }
 
     _params = new List.unmodifiable(params);
   }
+
+  String toString() => "MethodMirror on '$_name'";
 }