[DDS] Deprecate DDS APIs related to CPU sample caching

- Deprecate `getAvailableCachedCpuSamples` and `getCachedCpuSamples` RPCs.
- Deprecate the `cachedUserTags` parameter of `DartDevelopmentService.startDartDevelopmentService`.
- Deprecate the `DartDevelopmentService.cachedUserTags` getter.

Issue: #61267
Change-Id: I9f9088a810584c2031d8475c767a312dff6ab2cd
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/444100
Reviewed-by: Ben Konyi <[email protected]>
Commit-Queue: Derek Xu <[email protected]>

Author: derekxu16

pkg/dds/CHANGELOG.md

@@ -1,3 +1,9 @@
+# 5.1.0
+- Update to version 2.1 of the DDS protocol.
+- Deprecate `getAvailableCachedCpuSamples` and `getCachedCpuSamples` RPCs.
+- Deprecate the `cachedUserTags` parameter of `DartDevelopmentService.startDartDevelopmentService`.
+- Deprecate the `DartDevelopmentService.cachedUserTags` getter.
+
 # 5.0.5
 - [DAP] The change in DDS 5.0.4 to individually add/remove breakpoints has been reverted and may be restored in a future version.
 

pkg/dds/dds_protocol.md

@@ -1,6 +1,6 @@
-# Dart Development Service Protocol 2.0
+# Dart Development Service Protocol 2.1
 
-This document describes _version 2.0_ of the Dart Development Service Protocol.
+This document describes _version 2.1_ of the Dart Development Service Protocol.
 This protocol is an extension of the Dart VM Service Protocol and implements it
 in it's entirety. For details on the VM Service Protocol, see the [Dart VM Service Protocol Specification][service-protocol].
 
@@ -83,9 +83,9 @@ The DDS Protocol supports all [public RPCs defined in the VM Service protocol][s
 AvailableCachedCpuSamples getAvailableCachedCpuSamples();
 ```
 
-The _getAvailableCachedCpuSamples_ RPC is used to determine which caches of CPU samples
-are available. Caches are associated with individual _UserTag_ names and are specified
-when DDS is started via the _cachedUserTags_ parameter.
+The _getAvailableCachedCpuSamples_ RPC is deprecated and will always return an
+_AvailableCachedCpuSamples_ object containing a single property named
+_cacheNames_ with an empty array as its value.
 
 See [AvailableCachedCpuSamples](#availablecachedcpusamples).
 
@@ -95,8 +95,9 @@ See [AvailableCachedCpuSamples](#availablecachedcpusamples).
 CachedCpuSamples getCachedCpuSamples(string isolateId, string userTag);
 ```
 
-The _getCachedCpuSamples_ RPC is used to retrieve a cache of CPU samples collected
-under a _UserTag_ with name _userTag_.
+The _getCachedCpuSamples_ RPC is deprecated and will always return a
+_CachedCpuSamples_ object containing properties with meaningless placeholder
+values.
 
 See [CachedCpuSamples](#cachedcpusamples).
 
@@ -357,6 +358,7 @@ version | comments
 1.4 | Added the ability to subscribe to custom streams (which can be specified when calling `dart:developer`'s `postEvent`).
 1.5 | Added `getPerfettoCpuSamples` RPC.
 1.6 | Added `postEvent` RPC.
+2.1 | Deprecated `getAvailableCachedCpuSamples` and `getCachedCpuSamples` RPCs.
 
 [resume]: https://github.com/dart-lang/sdk/blob/main/runtime/vm/service/service.md#resume
 [success]: https://github.com/dart-lang/sdk/blob/main/runtime/vm/service/service.md#success

pkg/dds/lib/dds.dart

@@ -50,6 +50,10 @@ abstract class DartDevelopmentService {
     bool enableAuthCodes = true,
     bool ipv6 = false,
     bool enableServicePortFallback = false,
+    @Deprecated(
+      'This parameter is deprecated and supplying an argument to it will cause '
+      'no effect.',
+    )
     List<String> cachedUserTags = const [],
     DevToolsConfiguration? devToolsConfiguration,
     bool logRequests = false,
@@ -89,7 +93,6 @@ abstract class DartDevelopmentService {
       remoteVmServiceUri,
       serviceUri,
       enableAuthCodes,
-      cachedUserTags,
       ipv6,
       devToolsConfiguration,
       logRequests,
@@ -162,13 +165,14 @@ abstract class DartDevelopmentService {
   /// requests.
   bool get isRunning;
 
-  /// The list of [UserTag]s used to determine which CPU samples are cached by
-  /// DDS.
+  @Deprecated(
+    'This getter is deprecated and will always return an empty list.',
+  )
   List<String> get cachedUserTags;
 
   /// The version of the DDS protocol supported by this [DartDevelopmentService]
   /// instance.
-  static const String protocolVersion = '2.0';
+  static const String protocolVersion = '2.1';
 }
 
 /// Thrown by DDS during initialization failures, unexpected connection issues,

pkg/dds/lib/dds_launcher.dart

@@ -39,8 +39,8 @@ import 'src/dds_impl.dart';
 /// If [enableServicePortFallback] is enabled, DDS will attempt to bind to any
 /// available port if the specified port is unavailable.
 ///
-/// If set, the set of [cachedUserTags] will be used to determine which CPU
-/// samples should be cached by DDS.
+/// [cachedUserTags] is deprecated and supplying an argument to it will cause no
+/// effect.
 ///
 /// If provided, [dartExecutable] is the path to the 'dart' executable that
 /// should be used to spawn the DDS instance. By default, `Platform.executable`
@@ -60,18 +60,16 @@ class DartDevelopmentServiceLauncher {
     var args = <String>[
       '--${DartDevelopmentServiceOptions.vmServiceUriOption}=$remoteVmServiceUri',
       if (serviceUri != null) ...<String>[
-        '--${DartDevelopmentServiceOptions.bindAddressOption}=${serviceUri.host}',       '--${DartDevelopmentServiceOptions.bindPortOption}=${serviceUri.port}',
+        '--${DartDevelopmentServiceOptions.bindAddressOption}=${serviceUri.host}',
+        '--${DartDevelopmentServiceOptions.bindPortOption}=${serviceUri.port}',
       ],
       if (!enableAuthCodes)
         '--${DartDevelopmentServiceOptions.disableServiceAuthCodesFlag}',
-      if (serveDevTools)
-        '--${DartDevelopmentServiceOptions.serveDevToolsFlag}',
+      if (serveDevTools) '--${DartDevelopmentServiceOptions.serveDevToolsFlag}',
       if (devToolsServerAddress != null)
         '--${DartDevelopmentServiceOptions.devToolsServerAddressOption}=$devToolsServerAddress',
       if (enableServicePortFallback)
         '--${DartDevelopmentServiceOptions.enableServicePortFallbackFlag}',
-      for (final String tag in cachedUserTags)
-        '--${DartDevelopmentServiceOptions.cachedUserTagsOption}=$tag',
       if (google3WorkspaceRoot != null)
         '--${DartDevelopmentServiceOptions.google3WorkspaceRootOption}=$google3WorkspaceRoot',
     ];

pkg/dds/lib/src/arg_parser.dart

@@ -75,8 +75,8 @@ abstract class DartDevelopmentServiceOptions {
       )
       ..addMultiOption(
         cachedUserTagsOption,
-        help: 'A set of UserTag names used to determine which CPU samples are '
-            'cached by DDS.',
+        help: 'This option is deprecated and supplying it will cause no '
+            'effect.',
         defaultsTo: <String>[],
       )
       ..addOption(

pkg/dds/lib/src/client.dart

@@ -265,7 +265,7 @@ class DartDevelopmentServiceClient {
       'getAvailableCachedCpuSamples',
       (_) => {
         'type': 'AvailableCachedCpuSamples',
-        'cacheNames': dds.cachedUserTags,
+        'cacheNames': <String>[],
       },
     );
 
@@ -286,7 +286,18 @@ class DartDevelopmentServiceClient {
 
     _clientPeer.registerMethod(
       'getCachedCpuSamples',
-      dds.isolateManager.getCachedCpuSamples,
+      (_) => {
+        'type': 'CachedCpuSamples',
+        'userTag': '',
+        'samplePeriod': -1,
+        'maxStackDepth': -1,
+        'sampleCount': -1,
+        'timeOriginMicros': -1,
+        'timeExtentMicros': -1,
+        'pid': -1,
+        'functions': [],
+        'samples': [],
+      },
     );
 
     _clientPeer.registerMethod(

pkg/dds/lib/src/cpu_samples_manager.dart

@@ -117,8 +117,6 @@ ${argParser.usage}
   }
   final enableServicePortFallback =
       argResults[DartDevelopmentServiceOptions.enableServicePortFallbackFlag];
-  final cachedUserTags =
-      argResults[DartDevelopmentServiceOptions.cachedUserTagsOption];
 
   final google3WorkspaceRoot =
       argResults[DartDevelopmentServiceOptions.google3WorkspaceRootOption];
@@ -142,7 +140,6 @@ ${argParser.usage}
             )
           : null,
       enableServicePortFallback: enableServicePortFallback,
-      cachedUserTags: cachedUserTags,
       uriConverter: uriConverter,
     );
     final dtdInfo = dds.hostedDartToolingDaemon;