Bug 37592 - Add a record of creation and modification to bookings
Summary: Add a record of creation and modification to bookings
Status: Pushed to main
Alias: None
Product: Koha
Classification: Unclassified
Component: Circulation (show other bugs)
Version: Main
Hardware: All All
: P5 - low enhancement
Assignee: Paul Derscheid
QA Contact: Martin Renvoize (ashimema)
URL:
Keywords: release-notes-needed
Depends on: 29002
Blocks: 37601
  Show dependency treegraph
 
Reported: 2024-08-07 13:49 UTC by Paul Derscheid
Modified: 2024-09-18 07:36 UTC (History)
6 users (show)

See Also:
Change sponsored?: ---
Patch complexity: Small patch
Documentation contact:
Documentation submission:
Text to go in the release notes:
Version(s) released in:
24.11.00
Circulation function: bookings


Attachments
Bug 37592: Add created_at, updated_at fields to bookings table (4.45 KB, patch)
2024-08-07 15:58 UTC, Paul Derscheid
Details | Diff | Splinter Review
Bug 37592: Add created_at, updated_at fields to bookings table (4.50 KB, patch)
2024-08-08 14:19 UTC, Owen Leonard
Details | Diff | Splinter Review
Bug 37592: (follow-up) Change created_at, updated_at to created_on, updated_on (5.96 KB, patch)
2024-08-27 11:13 UTC, Paul Derscheid
Details | Diff | Splinter Review
Bug 37592: (follow-up) Change created_at, updated_at to created_on, updated_on (6.01 KB, patch)
2024-09-10 15:31 UTC, PTFS Europe Sandboxes
Details | Diff | Splinter Review
Bug 37592: Add created_at, updated_at fields to bookings table (4.56 KB, patch)
2024-09-12 10:52 UTC, Martin Renvoize (ashimema)
Details | Diff | Splinter Review
Bug 37592: (follow-up) Change created_at, updated_at to created_on, updated_on (6.08 KB, patch)
2024-09-12 10:52 UTC, Martin Renvoize (ashimema)
Details | Diff | Splinter Review
Bug 37592: (QA follow-up) Add API mapping and definition (1.77 KB, patch)
2024-09-12 10:52 UTC, Martin Renvoize (ashimema)
Details | Diff | Splinter Review
Bug 37592: (QA follow-up) Change created_on, updated_on to creation_date, modification_date (5.39 KB, patch)
2024-09-16 10:11 UTC, Paul Derscheid
Details | Diff | Splinter Review
Bug 37592: (QA follow-up) Fetch database fields for api return (2.09 KB, patch)
2024-09-18 04:01 UTC, Martin Renvoize (ashimema)
Details | Diff | Splinter Review

Note You need to log in before you can comment on or make changes to this bug.
Description Paul Derscheid 2024-08-07 13:49:31 UTC

    
Comment 1 Paul Derscheid 2024-08-07 15:58:02 UTC
Created attachment 170144 [details] [review]
Bug 37592: Add created_at, updated_at fields to bookings table
Comment 2 Paul Derscheid 2024-08-07 16:03:39 UTC
It would be helpful for some institutions to track when bookings were created and updated, for example when communicating with patrons.
Comment 3 Owen Leonard 2024-08-08 14:19:31 UTC
Created attachment 170161 [details] [review]
Bug 37592: Add created_at, updated_at fields to bookings table

Signed-off-by: Owen Leonard <oleonard@myacpl.org>
Comment 4 Martin Renvoize (ashimema) 2024-08-15 15:19:29 UTC
I like this.. but lets make sure we have a 100% consensus on the API guidelines and have it cloned to Database guidelines before we push it:

https://wiki.koha-community.org/wiki/Coding_Guidelines_-_API#REST1.3.4.1_date.2Fdatetime.2Ftimestamp_fields

Currently the guidelines says:

* Where a field contains a 'date' it should be consistently named thing_date as opposed to date_thing and it should always return a full datetime.
Comment 5 Paul Derscheid 2024-08-15 15:20:15 UTC
Good call!
Comment 6 Paul Derscheid 2024-08-27 11:13:45 UTC
Created attachment 170763 [details] [review]
Bug 37592: (follow-up) Change created_at, updated_at to created_on, updated_on

As per a discussion in the community chat, this change is more in line with the existing schema.
Comment 7 PTFS Europe Sandboxes 2024-09-10 15:31:28 UTC
Created attachment 171254 [details] [review]
Bug 37592: (follow-up) Change created_at, updated_at to created_on, updated_on

As per a discussion in the community chat, this change is more in line with the existing schema.

Signed-off-by: LEBSimonsen <simonsen@bz-sh.de>
Comment 8 Martin Renvoize (ashimema) 2024-09-12 10:52:07 UTC
Created attachment 171376 [details] [review]
Bug 37592: Add created_at, updated_at fields to bookings table

Signed-off-by: Owen Leonard <oleonard@myacpl.org>
Signed-off-by: Martin Renvoize <martin.renvoize@ptfs-europe.com>
Comment 9 Martin Renvoize (ashimema) 2024-09-12 10:52:10 UTC
Created attachment 171377 [details] [review]
Bug 37592: (follow-up) Change created_at, updated_at to created_on, updated_on

As per a discussion in the community chat, this change is more in line with the existing schema.

Signed-off-by: LEBSimonsen <simonsen@bz-sh.de>
Signed-off-by: Martin Renvoize <martin.renvoize@ptfs-europe.com>
Comment 10 Martin Renvoize (ashimema) 2024-09-12 10:52:13 UTC
Created attachment 171378 [details] [review]
Bug 37592: (QA follow-up) Add API mapping and definition

Sticking to API guidelines, this adds the creation_date and
modification_date fields to the api definitions and the required
to_api_mappings for those fields to be properly populated.

Signed-off-by: Martin Renvoize <martin.renvoize@ptfs-europe.com>
Comment 11 Katrin Fischer 2024-09-16 08:47:12 UTC
I don't want to block this, but forgive me this question:

Independent of the general discussion on naming things, should we not try to avoid API mappings for new columns? I think if we use creation_date in the API we might also name the column that. What do you think?

 
 sub to_api_mapping {
-    return {};
+    return {
+        created_on => "creation_date",
+        updated_on => "modification_date"
+    };
 }


Also a question for the release notes :)

Signed-off-by: LEBSimonsen <simonsen@bz-sh.de>

This will show as LEBSimonsen in the release notes - would you like to update to the name or another term?
Comment 12 Paul Derscheid 2024-09-16 08:52:18 UTC
I'll gladly refactor it, if it's pushed immediately afterwards as these are literally just name changes.
Comment 13 Katrin Fischer 2024-09-16 08:53:31 UTC
(In reply to Paul Derscheid from comment #12)
> I'll gladly refactor it, if it's pushed immediately afterwards as these are
> literally just name changes.

Once the patch has reached my queue and it comes back again, it automatically goes on top of the enhancements pile. Check the dashboard :)
Comment 14 Paul Derscheid 2024-09-16 10:11:58 UTC
Created attachment 171524 [details] [review]
Bug 37592: (QA follow-up) Change created_on, updated_on to creation_date, modification_date

It makes sense not to introduce mapping code if there's no reason for it.
Accordingly the the columns are now of type DATETIME instead.
Comment 15 Katrin Fischer 2024-09-16 11:49:04 UTC
Pushed for 24.11!

Well done everyone, thank you!
Comment 16 Martin Renvoize (ashimema) 2024-09-18 04:01:24 UTC
Created attachment 171645 [details] [review]
Bug 37592: (QA follow-up) Fetch database fields for api return

Creation and Modification times are maintained by the database, but on
add/update we were not fetching the updated fields from the database for
the api response.

This patch corrects that and also updates the api schema to reflect that
these are readOnly fields.

Signed-off-by: Martin Renvoize <martin.renvoize@ptfs-europe.com>
Comment 17 Martin Renvoize (ashimema) 2024-09-18 04:02:33 UTC
Follow-up pushed as RM Assistant; This gets the tests passing again and fixes a flaw in our logic.
Comment 18 Paul Derscheid 2024-09-18 07:36:35 UTC
Thanks for the assist Martin!