Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Changed warning message about invalid plugins to be more helpful #10251

Closed

Conversation

adaqus
Copy link

@adaqus adaqus commented Jun 23, 2016

Currently when plugin cannot be loaded warning message looks as below:

old_warning

This information is misleading, because it appears also when plugin's directory is empty or is not readable. This PR introduces following message:

new_warning

@tsteur tsteur added the Needs Review PRs that need a code review label Jun 29, 2016
@@ -19,7 +19,8 @@
"ImageTrackingLink": "Image Tracking Link",
"ImportingServerLogs": "Importing Server Logs",
"ImportingServerLogsDesc": "An alternative to tracking visitors through the browser (either via JavaScript or an image link) is to continuously import server logs. Learn more about %1$sServer Log File Analytics%2$s.",
"InvalidPluginsWarning": "The following plugins are not compatible with %1$s and could not be loaded: %2$s.",
"InvalidPluginsWarning": "The following plugins could not be loaded: %1$s.",
"InvalidPluginsWarningReasons": "Possible reasons of this situation are: plugin is not compatible with %1$s, plugin's directory is not readable or is empty.",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe rather something like

Please check if the plugin's directory exists and is readable. If so, the plugin may not be compatible with %1$s.

Problem is people won't know how to check whether a plugin is compatible. It would be even better to check all these things and then directly point it out. Eg we could check whether a plugin is not compatible, we could check if directory does not exist and mention it, and we could check if directory exists but is empty (or misses a plugin.json)

@mattab
Copy link
Member

mattab commented Jul 8, 2016

It would be even better to check all these things and then directly point it out. Eg we could check whether a plugin is not compatible, we could check if directory does not exist and mention it, and we could check if directory exists but is empty (or misses a plugin.json)

👍 to write the actual cause of the error, so it is most helpful for troubleshooting without effort needed on the user's part.

@mattab mattab added this to the 2.16.x (LTS) milestone Jul 8, 2016
@mattab mattab added PP and removed PP labels Jul 8, 2016
@mattab mattab modified the milestones: 2.16.3, 2.16.x (LTS) Jul 18, 2016
@adaqus
Copy link
Author

adaqus commented Jul 20, 2016

@mattab This is a good idea and it is even worth to enhance it: set of plugin validators can be created that would be reusable in many places in Piwik, for example also in plugin:activate command, where information about problems with plugin would be very helpful.

But so far we have no resources to implement feature where for each plugin actual cause of problem is displayed. Change introduced with this PR is still some improvement which may significantly decrease time spent on investigating why plugin cannot be activated.

@mattab mattab added the Pull Request WIP Indicates the current pull request is still work in progress and not ready yet for a review. label Jul 21, 2016
@mattab mattab modified the milestones: 2.16.x (LTS), 2.16.3 Jul 21, 2016
@mattab mattab modified the milestones: 2.16.x (LTS), 2.16.3, 3.0.0 Aug 23, 2016
@tsteur tsteur changed the base branch from master to 2.x-dev September 1, 2016 06:38
@mattab
Copy link
Member

mattab commented Sep 23, 2016

@adaqus Sounds like maybe you would not apply the feedback to the PR. I'm closing for now but feel free to re-open with the feedback applied and we'll be happy to merge 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Needs Review PRs that need a code review Pull Request WIP Indicates the current pull request is still work in progress and not ready yet for a review.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants