Rework how types work in the VM Service.

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 "platform/globals.h"
 
 #include "include/dart_debugger_api.h"
 #include "vm/dart_api_impl.h"
 #include "vm/dart_entry.h"
 #include "vm/debugger.h"
@@ skipping 504 matching lines @@
   Dart_Handle valid_id = Dart_NewInteger(arr_id);
   EXPECT_VALID(valid_id);
   EXPECT_VALID(Dart_SetField(lib, NewString("validId"), valid_id));
 
   Array& service_msg = Array::Handle();
 
   // null
   service_msg = Eval(lib, "[0, port, ['objects', 'null'], [], []]");
   Service::HandleIsolateMessage(isolate, service_msg);
   handler.HandleNextMessage();
-  handler.filterMsg("vmName");
+  handler.filterMsg("_vmName");
   EXPECT_SUBSTRING(
-      "{\"type\":\"Null\",\"id\":\"objects\\/null\","
+      "{\"type\":\"null\",\"id\":\"objects\\/null\","
       "\"valueAsString\":\"null\",\"class\":",
       handler.msg());
 
   // not initialized
   service_msg = Eval(lib, "[0, port, ['objects', 'not-initialized'], [], []]");
   Service::HandleIsolateMessage(isolate, service_msg);
   handler.HandleNextMessage();
-  handler.filterMsg("vmName");
+  handler.filterMsg("_vmName");
   EXPECT_STREQ(
       "{\"type\":\"Sentinel\",\"id\":\"objects\\/not-initialized\","
       "\"valueAsString\":\"<not initialized>\"}",
       handler.msg());
 
   // being initialized
   service_msg = Eval(lib,
                      "[0, port, ['objects', 'being-initialized'], [], []]");
   Service::HandleIsolateMessage(isolate, service_msg);
   handler.HandleNextMessage();
-  handler.filterMsg("vmName");
+  handler.filterMsg("_vmName");
   EXPECT_STREQ(
       "{\"type\":\"Sentinel\",\"id\":\"objects\\/being-initialized\","
       "\"valueAsString\":\"<being initialized>\"}",
       handler.msg());
 
   // optimized out
   service_msg = Eval(lib, "[0, port, ['objects', 'optimized-out'], [], []]");
   Service::HandleIsolateMessage(isolate, service_msg);
   handler.HandleNextMessage();
-  handler.filterMsg("vmName");
+  handler.filterMsg("_vmName");
   EXPECT_STREQ(
       "{\"type\":\"Sentinel\",\"id\":\"objects\\/optimized-out\","
       "\"valueAsString\":\"<optimized out>\"}",
       handler.msg());
 
   // collected
   service_msg = Eval(lib, "[0, port, ['objects', 'collected'], [], []]");
   Service::HandleIsolateMessage(isolate, service_msg);
   handler.HandleNextMessage();
-  handler.filterMsg("vmName");
+  handler.filterMsg("_vmName");
   EXPECT_STREQ(
       "{\"type\":\"Sentinel\",\"id\":\"objects\\/collected\","
       "\"valueAsString\":\"<collected>\"}",
       handler.msg());
 
   // expired
   service_msg = Eval(lib, "[0, port, ['objects', 'expired'], [], []]");
   Service::HandleIsolateMessage(isolate, service_msg);
   handler.HandleNextMessage();
-  handler.filterMsg("vmName");
+  handler.filterMsg("_vmName");
   EXPECT_STREQ(
       "{\"type\":\"Sentinel\",\"id\":\"objects\\/expired\","
       "\"valueAsString\":\"<expired>\"}",
       handler.msg());
 
   // bool
   service_msg = Eval(lib, "[0, port, ['objects', 'bool-true'], [], []]");
   Service::HandleIsolateMessage(isolate, service_msg);
   handler.HandleNextMessage();
-  handler.filterMsg("vmName");
+  handler.filterMsg("_vmName");
   EXPECT_STREQ(
-      "{\"type\":\"Bool\",\"id\":\"objects\\/bool-true\","
+      "{\"type\":\"bool\","
       "\"class\":{\"type\":\"@Class\",\"id\":\"classes\\/46\","
-      "\"name\":\"bool\"},\"valueAsString\":\"true\"}",
+      "\"name\":\"bool\"},"
+      "\"size\":8,\"fields\":[],\"id\":\"objects\\/bool-true\","
+      "\"valueAsString\":\"true\"}",
       handler.msg());
 
   // int
   service_msg = Eval(lib, "[0, port, ['objects', 'int-123'], [], []]");
   Service::HandleIsolateMessage(isolate, service_msg);
   handler.HandleNextMessage();
-  handler.filterMsg("vmName");
+  handler.filterMsg("_vmName");
   EXPECT_STREQ(
-      "{\"type\":\"Smi\","
+      "{\"type\":\"int\",\"_vmType\":\"Smi\","
       "\"class\":{\"type\":\"@Class\",\"id\":\"classes\\/42\","
       "\"name\":\"_Smi\",},"
       "\"fields\":[],"
       "\"id\":\"objects\\/int-123\","
       "\"valueAsString\":\"123\"}",
       handler.msg());
 
   // object id ring / valid
   service_msg = Eval(lib, "[0, port, ['objects', '$validId'], [], []]");
   Service::HandleIsolateMessage(isolate, service_msg);
   handler.HandleNextMessage();
-  handler.filterMsg("vmName");
+  handler.filterMsg("_vmName");
   handler.filterMsg("size");
   handler.filterMsg("id");
   EXPECT_STREQ(
-      "{\"type\":\"Array\","
+      "{\"type\":\"List\",\"_vmType\":\"Array\","
       "\"class\":{\"type\":\"@Class\",\"name\":\"_List\",},"
       "\"fields\":[],"
       "\"length\":1,"
       "\"elements\":[{"
           "\"index\":0,"
           "\"value\":{\"type\":\"@String\","
           "\"class\":{\"type\":\"@Class\",\"name\":\"_OneByteString\",},"
           "\"valueAsString\":\"\\\"value\\\"\"}}]}",
       handler.msg());
 
   // object id ring / invalid => expired
   service_msg = Eval(lib, "[0, port, ['objects', '99999999'], [], []]");
   Service::HandleIsolateMessage(isolate, service_msg);
   handler.HandleNextMessage();
-  handler.filterMsg("vmName");
+  handler.filterMsg("_vmName");
   EXPECT_STREQ(
       "{\"type\":\"Sentinel\",\"id\":\"objects\\/expired\","
       "\"valueAsString\":\"<expired>\"}",
       handler.msg());
 
   // expired/eval => error
   service_msg = Eval(lib, "[0, port, ['objects', 'expired', 'eval'], [], []]");
   Service::HandleIsolateMessage(isolate, service_msg);
   handler.HandleNextMessage();
-  handler.filterMsg("vmName");
+  handler.filterMsg("_vmName");
   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,
                      "[0, port, ['objects', 'int-123', 'eval'], "
                      "['expr'], ['this+99']]");
   Service::HandleIsolateMessage(isolate, service_msg);
   handler.HandleNextMessage();
-  handler.filterMsg("vmName");
+  handler.filterMsg("_vmName");
   EXPECT_STREQ(
-      "{\"type\":\"@Smi\","
+      "{\"type\":\"@int\",\"_vmType\":\"@Smi\","
       "\"class\":{\"type\":\"@Class\",\"id\":\"classes\\/42\","
       "\"name\":\"_Smi\",},"
       "\"id\":\"objects\\/int-222\","
       "\"valueAsString\":\"222\"}",
       handler.msg());
 
   // eval returning null works
   service_msg = Eval(lib,
                      "[0, port, ['objects', 'int-123', 'eval'], "
                      "['expr'], ['null']]");
   Service::HandleIsolateMessage(isolate, service_msg);
   handler.HandleNextMessage();
-  handler.filterMsg("vmName");
+  handler.filterMsg("_vmName");
   EXPECT_STREQ(
-      "{\"type\":\"@Null\",\"id\":\"objects\\/null\","
+      "{\"type\":\"@null\",\"id\":\"objects\\/null\","
       "\"valueAsString\":\"null\"}",
       handler.msg());
 
   // object id ring / invalid => expired
   service_msg = Eval(lib, "[0, port, ['objects', '99999999', 'eval'], "
                      "['expr'], ['this']]");
   Service::HandleIsolateMessage(isolate, service_msg);
   handler.HandleNextMessage();
-  handler.filterMsg("vmName");
+  handler.filterMsg("_vmName");
   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,
                      "[0, port, ['objects', 'int-123', 'eval', 'foo'], "
                      "['expr'], ['this+99']]");
   Service::HandleIsolateMessage(isolate, service_msg);
   handler.HandleNextMessage();
-  handler.filterMsg("vmName");
+  handler.filterMsg("_vmName");
   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());
 
   // Retained by single instance.
   service_msg = Eval(lib,
                      "[0, port, ['objects', '$validId', 'retained'], [], []]");
   Service::HandleIsolateMessage(isolate, service_msg);
   handler.HandleNextMessage();
-  handler.filterMsg("vmName");
+  handler.filterMsg("_vmName");
   ExpectSubstringF(handler.msg(),
                    "\"id\":\"objects\\/int-%" Pd "\"",
                    arr.raw()->Size() + arr.At(0)->Size());
 
   // Retaining path to 'arr', limit 1.
   service_msg = Eval(
       lib,
       "[0, port, ['objects', '$validId', 'retaining_path'], ['limit'], ['1']]");
   Service::HandleIsolateMessage(isolate, service_msg);
   handler.HandleNextMessage();
   ExpectSubstringF(
       handler.msg(),
       "{\"type\":\"RetainingPath\",\"id\":\"retaining_path\",\"length\":1,"
-      "\"elements\":[{\"index\":0,\"value\":{\"type\":\"@Array\"");
+      "\"elements\":[{\"index\":0,\"value\":{\"type\":\"@List\"");
 
   // Retaining path missing limit.
   service_msg = Eval(
       lib,
       "[0, port, ['objects', '$validId', 'retaining_path'], [], []]");
   Service::HandleIsolateMessage(isolate, service_msg);
   handler.HandleNextMessage();
   ExpectSubstringF(handler.msg(), "{\"type\":\"Error\"");
 
   // eval against list containing an internal object.
@@ skipping 114 matching lines @@
       lib,
       "[0, port, ['objects', '$idElem', 'retaining_path'], ['limit'], ['2']]");
   Service::HandleIsolateMessage(isolate, service_msg);
   handler.HandleNextMessage();
   ExpectSubstringF(
       handler.msg(),
       "{\"type\":\"RetainingPath\",\"id\":\"retaining_path\",\"length\":2,"
       "\"elements\":[{\"index\":0,\"value\":{\"type\":\"@String\"");
   ExpectSubstringF(handler.msg(), "\"parentListIndex\":%" Pd, kElemIndex);
   ExpectSubstringF(handler.msg(),
-      "{\"index\":1,\"value\":{\"type\":\"@Array\"");
+      "{\"index\":1,\"value\":{\"type\":\"@List\"");
 }
 
 
 TEST_CASE(Service_Libraries) {
   const char* kScript =
       "var port;\n"  // Set to our mock port by C++.
       "var libVar = 54321;\n"
       "\n"
       "main() {\n"
       "}";
@@ skipping 23 matching lines @@
   EXPECT_SUBSTRING("\"type\":\"Library\"", handler.msg());
   EXPECT_SUBSTRING("\"url\":\"test-lib\"", handler.msg());
 
   // Evaluate an expression from a library.
   service_msg = EvalF(lib,
                       "[0, port, ['libraries', '%" Pd "', 'eval'], "
                       "['expr'], ['libVar - 1']]",
                       vmlib.index());
   Service::HandleIsolateMessage(isolate, service_msg);
   handler.HandleNextMessage();
-  handler.filterMsg("vmName");
+  handler.filterMsg("_vmName");
   EXPECT_STREQ(
-      "{\"type\":\"@Smi\","
+      "{\"type\":\"@int\",\"_vmType\":\"@Smi\","
       "\"class\":{\"type\":\"@Class\",\"id\":\"classes\\/42\","
       "\"name\":\"_Smi\",},\"id\":\"objects\\/int-54320\","
       "\"valueAsString\":\"54320\"}",
       handler.msg());
 }
 
 
 TEST_CASE(Service_Classes) {
   const char* kScript =
       "var port;\n"  // Set to our mock port by C++.
@@ skipping 56 matching lines @@
   ExpectSubstringF(handler.msg(), "\"allocationStats\":");
   ExpectSubstringF(handler.msg(), "\"tokenPos\":");
   ExpectSubstringF(handler.msg(), "\"endTokenPos\":");
 
   // Evaluate an expression from class A.
   service_msg = EvalF(lib,
                       "[0, port, ['classes', '%" Pd "', 'eval'], "
                       "['expr'], ['cobra + 100000']]", cid);
   Service::HandleIsolateMessage(isolate, service_msg);
   handler.HandleNextMessage();
-  handler.filterMsg("vmName");
+  handler.filterMsg("_vmName");
   EXPECT_STREQ(
-      "{\"type\":\"@Smi\","
+      "{\"type\":\"@int\",\"_vmType\":\"@Smi\","
       "\"class\":{\"type\":\"@Class\",\"id\":\"classes\\/42\","
       "\"name\":\"_Smi\",},"
       "\"id\":\"objects\\/int-111235\","
       "\"valueAsString\":\"111235\"}",
       handler.msg());
 
   // Request function 'b' from class A.
   service_msg = EvalF(lib,
                       "[0, port, ['classes', '%" Pd "', 'functions', 'b'],"
                       "[], []]", cid);
@@ skipping 326 matching lines @@
                 address);
     EXPECT_SUBSTRING(buffer, handler.msg());
   }
 
   // Request native code at address. Expect the null code object back.
   address = last;
   service_msg = EvalF(lib, "[0, port, ['code', 'native-%" Px "'], [], []]",
                       address);
   Service::HandleIsolateMessage(isolate, service_msg);
   handler.HandleNextMessage();
-  EXPECT_SUBSTRING("{\"type\":\"Null\",\"id\":\"objects\\/null\","
+  EXPECT_SUBSTRING("{\"type\":\"null\",\"id\":\"objects\\/null\","
                    "\"valueAsString\":\"null\"",
                    handler.msg());
 
   // Request malformed native code.
   service_msg = EvalF(lib, "[0, port, ['code', 'native%" Px "'], [], []]",
                       address);
   Service::HandleIsolateMessage(isolate, service_msg);
   handler.HandleNextMessage();
   EXPECT_SUBSTRING("\"message\":\"Malformed code id:", handler.msg());
 }
@@ skipping 32 matching lines @@
   EXPECT_VALID(Dart_SetField(lib, NewString("port"), port));
 
   Array& service_msg = Array::Handle();
 
   // Fetch object.
   service_msg = EvalF(lib, "[0, port, ['objects', '%" Pd "'], [], []]", id);
   Service::HandleIsolateMessage(isolate, service_msg);
   handler.HandleNextMessage();
 
   // Check type.
-  EXPECT_SUBSTRING("\"type\":\"TokenStream\"", handler.msg());
+  EXPECT_SUBSTRING("\"type\":\"Object\"", handler.msg());
+  EXPECT_SUBSTRING("\"_vmType\":\"TokenStream\"", handler.msg());
   // Check for members array.
   EXPECT_SUBSTRING("\"members\":[", handler.msg());
 }
 
 
 TEST_CASE(Service_PcDescriptors) {
   const char* kScript =
     "var port;\n"  // Set to our mock port by C++.
     "\n"
     "class A {\n"
@@ skipping 38 matching lines @@
   EXPECT_VALID(port);
   EXPECT_VALID(Dart_SetField(lib, NewString("port"), port));
 
   Array& service_msg = Array::Handle();
 
   // Fetch object.
   service_msg = EvalF(lib, "[0, port, ['objects', '%" Pd "'], [], []]", id);
   Service::HandleIsolateMessage(isolate, service_msg);
   handler.HandleNextMessage();
   // Check type.
-  EXPECT_SUBSTRING("\"type\":\"PcDescriptors\"", handler.msg());
+  EXPECT_SUBSTRING("\"type\":\"Object\"", handler.msg());
+  EXPECT_SUBSTRING("\"_vmType\":\"PcDescriptors\"", handler.msg());
   // Check for members array.
   EXPECT_SUBSTRING("\"members\":[", handler.msg());
 }
 
 
 TEST_CASE(Service_LocalVarDescriptors) {
   const char* kScript =
     "var port;\n"  // Set to our mock port by C++.
     "\n"
     "class A {\n"
@@ skipping 38 matching lines @@
   EXPECT_VALID(port);
   EXPECT_VALID(Dart_SetField(lib, NewString("port"), port));
 
   Array& service_msg = Array::Handle();
 
   // Fetch object.
   service_msg = EvalF(lib, "[0, port, ['objects', '%" Pd "'], [], []]", id);
   Service::HandleIsolateMessage(isolate, service_msg);
   handler.HandleNextMessage();
   // Check type.
-  EXPECT_SUBSTRING("\"type\":\"LocalVarDescriptors\"", handler.msg());
+  EXPECT_SUBSTRING("\"type\":\"Object\"", handler.msg());
+  EXPECT_SUBSTRING("\"_vmType\":\"LocalVarDescriptors\"", handler.msg());
   // Check for members array.
   EXPECT_SUBSTRING("\"members\":[", handler.msg());
 }
 
 
 TEST_CASE(Service_VM) {
   const char* kScript =
       "var port;\n"  // Set to our mock port by C++.
       "\n"
       "main() {\n"
@@ skipping 524 matching lines @@
     Service::HandleIsolateMessage(isolate, service_msg);
     handler.HandleNextMessage();
     EXPECT_SUBSTRING("\"type\":\"@String\"", handler.msg());
     EXPECT_SUBSTRING("foobar", handler.msg());
   }
   // Expect null when no object is found.
   service_msg = Eval(lib, "[0, port, ['address', '7'], [], []]");
   Service::HandleIsolateMessage(isolate, service_msg);
   handler.HandleNextMessage();
   // TODO(turnidge): Should this be a ServiceException instead?
-  EXPECT_STREQ("{\"type\":\"@Null\",\"id\":\"objects\\/null\","
+  EXPECT_STREQ("{\"type\":\"@null\",\"id\":\"objects\\/null\","
                "\"valueAsString\":\"null\"}",
                handler.msg());
 }
 
 
 static const char* alpha_callback(
     const char* name,
     const char** arguments,
     intptr_t num_arguments,
     const char** option_keys,
@@ skipping 134 matching lines @@
   service_msg = Eval(lib, "[0, port, ['profile'], ['tags'], ['hidden']]");
   Service::HandleIsolateMessage(isolate, service_msg);
   handler.HandleNextMessage();
   // Expect error.
   EXPECT_SUBSTRING("\"type\":\"Error\"", handler.msg());
 }
 
 #endif  // !defined(TARGET_ARCH_ARM64)
 
 }  // namespace dart