[Bug 26207] New: Compare values of system preference log entries
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=26207 Bug ID: 26207 Summary: Compare values of system preference log entries Change sponsored?: --- Product: Koha Version: master Hardware: All OS: All Status: ASSIGNED Severity: enhancement Priority: P5 - low Component: Tools Assignee: koha-bugs@lists.koha-community.org Reporter: oleonard@myacpl.org QA Contact: testopia@bugs.koha-community.org I could be useful to offer a diff tool for system preference update entries in the log viewer. This is especially relevant to preferences like OpacUserCSS or OpacUserJS where it might be difficult to spot what changes were made. -- You are receiving this mail because: You are watching all bug changes. You are the assignee for the bug.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=26207 --- Comment #1 from Owen Leonard <oleonard@myacpl.org> --- *It* could be useful. But yes, I could be useful too I guess. -- You are receiving this mail because: You are watching all bug changes. You are the assignee for the bug.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=26207 Lucas Gass <lucas@bywatersolutions.com> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |lucas@bywatersolutions.com -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=26207 --- Comment #2 from Lucas Gass <lucas@bywatersolutions.com> --- +1 -- You are receiving this mail because: You are watching all bug changes. You are the assignee for the bug.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=26207 Owen Leonard <oleonard@myacpl.org> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|ASSIGNED |Needs Signoff Patch complexity|--- |Small patch -- You are receiving this mail because: You are watching all bug changes. You are the assignee for the bug.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=26207 --- Comment #3 from Owen Leonard <oleonard@myacpl.org> --- Created attachment 108271 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=108271&action=edit Bug 26207: Compare values of system preference log entries This patch adds the ability to compare the values of system preferences in the system log. The user can select two entries in the log search results and view a diff of the two versions. The feature is designed specifically for CSS and JS preferences like OpacUserCSS or OpacUserJS where code changes are difficult to track. To test, apply the patch and go to Tools -> Log viewer. You may need to add values and make changes to preferences like OpacUserCSS if you don't already have a history in your logs. - Perform a search for log entries in the "System prefs" module. - In the results, each entry for a system preference should have a "Compare" checkbox." - Check one of the checkboxes. - The table should now be filtered by the system preference name. This facilitates meaningful selections for comparison. - You should see a message displayed onscreen, "Showing results for...[ preference name]" - The "Check none" link in the toolbar above the table should now be enabled. - If youy click the "Compare selected" link in the toolbar at this stage you should get a message, "You must select two entries to compare." - If you uncheck the checkbox the table should return to an unfiltered state. - Check two checkboxes. - The "Compare selected" link in the toolbar should now be enabled. - Next to each of the checkboxes you checked should be a "View comparison" link. - Clicking either of the "View comparison" links or the "Compare selected" link should trigger a modal with the diff view of the two preferences. - Try to select a third checkbox. You should get a message, "You can select a maximum of two checkboxes." The box should remain unchecked. - Test that unchecking both checkboxes manually clears the table filter. - Test that the "Check none" link works to uncheck checked boxes and clear the table filter. -- You are receiving this mail because: You are watching all bug changes. You are the assignee for the bug.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=26207 Owen Leonard <oleonard@myacpl.org> changed: What |Removed |Added ---------------------------------------------------------------------------- Assignee|koha-bugs@lists.koha-commun |oleonard@myacpl.org |ity.org | -- You are receiving this mail because: You are watching all bug changes. You are the assignee for the bug.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=26207 Owen Leonard <oleonard@myacpl.org> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |barbara.johnson@bedfordtx.g | |ov -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=26207 --- Comment #4 from Barbara Johnson <barbara.johnson@bedfordtx.gov> --- The patch worked well and I will find it very useful. Here are some observations from testing: For libraries that have a lot of CSS or jQuery it would be helpful to add a horizontal scroll bar at the top of the modal. I think it would be preferable to have the first line of the modal left justified - right now it is indented. Also, it would be nice to have the name of the system preference (such as IntranetUserJS) on the first line of the modal with the first line of actual code displaying on a separate line - right now the first line of code displays after the system preference name and it runs off the page causing the user to have to scroll. Removing code worked just fine. Copying a section of code and moving to another place in the system preference would split comments. It would be helpful if the log entries were numbered - I know that this is not part of this bug but as I was testing it would have been helpful. I can submit that as another bug. Here's an example from testing - https://snipboard.io/ZFnmI0.jpg -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=26207 Brandon J <brandon.jimenez@inlibro.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|Needs Signoff |Signed Off -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=26207 Brandon J <brandon.jimenez@inlibro.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #108271|0 |1 is obsolete| | --- Comment #5 from Brandon J <brandon.jimenez@inlibro.com> --- Created attachment 108692 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=108692&action=edit Bug 26207: Compare values of system preference log entries This patch adds the ability to compare the values of system preferences in the system log. The user can select two entries in the log search results and view a diff of the two versions. The feature is designed specifically for CSS and JS preferences like OpacUserCSS or OpacUserJS where code changes are difficult to track. To test, apply the patch and go to Tools -> Log viewer. You may need to add values and make changes to preferences like OpacUserCSS if you don't already have a history in your logs. - Perform a search for log entries in the "System prefs" module. - In the results, each entry for a system preference should have a "Compare" checkbox." - Check one of the checkboxes. - The table should now be filtered by the system preference name. This facilitates meaningful selections for comparison. - You should see a message displayed onscreen, "Showing results for...[ preference name]" - The "Check none" link in the toolbar above the table should now be enabled. - If youy click the "Compare selected" link in the toolbar at this stage you should get a message, "You must select two entries to compare." - If you uncheck the checkbox the table should return to an unfiltered state. - Check two checkboxes. - The "Compare selected" link in the toolbar should now be enabled. - Next to each of the checkboxes you checked should be a "View comparison" link. - Clicking either of the "View comparison" links or the "Compare selected" link should trigger a modal with the diff view of the two preferences. - Try to select a third checkbox. You should get a message, "You can select a maximum of two checkboxes." The box should remain unchecked. - Test that unchecking both checkboxes manually clears the table filter. - Test that the "Check none" link works to uncheck checked boxes and clear the table filter. Signed-off-by: Brandon J <brandon.jimenez@inLibro.com> -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=26207 --- Comment #6 from Owen Leonard <oleonard@myacpl.org> --- (In reply to Barbara Johnson from comment #4)
For libraries that have a lot of CSS or jQuery it would be helpful to add a horizontal scroll bar at the top of the modal.
I don't think this is something I can add. The scrollbars are generated by the browser based on the overflow of the content in each pane.
I think it would be preferable to have the first line of the modal left justified - right now it is indented.
This is a whitespace issue which I can address in a follow-up.
Also, it would be nice to have the name of the system preference (such as IntranetUserJS) on the first line of the modal with the first line of actual code displaying on a separate line
I think the whitespace correction will at least help. -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=26207 --- Comment #7 from Owen Leonard <oleonard@myacpl.org> --- Created attachment 108736 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=108736&action=edit Bug 26207: (follow-up) Remove whitespace from markup Markup indentation around log entries in the template cause extra whitespace in the diff view. Removing the markup whitespace corrects it. -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=26207 Katrin Fischer <katrin.fischer@bsz-bw.de> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|Signed Off |Passed QA -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=26207 Katrin Fischer <katrin.fischer@bsz-bw.de> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #108692|0 |1 is obsolete| | --- Comment #8 from Katrin Fischer <katrin.fischer@bsz-bw.de> --- Created attachment 108760 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=108760&action=edit Bug 26207: Compare values of system preference log entries This patch adds the ability to compare the values of system preferences in the system log. The user can select two entries in the log search results and view a diff of the two versions. The feature is designed specifically for CSS and JS preferences like OpacUserCSS or OpacUserJS where code changes are difficult to track. To test, apply the patch and go to Tools -> Log viewer. You may need to add values and make changes to preferences like OpacUserCSS if you don't already have a history in your logs. - Perform a search for log entries in the "System prefs" module. - In the results, each entry for a system preference should have a "Compare" checkbox." - Check one of the checkboxes. - The table should now be filtered by the system preference name. This facilitates meaningful selections for comparison. - You should see a message displayed onscreen, "Showing results for...[ preference name]" - The "Check none" link in the toolbar above the table should now be enabled. - If youy click the "Compare selected" link in the toolbar at this stage you should get a message, "You must select two entries to compare." - If you uncheck the checkbox the table should return to an unfiltered state. - Check two checkboxes. - The "Compare selected" link in the toolbar should now be enabled. - Next to each of the checkboxes you checked should be a "View comparison" link. - Clicking either of the "View comparison" links or the "Compare selected" link should trigger a modal with the diff view of the two preferences. - Try to select a third checkbox. You should get a message, "You can select a maximum of two checkboxes." The box should remain unchecked. - Test that unchecking both checkboxes manually clears the table filter. - Test that the "Check none" link works to uncheck checked boxes and clear the table filter. Signed-off-by: Brandon J <brandon.jimenez@inLibro.com> Signed-off-by: Katrin Fischer <katrin.fischer.83@web.de> -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=26207 Katrin Fischer <katrin.fischer@bsz-bw.de> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #108736|0 |1 is obsolete| | --- Comment #9 from Katrin Fischer <katrin.fischer@bsz-bw.de> --- Created attachment 108761 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=108761&action=edit Bug 26207: (follow-up) Remove whitespace from markup Markup indentation around log entries in the template cause extra whitespace in the diff view. Removing the markup whitespace corrects it. Signed-off-by: Katrin Fischer <katrin.fischer.83@web.de> -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=26207 --- Comment #10 from Katrin Fischer <katrin.fischer@bsz-bw.de> --- I really like this feature! Only thing I was wondering is the label on the checkbox. Currently it reads 'compare' but it also has a filter function. I wonder if something like "Filter and compare" would work? -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=26207 --- Comment #11 from Owen Leonard <oleonard@myacpl.org> --- (In reply to Katrin Fischer from comment #10)
Currently it reads 'compare' but it also has a filter function.
I hoped that any confusion would be mitigated by the pop-up message that results were filtered after checking the box. -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=26207 Jonathan Druart <jonathan.druart@bugs.koha-community.org> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |jonathan.druart@bugs.koha-c | |ommunity.org --- Comment #12 from Jonathan Druart <jonathan.druart@bugs.koha-community.org> --- Some suggestions: 1. Isn't the popup superfluous? It appears quite often when you start clicking. Even when the second checkbox is unchecked. 2. "Check none" and "Compare selected" are styled differently when disabled, is that expected? 3. Should not we remove the toolbar if there is no syspref in the table result? And/or have a on hover tooltip to tell what it is? 4. Isn't the blue background colour too visible? We could have it only for the label (not on all the line)? https://snipboard.io/Rpdkxq.jpg vs https://snipboard.io/lvUfhV.jpg (I added a float: right) 5. Since the toolbar is float, aren't "Compare selected" and "View comparison" duplicate? https://snipboard.io/NuXwMp.jpg All for discussion, not considering blocker. -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=26207 Jonathan Druart <jonathan.druart@bugs.koha-community.org> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|Passed QA |ASSIGNED -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=26207 Katrin Fischer <katrin.fischer@bsz-bw.de> changed: What |Removed |Added ---------------------------------------------------------------------------- See Also| |https://bugs.koha-community | |.org/bugzilla3/show_bug.cgi | |?id=14233 -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=26207 --- Comment #13 from Barbara Johnson <barbara.johnson@bedfordtx.gov> --- (In reply to Jonathan Druart from comment #12) Item #4 - I actually prefer the blue background color extending the full width. We have a lot of jQuery and CSS - having that color to look for helped me to find the bottom of the long entries where the compare and select buttons are. -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=26207 --- Comment #14 from Owen Leonard <oleonard@myacpl.org> --- Created attachment 110848 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=110848&action=edit Bug 26207: (follow-up) Hide comparison toolbar if there are no comparisons This patch adds a check to the JavaScript so that the comparisons toolbar will be hidden if there are no system preferences in the results to compare. -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=26207 Owen Leonard <oleonard@myacpl.org> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|ASSIGNED |Needs Signoff -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=26207 Owen Leonard <oleonard@myacpl.org> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|Needs Signoff |Signed Off -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=26207 Owen Leonard <oleonard@myacpl.org> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|Signed Off |Passed QA -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=26207 --- Comment #15 from Owen Leonard <oleonard@myacpl.org> --- (In reply to Jonathan Druart from comment #12)
Some suggestions: 1. Isn't the popup superfluous? It appears quite often when you start clicking. Even when the second checkbox is unchecked.
It may be, but I think in this situation it's better to make it very clear to the user what is going on.
2. "Check none" and "Compare selected" are styled differently when disabled, is that expected?
Yes.
3. Should not we remove the toolbar if there is no syspref in the table result?
Addressed in the last followup.
5. Since the toolbar is float, aren't "Compare selected" and "View comparison" duplicate?
As with question #1, I think in this situation some redundancy is good for clarity. -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=26207 Jonathan Druart <jonathan.druart@bugs.koha-community.org> changed: What |Removed |Added ---------------------------------------------------------------------------- Version(s)| |20.11.00 released in| | Status|Passed QA |Pushed to master -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=26207 --- Comment #16 from Jonathan Druart <jonathan.druart@bugs.koha-community.org> --- Pushed to master for 20.11, thanks to everybody involved! -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=26207 --- Comment #17 from Katrin Fischer <katrin.fischer@bsz-bw.de> --- Owen, could we have this for reports log too? -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=26207 Owen Leonard <oleonard@myacpl.org> changed: What |Removed |Added ---------------------------------------------------------------------------- Blocks| |26736 Referenced Bugs: https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=26736 [Bug 26736] Compare values of reports log entries -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=26207 --- Comment #18 from Lucas Gass <lucas@bywatersolutions.com> --- enhancement will not be backported to 20.05.x -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=26207 Jonathan Druart <jonathan.druart@bugs.koha-community.org> changed: What |Removed |Added ---------------------------------------------------------------------------- Keywords| |release-notes-needed -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=26207 Owen Leonard <oleonard@myacpl.org> changed: What |Removed |Added ---------------------------------------------------------------------------- Keywords|release-notes-needed | Text to go in the| |This patch adds a feature release notes| |to the log viewer in the | |staff interface for use | |when viewing system | |preference log entries. The | |feature allows the user to | |select two system | |preference values in the | |log for comparison. The two | |versions are shown in a | |modal window with the | |differences highlighted. -- You are receiving this mail because: You are watching all bug changes.
participants (1)
-
bugzilla-daemon＠bugs.koha-community.org