eclipse-theia/theia

plugin: webviews on development host do not work on electron

Open

#10989 opened on Apr 5, 2022

View on GitHub
 (1 comment) (0 reactions) (0 assignees)TypeScript (18,676 stars) (2,478 forks)batch import
electronhelp wantedplug-in system

Description

Bug Description:

On electron, and when starting the development host (plugin-system) webviews fail to properly start due to a service worker error:

Uncaught (in promise) DOMException: Failed to register a ServiceWorker: The document is in an invalid state.

Steps to Reproduce:

  1. open https://github.com/microsoft/vscode-extension-samples/tree/main/webview-sample as a workspace
  2. build the extension (npm i)
  3. start the debug configuration run extension
  4. the development host should start
  5. trigger the command cat coding: start cat coding session
  6. the webview editor opens but there is no content with the above error

Additional Info

  • Operating System: Windows 10
  • Theia Version: latest

Contributor guide

Tech stack
typescriptjavascriptnodejs
Domain
desktop
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Electron basicsService worker conceptsTypeScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
25
Research direction
Investigate the service worker registration in Electron's main process when loading webviews. The error 'The document is in an invalid state' suggests the webview content is not in a valid state for service worker registration. Compare with the webview sample from vscode extension samples to see how it handles service workers. Check the plugin host startup code in theia/packages/plugin ext/src/hosted/browser/plugin host.ts or similar. Also review any recent changes to the webview implementation.