[ VM / Service ] Fix docs for @instance not including optional closur…

…eFunction and closureContext fields Fixes dart-lang/sdk#37989 Change-Id: I1e59dc9d27bc5c032d964207dca67bd8f4ce68ac Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/115610 Reviewed-by: Gary Roumanis <grouma@google.com> Commit-Queue: Ben Konyi <bkonyi@google.com>
aam · Sep 5, 2019 · 9a847a9 · 9a847a9
1 parent ff8b437
commit 9a847a9
Show file tree

Hide file tree

Showing 4 changed files with 38 additions and 34 deletions.
diff --git a/pkg/vm_service/CHANGELOG.md b/pkg/vm_service/CHANGELOG.md
@@ -1,5 +1,9 @@
 # Changelog
 
+## 1.1.2
+- Fixed issue where `closureFunction` and `closureContext` were only expected in
+  `Instance` objects rather than `InstanceRef`.
+
 ## 1.1.1
 - Fixed issue serializing list arguments for certain VM service methods.
   - Issue #37872

diff --git a/pkg/vm_service/lib/vm_service.dart b/pkg/vm_service/lib/vm_service.dart
@@ -3511,6 +3511,20 @@ class InstanceRef extends ObjRef {
   @optional
   InstanceRef pattern;
 
+  /// The function associated with a Closure instance.
+  ///
+  /// Provided for instance kinds:
+  ///  - Closure
+  @optional
+  FuncRef closureFunction;
+
+  /// The context associated with a Closure instance.
+  ///
+  /// Provided for instance kinds:
+  ///  - Closure
+  @optional
+  ContextRef closureContext;
+
   InstanceRef();
 
   InstanceRef._fromJson(Map<String, dynamic> json) : super._fromJson(json) {
@@ -3524,6 +3538,10 @@ class InstanceRef extends ObjRef {
     parameterizedClass =
         createServiceObject(json['parameterizedClass'], const ['ClassRef']);
     pattern = createServiceObject(json['pattern'], const ['InstanceRef']);
+    closureFunction =
+        createServiceObject(json['closureFunction'], const ['FuncRef']);
+    closureContext =
+        createServiceObject(json['closureContext'], const ['ContextRef']);
   }
 
   @override
@@ -3542,6 +3560,8 @@ class InstanceRef extends ObjRef {
     _setIfNotNull(json, 'typeClass', typeClass?.toJson());
     _setIfNotNull(json, 'parameterizedClass', parameterizedClass?.toJson());
     _setIfNotNull(json, 'pattern', pattern?.toJson());
+    _setIfNotNull(json, 'closureFunction', closureFunction?.toJson());
+    _setIfNotNull(json, 'closureContext', closureContext?.toJson());
     return json;
   }
 
@@ -3715,20 +3735,6 @@ class Instance extends Obj {
   @optional
   String bytes;
 
-  /// The function associated with a Closure instance.
-  ///
-  /// Provided for instance kinds:
-  ///  - Closure
-  @optional
-  FuncRef closureFunction;
-
-  /// The context associated with a Closure instance.
-  ///
-  /// Provided for instance kinds:
-  ///  - Closure
-  @optional
-  ContextRef closureContext;
-
   /// The referent of a MirrorReference instance.
   ///
   /// Provided for instance kinds:
@@ -3835,10 +3841,6 @@ class Instance extends Obj {
         : new List<MapAssociation>.from(
             _createSpecificObject(json['associations'], MapAssociation.parse));
     bytes = json['bytes'];
-    closureFunction =
-        createServiceObject(json['closureFunction'], const ['FuncRef']);
-    closureContext =
-        createServiceObject(json['closureContext'], const ['ContextRef']);
     mirrorReferent =
         createServiceObject(json['mirrorReferent'], const ['InstanceRef']);
     pattern = json['pattern'];
@@ -3878,8 +3880,6 @@ class Instance extends Obj {
     _setIfNotNull(
         json, 'associations', associations?.map((f) => f?.toJson())?.toList());
     _setIfNotNull(json, 'bytes', bytes);
-    _setIfNotNull(json, 'closureFunction', closureFunction?.toJson());
-    _setIfNotNull(json, 'closureContext', closureContext?.toJson());
     _setIfNotNull(json, 'mirrorReferent', mirrorReferent?.toJson());
     _setIfNotNull(json, 'pattern', pattern);
     _setIfNotNull(json, 'isCaseSensitive', isCaseSensitive);

diff --git a/pkg/vm_service/pubspec.yaml b/pkg/vm_service/pubspec.yaml
@@ -2,7 +2,7 @@ name: vm_service
 description: >-
   A library to communicate with a service implementing the Dart VM
   service protocol.
-version: 1.1.1
+version: 1.1.2
 
 author: Dart Team <misc@dartlang.org>
 homepage: https://github.com/dart-lang/sdk/tree/master/pkg/vm_service

diff --git a/runtime/vm/service/service.md b/runtime/vm/service/service.md
@@ -2,7 +2,7 @@
 
 > Please post feedback to the [observatory-discuss group][discuss-list]
 
-This document describes of _version 3.25_ of the Dart VM Service Protocol. This
+This document describes of _version 3.26_ of the Dart VM Service Protocol. This
 protocol is used to communicate with a running Dart Virtual Machine.
 
 To use the Service Protocol, start the VM with the *--observe* flag.
@@ -2088,6 +2088,18 @@ class @Instance extends @Object {
   // Provided for instance kinds:
   //   RegExp
   @Instance pattern [optional];
+
+  // The function associated with a Closure instance.
+  //
+  // Provided for instance kinds:
+  //   Closure
+  @Function closureFunction [optional];
+
+  // The context associated with a Closure instance.
+  //
+  // Provided for instance kinds:
+  //   Closure
+  @Context closureContext [optional];
 }
 ```
 
@@ -2239,18 +2251,6 @@ class Instance extends Object {
   //   Float64x2List
   string bytes [optional];
 
-  // The function associated with a Closure instance.
-  //
-  // Provided for instance kinds:
-  //   Closure
-  @Function closureFunction [optional];
-
-  // The context associated with a Closure instance.
-  //
-  // Provided for instance kinds:
-  //   Closure
-  @Context closureContext [optional];
-
   // The referent of a MirrorReference instance.
   //
   // Provided for instance kinds: