Koha-community/Koha
13
7
Fork 0
Code Issues Releases Wiki Activity

Bug 24487: Don't apply matching criteria to path parameters

Browse source 
This patch separates query parameters from path parameters, and uses exact matching for the later.

To test:
1. Apply this patch
2. prove t/Koha/REST/Plugin/Query.t t/db_dependent/Koha/REST/Plugin/Objects.t
SUCCESS => tests ok
3. Sign off

Signed-off-by: Tomas Cohen Arazi <tomascohen@theke.io>
Signed-off-by: Martin Renvoize <martin.renvoize@ptfs-europe.com>
This commit is contained in:
Agustin Moyano 2020-01-23 01:50:29 -03:00 committed by Martin Renvoize
parent 4584d36df4
commit 1e5fca80e6
Signed by: martin.renvoize
GPG key ID: 422B469130441A0F
3 changed files with 34 additions and 24 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
Koha/REST/Plugin/Objects.pm
View file

@ -50,7 +50,7 @@ sub register {
my $attributes = {};
# Extract reserved params
my ( $filtered_params, $reserved_params ) = $c->extract_reserved_params($args);
my ( $filtered_params, $reserved_params, $path_params ) = $c->extract_reserved_params($args);
# Look for embeds
my $embed = $c->stash('koha.embed');
@ -79,6 +79,16 @@ sub register {
$filtered_params = $c->build_query_params( $filtered_params, $reserved_params );
}
if ( defined $path_params ) {
# Apply the mapping function to the passed params
$filtered_params //= {};
$path_params = $result_set->attributes_from_api($path_params);
foreach my $param (keys %{$path_params}) {
$filtered_params->{$param} = $path_params->{$param};
}
}
# Perform search
my $objects = $result_set->search( $filtered_params, $attributes );

9
Koha/REST/Plugin/Query.pm
View file

@ -54,19 +54,24 @@ Generates the DBIC query from the query parameters.
my $reserved_params;
my $filtered_params;
my $path_params;
my $reserved_words = _reserved_words();
my @query_param_names = keys %{$c->req->params->to_hash};
foreach my $param ( keys %{$params} ) {
if ( grep { $param eq $_ } @{$reserved_words} ) {
$reserved_params->{$param} = $params->{$param};
}
else {
elsif ( grep { $param eq $_ } @query_param_names ) {
$filtered_params->{$param} = $params->{$param};
}
else {
$path_params->{$param} = $params->{$param};
}
}
return ( $filtered_params, $reserved_params );
return ( $filtered_params, $reserved_params, $path_params );
}
);

37
t/Koha/REST/Plugin/Query.t
View file

@ -35,13 +35,7 @@ get '/empty' => sub {
get '/query' => sub {
my $c = shift;
my $input = {
_page => 2,
_per_page => 3,
firstname => 'Manuel',
surname => 'Cohen Arazi'
};
my ( $filtered_params, $reserved_params ) = $c->extract_reserved_params($input);
my ( $filtered_params, $reserved_params ) = $c->extract_reserved_params($c->req->params->to_hash);
$c->render(
json => {
filtered_params => $filtered_params,
@ -51,21 +45,17 @@ get '/query' => sub {
);
};
get '/query_full' => sub {
get '/query_full/:id/:subid' => sub {
my $c = shift;
my $input = {
_match => 'exact',
_order_by => 'blah',
_page => 2,
_per_page => 3,
firstname => 'Manuel',
surname => 'Cohen Arazi'
};
my ( $filtered_params, $reserved_params ) = $c->extract_reserved_params($input);
my $params = $c->req->params->to_hash;
$params->{id} = $c->stash->{id};
$params->{subid} = $c->stash->{subid};
my ( $filtered_params, $reserved_params, $path_params ) = $c->extract_reserved_params($params);
$c->render(
json => {
filtered_params => $filtered_params,
reserved_params => $reserved_params
reserved_params => $reserved_params,
path_params => $path_params
},
status => 200
);
@ -202,16 +192,16 @@ use Test::Mojo;
subtest 'extract_reserved_params() tests' => sub {
plan tests => 8;
plan tests => 9;
my $t = Test::Mojo->new;
$t->get_ok('/query')->status_is(200)
$t->get_ok('/query?_page=2&_per_page=3&firstname=Manuel&surname=Cohen%20Arazi')->status_is(200)
->json_is( '/filtered_params' =>
{ firstname => 'Manuel', surname => 'Cohen Arazi' } )
->json_is( '/reserved_params' => { _page => 2, _per_page => 3 } );
$t->get_ok('/query_full')->status_is(200)
$t->get_ok('/query_full/with/path?_match=exact&_order_by=blah&_page=2&_per_page=3&firstname=Manuel&surname=Cohen%20Arazi')->status_is(200)
->json_is(
'/filtered_params' => {
firstname => 'Manuel',
@ -223,6 +213,11 @@ subtest 'extract_reserved_params() tests' => sub {
_per_page => 3,
_match => 'exact',
_order_by => 'blah'
} )
->json_is(
'/path_params' => {
id => 'with',
subid => 'path'
} );
};