Improve error message when installing an offline plugin #28298

mayya-sharipova · 2018-01-18T15:00:13Z

Provide more actionable error message when installing an offline plugin
in the plugins directory, and the plugins directory for the node
contains plugin distribution.

Closes #27401

jasontedor

I think we can detect this situation sooner and much more clearly (e.g., in install). Would you take another approach?

jasontedor · 2018-01-29T16:43:38Z

distribution/tools/plugin-cli/src/main/java/org/elasticsearch/plugins/InstallPluginCommand.java

+            }
+            // TODO: no jars should be an error
+            // TODO: verify the classname exists in one of the jars!
+        } catch (IllegalStateException e) {


I do not think this is right, we could catch an IllegalStateException for JAR hell and really we are only trying to detect when the offline plugin is contained in the plugins folder.

rjernst · 2018-01-31T08:35:46Z

I think downloadZip would be the best place to detect this. Once the URL is created, see if it is a file URL, and if it is, convert it to a local path, then see if the path is prefixed by the plugins dir?

jasontedor · 2018-03-14T02:29:02Z

@mayya-sharipova Would you be able to incorporate the feedback here and iterate on this PR?

mayya-sharipova · 2018-03-14T02:36:08Z

@jasontedor Thanks Jason, I have already incorporated it. I followed the last suggestion from Ryan.

jasontedor · 2018-03-14T02:39:52Z

@mayya-sharipova I see, again we see the problem with force pushing to a pull request; I do not think anyone knew that new commits were pushed here. Please ping when you push commits. Also, would you resolve the existing merge conflicts?

jasontedor

Thank you @mayya-sharipova, the change looks good. I left one comment.

jasontedor · 2018-03-14T12:57:51Z

distribution/tools/plugin-cli/src/main/java/org/elasticsearch/plugins/InstallPluginCommand.java

+            Path pluginsFile = Paths.get(url.getFile());
+            if (pluginsFile.startsWith(pluginsDir)) {
+                throw new IllegalStateException("Installation failed! " +
+                    "Make sure `plugins` directory doesn't contain the plugin distribution! " );


I think we can have a more actionable error message here like: "the plugins directory [" + pluginsDir + "] can not contain the plugin distribution [" + pluginsFile + "]; move the distribution to an alternate location"

elasticmachine · 2018-03-14T12:58:58Z

Pinging @elastic/es-core-infra

Provide more actionable error message when installing an offline plugin in the plugins directory, and the `plugins` directory for the node contains plugin distribution. Closes elastic#27401

Provide more actionable error message when installing an offline plugin in the plugins directory, and the `plugins` directory for the node contains plugin distribution. Closes #27401

jasontedor · 2018-03-14T23:26:55Z

@mayya-sharipova I’m confused. I left a comment about the user-facing message but I do not see that incorporated here nor a response to that comment although this change has been merged?

jasontedor · 2018-03-14T23:30:00Z

Oh I see that you force pushed! Please prefer to push additional commits instead of force pushing. There are generally very few situations in which we need to force push.

This reverts commit 0cc1ffd The reason is that Windows test are failing, because of the incorrect path for the plugin

This reverts commit 6284b7e. The reason is that Windows test are failing, because of the incorrect path for the plugin

* es/6.x: (89 commits) Clarify requirements of strict date formats. (#29090) Clarify that dates are always rendered as strings. (#29093) [Docs] Fix link to Grok patterns (#29088) Fix starting on Windows from another drive (#29086) Use removeTask instead of finishTask in PersistentTasksClusterService (#29055) Added minimal docs for reindex api in java-api docs Allow overriding JVM options in Windows service (#29044) Clarify how to set compiler and runtime JDKs (#29101) Fix Parsing Bug with Update By Query for Stored Scripts (#29039) TEST: write ops should execute under shard permit (#28966) [DOCS] Add X-Pack upgrade details (#29038) Revert "Improve error message for installing plugin (#28298)" Docs: HighLevelRestClient#exists (#29073) Validate regular expressions in dynamic templates. (#29013) [Tests] Fix GetResultTests and DocumentFieldTests failures (#29083) Reenable LiveVersionMapTests.testRamBytesUsed on Java 9. (#29063) Mute failing GetResultTests and DocumentFieldTests [Docs] Fix Java Api index administration usage (#28260) Improve error message for installing plugin (#28298) Decouple XContentBuilder from BytesReference (#28972) ...

* es/master: (97 commits) Clarify requirements of strict date formats. (#29090) Clarify that dates are always rendered as strings. (#29093) Compilation fix for #29067 [Docs] Fix link to Grok patterns (#29088) Store offsets in index prefix fields when stored in the parent field (#29067) Fix starting on Windows from another drive (#29086) Use removeTask instead of finishTask in PersistentTasksClusterService (#29055) Added minimal docs for reindex api in java-api docs Allow overriding JVM options in Windows service (#29044) Clarify how to set compiler and runtime JDKs (#29101) CLI: Close subcommands in MultiCommand (#28954) TEST: write ops should execute under shard permit (#28966) [DOCS] Add X-Pack upgrade details (#29038) Revert "Improve error message for installing plugin (#28298)" Docs: HighLevelRestClient#exists (#29073) Validate regular expressions in dynamic templates. (#29013) [Tests] Fix GetResultTests and DocumentFieldTests failures (#29083) Reenable LiveVersionMapTests.testRamBytesUsed on Java 9. (#29063) Mute failing GetResultTests and DocumentFieldTests Improve error message for installing plugin (#28298) ...

mayya-sharipova added :Core/Infra/Core Core issues without another label >enhancement v7.0.0 v6.3.0 labels Jan 18, 2018

jasontedor requested changes Jan 29, 2018

View reviewed changes

mayya-sharipova force-pushed the improve-error-message-for-installing-offline-plugins branch from 0718c7e to ec9b77f Compare January 29, 2018 19:26

mayya-sharipova force-pushed the improve-error-message-for-installing-offline-plugins branch from ec9b77f to 3a0b5a1 Compare February 1, 2018 16:30

jasontedor approved these changes Mar 14, 2018

View reviewed changes

jasontedor added :Core/Infra/Plugins Plugin API and infrastructure and removed :Core/Infra/Core Core issues without another label labels Mar 14, 2018

mayya-sharipova force-pushed the improve-error-message-for-installing-offline-plugins branch from 3a0b5a1 to 8c132d6 Compare March 14, 2018 20:56

Improve error message for installing plugin

68c91ac

Provide more actionable error message when installing an offline plugin in the plugins directory, and the `plugins` directory for the node contains plugin distribution. Closes elastic#27401

mayya-sharipova force-pushed the improve-error-message-for-installing-offline-plugins branch from 8c132d6 to 68c91ac Compare March 14, 2018 21:03

mayya-sharipova merged commit 0cc1ffd into elastic:master Mar 14, 2018

mayya-sharipova deleted the improve-error-message-for-installing-offline-plugins branch March 14, 2018 23:19

mayya-sharipova added a commit that referenced this pull request Mar 15, 2018

Revert "Improve error message for installing plugin (#28298)"

8cb3d18

This reverts commit 0cc1ffd The reason is that Windows test are failing, because of the incorrect path for the plugin

mayya-sharipova added a commit that referenced this pull request Mar 15, 2018

Revert "Improve error message for installing plugin (#28298)"

0dcd0f7

This reverts commit 6284b7e. The reason is that Windows test are failing, because of the incorrect path for the plugin

colings86 added v7.0.0-beta1 and removed v7.0.0 labels Feb 7, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Improve error message when installing an offline plugin #28298

Improve error message when installing an offline plugin #28298

mayya-sharipova commented Jan 18, 2018

jasontedor left a comment

jasontedor Jan 29, 2018

rjernst commented Jan 31, 2018

jasontedor commented Mar 14, 2018

mayya-sharipova commented Mar 14, 2018 •

edited

Loading

jasontedor commented Mar 14, 2018

jasontedor left a comment

jasontedor Mar 14, 2018

elasticmachine commented Mar 14, 2018

jasontedor commented Mar 14, 2018

jasontedor commented Mar 14, 2018

Improve error message when installing an offline plugin #28298

Improve error message when installing an offline plugin #28298

Conversation

mayya-sharipova commented Jan 18, 2018

jasontedor left a comment

Choose a reason for hiding this comment

jasontedor Jan 29, 2018

Choose a reason for hiding this comment

rjernst commented Jan 31, 2018

jasontedor commented Mar 14, 2018

mayya-sharipova commented Mar 14, 2018 • edited Loading

jasontedor commented Mar 14, 2018

jasontedor left a comment

Choose a reason for hiding this comment

jasontedor Mar 14, 2018

Choose a reason for hiding this comment

elasticmachine commented Mar 14, 2018

jasontedor commented Mar 14, 2018

jasontedor commented Mar 14, 2018

mayya-sharipova commented Mar 14, 2018 •

edited

Loading