Microsoft/monaco-editor

[Bug] Incorrect `[contenthash]` for filename for worker scripts from monaco-editor-webpack-plugin

Open

#3615 opened on Feb 28, 2023

View on GitHub
 (3 comments) (4 reactions) (0 assignees)JavaScript (14,836 stars) (1,283 forks)batch import
bughelp wantedopen for PRwebpack-plugin

Description

Reproducible in vscode.dev or in VS Code Desktop?

  • Not reproducible in vscode.dev or VS Code Desktop

Reproducible in the monaco editor playground?

Monaco Editor Playground Link

No response

Monaco Editor Playground Code

No response

Reproduction Steps

No response

Actual (Problematic) Behavior

The monaco-editor-webpack-plugin uses loaderUtils.interpolateName to produce the file name for worker bundles:

https://github.com/microsoft/monaco-editor/blob/2b2e2a1eb793090ea4e91d2f6998ebeede9b6129/webpack-plugin/src/index.ts#L43-L51

The interpolateName function calculates the value of a [contentHash] placeholder in the provided string by hashing the contents of the contents value passed to it:

[contenthash] the hash of options.content (Buffer) (by default it's the hex digest of the xxhash64 hash)

In the code snippet above, this is fs.readFileSync(resolveMonacoPath(entry, monacoEditorPath)), which ends up loading something like monaco-editor/esm/vs/editor/editor.worker which is this file.

The issue here is that this file itself rarely changes which means that the [contenthash] value doesn't end up changing between releases even though it should.

For example, in a project we have using monaco, we upgraded to 0.35.0 recently, which contains meaningful changes in the worker. However, the [contenthash] value didn't change, so users who had previously loaded our project with an older version of monaco would continue to be served that older worker file via our caching rules.

Does the above make sense? Apologies if anything is misexplained, I haven't necessarily fully investigated how all the details of the webpack plugin work.

Expected Behavior

[contenthash] is a different value whenever anything in the worker bundle is different.

Additional Context

No response

Contributor guide

Tech stack
typescript
Domain
build systemperformance
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.
half day
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
Knowledge of webpack plugin systemUnderstanding of content hashingFamiliarity with monaco editor webpack plugin code
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
45
Research direction
Investigate the monaco editor webpack plugin's usage of loaderUtils.interpolateName in webpack plugin/src/index.ts (lines 43-51). The current implementation hashes only the entry worker file content, which rarely changes. Consider modifying the hash calculation to include the entire output bundle content or use a different method that accounts for all dependencies. Also evaluate if using webpack's own compilation hash or chunk hash could solve the issue.