[Bug 35568] New: Add a plugin hook to allow modification of notices created via GetPreparedLetter
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=35568 Bug ID: 35568 Summary: Add a plugin hook to allow modification of notices created via GetPreparedLetter Change sponsored?: --- Product: Koha Version: master Hardware: All OS: All Status: NEW Severity: enhancement Priority: P5 - low Component: Plugin architecture Assignee: koha-bugs@lists.koha-community.org Reporter: kyle@bywatersolutions.com QA Contact: testopia@bugs.koha-community.org A plugin hook for GetPreparedLetter would be very useful. It could be used to add universal headers and/or footers to messages, attach news, and modify notices in other ways in whole or in part. It could even be used for call webhooks when certain types of notices are sent. For example, the MessageBee ( https://uniquelibrary.com/messagebee/ ) plugin for Koha generates YAML based notice content, which is then further processed by the before_send_messages hook. This process is unreliable due to the possible changes in data between the creation of the yaml and the reading of that yaml and transforming it into JSON with much more data. For example, the yaml may contain an issue_id, but that checkout may have been returned in the meantime. A hook like this would allow the MessageBee plugin to skip the yaml step and create the json data directly which is then sent to MessageBee for transmission to the patron. -- 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=35568 Kyle M Hall <kyle@bywatersolutions.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Assignee|koha-bugs@lists.koha-commun |kyle@bywatersolutions.com |ity.org | -- You are receiving this mail because: You are the assignee for the bug. You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=35568 Kyle M Hall <kyle@bywatersolutions.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|NEW |Needs Signoff -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=35568 --- Comment #1 from Kyle M Hall <kyle@bywatersolutions.com> --- Created attachment 159832 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=159832&action=edit Bug 35568: Add a transform_prepared_letter plugin hook to allow modification of notices created via GetPreparedLetter A plugin hook for GetPreparedLetter would be very useful. It could be used to add universal headers and/or footers to messages, attach news, and modify notices in other ways in whole or in part. It could even be used for call webhooks when certain types of notices are sent. For example, the MessageBee ( https://uniquelibrary.com/messagebee/ ) plugin for Koha generates YAML based notice content, which is then further processed by the before_send_messages hook. This process is unreliable due to the possible changes in data between the creation of the yaml and the reading of that yaml and transforming it into JSON with much more data. For example, the yaml may contain an issue_id, but that checkout may have been returned in the meantime. A hook like this would allow the MessageBee plugin to skip the yaml step and create the json data directly which is then sent to MessageBee for transmission to the patron. Test Plan: 1) Apply this patch 2) prove t/db_dependent/Koha/Plugins/Transform_prepared_letter_hook.t 3) Download and install the Kitchen Sink plugin v2.4.0 https://github.com/bywatersolutions/dev-koha-plugin-kitchen-sink/releases/ta... 4) Generate any notice or slip, such as a checkin or checkout notice 5) Note that all notices now end with "Thanks for using your local library!" -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=35568 Kyle M Hall <kyle@bywatersolutions.com> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |kyle@bywatersolutions.com, | |nick@bywatersolutions.com -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=35568 David Nind <david@davidnind.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=35568 David Nind <david@davidnind.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #159832|0 |1 is obsolete| | --- Comment #2 from David Nind <david@davidnind.com> --- Created attachment 159932 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=159932&action=edit Bug 35568: Add a transform_prepared_letter plugin hook to allow modification of notices created via GetPreparedLetter A plugin hook for GetPreparedLetter would be very useful. It could be used to add universal headers and/or footers to messages, attach news, and modify notices in other ways in whole or in part. It could even be used for call webhooks when certain types of notices are sent. For example, the MessageBee ( https://uniquelibrary.com/messagebee/ ) plugin for Koha generates YAML based notice content, which is then further processed by the before_send_messages hook. This process is unreliable due to the possible changes in data between the creation of the yaml and the reading of that yaml and transforming it into JSON with much more data. For example, the yaml may contain an issue_id, but that checkout may have been returned in the meantime. A hook like this would allow the MessageBee plugin to skip the yaml step and create the json data directly which is then sent to MessageBee for transmission to the patron. Test Plan: 1) Apply this patch 2) prove t/db_dependent/Koha/Plugins/Transform_prepared_letter_hook.t 3) Download and install the Kitchen Sink plugin v2.4.0 https://github.com/bywatersolutions/dev-koha-plugin-kitchen-sink/releases/ta... 4) Generate any notice or slip, such as a checkin or checkout notice 5) Note that all notices now end with "Thanks for using your local library!" Signed-off-by: David Nind <david@davidnind.com> -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=35568 David Nind <david@davidnind.com> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |david@davidnind.com --- Comment #3 from David Nind <david@davidnind.com> --- Testing notes (using KTD): 1. Added an email address for a patron (for example, Mary Burton - mary@example.com) 2. Generated notice: Patron page > More > Send welcome email Note: With the v2.4.0 of the plugin it adds an 'I' in front of barcodes entered, so an existing barcode is never found when checking an item in or out (I'm assuming that is part of the code): "Check in message No item with barcode: I39999000011418" -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=35568 Kyle M Hall <kyle@bywatersolutions.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #159932|0 |1 is obsolete| | --- Comment #4 from Kyle M Hall <kyle@bywatersolutions.com> --- Created attachment 162721 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=162721&action=edit Bug 35568: Add a transform_prepared_letter plugin hook to allow modification of notices created via GetPreparedLetter A plugin hook for GetPreparedLetter would be very useful. It could be used to add universal headers and/or footers to messages, attach news, and modify notices in other ways in whole or in part. It could even be used for call webhooks when certain types of notices are sent. For example, the MessageBee ( https://uniquelibrary.com/messagebee/ ) plugin for Koha generates YAML based notice content, which is then further processed by the before_send_messages hook. This process is unreliable due to the possible changes in data between the creation of the yaml and the reading of that yaml and transforming it into JSON with much more data. For example, the yaml may contain an issue_id, but that checkout may have been returned in the meantime. A hook like this would allow the MessageBee plugin to skip the yaml step and create the json data directly which is then sent to MessageBee for transmission to the patron. Test Plan: 1) Apply this patch 2) prove t/db_dependent/Koha/Plugins/Transform_prepared_letter_hook.t 3) Download and install the Kitchen Sink plugin v2.4.0 https://github.com/bywatersolutions/dev-koha-plugin-kitchen-sink/releases/ta... 4) Generate any notice or slip, such as a checkin or checkout notice 5) Note that all notices now end with "Thanks for using your local library!" Signed-off-by: David Nind <david@davidnind.com> -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=35568 Martin Renvoize <martin.renvoize@ptfs-europe.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #162721|0 |1 is obsolete| | --- Comment #5 from Martin Renvoize <martin.renvoize@ptfs-europe.com> --- Created attachment 163614 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=163614&action=edit Bug 35568: Add a transform_prepared_letter plugin hook to allow modification of notices created via GetPreparedLetter A plugin hook for GetPreparedLetter would be very useful. It could be used to add universal headers and/or footers to messages, attach news, and modify notices in other ways in whole or in part. It could even be used for call webhooks when certain types of notices are sent. For example, the MessageBee ( https://uniquelibrary.com/messagebee/ ) plugin for Koha generates YAML based notice content, which is then further processed by the before_send_messages hook. This process is unreliable due to the possible changes in data between the creation of the yaml and the reading of that yaml and transforming it into JSON with much more data. For example, the yaml may contain an issue_id, but that checkout may have been returned in the meantime. A hook like this would allow the MessageBee plugin to skip the yaml step and create the json data directly which is then sent to MessageBee for transmission to the patron. Test Plan: 1) Apply this patch 2) prove t/db_dependent/Koha/Plugins/Transform_prepared_letter_hook.t 3) Download and install the Kitchen Sink plugin v2.4.0 https://github.com/bywatersolutions/dev-koha-plugin-kitchen-sink/releases/ta... 4) Generate any notice or slip, such as a checkin or checkout notice 5) Note that all notices now end with "Thanks for using your local library!" Signed-off-by: David Nind <david@davidnind.com> Signed-off-by: Martin Renvoize <martin.renvoize@ptfs-europe.com> -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=35568 Martin Renvoize <martin.renvoize@ptfs-europe.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|Signed Off |Passed QA CC| |martin.renvoize@ptfs-europe | |.com --- Comment #6 from Martin Renvoize <martin.renvoize@ptfs-europe.com> --- Simple hook, all working as designed and nothing contentious here. Test present too.. Passing QA (Lets also make sure it's added to the wiki page please) -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=35568 Katrin Fischer <katrin.fischer@bsz-bw.de> changed: What |Removed |Added ---------------------------------------------------------------------------- Keywords| |additional_work_needed, | |release-notes-needed QA Contact|testopia@bugs.koha-communit |martin.renvoize@ptfs-europe |y.org |.com --- Comment #7 from Katrin Fischer <katrin.fischer@bsz-bw.de> --- Please remember to update the wiki: https://wiki.koha-community.org/wiki/Koha_Plugin_Hooks -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=35568 Katrin Fischer <katrin.fischer@bsz-bw.de> changed: What |Removed |Added ---------------------------------------------------------------------------- Version(s)| |24.05.00 released in| | Status|Passed QA |Pushed to main -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=35568 --- Comment #8 from Katrin Fischer <katrin.fischer@bsz-bw.de> --- Pushed for 24.05! Well done everyone, thank you! -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=35568 --- Comment #9 from Katrin Fischer <katrin.fischer@bsz-bw.de> --- This appears to make a test fail - could be a merge issue? prove t/db_dependent/Koha/Plugins/Recall_hooks.t t/db_dependent/Koha/Plugins/Recall_hooks.t .. 1/4 # Failed test '->add_recall calls the after_recall_action hook with action add' # at t/db_dependent/Koha/Plugins/Recall_hooks.t line 94. # found warning: Plugin error (Test Plugin): Exception 'Koha::Exception' thrown 'transform_prepared_letter called with letter content Date: 04/22/2024 08:05 # found warning: Plugin error (Test Plugin): Exception 'Koha::Exception' thrown 'after_recall_action called with action: add, ref: Koha::Recall' # expected to find warning: (?^u:after_recall_action called with action: add, ref: Koha::Recall) # Looks like you failed 1 test of 1. t/db_dependent/Koha/Plugins/Recall_hooks.t .. 4/4 # Failed test 'after_recall_action hook' # at t/db_dependent/Koha/Plugins/Recall_hooks.t line 99. # Looks like you failed 1 test of 4. t/db_dependent/Koha/Plugins/Recall_hooks.t .. Dubious, test returned 1 (wstat 256, 0x100) Failed 1/4 subtests Test Summary Report ------------------- t/db_dependent/Koha/Plugins/Recall_hooks.t (Wstat: 256 Tests: 4 Failed: 1) Failed test: 4 Non-zero exit status: 1 Files=1, Tests=4, 1 wallclock secs ( 0.02 usr 0.00 sys + 1.45 cusr 0.09 csys = 1.56 CPU) Result: FAIL -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=35568 Martin Renvoize <martin.renvoize@ptfs-europe.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Keywords|additional_work_needed | --- Comment #10 from Martin Renvoize <martin.renvoize@ptfs-europe.com> --- I fixed the recalls test and just pushed.. removing additional_work_needed flag. -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=35568 Jonathan Druart <jonathan.druart@gmail.com> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |jonathan.druart@gmail.com Keywords| |additional_work_needed --- Comment #11 from Jonathan Druart <jonathan.druart@gmail.com> --- Unexpected warning caused by this change: $ prove t/db_dependent/Koha/REST/Plugin/PluginRoutes.t t/db_dependent/Koha/REST/Plugin/PluginRoutes.t .. 2/4 Plugin error (Test Plugin): Exception 'Koha::Exception' thrown 'transform_prepared_letter called with letter content Dear s9Npnm sx9amQ, We want to notify you that your password has been changed. If you did not change it yourself (or requested that change), please contact library staff. Your library. Thank you for using your local library!' t/db_dependent/Koha/REST/Plugin/PluginRoutes.t .. ok All tests successful. Files=1, Tests=4, 43 wallclock secs ( 0.03 usr 0.00 sys + 36.72 cusr 0.56 csys = 37.31 CPU) Result: PASS -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=35568 --- Comment #12 from Kyle M Hall <kyle@bywatersolutions.com> --- Created attachment 167018 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=167018&action=edit Bug 35568: Supress exception -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=35568 --- Comment #13 from Kyle M Hall <kyle@bywatersolutions.com> --- (In reply to Kyle M Hall from comment #12)
Created attachment 167018 [details] [review] Bug 35568: Supress exception
This this follow up be moved to its' own bug report? -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=35568 Martin Renvoize <martin.renvoize@ptfs-europe.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Keywords|additional_work_needed | --- Comment #14 from Martin Renvoize <martin.renvoize@ptfs-europe.com> --- Follow-up pushed, removing additional_work_needed keyword. -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=35568 Lucas Gass <lucas@bywatersolutions.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|Pushed to main |RESOLVED Resolution|--- |FIXED CC| |lucas@bywatersolutions.com --- Comment #15 from Lucas Gass <lucas@bywatersolutions.com> --- Enhancement will not be backported to 24.05.x series -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=35568 Lisette Scheer <lisette@bywatersolutions.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Keywords|release-notes-needed | -- You are receiving this mail because: You are watching all bug changes.
participants (1)
-
bugzilla-daemon＠bugs.koha-community.org