Repository navigation
Conversation
This replaces the `packageRootUri` query parameter with `VmServiceUri` in `api/serveAvailableExtensions`. Before this change, the DevTools app requested the user's package root file path from the VM service, and passed it along to `api/serveAvailableExtensions` using the `packageRootUri` query parameter. This meant that an untrusted caller could pass any directory on the host fileystem to probe directories or serve extensions outside of the active project directory. This deprecates the `packageRootUri` query parameter and replaces it with `vmServiceUri`, which allows the DevTools server to validate `vmServiceUri` and resolve the package root in `VmServiceHandler.detectRootPackageForVmService`.
There was a problem hiding this comment.
Code Review
This pull request refactors the DevTools extension resolution mechanism to use the VM service URI instead of the client-provided package root file URI when querying and serving available extensions. This change includes updates to the ExtensionService, server-side handlers, and test targets to resolve the package root on the server. The review feedback highlights a placeholder PR link in the release notes that must be resolved, a potential null dereference on packageRootUriString in _vm_service.dart, and a recommendation to use p.posix.dirname instead of fragile manual substring arithmetic for resolving the package config path.
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
1. ExtensionService() – tracks the current app via the global service connection 2. ExtensionService.forVmService()– tracks extensions outside the current VSCode workspace. 3. ExtensionService.forWorkspace - tracks extensions for projects in the user's current VSCode workspace.
_refresh() no longer queries the main isolate on the client—it just passes serviceConnection.serviceManager.serviceUri to the server. So the mainIsolate.value != null guard was just a leftover from when the client had to inspect mainIsolate to compute _appRoot.
- Record VM service root-detection failures as warnings in `handleServeAvailableExtensions` and still serve static DTD extensions, returning HTTP 500 only when no static extensions are found. - Key `_packageRootsForVmServiceConnections` solely by normalized `vmServiceUri.toString()`, normalize arguments in `setPackageRootForVmServiceForTesting`, and remove cached entries on disconnect. - Extract `VmServicePackageRootExtension.rootPackageDirectoryForMainIsolate` into `devtools_shared` (`service_utils.dart`) and remove the duplicated logic from `_vm_service.dart`. - Deprecate `ServiceManager.connectedAppPackageRoot` in `devtools_app_shared`, delegate it to `VmService.rootPackageDirectoryForMainIsolate`, add a `TODO(johnpryan)` to remove it in the next breaking release, and clean up unused private helpers and imports. - Await `ws.ready` in `_connectWithWebSocket` to prevent unhandled `WebSocketChannelException` errors when a VM service connection fails. - Add tests for uncached unreachable loopback `vmServiceUri` handling (with and without static extensions) and for cache eviction on VM service disconnect. - Update `CHANGELOG.md` in `devtools_shared` and `devtools_app_shared`.
| final cachedRoot = | ||
| _packageRootsForVmServiceConnections[normalizedUriAsString]; | ||
| if (cachedRoot != null) { | ||
| return (success: true, message: null, uri: cachedRoot); | ||
| } |
There was a problem hiding this comment.
[agent] Evict _packageRootsForVmServiceConnections on disconnect in handleNotifyForVmServiceConnection before the dtdUri == null || dtdSecret == null early return at lines 58-66 (or skip using this cache when eviction cannot run), and update the doc comment at lines 10-18. Because handleServeAvailableExtensions populates this map even when dtdSecret is null and ExtensionService(fixedVmServiceUri:) never sends disconnect notifications, entries remain cached indefinitely and serve a stale root if a later app reuses the same VM service URI.
| if (evalResult is InstanceRef) { | ||
| final packageConfig = evalResult.valueAsString; |
There was a problem hiding this comment.
[agent] Fetch the full string with getObject(isolateId, evalResult.id!, offset: 0, count: evalResult.length) when evalResult.valueAsStringIsTruncated == true. VmService.evaluate truncates InstanceRef.valueAsString at 128 characters, so endsWith(packageConfigSuffix) fails for longer packageConfigLocation URIs.
This replaces the
packageRootUriquery parameter withVmServiceUriin
api/serveAvailableExtensions.Before this change, the DevTools app requested the user's package root file path from the VM service, and passed it along to
api/serveAvailableExtensionsusing thepackageRootUriquery parameter. This meant that an untrusted caller could pass any directory on the host fileystem to probe directories or serve extensions outside of the active project directory.This deprecates the
packageRootUriquery parameter and replaces it withvmServiceUri, which allows the DevTools server to validatevmServiceUriand resolve the package root inVmServiceHandler.detectRootPackageForVmService.