latex-workshop version 8.20.2 is broken

[exploide]

Since the update to latex-workshop version 8.20.2, the extension does no longer work. The build command for example is broken. It isn't even possible to type newlines because of an error saying "command 'latex-workshop.onEnterKey' not found".

This has been reported upstream James-Yu/LaTeX-Workshop#2845 but it was explained that it is an issue with open-vsx:

The James-Yu.latex-workshop-8.20.2.vsix file at open-vsx does not include extension/out/src/main.js. The .vsix file is invalid. And, we don't publish the file at open-vsx. The admin of open-vsx publishes the file independently of us.

[jemand771]

here's the corresponding actions log. I don't see anything wrong with it though 🤔
https://github.com/open-vsx/publish-extensions/runs/3407072828?check_suite_focus=true#step:7:5595 (the link takes a while to load and auto-scroll)

[jankeromnes]

Thanks @exploide and @jemand771 for reporting this!

Let's see if we can fix James-Yu.latex-workshop somehow.

@tamuratak says in James-Yu/LaTeX-Workshop#2845 (comment) that:

The James-Yu.latex-workshop-8.20.2.vsix file at open-vsx does not include extension/out/src/main.js. The .vsix file is invalid.

So I guess the question is: How can we include extension/out/src/main.js when re-packaging James-Yu.latex-workshop?

Looking at their package.json "scripts", it seems that the only non-conventional step required to publish the extension is npm run compile.

However, we already execute this step when re-packaging (as you've correctly identified @jemand771 -- many thanks for checking the GitHub Action logs!):

https://github.com/open-vsx/publish-extensions/blob/caf170fa7e92a55b93c8cfbe3cd46c368760fa43/extensions.json#L808-L814

So, is there some other non-documented step we need to take when repackaging James-Yu.latex-workshop?

I also tried looking for the script or CI that publishes to the Microsoft proprietary marketplace, but I couldn't find one (at least it doesn't seem to be in their GitHub Actions). Maybe their publishing steps are closed-source?

@jlelong @tamuratak @James-Yu would you know which extra step is required to successfully build the James-Yu.latex-workshop VS Code extension?

We currently do this (but the resulting .vsix seems is broken because it's missing some critical files):

git clone https://github.com/James-Yu/LaTeX-Workshop
git checkout v8.20.2
npm install
npm run compile
vsce publish

[jemand771]

not sure if that's what you're looking for, but I can successfully build a vsix file by running

<clone+checkout>
npm install
npm run release

the resulting vsix file is installable and seems to work just fine.

I'm not sure if those are the exact commands you need since npm run release is just an alias for npm run clean && npm run lint && npm run compile && vsce package according to https://github.com/James-Yu/LaTeX-Workshop/blob/master/package.json#L2092
---> the only important step that's missing is vsce package. I assume that vsce publish inclused the package step since the workflow run did package something (the broken version we have now), but I don't know. (not a js dev)

Also, here's the diff between 8.19.2 and 8.20.2: James-Yu/LaTeX-Workshop@v8.19.2...v8.20.2 (especially changes in package.json)
I don't see any build-related changes that would cause this repo's build to fail, but I could be missing something

As an alternative: Is there a way for you/someone else to delete or "invalidate" a release on openvsx? Maybe the build fail was just some strange hiccup and a simple rebuild could fix it? (This will happen automatically once a new upstream version gets released, though that might take a couple of weeks)

[tamuratak]

Please update vsce to v1.96.1 in openvsx:

https://github.com/eclipse/openvsx/blob/41ff07e380d7a8a29cfbce2ba45eb7fb9e98570a/cli/package.json#L44

The number of files, 4448, in the log is smaller than the correct one:

This extension consists of 4448 files, out of which 2793 are JavaScript files. For performance reasons, you should bundle your extension: https://aka.ms/vscode-bundle-extension . You should also exclude unnecessary files by adding them to your .vscodeignore: https://aka.ms/vscode-vscodeignore

It indicates that interpreting .vscodeignore might has an issue. It might be related to microsoft/vscode-vsce/issues/588. You should update vsce to the latest version.

[5HT2]

Can confirm that building it manually works fine. Seeing as vsce has been bumped to the latest version, what is actually blocking things from working now? https://github.com/eclipse/openvsx/blob/2ce0e286df21fae0255d482be47c174049702ccf/cli/package.json#L44

[jankeromnes]

@L1ving Thanks for noticing and confirming!

The latest publish run says this:

Processing extension: {
  "id": "James-Yu.latex-workshop",
  "repository": "https://github.com/James-Yu/LaTeX-Workshop",
  "version": "8.20.2",
  "checkout": "v8.20.2",
  "prepublish": "npm run compile"
}
Checking Open VSX version of James-Yu.latex-workshop
Found version: 8.20.2
[SKIPPED] Requested version 8.20.2 is already published on Open VSX

If the currently-uploaded version 8.20.2 is broken, we'll need to either wait for the next release of James-Yu.latex-workshop to publish a fixed version, or we can request that an OpenVSX admin deletes the currently-broken 8.20.2 artifact so that it can be re-published successfully.

[jankeromnes]

Hi @spoenemann! What is the current process to get a broken extension versions deleted from OpenVSX? (Specifically James-Yu.latex-workshop@8.20.2)

[brianking]

@jankeromnes You can file an issue at https://github.com/EclipseFdn/open-vsx.org/issues to remove extensions.

[5HT2]

Thank you for following up, glad to here there isn't much of an issue at this point :)

[brianking]

If the currently-uploaded version 8.20.2 is broken, we'll need to either wait for the next release of James-Yu.latex-workshop to publish a fixed version, or we can request that an OpenVSX admin deletes the currently-broken 8.20.2 artifact so that it can be re-published successfully.

v8.20.2 has been removed.

[jemand771]

thanks! the extension should rebuild in about 12 hours from now, hopefully we'll get a working 8.20.2 out of that :)

[jemand771]

for me it looks like all of the weird issues the broken vsix file had are gone now - can someone else confirm that? ^^

[arnaudgolfouse]

Installing manually the .vsix file at https://open-vsx.org/extension/James-Yu/latex-workshop works for me, but it doesn't via codium... is that to be expected ?

[arnaudgolfouse]

Well nevermind, it works now 🎉

[exploide]

Thanks, it's working. I'm closing this issue then.