Skip to content

Replace packageRootUri with vmServiceUri - #10097

Open
johnpryan wants to merge 14 commits into
masterfrom
serve-extensions-via-vm-service
Open

johnpryan wants to merge 14 commits into
masterfrom
serve-extensions-via-vm-service

Conversation

@johnpryan

Copy link
Copy Markdown
Contributor

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.

 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`.
@johnpryan
johnpryan requested review from a team, bkonyi and kenzieschmoll as code owners November 18, 2026 23:34
@johnpryan
johnpryan requested review from srawlins and removed request for a team November 18, 2026 23:34

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

johnpryan and others added 4 commits November 18, 2026 17:07
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.
Comment thread pubspec.lock Resolved
- 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`.
Comment on lines +142 to +146
final cachedRoot =
_packageRootsForVmServiceConnections[normalizedUriAsString];
if (cachedRoot != null) {
return (success: true, message: null, uri: cachedRoot);
}

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[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.

Comment on lines +158 to +159
if (evalResult is InstanceRef) {
final packageConfig = evalResult.valueAsString;

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[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 branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants