Publishing extension via cli takes for ever

[cedric05]

we use

npx ovsx publish ./filename.vsix -p ***

to publish. earlier it used to work correctly, from past one week, its taking for ever. fyi, it looks like it has published extension but still process did not die/killed

refer1: https://github.com/cedric05/dothttp-runner/runs/6830285884?check_suite_focus=true#step:9:1 refer2: https://github.com/cedric05/dothttp-runner/runs/6642336794?check_suite_focus=true#step:9:2

[TwitchBronBron]

I've been having the same issue for months now. https://github.com/rokucommunity/vscode-brightscript-language/runs/6864880864?check_suite_focus=true#step:10:38

[amvanbaren]

@TwitchBronBron You've had this issue with ovsx 0.3.0 (or earlier)?

[Princesseuh]

This has also been happening to us for months over at Astro.

Example from today's release: https://github.com/withastro/language-tools/runs/6985935480?check_suite_focus=true

[TwitchBronBron]

This is the last time it worked for me (ovsx@0.2.0 in package-lock.json; on January 12, 2022): https://github.com/rokucommunity/vscode-brightscript-language/actions/runs/1689259345

And this is the first failure after that (ovsx@0.2.1 in package-lock.json: on January 14, 2022): https://github.com/rokucommunity/vscode-brightscript-language/actions/runs/1699095172

[amvanbaren]

Thanks @TwitchBronBron I diffed versions 0.2.0 and 0.2.1 The main difference is that in version 0.2.1 the ExtensionProcessor starts reading properties from the *.vsixmanifest XML file (instead of package.json) and it creates WEB__RESOURCE FileResources for web extensions. This most likely has a performance impact, especially creating the FileResources.

@TwitchBronBron @Princesseuh I'll try publishing your extensions against versions 0.2.0 and 0.2.1 to see if there's a performance difference.

git diff b2e43eb60bd8737bb41e5a99f5e45538472499c8:server/src/main/java/org/eclipse/openvsx/ExtensionProcessor.java 9a1b96483b504f1403a8e1a3e04e3abff5dda099:server/src/main/java/org/eclipse/openvsx/ExtensionProcessor.java

``` diff --git a/server/src/main/java/org/eclipse/openvsx/ExtensionProcessor.java b/server/src/main/java/org/eclipse/openvsx/ExtensionProcessor.java diff --git a/server/src/main/java/org/eclipse/openvsx/ExtensionProcessor.java b/server/src/main/java/org/eclipse/openvsx/ExtensionProcessor.java index 65b2a00..58d8f17 100644 --- a/server/src/main/java/org/eclipse/openvsx/ExtensionProcessor.java +++ b/server/src/main/java/org/eclipse/openvsx/ExtensionProcessor.java @@ -22,6 +22,8 @@ import java.util.zip.ZipFile; import com.fasterxml.jackson.core.JsonParseException; import com.fasterxml.jackson.databind.JsonNode; import com.fasterxml.jackson.databind.ObjectMapper; +import com.fasterxml.jackson.databind.node.MissingNode; +import com.fasterxml.jackson.dataformat.xml.XmlMapper; import com.google.common.io.ByteStreams; import com.google.common.io.Files; @@ -39,8 +41,8 @@ import org.springframework.http.HttpStatus; */ public class ExtensionProcessor implements AutoCloseable { + private static final String VSIX_MANIFEST = "extension.vsixmanifest"; private static final String PACKAGE_JSON = "extension/package.json"; - private static final String PACKAGE_NLS_JSON = "extension/package.nls.json"; private static final String[] README = { "extension/README.md", "extension/README", "extension/README.txt" }; private static final String[] LICENSE = { "extension/LICENSE.md", "extension/LICENSE", "extension/LICENSE.txt" }; private static final String[] CHANGELOG = { "extension/CHANGELOG.md", "extension/CHANGELOG", "extension/CHANGELOG.txt" }; @@ -48,16 +50,16 @@ public class ExtensionProcessor implements AutoCloseable { private static final int MAX_CONTENT_SIZE = 512 * 1024 * 1024; private static final Pattern LICENSE_PATTERN = Pattern.compile("SEE( (?\\S+))? LICENSE IN (?\\S+)"); - private final PublishOptions publishOptions; + private static final String WEB_EXTENSION_TAG = "__web_extension"; + private final InputStream inputStream; private byte[] content; private ZipFile zipFile; private JsonNode packageJson; - private JsonNode packageNlsJson; + private JsonNode vsixManifest; - public ExtensionProcessor(InputStream stream, PublishOptions publishOptions) { + public ExtensionProcessor(InputStream stream) { this.inputStream = stream; - this.publishOptions = publishOptions; } @Override @@ -111,99 +113,135 @@ public class ExtensionProcessor implements AutoCloseable { } catch (IOException exc) { throw new RuntimeException(exc); } + } - // Read package.nls.json - bytes = ArchiveUtil.readEntry(zipFile, PACKAGE_NLS_JSON); - if (bytes != null) { - try { - var mapper = new ObjectMapper(); - packageNlsJson = mapper.readTree(bytes); - } catch (JsonParseException exc) { - throw new ErrorResultException("Invalid JSON format in " + PACKAGE_NLS_JSON - + ": " + exc.getMessage()); - } catch (IOException exc) { - throw new RuntimeException(exc); + private void loadVsixManifest() { + if (vsixManifest != null) { + return; + } + + readInputStream(); + + // Read extension.vsixmanifest + var bytes = ArchiveUtil.readEntry(zipFile, VSIX_MANIFEST); + if (bytes == null) + throw new ErrorResultException("Entry not found: " + VSIX_MANIFEST); + + try { + var mapper = new XmlMapper(); + vsixManifest = mapper.readTree(bytes); + } catch (JsonParseException exc) { + throw new ErrorResultException("Invalid JSON format in " + VSIX_MANIFEST + + ": " + exc.getMessage()); + } catch (IOException exc) { + throw new RuntimeException(exc); + } + } + + private JsonNode findByIdInArray(Iterable iter, String id) { + for(JsonNode node : iter){ + var idNode = node.get("Id"); + if(idNode != null && idNode.asText().equals(id)){ + return node; } } + return MissingNode.getInstance(); } public String getExtensionName() { - loadPackageJson(); - return packageJson.path("name").asText(); + loadVsixManifest(); + return vsixManifest.path("Metadata").path("Identity").path("Id").asText(); } public String getNamespace() { - loadPackageJson(); - return packageJson.path("publisher").asText(); + loadVsixManifest(); + return vsixManifest.path("Metadata").path("Identity").path("Publisher").asText(); } public List getExtensionDependencies() { - loadPackageJson(); - var result = getStringList(packageJson.path("extensionDependencies")); - return result != null ? result : Collections.emptyList(); + loadVsixManifest(); + var extDepenNode = findByIdInArray(vsixManifest.path("Metadata").path("Properties").path("Property"), "Microsoft.VisualStudio.Code.ExtensionDependencies"); + return asStringList(extDepenNode.path("Value").asText(), ","); } public List getBundledExtensions() { - loadPackageJson(); - var result = getStringList(packageJson.path("extensionPack")); - return result != null ? result : Collections.emptyList(); + loadVsixManifest(); + var extPackNode = findByIdInArray(vsixManifest.path("Metadata").path("Properties").path("Property"), "Microsoft.VisualStudio.Code.ExtensionPack"); + return asStringList(extPackNode.path("Value").asText(), ","); + } + + public List getExtensionKinds() { + loadVsixManifest(); + var extKindNode = findByIdInArray(vsixManifest.path("Metadata").path("Properties").path("Property"), "Microsoft.VisualStudio.Code.ExtensionKind"); + return asStringList(extKindNode.path("Value").asText(), ","); + } + + public String getHomepage() { + loadVsixManifest(); + var extKindNode = findByIdInArray(vsixManifest.path("Metadata").path("Properties").path("Property"), "Microsoft.VisualStudio.Services.Links.Learn"); + return extKindNode.path("Value").asText(); + } + + public String getRepository() { + loadVsixManifest(); + var sourceNode = findByIdInArray(vsixManifest.path("Metadata").path("Properties").path("Property"), "Microsoft.VisualStudio.Services.Links.Source"); + return sourceNode.path("Value").asText(); + } + + public String getBugs() { + loadVsixManifest(); + var supportNode = findByIdInArray(vsixManifest.path("Metadata").path("Properties").path("Property"), "Microsoft.VisualStudio.Services.Links.Support"); + return supportNode.path("Value").asText(); + } + + public String getGalleryColor() { + loadVsixManifest(); + var colorNode = findByIdInArray(vsixManifest.path("Metadata").path("Properties").path("Property"), "Microsoft.VisualStudio.Services.Branding.Color"); + return colorNode.path("Value").asText(); + } + + public String getGalleryTheme() { + loadVsixManifest(); + var themeNode = findByIdInArray(vsixManifest.path("Metadata").path("Properties").path("Property"), "Microsoft.VisualStudio.Services.Branding.Theme"); + return themeNode.path("Value").asText(); + } + + public boolean isPreview() { + loadVsixManifest(); + var galleryFlags = vsixManifest.path("Metadata").path("GalleryFlags"); + return asStringList(galleryFlags.asText(), " ").contains("Preview"); } public ExtensionVersion getMetadata() { loadPackageJson(); + loadVsixManifest(); var extension = new ExtensionVersion(); - extension.setVersion(packageJson.path("version").textValue()); - extension.setPreview(packageJson.path("preview").booleanValue()); - extension.setDisplayName(getNlsValue(packageJson.path("displayName"))); - extension.setDescription(getNlsValue(packageJson.path("description"))); + extension.setVersion(vsixManifest.path("Metadata").path("Identity").path("Version").asText()); + extension.setPreview(isPreview()); + extension.setDisplayName(vsixManifest.path("Metadata").path("DisplayName").asText()); + extension.setDescription(vsixManifest.path("Metadata").path("Description").path("").asText()); extension.setEngines(getEngines(packageJson.path("engines"))); - extension.setCategories(getStringList(packageJson.path("categories"))); - extension.setExtensionKind(getStringList(packageJson.path("extensionKind"))); - extension.setTags(getStringList(packageJson.path("keywords"))); + extension.setCategories(asStringList(vsixManifest.path("Metadata").path("Categories").asText(), ",")); + extension.setExtensionKind(getExtensionKinds()); + extension.setTags(asStringList(vsixManifest.path("Metadata").path("Tags").asText(), ",")); extension.setLicense(packageJson.path("license").textValue()); - extension.setHomepage(getUrl(packageJson.path("homepage"))); - extension.setRepository(getUrl(packageJson.path("repository"))); - extension.setBugs(getUrl(packageJson.path("bugs"))); + extension.setHomepage(getHomepage()); + extension.setRepository(getRepository()); + extension.setBugs(getBugs()); extension.setMarkdown(packageJson.path("markdown").textValue()); - var galleryBanner = packageJson.path("galleryBanner"); - if (galleryBanner.isObject()) { - extension.setGalleryColor(galleryBanner.path("color").textValue()); - extension.setGalleryTheme(galleryBanner.path("theme").textValue()); - } + extension.setGalleryColor(getGalleryColor()); + extension.setGalleryTheme(getGalleryTheme()); extension.setQna(packageJson.path("qna").textValue()); - return extension; - } - private List getStringList(JsonNode node) { - if (node.isArray()) { - var set = new LinkedHashSet(); - for (var element : node) { - if (element.isTextual()) - set.add(element.textValue()); - } - return new ArrayList<>(set); - } - return null; + return extension; } - private String getNlsValue(JsonNode node) { - var value = node.textValue(); - if (packageNlsJson != null && value.length() > 2 && value.startsWith("%") && value.endsWith("%")) { - var key = value.substring(1, value.length() - 1); - return packageNlsJson.path(key).textValue(); + private List asStringList(String value, String sep){ + if (Strings.isNullOrEmpty(value)){ + return new ArrayList(); } - return value; - } - private String getUrl(JsonNode node) { - String result = null; - if (node.isTextual()) - result = node.textValue(); - if (node.isObject()) - result = node.path("url").textValue(); - if (result != null && (result.isEmpty() || result.equals("."))) - result = null; - return result; + return Arrays.asList(value.split(sep)); } private List getEngines(JsonNode node) { @@ -219,6 +257,10 @@ public class ExtensionProcessor implements AutoCloseable { return null; } + private boolean isWebExtensionKind(ExtensionVersion extension) { + return extension.getTags().contains(WEB_EXTENSION_TAG); + } + public List getResources(ExtensionVersion extension) { var resources = new ArrayList(); var binary = getBinary(extension); @@ -239,7 +281,7 @@ public class ExtensionProcessor implements AutoCloseable { var icon = getIcon(extension); if (icon != null) resources.add(icon); - if (extension.getExtensionKind() != null && extension.getExtensionKind().contains("web") && publishOptions.web) + if (isWebExtensionKind(extension)) resources.addAll(getWebResources(extension)); return resources; } ```

[amvanbaren]

@TwitchBronBron @Princesseuh After looking at your failed CI jobs again, I can't really pinpoint a openvsx-server release that may have introduced this issue. I mean https://github.com/withastro/language-tools/runs/5484791314?check_suite_focus=true was able to publish the extension to Open VSX on March 9, 2022, while https://github.com/rokucommunity/vscode-brightscript-language/actions/runs/1699095172 already started failing on January 14, 2022.

It might be the file size (~20MB). I'll compare publishing your extensions with some small extensions (~500KB)

[Princesseuh]

After looking at your failed CI jobs again, I can't really pinpoint a openvsx-server release that may have introduced this issue. I mean https://github.com/withastro/language-tools/runs/5484791314?check_suite_focus=true was able to publish the extension to Open VSX on March 9, 2022

If that can help, that release was completely empty due to an issue on our side 😅 None of our actual working releases have ever completed, as far as I know

Something to note is that like the original poster says, the publishing always work, the process just never ends

[amvanbaren]

the publishing always work, the process just never ends

That sounds like a Gateway Timeout (504) or Bad Gateway (502) status code. The request times out, but the extension still gets published.

How does the CI publishing step determine it finished (either successfully or with an exception)?

[Princesseuh]

I'm not too familiar, but I would assume it waits for the process to end and checks the return code

[cedric05]

Yes, like mentioned in the issue description, extension gets published but process never dies. I'm guessing

// filename cli/src/publish.ts
      const packagePaths = options.packagePath || [undefined];
        const targets = options.targets || [undefined];
        for (const packagePath of packagePaths) {
            for (const target of targets) {
                internalPublishOptions.push({ ... options, packagePath: packagePath, target: target });
            }
        }
       // promise.all is taking for ever or 
        await Promise.all(internalPublishOptions.map(publishOptions => doPublish(publishOptions)));

for this commit https://github.com/eclipse/openvsx/commit/36ef42f5e293789e7b78fb9839e586b4c44665b2

[marshallwalker]

I've noticed that the extension folder inside the .vsix is being stored in the external storage provider, if the extension happens to have many dependencies in the node_modules, this process can be painfully slow.

[amvanbaren]

@cedric05 I'll test that piece of code, publishing 1 and multiple extensions at once.

@marshallwalker That's true. However the MS Marketplace does that too: https://rokucommunity.vscode-unpkg.net/RokuCommunity/brightscript/2.33.2/extension/node_modules/ Maybe uploading resources or the whole publishing process should run in the background?

[cedric05]

@amvanbaren today i submitted a very small extension. i didn't run into any issues, looks like filesize is the issue.

[amvanbaren]

@amvanbaren today i submitted a very small extension. i didn't run into any issues, looks like filesize is the issue.

That's what I'm thinking too. That's also why when you publish to the VS marketplace, it tells you the URL to the published version will be available in a couple minutes (not right away).

PR #482 changes the publishing logic in the CLI. It waits until all publish processes have finished and then reports the errors it encountered, if any. You can give it a try to see if you get a clear error message or at least that ovsx doesn't hang.