|
Description
Chip Halvorsen
2025-06-25 18:20:06 UTC
Created attachment 184501 [details] [review] Bug 40245: Add new system preference ShowFirstIfDifferentThanPreferred Adds a new system preference ShowFirstIfDifferentThanPreferred to allow a patron's firstname to be shown in search results when different than their preferred name. Created attachment 184502 [details] [review] Bug 40245: Show firstname in patron search results when different than preferred_name This patch shows the patron's firstname in search results and autosuggestions when thier preferred_name is different than their first name. Requires that sysprep ShowFirstIfDifferentThanPreferred is enabled. When disabled, only the preferred name shows in results. Test plan: 0. Apply patches and login to the staff interface. 1. Edit a patron to give a different preferred name than first. 2. Return to home page and search for the patron in the quick-search bar. 3. Verify patron shows up in autosuggest list, showing preferred name only. 4. Verify patron shows up in regular list (member.pl) with preferred name showing only. 5. Change syspref ShowFirstIfDifferentThanPreferred to "Show" and save. 6. Return to home page and search for the patron in the quick-search bar. 7. Verify patron shows up in autosuggest list, showing preferred name, and firstname in brackets. 8. Verify patron shows up in regular list (member.pl) with preferred name, and firstname in brackets. Sponsored-by: Westlake Porter Public Library <https://westlakelibrary.org> *** Bug 40484 has been marked as a duplicate of this bug. *** Created attachment 184637 [details] [review] Bug 40245: Show firstname in patron search results when different than preferred_name This patch shows the patron's firstname in search results and autosuggestions when thier preferred_name is different than their first name. Requires that sysprep ShowFirstIfDifferentThanPreferred is enabled. When disabled, only the preferred name shows in results. Test plan: 0. Apply patches and login to the staff interface. 1. Edit a patron to give a different preferred name than first. 2. Return to home page and search for the patron in the quick-search bar. 3. Verify patron shows up in autosuggest list, showing preferred name only. 4. Verify patron shows up in regular list (member.pl) with preferred name showing only. 5. Change syspref ShowFirstIfDifferentThanPreferred to "Show" and save. 6. Return to home page and search for the patron in the quick-search bar. 7. Verify patron shows up in autosuggest list, showing preferred name, and firstname in brackets. 8. Verify patron shows up in regular list (member.pl) with preferred name, and firstname in brackets. Sponsored-by: Westlake Porter Public Library <https://westlakelibrary.org> Signed-off-by: Emily Lamancusa <emily.lamancusa@montgomerycountymd.gov> Created attachment 184638 [details] [review] Bug 40245: Add new system preference ShowFirstIfDifferentThanPreferred Adds a new system preference ShowFirstIfDifferentThanPreferred to allow a patron's firstname to be shown in search results when different than their preferred name. Signed-off-by: Emily Lamancusa <emily.lamancusa@montgomerycountymd.gov> Created attachment 184639 [details] [review] Bug 40245: Show firstname in patron search results when different than preferred_name This patch shows the patron's firstname in search results and autosuggestions when thier preferred_name is different than their first name. Requires that sysprep ShowFirstIfDifferentThanPreferred is enabled. When disabled, only the preferred name shows in results. Test plan: 0. Apply patches and login to the staff interface. 1. Edit a patron to give a different preferred name than first. 2. Return to home page and search for the patron in the quick-search bar. 3. Verify patron shows up in autosuggest list, showing preferred name only. 4. Verify patron shows up in regular list (member.pl) with preferred name showing only. 5. Change syspref ShowFirstIfDifferentThanPreferred to "Show" and save. 6. Return to home page and search for the patron in the quick-search bar. 7. Verify patron shows up in autosuggest list, showing preferred name, and firstname in brackets. 8. Verify patron shows up in regular list (member.pl) with preferred name, and firstname in brackets. Sponsored-by: Westlake Porter Public Library <https://westlakelibrary.org> Signed-off-by: Emily Lamancusa <emily.lamancusa@montgomerycountymd.gov> Thanks, CJ! This looks nice and works as advertised! Testing notes: - After applying patch, run updatedatabase and clear browser cache Created attachment 185601 [details] [review] Bug 40245: Show firstname in patron search results when different than preferred_name This patch shows the patron's firstname in search results and autosuggestions when thier preferred_name is different than their first name. Requires that sysprep ShowFirstIfDifferentThanPreferred is enabled. When disabled, only the preferred name shows in results. Test plan: 0. Apply patches and login to the staff interface. 1. Edit a patron to give a different preferred name than first. 2. Return to home page and search for the patron in the quick-search bar. 3. Verify patron shows up in autosuggest list, showing preferred name only. 4. Verify patron shows up in regular list (member.pl) with preferred name showing only. 5. Change syspref ShowFirstIfDifferentThanPreferred to "Show" and save. 6. Return to home page and search for the patron in the quick-search bar. 7. Verify patron shows up in autosuggest list, showing preferred name, and firstname in brackets. 8. Verify patron shows up in regular list (member.pl) with preferred name, and firstname in brackets. Sponsored-by: Westlake Porter Public Library <https://westlakelibrary.org> Signed-off-by: Emily Lamancusa <emily.lamancusa@montgomerycountymd.gov> Signed-off-by: Chip <chip.halvorsen@westlakelibrary.org> Tested and everything works as expected. Created attachment 185602 [details] [review] Bug 40245: Add new system preference ShowFirstIfDifferentThanPreferred Adds a new system preference ShowFirstIfDifferentThanPreferred to allow a patron's firstname to be shown in search results when different than their preferred name. Signed-off-by: Emily Lamancusa <emily.lamancusa@montgomerycountymd.gov> Signed-off-by: Chip <chip.halvorsen@westlakelibrary.org> Created attachment 185603 [details] [review] Bug 40245: Show firstname in patron search results when different than preferred_name This patch shows the patron's firstname in search results and autosuggestions when thier preferred_name is different than their first name. Requires that sysprep ShowFirstIfDifferentThanPreferred is enabled. When disabled, only the preferred name shows in results. Test plan: 0. Apply patches and login to the staff interface. 1. Edit a patron to give a different preferred name than first. 2. Return to home page and search for the patron in the quick-search bar. 3. Verify patron shows up in autosuggest list, showing preferred name only. 4. Verify patron shows up in regular list (member.pl) with preferred name showing only. 5. Change syspref ShowFirstIfDifferentThanPreferred to "Show" and save. 6. Return to home page and search for the patron in the quick-search bar. 7. Verify patron shows up in autosuggest list, showing preferred name, and firstname in brackets. 8. Verify patron shows up in regular list (member.pl) with preferred name, and firstname in brackets. Sponsored-by: Westlake Porter Public Library <https://westlakelibrary.org> Signed-off-by: Emily Lamancusa <emily.lamancusa@montgomerycountymd.gov> Signed-off-by: Chip <chip.halvorsen@westlakelibrary.org> Created attachment 186732 [details] [review] Bug 40245: Add new system preference ShowFirstIfDifferentThanPreferred Adds a new system preference ShowFirstIfDifferentThanPreferred to allow a patron's firstname to be shown in search results when different than their preferred name. Signed-off-by: Emily Lamancusa <emily.lamancusa@montgomerycountymd.gov> Signed-off-by: Chip <chip.halvorsen@westlakelibrary.org> Signed-off-by: Laura_Escamilla <laura.escamilla@bywatersolutions.com> Created attachment 186733 [details] [review] Bug 40245: Show firstname in patron search results when different than preferred_name This patch shows the patron's firstname in search results and autosuggestions when thier preferred_name is different than their first name. Requires that sysprep ShowFirstIfDifferentThanPreferred is enabled. When disabled, only the preferred name shows in results. Test plan: 0. Apply patches and login to the staff interface. 1. Edit a patron to give a different preferred name than first. 2. Return to home page and search for the patron in the quick-search bar. 3. Verify patron shows up in autosuggest list, showing preferred name only. 4. Verify patron shows up in regular list (member.pl) with preferred name showing only. 5. Change syspref ShowFirstIfDifferentThanPreferred to "Show" and save. 6. Return to home page and search for the patron in the quick-search bar. 7. Verify patron shows up in autosuggest list, showing preferred name, and firstname in brackets. 8. Verify patron shows up in regular list (member.pl) with preferred name, and firstname in brackets. Sponsored-by: Westlake Porter Public Library <https://westlakelibrary.org> Signed-off-by: Emily Lamancusa <emily.lamancusa@montgomerycountymd.gov> Signed-off-by: Chip <chip.halvorsen@westlakelibrary.org> Signed-off-by: Laura_Escamilla <laura.escamilla@bywatersolutions.com> Should we add a Cypress test? I think we should have "Patron" and "Firstname" in the name of the pref. The current version "ShowFirstIfDifferentThanPreferred" is confusing IMO. 1. What does "showlegal" mean?
2.
var showFirstIfDifferentThanPreferred = [% Koha.Preference('ShowFirstIfDifferentThanPreferred') | html %];
Should be
var showFirstIfDifferentThanPreferred = [% Koha.Preference('ShowFirstIfDifferentThanPreferred') ? 1 : 0 | html %];
To prevent a JS error if the pref is not set.
3. js-patron-format.inc is going to be removed on bug 40958, in favor of a js file, and the TT variable won't be accessible. Why don't you pass the "showFirstIfDifferentThanPreferred" flag from the patron search if the pref is set? You won't need to check the pref in the inc file
4. Commit message states that it affects "search results and autosuggestions" but it's actually all patron searches (bug title should also be adjusted)
5.
(In reply to Lucas Gass (lukeg) from comment #14)
> Should we add a Cypress test?
Yes, that would be great!
Feel free to ask if you have questions or need help! (In reply to Jonathan Druart from comment #16) > 1. What does "showlegal" mean? Show legal name (vs nickname or dead name), though in retrospect, 'showfirstname' would be more appropriate and match other language. > 2. [...] Thanks for catching, I'll make that change (and remember for next time) > 3. [...] Good idea, and thanks for pointing out bug 40958. I'll adjust to incorporate those changes. > 4. Commit message states that it affects "search results and > autosuggestions" but it's actually all patron searches (bug title should > also be adjusted) Thanks and good point, I will adjust. > 5. > (In reply to Lucas Gass (lukeg) from comment #14) > > Should we add a Cypress test? I might need some help on this one, I've not written Cypress tests before. Is there a past bug or two that has some good Koha-related examples to look at? Thanks! (In reply to Jonathan Druart from comment #15) > I think we should have "Patron" and "Firstname" in the name of the pref. The > current version "ShowFirstIfDifferentThanPreferred" is confusing IMO. Is there a limit on how long a system pref name could/should be? ShowPatronFirstnameIfDifferentThanPreferredname is more clear, but long (48 chr) It is shorter than PatronSelfRegistrationExpireTemporaryAccountsDelay (51 chr) (In reply to CJ Lynce from comment #18) > (In reply to Jonathan Druart from comment #16) > > 5. > > (In reply to Lucas Gass (lukeg) from comment #14) > > > Should we add a Cypress test? > > I might need some help on this one, I've not written Cypress tests before. > Is there a past bug or two that has some good Koha-related examples to look > at? I have spent some time to write some tests for main. And all the bugs in the queue should be based on it. See bug 41003. You will see that your patch breaks it (because of the changes in autocomplete, other_name is now missing) We already have: Bug 40958 - Move patron_to_html (from js-patron-format.inc) to a standalone JS file Bug 40995 - Patron search autocomplete adds extraneous spacing and punctuation when patron lacks surname In this second one I suggested to use patron-format for the autocomplete result. I think it is good for this change (40245) actually: you won't need to adjust much patron_autocomplete, only to pass the "show first if different" flag. (In reply to CJ Lynce from comment #19) > (In reply to Jonathan Druart from comment #15) > > I think we should have "Patron" and "Firstname" in the name of the pref. The > > current version "ShowFirstIfDifferentThanPreferred" is confusing IMO. > > Is there a limit on how long a system pref name could/should be? > ShowPatronFirstnameIfDifferentThanPreferredname is more clear, but long (48 > chr) > It is shorter than PatronSelfRegistrationExpireTemporaryAccountsDelay (51 > chr) The max length is 50. And PatronSelfRegistrationExpireTemporaryAccountsDelay is 50 char length ;) Created attachment 187891 [details] [review] Bug 40245: Add new system preference ShowPatronFirstnameIfDifferentThanPreferredname Adds a new system preference ShowPatronFirstnameIfDifferentThanPreferredname to allow a patron's firstname to be shown in search results when different than their preferred name. Sponsored-by: Westlake Porter Public Library <https://westlakelibrary.org> Created attachment 187892 [details] [review] Bug 40245: Show firstname in patron search results when different than preferred_name This patch shows the patron's firstname in patron search results and autosuggestions when the patrons preferred_name is different than their first name. Requires that the ShowPatronFirstnameIfDifferentThanPreferredname system preference is enabled. Test plan: 0. Apply patches and login to the staff interface. 1. Edit a patron to give a different preferred name than firstname. 2. Return to home page and search for the patron in the quick-search bar. 3. Verify patron shows up in autosuggest list, showing preferred name only. 4. Verify patron shows up in regular list (member.pl) with preferred name showing only. 5. Change syspref ShowFirstIfDifferentThanPreferred to "Show" and save. 6. Return to home page and search for the patron in the quick-search bar. 7. Verify patron shows up in autosuggest list, showing preferred name, and firstname in brackets. 8. Verify patron shows up in regular list (member.pl) with preferred name, and firstname in brackets. Sponsored-by: Westlake Porter Public Library <https://westlakelibrary.org> Created attachment 187893 [details] [review] Bug 40245: Update cypress test to handle ShowPatronFirstnameIfDifferentThanPreferredname Updates patron format cypress tests to allow for ShowPatronFirstnameIfDifferentThanPreferredname These new patches incorporate previous suggestions. Additionally, I changed the display behavior of the `Firstname` when the feature is turned on and preferred_name is different for a patron; it now displays in addition to the `othernames`, and not instead of `othernames` as it did originally. It adds slightly to the length of the overall patron name in search results, but will better accommodate organizations that use both `preferred_name` and `othernames`. For the Cypress tests, I adjusted the existing patron displays tests from previous bugs (bug 40995, bug 32176, bug 41003), to accommodate the addition of `preferred_name`. I welcome any feedback! Thanks for the help and suggestions thus far. Created attachment 187943 [details] [review] Bug 40245: Update cypress tests to handle ShowPatronFirstnameIfDifferentThanPreferredname Updates patron format cypress tests to allow for ShowPatronFirstnameIfDifferentThanPreferredname Test Plan: -Install Patch -On command line, in koha root directory, run `cypress run --spec t/cypress/integration/Patron/Format.ts` -Check to make all tests pass Created attachment 188112 [details] [review] Bug 40245: Add new system preference ShowPatronFirstnameIfDifferentThanPreferredname Adds a new system preference ShowPatronFirstnameIfDifferentThanPreferredname to allow a patron's firstname to be shown in search results when different than their preferred name. Sponsored-by: Westlake Porter Public Library <https://westlakelibrary.org> Signed-off-by: Andrew Fuerste Henry <andrew@bywatersolutions.com> Created attachment 188113 [details] [review] Bug 40245: Show firstname in patron search results when different than preferred_name This patch shows the patron's firstname in patron search results and autosuggestions when the patrons preferred_name is different than their first name. Requires that the ShowPatronFirstnameIfDifferentThanPreferredname system preference is enabled. Test plan: 0. Apply patches and login to the staff interface. 1. Edit a patron to give a different preferred name than firstname. 2. Return to home page and search for the patron in the quick-search bar. 3. Verify patron shows up in autosuggest list, showing preferred name only. 4. Verify patron shows up in regular list (member.pl) with preferred name showing only. 5. Change syspref ShowFirstIfDifferentThanPreferred to "Show" and save. 6. Return to home page and search for the patron in the quick-search bar. 7. Verify patron shows up in autosuggest list, showing preferred name, and firstname in brackets. 8. Verify patron shows up in regular list (member.pl) with preferred name, and firstname in brackets. Sponsored-by: Westlake Porter Public Library <https://westlakelibrary.org> Signed-off-by: Andrew Fuerste Henry <andrew@bywatersolutions.com> Created attachment 188114 [details] [review] Bug 40245: Update cypress test to handle ShowPatronFirstnameIfDifferentThanPreferredname Updates patron format cypress tests to allow for ShowPatronFirstnameIfDifferentThanPreferredname Test Plan: -Install Patch -On command line, in koha root directory, run `cypress run --spec t/cypress/integration/Patron/Format.ts` -Check to make all tests pass Signed-off-by: Andrew Fuerste Henry <andrew@bywatersolutions.com> Created attachment 188811 [details] [review] Bug 40245: Add new system preference ShowPatronFirstnameIfDifferentThanPreferredname Adds a new system preference ShowPatronFirstnameIfDifferentThanPreferredname to allow a patron's firstname to be shown in search results when different than their preferred name. Sponsored-by: Westlake Porter Public Library <https://westlakelibrary.org> Signed-off-by: Andrew Fuerste Henry <andrew@bywatersolutions.com> Signed-off-by: Nick Clemens <nick@bywatersolutions.com> Created attachment 188812 [details] [review] Bug 40245: Show firstname in patron search results when different than preferred_name This patch shows the patron's firstname in patron search results and autosuggestions when the patrons preferred_name is different than their first name. Requires that the ShowPatronFirstnameIfDifferentThanPreferredname system preference is enabled. Test plan: 0. Apply patches and login to the staff interface. 1. Edit a patron to give a different preferred name than firstname. 2. Return to home page and search for the patron in the quick-search bar. 3. Verify patron shows up in autosuggest list, showing preferred name only. 4. Verify patron shows up in regular list (member.pl) with preferred name showing only. 5. Change syspref ShowFirstIfDifferentThanPreferred to "Show" and save. 6. Return to home page and search for the patron in the quick-search bar. 7. Verify patron shows up in autosuggest list, showing preferred name, and firstname in brackets. 8. Verify patron shows up in regular list (member.pl) with preferred name, and firstname in brackets. Sponsored-by: Westlake Porter Public Library <https://westlakelibrary.org> Signed-off-by: Andrew Fuerste Henry <andrew@bywatersolutions.com> Signed-off-by: Nick Clemens <nick@bywatersolutions.com> Created attachment 188813 [details] [review] Bug 40245: Update cypress test to handle ShowPatronFirstnameIfDifferentThanPreferredname Updates patron format cypress tests to allow for ShowPatronFirstnameIfDifferentThanPreferredname Test Plan: -Install Patch -On command line, in koha root directory, run `cypress run --spec t/cypress/integration/Patron/Format.ts` -Check to make all tests pass Signed-off-by: Andrew Fuerste Henry <andrew@bywatersolutions.com> Signed-off-by: Nick Clemens <nick@bywatersolutions.com> Nice work everyone! Pushed to main for 25.11 I've updated the manual with the new system preference https://koha-community.org/manual/latest/en/html/patronspreferences.html#showpatronfirstnameifdifferentthanpreferredname-label |