devtools_shared

• Breaking changes: LocalFileSystem, an extension which provided some handy helpers, has been refactored into an extension on the file package's FileSystem abstraction. In detail:
  • fileSystem is a new top-level constant which represents the local (real) file system.
  • LocalFileSystem.devToolsDir() is now a static getter, FileSystemExtension.devToolsDir.
  • LocalFileSystem.maybeMoveLegacyDevToolsStore() is now an instance method, FileSystemExtension.maybeMoveLegacyDevToolsStore().
  • LocalFileSystem.devToolsStoreLocation() is now a static getter, FileSystemExtension.devToolsStoreLocation.
  • LocalFileSystem.ensureDevToolsDirectory() is now private.
  • LocalFileSystem.devToolsFileFromPath() is now an instance method, FileSystemExtension.devToolsFileFromPath().
  • LocalFileSystem.devToolsFileAsJson() is now an instance method, FileSystemExtension.devToolsFileAsJson().
  • LocalFileSystem.flutterStoreExists() is now an instance getter, FileSystemExtension.flutterStoreExists.
  • IOPersistentProperties.new accepts a new optional FileSystem fs argument.
• Update LocalFileSystem and IOPersistentProperties to use package:file instead of dart:io to allow mocking the file system.
• Increase ChromeDriver startup wait timeout to 30 seconds to support slower environments.

• Handle null values for FlutterStore.flutterClientId.

• Breaking change: Removed DevToolsStoreKeys.analyticsEnabled and DevToolsStoreKeys.isFirstRun since these were only used for legacy analytics.
• Breaking change: Removed legacy analytics APIs and state cleanup (e.g. apiGetFlutterGAEnabled, apiGetDevToolsEnabled, apiSetDevToolsEnabled, apiGetDevToolsFirstRun, apiResetDevTools).
• Breaking change: Removed public constant devToolsEnabledPropertyName.
• Breaking change: Removed isFirstRun, reset, and analyticsEnabled from DevToolsUsage.

• Adds additional logging to IntegrationTestRunner.
• Fixes assertion error when parsing Flutter channel versions using the format X.XX.X-X.X.pre-XXX.
• Fixes breakage associated with ChromeDriver 138 when using IntegrationTestRunner.
• Adds sanitizeVersionStr helper to SemanticVersion.
• Fixes null error when parsing bundleIdentifier or teamIndentifier in UniversalLinkSettings.

• Update dtd dependency to ^4.0.0.
• Register and unregister VM service connections on DTD. This change only applies to the case where the DevTools server starts DTD (i.e. when a DTD connection was not passed to the server on startup).

• Rename Handler extension methods to VmServiceHandler. This member was marked @visibleForTesting and should not be used outside of this package, so we consider this change non-breaking.

• Bump vm_service dependency upper bound to <16.0.0.

• Bump minimum SDK version to 3.6.0.
• Update package:vm_service to >=13.0.0 <16.0.0.

• Breaking change: replace apiGetLastReleaseNotesVersion with ReleaseNotesApi.getLastReleaseNotesVersion.
• Breaking change: replace apiSetLastReleaseNotesVersion with ReleaseNotesApi.setLastReleaseNotesVersion.
• Breaking change: replace lastReleaseNotesVersionPropertyName.
• Breaking change: replace apiGetBaseAppSizeFile with AppSizeApi.getBaseAppSizeFile.
• Breaking change: replace apiGetTestAppSizeFile with AppSizeApi.getTestAppSizeFile.
• Breaking change: replace baseAppSizeFilePropertyName with AppSizeApi.baseAppSizeFilePropertyName.
• Breaking change: replace testAppSizeFilePropertyName with AppSizeApi.testAppSizeFilePropertyName.
• Breaking change: replace apiSetActiveSurvey with SurveyApi.setActiveSurvey.
• Breaking change: remove activeSurveyName.
• Breaking change: replace apiGetSurveyActionTaken with SurveyApi.getSurveyActionTaken.
• Breaking change: replace apiSetSurveyActionTaken with SurveyApi.setSurveyActionTaken.
• Breaking change: remove surveyActionTakenPropertyName.
• Breaking change: replace apiGetSurveyShownCount with SurveyApi.getSurveyShownCount.
• Breaking change: replace apiIncrementSurveyShownCount with SurveyApi.incrementSurveyShownCount.
• Support Chrome's new headless mode in the integration test runner.
• Add PreferencesApi to get and set preference values.
• Deprecate DTDConnectionInfo in favor of DtdInfo which supports tracking two URIs for DTD to better support web/remote environments.

• Update dependency web_socket_channel: '>=2.4.0 <4.0.0'.

• Added helper deserialize and deserializeNullable
• Extended serialization for HeapSample and ExtensionEvents
• Added mixin Serializable
• Fix a regression with accessing the Flutter store file.
• Bump minimum Dart SDK version to Dart stable 3.4.3.

• Support detecting package roots for nested Dart projects in the packageRootFromFileUriString utility method.

• Export DTDConnectionInfo from the devtools_shared.dart library instead of the devtools_server.dart library.

• Breaking change: rename DevToolsExtensionConfig.path to DevToolsExtensionConfig.extensionAssetsPath and update class documentation.
• Breaking change: rename ExtensionsApi.extensionRootPathPropertyName to ExtensionsApi.packageRootUriPropertyName, and modify the String value for the parameter from 'rootPath' to 'packageRootUri'.
• Breaking change: add new required JSON fields "devtoolsOptionsUri" and "detectedFromStaticContext" in the DevToolsExtensionConfig.parse factory constructor.
• Breaking change: remove DevToolsOptions.optionsFileName constant in favor of new constant devtoolsOptionsFileName.
• Breaking change: modify the ExtensionsApi.apiExtensionEnabledState API to expect a query parameter "devtoolsOptionsUri" instead of "rootPath".
• Breaking change: replace the rootUri parameter in the DevToolsOptions.lookupExtensionEnabledState and DevToolsOptions.setExtensionEnabledState methods with new parameter devtoolsOptionsUri. Modify logic to expect a full file URI to the options file instead of expecting the package root in which it is contained.
• Add new fields requiresConnection, devtoolsOptionsUri, and detectedFromStaticContext to DevToolsExtensionConfig.
• Add ExtensionsApi.devtoolsOptionsUriPropertyName field.
• Return valid extensions from the apiServeAvailableExtensions endpoint even when an exception is thrown.
• Add utility extension methods on Completer: safeComplete and safeCompleteError.

• Restructure devtools_extensions.dart and devtools_extensions_io.dart libraries.

• Breaking change: remove parameter analytics from ServerApi.handle in favor of DTD implementation.
• Breaking change: remove DevTools server APIs apiMarkConsentMessageAsShown and apiGetConsentMessage
• Breaking change: remove parameter buildDir from ExtensionsManager. in favor of DTD implementation.
• Stop copying DevTools extensions assets to the DevTools build directory.
• Bump package:dtd to 2.2.0
• Remove package:unified_analytics dependency.
• Use DTD in the packageRootFromFileUriString utility to detect the package root.
• Add runWithRetry utility method.

• Bump package:dtd to 2.1.0.
• Bump the minimum Dart SDK version to 3.4.0-282.1.beta.

• Bump package:dtd to 2.0.0.
• Bump package:unified_analytics to 5.8.8.

• Breaking change: rename ServerApi.getCompleted to ServerApi.success and make the value parameter optional.
• Breaking change: remove the String? dtdUri parameter from ServerApi.handle and replace it with a parameter DTDConnectionInfo? dtd.
• Introduce a new typedef DTDConnectionInfo.
• Add a new API apiNotifyForVmServiceConnection that DevTools will call when a VM service connection is connected or disconnected from the client.
• Add a helper method packageRootFromFileUriString.
• Refactor yaml extension methods.
• Add intent filters checking functionality for deep link validation.

• Breaking change: remove the ServerApi.setCompleted method that was a duplicate of ServerApi.getCompleted.
• Breaking change: add required parameter analytics to ServerApi.handle, which accepts an instance of Analytics from package:unified_analytics.
• Add the ability to send debug logs in DevTools server request responses.
• Add an optional positional parameter logs to the ServerApi.serverError method.
• Include debug logs with the ExtensionsApi.apiServeAvailableExtensions API response.
• Devtools server API apiGetConsentMessage added to fetch the consent message from package:unified_analytics.
• Devtools server API apiMarkConsentMessageAsShown added to mark the consent message for package:unified_analytics as shown to enable telemetry.

• Add apiGetDtdUri to the server api.
• Add a description and link to documentation to the devtools_options.yaml file that is created in a user's project.

• CompareMixin is now generic, implementing Comparable<T> instead of Comparable<dynamic>, and it's operators each therefore accept a T argument.
• SemanticVersion now mixes in CompareMixin<SemanticVersion>, and it's compareTo method therefore now accepts a SemanticVersion.
• Fix an issue parsing file paths that could prevent extensions from being detected.
• Bump package:vm_service dependency to >=13.0.0 <15.0.0.

• Fix an issue parsing file paths on Windows that could prevent extensions from being detected.

• Bump minimum Dart SDK version to 3.3.0-91.0.dev and minimum Flutter SDK version to 3.17.0-0.0.pre.
• Add field isPublic to DevToolsExtensionConfig.
• Add validation for DevToolsExtensionConfig.name field to ensure it is a valid Dart package name.
• Pass warnings and errors for DevTools extension APIs from the DevTools server to DevTools app.

• Bump package:vm_service dependency to ^13.0.0.
• Remove ServiceCreator typedef and replace usages with VmServiceFactory typedef from package:vm_service.

• Split deeplink exports into devtools_deeplink_io.dart and devtools_deeplink.dart.
• Bump package:vm_service to ^12.0.0.
• Adds DeeplinkApi.androidAppLinkSettings, DeeplinkApi.iosBuildOptions, and DeeplinkApi.iosUniversalLinkSettings endpoints to ServerApi.
• Add shared integration test utilities to package:devtools_shared. These test utilities are exported as part of the existing devtools_test_utils.dart library.

• Override equality operator and hashCode for DevToolsExtensionConfig to be based on the values of its fields.

• Bump package:extension_discovery version to ^2.0.0
• Adds a DeeplinkApi.androidBuildVariants endpoint to ServerApi.
• BREAKING CHANGE:
  • ServerApi.handle parameters extensionsManager and api were converted to named parameters
  • Adds a new required named parameter deeplinkManager to ServerApi.handle.

• Bump package:extension_discovery version to ^1.0.1

• Separate extension-related libraries into those that require dart:io (exported as devtools_extensions_io.dart) and those that do not (exported as devtools_extensions.dart).

Prior to version 3.0.0, package:devtools_shared was versioned in lockstep with package:devtools_app. Both of these packages are developed as part of the broader DevTools project. To see changes and commits for package:devtools_shared, prior to version 3.0.0 please view the git log here.