eclipse-theia/theia

Lazily Create Monaco Models in Resource Preference Providers

Open

#7,426 opened on Mar 26, 2020

View on GitHub
 (4 comments) (0 reactions) (0 assignees)TypeScript (2,478 forks)batch import
enhancementhelp wantedmonacopreferences

Repository metrics

Stars
 (18,676 stars)
PR merge metrics
 (Avg merge 15d 4h) (75 merged PRs in 30d)

Description

For a while now, AbstractResourcePreferenceProvider has used monaco editor models to manage the contents of settings files. This creates a circular dependency, because the editor model waits for preferences to be ready and preferences can't be read before the editor model is created. While this seems to work, I think it would be better if we would apply the following changes:

  1. Read the file contents directly from the file initially. Only signal "ready" once the file contents have been read
  2. Create a monaco model on demand, that is when opening an editor or when setting a preference programatically. Once we have the model, we can keep it just like now.

Opening an editor will create a model, which will wait for preferences to be ready. I also would setting a preference before the preferences provider is ready to be a programming error to be rejected.

Contributor guide

Research direction
Understand the current AbstractResourcePreferenceProvider implementation, especially how Monaco models are created. Then implement lazy creation by reading file contents initially and creating the model only when opening an editor or setting a preference programmatically.
Tech stack
typescript
Domain
frontenddeveloper experience
Issue type
Refactor
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.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitTypeScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65