Improve the instance-view page in observatory.

runtime/vm/service_test.cc

 // 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.
 
 #include "include/dart_debugger_api.h"
 #include "vm/dart_api_impl.h"
 #include "vm/dart_entry.h"
 #include "vm/debugger.h"
 #include "vm/globals.h"
 #include "vm/message_handler.h"
+#include "vm/object_id_ring.h"
 #include "vm/os.h"
 #include "vm/port.h"
 #include "vm/service.h"
 #include "vm/unit_test.h"
 
 namespace dart {
 
 class ServiceTestMessageHandler : public MessageHandler {
  public:
   ServiceTestMessageHandler() : _msg(NULL) {}
@@ skipping 10 matching lines @@
     // Parse the message.
     SnapshotReader reader(message->data(), message->len(),
                           Snapshot::kMessage, Isolate::Current());
     const Object& response_obj = Object::Handle(reader.ReadObject());
     String& response = String::Handle();
     response ^= response_obj.raw();
     _msg = strdup(response.ToCString());
     return true;
   }
 
+  // Removes a given json key:value from _msg.
+  void filterMsg(const char* key) {
+    int key_len = strlen(key);
+    int old_len = strlen(_msg);
+    char* new_msg = reinterpret_cast<char*>(malloc(old_len + 1));
+    int old_pos = 0;
+    int new_pos = 0;
+    while (_msg[old_pos] != '\0') {
+      if (_msg[old_pos] == '\"') {
+        old_pos++;
+        if ((old_len - old_pos) > key_len &&
+            strncmp(&_msg[old_pos], key, key_len) == 0 &&
+            _msg[old_pos + key_len + 2] == '\"') {
+          old_pos += (key_len + 2);
+          // Skip until next , or }.
+          while (_msg[old_pos] != '\0' &&
+                 _msg[old_pos] != ',' &&
+                 _msg[old_pos] != '}') {
+            old_pos++;
+          }
+          if (_msg[old_pos] == ',') {
+            old_pos++;
+          }
+        } else {
+          new_msg[new_pos] = '\"';;
+          new_pos++;
+        }
+      } else {
+        new_msg[new_pos] = _msg[old_pos];
+        new_pos++;
+        old_pos++;
+      }
+    }
+    new_msg[new_pos] = '\0';
+    free(_msg);
+    _msg = new_msg;
+  }
+
   const char* msg() const { return _msg; }
 
  private:
   char* _msg;
 };
 
 
 static RawInstance* Eval(Dart_Handle lib, const char* expr) {
   Dart_Handle result = Dart_EvaluateExpr(lib, NewString(expr));
   EXPECT_VALID(result);
@@ skipping 240 matching lines @@
   Service::HandleIsolateMessage(isolate, service_msg);
   handler.HandleNextMessage();
   EXPECT_STREQ("{\"type\":\"Error\",\"id\":\"\","
                 "\"message\":\"Unrecognized subcommand 'nosferatu'\","
                 "\"request\":{\"arguments\":[\"debug\",\"nosferatu\"],"
                              "\"option_keys\":[],\"option_values\":[]}}",
                handler.msg());
 }
 
 
+TEST_CASE(Service_Objects) {
+  // TODO(turnidge): Extend this test to cover a non-trivial stack trace.
+  const char* kScript =
+      "var port;\n"     // Set to our mock port by C++.
+      "var validId;\n"  // Set to a valid object id by C++.
+      "\n"
+      "main() {\n"
+      "}";
+
+  Isolate* isolate = Isolate::Current();
+  Dart_Handle lib = TestCase::LoadTestScript(kScript, NULL);
+  EXPECT_VALID(lib);
+
+  // Build a mock message handler and wrap it in a dart port.
+  ServiceTestMessageHandler handler;
+  Dart_Port port_id = PortMap::CreatePort(&handler);
+  Dart_Handle port =
+      Api::NewHandle(isolate, DartLibraryCalls::NewSendPort(port_id));
+  EXPECT_VALID(port);
+  EXPECT_VALID(Dart_SetField(lib, NewString("port"), port));
+
+  ObjectIdRing* ring = isolate->object_id_ring();
+  const String& str = String::Handle(String::New("value"));
+  intptr_t str_id = ring->GetIdForObject(str.raw());
+  Dart_Handle valid_id = Dart_NewInteger(str_id);
+  EXPECT_VALID(valid_id);
+  EXPECT_VALID(Dart_SetField(lib, NewString("validId"), valid_id));
+
+  Instance& service_msg = Instance::Handle();
+
+  // null
+  service_msg = Eval(lib, "[port, ['objects', 'null'], [], []]");
+  Service::HandleIsolateMessage(isolate, service_msg);
+  handler.HandleNextMessage();
+  handler.filterMsg("name");
+  EXPECT_STREQ(
+      "{\"type\":\"Null\",\"id\":\"objects\\/null\","
+      "\"preview\":\"null\"}",
+      handler.msg());
+
+  // not initialized
+  service_msg = Eval(lib, "[port, ['objects', 'not-initialized'], [], []]");
+  Service::HandleIsolateMessage(isolate, service_msg);
+  handler.HandleNextMessage();
+  handler.filterMsg("name");
+  EXPECT_STREQ(
+      "{\"type\":\"Null\",\"id\":\"objects\\/not-initialized\","
+      "\"preview\":\"<not initialized>\"}",
+      handler.msg());
+
+  // being initialized
+  service_msg = Eval(lib, "[port, ['objects', 'being-initialized'], [], []]");
+  Service::HandleIsolateMessage(isolate, service_msg);
+  handler.HandleNextMessage();
+  handler.filterMsg("name");
+  EXPECT_STREQ(
+      "{\"type\":\"Null\",\"id\":\"objects\\/being-initialized\","
+      "\"preview\":\"<being initialized>\"}",
+      handler.msg());
+
+  // optimized out
+  service_msg = Eval(lib, "[port, ['objects', 'optimized-out'], [], []]");
+  Service::HandleIsolateMessage(isolate, service_msg);
+  handler.HandleNextMessage();
+  handler.filterMsg("name");
+  EXPECT_STREQ(
+      "{\"type\":\"Null\",\"id\":\"objects\\/optimized-out\","
+      "\"preview\":\"<optimized out>\"}",
+      handler.msg());
+
+  // collected
+  service_msg = Eval(lib, "[port, ['objects', 'collected'], [], []]");
+  Service::HandleIsolateMessage(isolate, service_msg);
+  handler.HandleNextMessage();
+  handler.filterMsg("name");
+  EXPECT_STREQ(
+      "{\"type\":\"Null\",\"id\":\"objects\\/collected\","
+      "\"preview\":\"<collected>\"}",
+      handler.msg());
+
+  // expired
+  service_msg = Eval(lib, "[port, ['objects', 'expired'], [], []]");
+  Service::HandleIsolateMessage(isolate, service_msg);
+  handler.HandleNextMessage();
+  handler.filterMsg("name");
+  EXPECT_STREQ(
+      "{\"type\":\"Null\",\"id\":\"objects\\/expired\","
+      "\"preview\":\"<expired>\"}",
+      handler.msg());
+
+  // bool
+  service_msg = Eval(lib, "[port, ['objects', 'bool-true'], [], []]");
+  Service::HandleIsolateMessage(isolate, service_msg);
+  handler.HandleNextMessage();
+  handler.filterMsg("name");
+  EXPECT_STREQ(
+      "{\"type\":\"Bool\",\"id\":\"objects\\/bool-true\","
+      "\"class\":{\"type\":\"@Class\",\"id\":\"classes\\/46\","
+      "\"user_name\":\"bool\"},\"preview\":\"true\"}",
+      handler.msg());
+
+  // int
+  service_msg = Eval(lib, "[port, ['objects', 'int-123'], [], []]");
+  Service::HandleIsolateMessage(isolate, service_msg);
+  handler.HandleNextMessage();
+  handler.filterMsg("name");
+  EXPECT_STREQ(
+      "{\"type\":\"Smi\",\"id\":\"objects\\/int-123\","
+      "\"class\":{\"type\":\"@Class\",\"id\":\"classes\\/42\","
+      "\"user_name\":\"int\"},\"preview\":\"123\"}",
+      handler.msg());
+
+  // object id ring / valid
+  service_msg = Eval(lib, "[port, ['objects', '$validId'], [], []]");
+  Service::HandleIsolateMessage(isolate, service_msg);
+  handler.HandleNextMessage();
+  handler.filterMsg("name");
+  EXPECT_STREQ(
+      "{\"type\":\"String\",\"id\":\"objects\\/1\","
+      "\"class\":{\"type\":\"@Class\",\"id\":\"classes\\/60\","
+      "\"user_name\":\"String\"},\"preview\":\"\\\"value\\\"\","
+      "\"fields\":[],\"size\":24}",
+      handler.msg());
+
+  // object id ring / invalid => expired
+  service_msg = Eval(lib, "[port, ['objects', '99999999'], [], []]");
+  Service::HandleIsolateMessage(isolate, service_msg);
+  handler.HandleNextMessage();
+  handler.filterMsg("name");
+  EXPECT_STREQ(
+      "{\"type\":\"Null\",\"id\":\"objects\\/expired\","
+      "\"preview\":\"<expired>\"}",
+      handler.msg());
+
+  // expired/eval => error
+  service_msg = Eval(lib, "[port, ['objects', 'expired', 'eval'], [], []]");
+  Service::HandleIsolateMessage(isolate, service_msg);
+  handler.HandleNextMessage();
+  handler.filterMsg("name");
+  EXPECT_STREQ(
+      "{\"type\":\"Error\",\"id\":\"\","
+      "\"message\":\"expected at most 2 arguments but found 3\\n\","
+      "\"request\":{\"arguments\":[\"objects\",\"expired\",\"eval\"],"
+      "\"option_keys\":[],\"option_values\":[]}}",
+      handler.msg());
+
+  // int/eval => good
+  service_msg = Eval(lib,
+                     "[port, ['objects', 'int-123', 'eval'], "
+                     "['expr'], ['this+99']]");
+  Service::HandleIsolateMessage(isolate, service_msg);
+  handler.HandleNextMessage();
+  handler.filterMsg("name");
+  EXPECT_STREQ(
+      "{\"type\":\"@Smi\",\"id\":\"objects\\/int-222\","
+      "\"class\":{\"type\":\"@Class\",\"id\":\"classes\\/42\","
+      "\"user_name\":\"int\"},\"preview\":\"222\"}",
+      handler.msg());
+
+  // object id ring / invalid => expired
+  service_msg = Eval(lib, "[port, ['objects', '99999999', 'eval'], "
+                     "['expr'], ['this']]");
+  Service::HandleIsolateMessage(isolate, service_msg);
+  handler.HandleNextMessage();
+  handler.filterMsg("name");
+  EXPECT_STREQ(
+      "{\"type\":\"Error\",\"id\":\"\",\"kind\":\"EvalExpired\","
+      "\"message\":\"attempt to evaluate against expired object\\n\","
+      "\"request\":{\"arguments\":[\"objects\",\"99999999\",\"eval\"],"
+      "\"option_keys\":[\"expr\"],\"option_values\":[\"this\"]}}",
+      handler.msg());
+
+  // Extra arg to eval.
+  service_msg = Eval(lib,
+                     "[port, ['objects', 'int-123', 'eval', 'foo'], "
+                     "['expr'], ['this+99']]");
+  Service::HandleIsolateMessage(isolate, service_msg);
+  handler.HandleNextMessage();
+  handler.filterMsg("name");
+  EXPECT_STREQ(
+      "{\"type\":\"Error\",\"id\":\"\","
+      "\"message\":\"expected at most 3 arguments but found 4\\n\","
+      "\"request\":{\"arguments\":[\"objects\",\"int-123\",\"eval\",\"foo\"],"
+      "\"option_keys\":[\"expr\"],\"option_values\":[\"this+99\"]}}",
+      handler.msg());
+}
+
+
+
 TEST_CASE(Service_Classes) {
   const char* kScript =
       "var port;\n"  // Set to our mock port by C++.
       "\n"
       "class A {\n"
       "  var a;\n"
       "  dynamic b() {}\n"
       "  dynamic c() {\n"
       "    var d = () { b(); };\n"
       "    return d;\n"
@@ skipping 440 matching lines @@
   Service::HandleIsolateMessage(isolate, service_msg);
   handler.HandleNextMessage();
   EXPECT_STREQ("alpha", handler.msg());
   service_msg = Eval(lib, "[port, ['beta'], [], []]");
   Service::HandleIsolateMessage(isolate, service_msg);
   handler.HandleNextMessage();
   EXPECT_STREQ("beta", handler.msg());
 }
 
 }  // namespace dart