Display plugins versions

[ggrossetie]

This is useful to determine if a plugin needs to be updated when using deployment automation solution (like Ansible).

 ./kibana-plugin list
[email protected]

[elasticsearch-release]

Jenkins standing by to test this. If you aren't a maintainer, you can ignore this comment. Someone with commit access, please review this and clear it for Jenkins to run; then say 'jenkins, test it'.

[ggrossetie]

fs.existsSync is deprecated and I think it's better to check that we can read the file: https://nodejs.org/api/fs.html#fs_fs_existssync_path
Is there a better place to put this utility function ?

[jbudz]

in this case it shouldn't be needed, readFileSync will already throw if the file isn't available.

thoughts on something like:

try {
  var packageJSON = JSON.parse(readFileSync(packagePath, 'utf8'));
  logger.log(filename + '@' + packageJSON.version);
} catch(e) {
  logger.log(filename);
}

?

[epixa]

For 5.0+, plugins are required to have package.json (the installer will fail without that file). You should be able to assume that they exist, and a thrown error would be appropriate if the file didn't exist or was not readable.

[ggrossetie]

in this case it shouldn't be needed, readFileSync will already throw if the file isn't available.

True but I didn't want to put logger.log(filename) in the catch.

For 5.0+, plugins are required to have package.json (the installer will fail without that file). You should be able to assume that they exist, and a thrown error would be appropriate if the file didn't exist or was not readable.

Ok, something like: throw Error('Unable to read package.json for ' + filename) ?

[epixa]

Yep, that could work. Don't forget the new operator though.

[ggrossetie]

@epixa I think it would be nice to have the same behavior between Elastic stack products (ie. Elasticsearch and maybe Logstash). Wdyt ?

[epixa]

Since you only need version, I'd recommend using destructuring:

const { version } = JSON.parse(readFileSync(packagePath, 'utf8'));

One way or another, it should be a const rather than var.

[jbudz]

jenkins, test it

[jbudz]

@Mogztter thanks for the updates! It looks like we need a little more, tests in src/cli_plugin/list__tests__/list.js are mocking plugins but not writing a package.json/version causing this to throw.

[ggrossetie]

@jbudz Got it, sorry about that. I had troubles running tests locally 😣

I've updated the existing tests and added two more 😄

[epixa]

jenkins, test it

[ggrossetie]

Green bars 🎉

[jbudz]

Code LGTM

[jbudz]

Thanks @Mogztter!

[ggrossetie]

My pleasure!