Microsoft/vscode

[webviews] deserializeWebviewPanel is not called when switching workspace trust to restricted

Open

#195,009 opened on Oct 6, 2023

View on GitHub
 (0 comments) (0 reactions) (1 assignee)TypeScript (74,848 stars) (10,221 forks)batch import
bughelp wantedwebview

Description

Does this issue occur when all extensions are disabled?: Yes/No

It is a custom extension which uses the Webview Api.

  • VS Code Version: 1.83.0
  • OS Version: Ubuntu 23.04

Steps to Reproduce:

  1. Use a webview which implements deserializeWebviewPanel
  2. Write console.log() statements when extension starts, ends, registers deserializeWebviewPanel and inside deserializeWebviewPanel
  3. Notice that on VSCode reload deserializeWebviewPanel is called, on workspace trust change to false the extension is reloaded but deserializeWebviewPanel is not called.
  4. The webview becomes unusable as it is not tracked anymore by the extension (trust=false restarts extension apparently).

First lines are printed when Reload Window is triggered. Last lines when switching the workspace trust to false: Screenshot from 2023-10-06 17-17-51

Possible workarounds:

Use onDidGrantWorkspaceTrust which is fired only when trusting the workspace + window.tabGroup Api (available from 1.67) to find the Panel and reuse it.

Contributor guide

Tech stack
typescriptnodejs
Domain
frontendapi
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
4
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
3-5 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
blocked
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
understanding of VS Code extension APIwebview APIworkspace trust concept
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
20
Research direction
Investigate the source code for webview serialization, specifically `deserializeWebviewPanel`. Look at how workspace trust changes trigger extension reload and whether the panel's serialization is skipped. Check the VS Code repository files related to webview and workspace trust, such as `src/vs/workbench/services/extensions/...` and webview panel implementations.