Add `APPLICATION_SHARED` storage scope for cross-app state sharing by sandy081 · Pull Request #311317 · microsoft/vscode

sandy081 · 2026-04-20T06:58:50Z

Implements #311337

Summary

Introduces a new StorageScope.APPLICATION_SHARED that stores state in a separate SQLite database shared between VS Code and the Sessions (Agents) app. This enables both apps to read/write shared state (e.g., workspace trust) with real-time cross-process change notifications.

Architecture

New Storage Scope

StorageScope.APPLICATION_SHARED = -2 — a new scope alongside APPLICATION, PROFILE, and WORKSPACE. Callers use it like any other scope and can independently choose StorageTarget.USER (synced) or StorageTarget.MACHINE (local-only).

Storage Location

The shared database lives at ~/<dataFolderName>-shared/sharedStorage/state.vscdb (e.g., ~/.vscode-insiders-shared/sharedStorage/state.vscdb). This is a dedicated folder outside either app's user data directory, configurable via --shared-data-dir CLI argument.

IEnvironmentService.appSharedDataHome — URI pointing to the shared data root
WAL mode enabled on the SQLite database for concurrent read/write access across processes

Cross-App Change Notifications

Uses ICrossAppIPCService (Electron's cross-app IPC via Mach ports on macOS) as the primary mechanism for instant change notifications between VS Code and the Sessions app. When one app writes to the shared storage, it sends a sharedStorage:changed IPC message with the changed/deleted keys. The sibling app receives it and fires onDidChangeItemsExternal events.

Messages received before storage initialization are ignored to avoid processing stale queued messages on startup.

Settings Sync Integration

APPLICATION_SHARED keys are included in the global state sync payload with a scope field for correct round-tripping:

Read: readStorageData() includes APPLICATION_SHARED keys for the default profile only
Write: Keys are routed to the correct scope based on the payload's scope field
Non-default profiles: APPLICATION_SHARED keys are skipped entirely (not downgraded)
Wire format: IStorageValue.scope is optional and defaults to PROFILE for backward compatibility

Migration Example

Workspace trust storage key migrated from APPLICATION → APPLICATION_SHARED with explicit data migration (reads from old scope, writes to new, removes from old).

Key Files Changed

Area	Files
Storage scope & abstract service	`storage.ts` — enum, events, key targets, flush/log
IPC (client)	`storageIpc.ts` — `applicationShared` flag, `ApplicationSharedStorageDatabaseClient`
IPC (server)	`electron-main/storageIpc.ts` — routing via `applicationShared` flag
Main process storage	`storageMain.ts` — `ApplicationSharedStorageMain`, `SharedSQLiteStorageDatabase`
Main service	`storageMainService.ts` — `applicationSharedStorage` lifecycle
Renderer storage	`storageService.ts` (common), `storageService.ts` (browser)
Environment	`environment.ts`, `environmentService.ts` — `appSharedDataHome`
SQLite	`node/storage.ts` — WAL mode support, `getDataVersion()`
Sync	`globalStateSync.ts`, `userDataSync.ts`, `userDataProfileStorageService.ts`
Workspace trust	`workspaceTrust.ts` — migrated to `APPLICATION_SHARED`
CLI	`argv.ts`, `cli.ts` — `--shared-data-dir`, `--transient` support
Layout/Memento	`layout.ts`, `memento.ts` — new scope handling

github-actions · 2026-04-20T07:02:32Z

Screenshot Changes

Base: 32ccba70 Current: f1ac4162

Changed (5)

chat/aiCustomizations/aiCustomizationManagementEditor/McpBrowseMode/Dark

Before	After

chat/aiCustomizations/aiCustomizationManagementEditor/McpBrowseMode/Light

Before	After

editor/inlineCompletions/other/JumpToHint/Dark

Before	After

agentSessionsViewer/CompletedUnread/Dark

Before	After

agentSessionsViewer/CompletedUnread/Light

Before	After

Copilot

Pull request overview

This PR introduces an application-shared storage scope intended to persist state across all profiles/workspaces and share it between VS Code and the Sessions app, wiring it through storage backends (browser/remote/electron-main) and user data sync.

Changes:

Add StorageScope.APPLICATION_SHARED and plumb it through IStorageService, mementos, storage IPC clients/channels, and browser/remote storage services.
Introduce electron-main “application shared” SQLite storage backed by CrossAppIPC change notifications.
Extend global state sync/profile storage reads & writes to preserve storage scope and support syncing application-shared keys.

Show a summary per file

File	Description
src/vs/workbench/test/browser/componentFixtures/fixtureUtils.ts	Updates test storage fixture typing to include APPLICATION_SHARED change events.
src/vs/workbench/services/workspaces/common/workspaceTrust.ts	Moves workspace trust persistence to APPLICATION_SHARED and migrates from APPLICATION scope.
src/vs/workbench/services/storage/browser/storageService.ts	Adds IndexedDB-backed application-shared storage in web and includes it in init/clear/logging.
src/vs/workbench/contrib/notebook/test/browser/notebookKernelHistory.test.ts	Updates test stubs for new APPLICATION_SHARED change-event overload.
src/vs/workbench/common/memento.ts	Adds application-shared mementos alongside application/profile/workspace mementos.
src/vs/workbench/browser/layout.ts	Tracks “isNew” state for APPLICATION_SHARED storage scope.
src/vs/platform/userDataSync/common/userDataSync.ts	Extends synced storage value model to optionally carry `scope`.
src/vs/platform/userDataSync/common/globalStateSync.ts	Reads/writes global state with scope awareness; adds application-shared updates and initialization handling.
src/vs/platform/userDataProfile/common/userDataProfileStorageService.ts	Adds scope-awareness to read/update storage data; includes APPLICATION_SHARED for default profile.
src/vs/platform/storage/test/electron-main/storageMainService.test.ts	Adds tests for application-shared storage basics and CrossAppIPC propagation.
src/vs/platform/storage/electron-main/storageMainService.ts	Adds `applicationSharedStorage` to main service and exposes it via IPC + main storage service routing.
src/vs/platform/storage/electron-main/storageMain.ts	Implements `ApplicationSharedStorageMain` + SQLite wrapper that broadcasts external changes via CrossAppIPC.
src/vs/platform/storage/electron-main/storageIpc.ts	Extends storage IPC channel to route application-shared requests/events.
src/vs/platform/storage/common/storageService.ts	Adds remote window-side application-shared storage via IPC database client.
src/vs/platform/storage/common/storageIpc.ts	Adds application-shared IPC request flag and a dedicated database client for shared storage.
src/vs/platform/storage/common/storage.ts	Introduces `StorageScope.APPLICATION_SHARED`, events, flushing/logging support, and key-target caching.
src/vs/platform/environment/node/argv.ts	Adds `--shared-data-dir` CLI option.
src/vs/platform/environment/common/environmentService.ts	Adds `appSharedDataLocation` resolution (CLI override or default).
src/vs/platform/environment/common/environment.ts	Extends `INativeEnvironmentService` with `appSharedDataLocation`.
src/vs/platform/environment/common/argv.ts	Adds `shared-data-dir` to parsed native args type.
src/vs/code/node/cli.ts	Ensures transient mode creates/prints `--shared-data-dir` alongside user-data/extensions dirs.
src/vs/base/parts/storage/node/storage.ts	Adds SQLite option `useWAL` and exposes `getDataVersion()`; enables WAL when requested.

Copilot's findings

Files reviewed: 22/22 changed files
Comments generated: 3

Co-authored-by: Copilot <copilot@github.com>

vs-code-engineering · 2026-04-20T09:29:15Z

📬 CODENOTIFY

The following users are being notified based on files changed in this PR:

@deepak1556

Matched files:

src/vs/code/node/cli.ts

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

VS Code: AbstractStorageService.get() falls back from APPLICATION_SHARED to APPLICATION scope transparently, enabling lazy per-key migration without a registry. Agents App: SharedSQLiteStorageDatabase reads the host (VS Code) app's application storage DB as a fallback during getItems(), merging missing keys so shared data is available even before VS Code runs with new scope code. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Move the APPLICATION → APPLICATION_SHARED fallback logic from AbstractStorageService into the base Storage class via the new fallbackStorage property on IStorage. When a key is not found, the fallback is checked and the value is automatically written through to persist the migration. This eliminates duplicated fallback code in get/getBoolean/ getNumber and ensures write-through happens for all access patterns. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Remove fallbackStorage from IStorage interface. It is now a property on the Storage class only, set directly by callers that have access to the concrete type. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Wire up the application storage as fallback during doCreate() instead of post-init. The ApplicationStorageMain is created first and passed to ApplicationSharedStorageMain's constructor. The fallback is set on the Storage instance when the shared database is created, so it's ready by the time reads happen. Removes setFallbackStorage() method and post-init wiring. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

The in-memory fallbackStorage (application storage) makes the DB-level fallback (reading VS Code's DB from disk) redundant. Both VS Code and Agents App now use the same mechanism: the Storage.fallbackStorage property that reads from application storage and auto-migrates on hit. Removes getHostUserDataPath, IProductService dependency, and INativeEnvironmentService from StorageMainService. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Introduce MigratingStorage that migrates keys from a fallback storage on first access. Migrated keys are tracked via a persisted marker key (__$__migratedStorageMarker) in the DB so deleted keys are never resurrected from the fallback. - VS Code windows: MigratingStorage falls back to own APPLICATION storage for transparent key migration - Sessions windows: MigratingStorage falls back to host (VS Code) application storage loaded via IPC - Main process: ApplicationSharedStorageMain uses HostApplicationStorageMain for embedded app fallback - sharedDataFolderName added to product configuration - Workspace trust migration simplified (handled by MigratingStorage automatically) Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Co-authored-by: Copilot <copilot@github.com>

Add key to migratedKeys immediately before checking fallback to prevent redundant lookups. Only persist the MIGRATED_KEY marker when a value was actually found and migrated, avoiding unnecessary writes when the key doesn't exist in the fallback. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Co-authored-by: Copilot <copilot@github.com>

Log the fallback storage type (host vs local), paths, and item counts during application shared storage creation to help diagnose issues when the feature is deployed. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

sandy081 added 3 commits April 17, 2026 14:48

shared application storage

1949707

add tests

dc929e7

Merge branch 'main' into sandy081/main-scorpion

2383633

Copilot AI review requested due to automatic review settings April 20, 2026 06:58

sandy081 self-assigned this Apr 20, 2026

Copilot started reviewing on behalf of sandy081 April 20, 2026 06:59 View session

Copilot AI reviewed Apr 20, 2026

View reviewed changes

Comment thread src/vs/platform/storage/test/electron-main/storageMainService.test.ts Outdated

Comment thread src/vs/platform/userDataSync/common/globalStateSync.ts Outdated

Comment thread src/vs/platform/storage/electron-main/storageMain.ts

sandy081 and others added 2 commits April 20, 2026 09:17

fix tests

049e0ed

Co-authored-by: Copilot <copilot@github.com>

add logging and address feedback

117c46c

sandy081 changed the title ~~shared application storage~~ Add APPLICATION_SHARED storage scope for cross-app state sharing Apr 20, 2026

sandy081 requested a review from bpasero April 20, 2026 09:20

sandy081 added this to the 1.118.0 milestone Apr 20, 2026

sandy081 marked this pull request as ready for review April 20, 2026 09:28

sandy081 enabled auto-merge (squash) April 20, 2026 09:28

sandy081 and others added 14 commits April 20, 2026 13:26

Add application shared storage scope

efa4eab

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Make fallbackStorage an implementation detail of Storage

d3145c7

Remove fallbackStorage from IStorage interface. It is now a property on the Storage class only, set directly by callers that have access to the concrete type. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Merge branch 'main' into sandy081/main-scorpion

c9eee0a

fix compilation

497ff3d

minimise changes

47972dc

some fixes

e9b7d5a

Co-authored-by: Copilot <copilot@github.com>

fixes

c4d4be3

fix

6ee1aed

delete migrated key

21c358b

sandy081 added 3 commits April 21, 2026 14:31

fix removing migrated key

9841a76

update distro

0c61bfb

feedback

799f168

bpasero requested changes Apr 21, 2026

View reviewed changes

Comment thread src/vs/base/parts/storage/node/storage.ts Outdated

Comment thread src/vs/code/node/cli.ts

Comment thread src/vs/platform/environment/common/environmentService.ts

bpasero requested changes Apr 21, 2026

View reviewed changes

Comment thread src/vs/platform/storage/electron-main/storageMain.ts

Comment thread src/vs/base/parts/storage/node/storage.ts Outdated

sandy081 and others added 2 commits April 21, 2026 17:00

feedback

45a2ad5

sandy081 disabled auto-merge April 21, 2026 15:12

fix tests

5c74779

Co-authored-by: Copilot <copilot@github.com>

dmitrivMS previously approved these changes Apr 21, 2026

View reviewed changes

bpasero previously approved these changes Apr 21, 2026

View reviewed changes

Merge branch 'main' into sandy081/main-scorpion

9aa6815

sandy081 dismissed stale reviews from bpasero and dmitrivMS via 9aa6815 April 21, 2026 21:30

fix application storage path

52323b0

roblourens previously approved these changes Apr 21, 2026

View reviewed changes

fix compilation

e039cc4

sandy081 dismissed roblourens’s stale review via e039cc4 April 21, 2026 22:01

roblourens previously approved these changes Apr 21, 2026

View reviewed changes

sandy081 and others added 3 commits April 22, 2026 08:02

Merge branch 'main' into sandy081/main-scorpion

bf6640f

Merge branch 'main' into sandy081/main-scorpion

ef0f2c9

sandy081 dismissed roblourens’s stale review via 272e324 April 22, 2026 11:06

sandy081 enabled auto-merge (squash) April 22, 2026 11:07

alexr00 approved these changes Apr 22, 2026

View reviewed changes

sandy081 merged commit 717e853 into main Apr 22, 2026
40 of 41 checks passed

sandy081 deleted the sandy081/main-scorpion branch April 22, 2026 14:17

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add `APPLICATION_SHARED` storage scope for cross-app state sharing#311317

Add `APPLICATION_SHARED` storage scope for cross-app state sharing#311317
sandy081 merged 31 commits intomainfrom
sandy081/main-scorpion

sandy081 commented Apr 20, 2026 •

edited

Loading

Uh oh!

github-actions Bot commented Apr 20, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

vs-code-engineering Bot commented Apr 20, 2026 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

Conversation

sandy081 commented Apr 20, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Architecture

New Storage Scope

Storage Location

Cross-App Change Notifications

Settings Sync Integration

Migration Example

Key Files Changed

Uh oh!

github-actions Bot commented Apr 20, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Screenshot Changes

Changed (5)

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Copilot's findings

Uh oh!

Uh oh!

Uh oh!

Uh oh!

vs-code-engineering Bot commented Apr 20, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

📬 CODENOTIFY

@deepak1556

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

sandy081 commented Apr 20, 2026 •

edited

Loading

github-actions Bot commented Apr 20, 2026 •

edited

Loading

vs-code-engineering Bot commented Apr 20, 2026 •

edited

Loading