Skip to content

Breaking Change regarding the usage of keytar and semver #217

Closed

Description

Hi,

I'm working on VSCode and I am trying to enable the usage of ASAR for VSCode. This can improve the startup time of VSCode by up to 5%. We are at a point where we are pursuing even such small gains...

I have found that your extension makes an assumption about the disk layout of VSCode's node_modules:

PeterJausovec.vscode-docker/out/commands/system-prune.js:19
  const semver = require(`${vscode.env.appRoot}/node_modules/semver`);
PeterJausovec.vscode-docker/out/explorer/models/dockerHubUtils.js:19
  const keytar = require(`${vscode.env.appRoot}/node_modules/keytar`);
PeterJausovec.vscode-docker/out/explorer/models/registryRootNode.js:27
  this._keytar = require(`${vscode.env.appRoot}/node_modules/keytar`);
PeterJausovec.vscode-docker/out/explorer/utils/dockerHubUtils.js:19
  const keytar = require(`${vscode.env.appRoot}/node_modules/keytar`);

To make your extension entirely compatible with a distribution of VSCode that uses ASAR, and to make your extension work with both VSCode stable and VSCode insiders, you will need to try to load from two paths... Something like the following:

function getNodeModule(moduleName) {
  try {
    return require(`${vscode.env.appRoot}/node_modules.asar/${moduleName}`);
  } catch(err) { }
  try {
    return require(`${vscode.env.appRoot}/node_modules/${moduleName}`);
  } catch(err) {}
  return null;
}

I plan to release the changes to Insiders this week, such that the Insiders build on Friday, 23.02.2018, will contain the ASAR packing of node modules. In the meantime, I have created custom builds that include this change if you wish to test your extension against a VSCode version which contains these changes:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions