gitea
/
Koha-clms
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Bug 25159: Add ability to specify a pre-modified version of action log data and store as diff 

Test Plan:
1) sudo cpanm Struct::Diff
2) prove t/db_dependent/Log.t

Signed-off-by: Kyle Hall <kyle@bywatersolutions.com>
Signed-off-by: Andrew Fuerste-Henry <andrewfh@dubcolib.org>
Signed-off-by: Emmi Takkinen <emmi.takkinen@koha-suomi.fi>
Signed-off-by: Martin Renvoize <martin.renvoize@ptfs-europe.com>
Signed-off-by: Katrin Fischer <katrin.fischer@bsz-bw.de>
This commit is contained in:
Kyle M Hall 2023-07-18 09:06:36 -04:00 committed by Katrin Fischer
parent c18573d7a4
commit 97c2110fa6
No known key found for this signature in database
GPG Key ID: 0EF6E2C03357A834
3 changed files with 33 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
C4/Log.pm
View File

@ -25,9 +25,10 @@ use strict;
use warnings;
use Data::Dumper qw( Dumper );
use JSON qw( to_json );
use Scalar::Util qw( blessed );
use File::Basename qw( basename );
use JSON qw( to_json encode_json );
use Scalar::Util qw( blessed );
use Struct::Diff qw( diff );
use C4::Context;
use Koha::Logger;
@ -59,7 +60,7 @@ The functions in this module perform various functions in order to log all the o
=item logaction
&logaction($modulename, $actionname, $objectnumber, $infos, $interface);
&logaction($modulename, $actionname, $objectnumber, $infos, $interface, $hashref_of_original);
Adds a record into action_logs table to report the different changes upon the database.
Each log entry includes the number of the user currently logged in. For batch
@ -70,7 +71,9 @@ number is set to 0, which is the same as the superlibrarian's number.
#'
sub logaction {
my ($modulename, $actionname, $objectnumber, $infos, $interface)=@_;
my ($modulename, $actionname, $objectnumber, $infos, $interface, $original )=@_;
my $updated;
# Get ID of logged in user. if called from a batch job,
# no user session exists and C4::Context->userenv() returns
@ -82,13 +85,16 @@ sub logaction {
if( blessed($infos) && $infos->isa('Koha::Object') ) {
$infos = $infos->get_from_storage if $infos->in_storage;
$updated = $infos->unblessed;
local $Data::Dumper::Sortkeys = 1;
if ( $infos->isa('Koha::Item') && $modulename eq 'CATALOGUING' && $actionname eq 'MODIFY' ) {
$infos = "item " . Dumper( $infos->unblessed );
$infos = "item " . Dumper( $updated );
} else {
$infos = Dumper( $infos->unblessed );
$infos = Dumper( $updated );
}
} else {
$updated = $infos;
}
my $script = ( $interface eq 'cron' or $interface eq 'commandline' )
@ -112,6 +118,8 @@ sub logaction {
}
my $trace = @trace ? to_json( \@trace, { utf8 => 1, pretty => 0 } ) : undef;
my $diff = ( $original && ref $updated eq 'HASH' ) ? encode_json( diff( $original, $updated, noU => 1 ) ) : undef;
Koha::ActionLog->new(
{
timestamp => \'NOW()',
@ -123,6 +131,7 @@ sub logaction {
interface => $interface,
script => $script,
trace => $trace,
diff => $diff,
}
)->store();
@ -134,7 +143,7 @@ sub logaction {
);
$logger->debug(
sub {
"ACTION LOG: " . to_json(
"ACTION LOG: " . encode_json(
{
user => $usernumber,
module => $modulename,

1
cpanfile
View File

@ -97,6 +97,7 @@ requires 'POSIX', '1.09';
requires 'Plack::Middleware::LogWarn', '0.001002';
requires 'Plack::Middleware::ReverseProxy', '0.14';
requires 'Readonly', '2.00';
requires 'Struct::Diff', '0.98';
requires 'Schedule::At', '1.06';
requires 'Search::Elasticsearch', '6.80';
requires 'Sereal::Decoder', '3.0';

17
t/db_dependent/Log.t
View File

@ -16,7 +16,7 @@
use Modern::Perl;
use Data::Dumper qw( Dumper );
use Test::More tests => 5;
use Test::More tests => 6;
use C4::Context;
use C4::Log qw( logaction cronlogaction );
@ -27,6 +27,8 @@ use Koha::ActionLogs;
use t::lib::Mocks qw/mock_preference/; # to mock CronjobLog
use t::lib::TestBuilder;
use JSON qw( decode_json );
# Make sure we can rollback.
our $schema = Koha::Database->new->schema;
$schema->storage->txn_begin;
@ -194,4 +196,17 @@ subtest 'Reduce log size by unblessing Koha objects' => sub {
like( $logs->next->info, qr/^t::lib::TestBuilder/, 'Dumped TestBuilder object' );
};
subtest 'Test storing diff of objects' => sub {
plan tests => 1;
my $builder = t::lib::TestBuilder->new;
my $item = $builder->build_sample_item;
my $original = $item->unblessed();
$item->barcode('_MY_TEST_BARCODE_')->store();
logaction( 'MY_MODULE', 'TEST01', $item->itemnumber, $item, 'opac', $original );
my $logs = Koha::ActionLogs->search({ module => 'MY_MODULE', action => 'TEST01', object => $item->itemnumber })->next;
my $diff = decode_json( $logs->diff );
is( $diff->{D}->{barcode}->{N}, '_MY_TEST_BARCODE_', 'Diff of changes logged successfully' );
};
$schema->storage->txn_rollback;