Koha-clms/t/db_dependent/Koha/SearchEngine/Elasticsearch/QueryBuilder.t

1325 lines
51 KiB
Perl
Executable File

#!/usr/bin/perl
#
# This file is part of Koha.
#
# Koha is free software; you can redistribute it and/or modify it
# under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 3 of the License, or
# (at your option) any later version.
#
# Koha is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Koha; if not, see <https://www.gnu.org/licenses>.
use Modern::Perl;
use C4::Context;
use Test::Exception;
use Test::Warn;
use t::lib::Mocks;
use t::lib::TestBuilder;
use Test::NoWarnings;
use Test::More tests => 10;
use List::Util qw( all );
use Koha::Database;
use Koha::SearchEngine::Elasticsearch::QueryBuilder;
use Koha::SearchFilters;
my $schema = Koha::Database->new->schema;
$schema->storage->txn_begin;
my $se = Test::MockModule->new('Koha::SearchEngine::Elasticsearch');
$se->mock(
'get_elasticsearch_mappings',
sub {
my ($self) = @_;
my %all_mappings;
my $mappings = {
properties => {
title => { type => 'text' },
title__sort => { type => 'text' },
subject => {
type => 'text',
facet => 1
},
'subject-heading-thesaurus' => {
type => 'text',
facet => 1
},
'subject-heading-thesaurus-conventions' => { type => 'text' },
itemnumber => { type => 'integer' },
sortablenumber => { type => 'integer' },
sortablenumber__sort => { type => 'integer' },
heading => { type => 'text' },
'heading-main' => { type => 'text' },
heading__sort => { type => 'text' },
match => { type => 'text' },
'match-heading' => { type => 'text' },
'match-heading-see-from' => { type => 'text' },
}
};
$all_mappings{ $self->index } = $mappings;
my $sort_fields = {
$self->index => {
title => 1,
subject => 0,
itemnumber => 0,
sortablenumber => 1,
mainentry => 1
}
};
$self->sort_fields( $sort_fields->{ $self->index } );
return $all_mappings{ $self->index };
}
);
subtest 'build_authorities_query_compat() tests' => sub {
plan tests => 81;
my $qb;
ok(
$qb = Koha::SearchEngine::Elasticsearch::QueryBuilder->new( { 'index' => 'authorities' } ),
'Creating new query builder object for authorities'
);
my $koha_name = 'any';
my $search_term = 'a';
my $query = $qb->build_authorities_query_compat(
[$koha_name], undef, undef, ['contains'], [$search_term], 'AUTH_TYPE',
'asc'
);
ok( !defined $query->{query}->{bool}->{should}, "Should query not used if 'and_or' not passed" );
ok( defined $query->{query}->{bool}->{must}, "Must query used if 'and_or' not passed" );
is( $query->{query}->{bool}->{must}[0]->{query_string}->{query}, "a*" );
$query = $qb->build_authorities_query_compat(
[$koha_name], ['and'], undef, ['contains'], [$search_term], 'AUTH_TYPE',
'asc'
);
ok( !defined $query->{query}->{bool}->{should}, "Should query not used when 'and_or' passed 'and'" );
ok( defined $query->{query}->{bool}->{must}, "Must query used when 'and_or' passed 'and'" );
is( $query->{query}->{bool}->{must}[0]->{query_string}->{query}, "a*" );
$query = $qb->build_authorities_query_compat(
[$koha_name], ['or'], undef, ['contains'], [$search_term], 'AUTH_TYPE',
'asc'
);
ok( defined $query->{query}->{bool}->{should}, "Should query used if 'and_or' passed 'or'" );
ok( defined $query->{query}->{bool}->{should}, "Must query not used if 'and_or' passed 'or'" );
is( $query->{query}->{bool}->{should}[0]->{query_string}->{query}, "a*" );
my $koha_to_index_name = $Koha::SearchEngine::Elasticsearch::QueryBuilder::koha_to_index_name;
$search_term = 'a';
foreach my $koha_name ( keys %{$koha_to_index_name} ) {
my $query = $qb->build_authorities_query_compat(
[$koha_name], undef, undef, ['contains'], [$search_term], 'AUTH_TYPE',
'asc'
);
if ( $koha_name eq 'all' || $koha_name eq 'any' ) {
is(
$query->{query}->{bool}->{must}[0]->{query_string}->{query},
"a*"
);
} else {
is(
$query->{query}->{bool}->{must}[0]->{query_string}->{query},
"a*"
);
}
is(
$query->{query}->{bool}->{must}[0]->{query_string}->{analyze_wildcard}, JSON::true,
'Set analyze_wildcard true'
);
is( $query->{query}->{bool}->{must}[0]->{query_string}->{lenient}, JSON::true, 'Set lenient true' );
}
$search_term = 'Donald Duck';
foreach my $koha_name ( keys %{$koha_to_index_name} ) {
my $query = $qb->build_authorities_query_compat(
[$koha_name], undef, undef, ['contains'], [$search_term], 'AUTH_TYPE',
'asc'
);
is( $query->{query}->{bool}->{must}[0]->{query_string}->{query}, "(Donald*) AND (Duck*)" );
if ( $koha_name eq 'all' || $koha_name eq 'any' ) {
isa_ok( $query->{query}->{bool}->{must}[0]->{query_string}->{fields}, 'ARRAY' );
} else {
is(
$query->{query}->{bool}->{must}[0]->{query_string}->{default_field},
$koha_to_index_name->{$koha_name}
);
}
}
foreach my $koha_name ( keys %{$koha_to_index_name} ) {
my $query = $qb->build_authorities_query_compat(
[$koha_name], undef, undef, ['is'], [$search_term], 'AUTH_TYPE',
'asc'
);
if ( $koha_name eq 'all' || $koha_name eq 'any' ) {
is(
$query->{query}->{bool}->{must}[0]->{multi_match}->{query},
"Donald Duck"
);
my $all_matches = all { /\.ci_raw$/ } @{ $query->{query}->{bool}->{must}[0]->{multi_match}->{fields} };
ok( $all_matches, 'Correct fields parameter for "is" query in "any" or "all"' );
} else {
is(
$query->{query}->{bool}->{must}[0]->{term}->{ $koha_to_index_name->{$koha_name} . ".ci_raw" },
"Donald Duck"
);
}
}
foreach my $koha_name ( keys %{$koha_to_index_name} ) {
my $query = $qb->build_authorities_query_compat(
[$koha_name], undef, undef, ['start'], [$search_term], 'AUTH_TYPE',
'asc'
);
if ( $koha_name eq 'all' || $koha_name eq 'any' ) {
my $all_matches =
all { ( %{ $_->{prefix} } )[0] =~ /\.ci_raw$/ && ( %{ $_->{prefix} } )[1] eq "Donald Duck" }
@{ $query->{query}->{bool}->{must}[0]->{bool}->{should} };
ok( $all_matches, "Correct multiple prefix query" );
} else {
is(
$query->{query}->{bool}->{must}[0]->{prefix}->{ $koha_to_index_name->{$koha_name} . ".ci_raw" },
"Donald Duck"
);
}
}
# Sorting
$query = $qb->build_authorities_query_compat(
['mainentry'], undef, undef, ['start'], [$search_term], 'AUTH_TYPE',
'HeadingAsc'
);
is_deeply(
$query->{sort},
[ { 'heading__sort' => 'asc' } ],
"ascending sort parameter properly formed"
);
$query = $qb->build_authorities_query_compat(
['mainentry'], undef, undef, ['start'], [$search_term], 'AUTH_TYPE',
'HeadingDsc'
);
is_deeply(
$query->{sort},
[ { 'heading__sort' => 'desc' } ],
"descending sort parameter properly formed"
);
# Authorities type
$query = $qb->build_authorities_query_compat(
['mainentry'], undef, undef, ['contains'], [$search_term], 'AUTH_TYPE',
'asc'
);
is_deeply(
$query->{query}->{bool}->{filter},
{ term => { 'authtype.raw' => 'AUTH_TYPE' } },
"authorities type code is used as filter"
);
# Authorities marclist check
warning_like {
$query = $qb->build_authorities_query_compat(
[ 'tomas', 'mainentry' ], undef, undef, ['contains'],
[ $search_term, $search_term ], 'AUTH_TYPE', 'asc'
)
}
qr/Unknown search field tomas/,
"Warning for unknown field in marclist";
is_deeply(
$query->{query}->{bool}->{must}[0]->{query_string}->{default_field},
'tomas',
"If no mapping for marclist the index is passed through as defined"
);
is_deeply(
$query->{query}->{bool}->{must}[1]->{query_string}{default_field},
'heading',
"If mapping found for marclist the index is passed through converted"
);
};
subtest 'build_query tests' => sub {
plan tests => 72;
my $qb;
ok(
$qb = Koha::SearchEngine::Elasticsearch::QueryBuilder->new( { 'index' => 'biblios' } ),
'Creating new query builder object for biblios'
);
my @sort_by = 'title_asc';
my @sort_params = $qb->_convert_sort_fields(@sort_by);
my %options;
$options{sort} = \@sort_params;
my $query = $qb->build_query( 'test', %options );
is_deeply(
$query->{sort},
[ { 'title__sort' => { 'order' => 'asc' } }, { 'local-number' => { 'order' => 'desc' } } ],
"sort parameter properly formed"
);
t::lib::Mocks::mock_preference( 'FacetMaxCount', '37' );
t::lib::Mocks::mock_preference( 'DisplayLibraryFacets', 'both' );
$query = $qb->build_query( 'test', %options );
ok( defined $query->{aggregations}{ccode}{terms}{size}, 'we need to ask for a size or we get only 5 facet' );
is( $query->{aggregations}{ccode}{terms}{size}, 37, 'we ask for the size as defined by the syspref FacetMaxCount' );
is(
$query->{aggregations}{homebranch}{terms}{size}, 37,
'we ask for the size as defined by the syspref FacetMaxCount for homebranch'
);
is(
$query->{aggregations}{holdingbranch}{terms}{size}, 37,
'we ask for the size as defined by the syspref FacetMaxCount for holdingbranch'
);
$options{skip_facets} = 1;
$query = $qb->build_query( 'test', %options );
ok( !defined $query->{aggregations}, 'Skipping facets means we do not have aggregations in the the query' );
$query = $qb->build_query( 'test', () );
is_deeply(
$query->{sort},
[
{ '_score' => { 'order' => 'desc' } },
{ 'local-number' => { 'order' => 'desc' } }
],
"sort parameter properly formed if no sort passed"
);
t::lib::Mocks::mock_preference( 'QueryAutoTruncate', '' );
( undef, $query ) = $qb->build_query_compat( undef, ['donald duck'] );
is(
$query->{query}{bool}{must}[0]{query_string}{query},
"(donald duck)",
"query not altered if QueryAutoTruncate disabled"
);
ok( defined $query->{aggregations}, 'Aggregations generated normally' );
( undef, $query ) =
$qb->build_query_compat( undef, ['donald duck'], undef, undef, undef, undef, undef, { skip_facets => 1 } );
ok( !defined $query->{aggregations}, 'Aggregations generated normally' );
( undef, $query ) = $qb->build_query_compat( undef, ['donald duck'], ['kw,phr'] );
is(
$query->{query}{bool}{must}[0]{query_string}{query},
'("donald duck")',
"keyword as phrase correctly quotes search term and strips index"
);
( undef, $query ) = $qb->build_query_compat( undef, ['donald duck'], ['title'] );
is(
$query->{query}{bool}{must}[0]{query_string}{query},
'(title:(donald duck))',
'multiple words in a query term are enclosed in parenthesis'
);
( undef, $query ) = $qb->build_query_compat( ['AND'], [ 'donald duck', 'disney' ], [ 'title', 'author' ] );
is(
$query->{query}{bool}{must}[0]{query_string}{query},
'(title:(donald duck)) AND (author:disney)',
'multiple query terms are enclosed in parenthesis while a single one is not'
);
my ( $simple_query, $query_cgi, $query_desc );
( undef, $query, $simple_query, $query_cgi, $query_desc ) =
$qb->build_query_compat( undef, [ '"donald duck"', 'walt disney' ], [ 'ti', 'au' ] );
is( $query_cgi, 'idx=ti&q=%22donald%20duck%22&idx=au&q=walt%20disney', 'query cgi ok for multiterm query' );
is( $query_desc, '(title:("donald duck")) (author:(walt disney))', 'query desc ok for multiterm query' );
# Test whole_record and weighted_fields parameters in query_cgi
( undef, $query, $simple_query, $query_cgi, $query_desc ) = $qb->build_query_compat(
undef, ['test'], ['kw'], undef, undef, undef, undef,
{ whole_record => 1, weighted_fields => 1, weight_search_submitted => 1 }
);
is(
$query_cgi, 'idx=kw&q=test&weight_search=1&weight_search_submitted=1&whole_record=1',
'query_cgi includes whole_record, weight_search and weight_search_submitted parameters'
);
( undef, $query, $simple_query, $query_cgi, $query_desc ) = $qb->build_query_compat(
undef, ['test'], ['kw'], undef, undef, undef, undef,
{ whole_record => 1 }
);
is( $query_cgi, 'idx=kw&q=test&whole_record=1', 'query_cgi includes whole_record parameter only' );
( undef, $query, $simple_query, $query_cgi, $query_desc ) = $qb->build_query_compat(
undef, ['test'], ['kw'], undef, undef, undef, undef,
{ weighted_fields => 1, weight_search_submitted => 1 }
);
is(
$query_cgi, 'idx=kw&q=test&weight_search=1&weight_search_submitted=1',
'query_cgi includes weight_search and weight_search_submitted parameters only'
);
( undef, $query ) = $qb->build_query_compat( undef, ['2019'], ['yr,st-year'] );
is(
$query->{query}{bool}{must}[0]{query_string}{query},
'(date-of-publication:2019)',
'Year in an st-year search is handled properly'
);
( undef, $query ) = $qb->build_query_compat( undef, ['2018-2019'], ['yr,st-year'] );
is(
$query->{query}{bool}{must}[0]{query_string}{query},
'(date-of-publication:[2018 TO 2019])',
'Year range in an st-year search is handled properly'
);
( undef, $query ) = $qb->build_query_compat( undef, ['-2019'], ['yr,st-year'] );
is(
$query->{query}{bool}{must}[0]{query_string}{query},
'(date-of-publication:[* TO 2019])',
'Open start year in year range of an st-year search is handled properly'
);
( undef, $query ) = $qb->build_query_compat( undef, ['2019-'], ['yr,st-year'] );
is(
$query->{query}{bool}{must}[0]{query_string}{query},
'(date-of-publication:[2019 TO *])',
'Open end year in year range of an st-year search is handled properly'
);
( undef, $query ) = $qb->build_query_compat( undef, ['2019-'], ['yr,st-year'], ['yr,st-numeric=-2019'] );
is(
$query->{query}{bool}{must}[0]{query_string}{query},
'(date-of-publication:[2019 TO *]) AND date-of-publication:[* TO 2019]',
'Open end year in year range of an st-year search is handled properly'
);
( undef, $query ) = $qb->build_query_compat(
undef, ['2019-'], ['yr,st-year'],
[ 'yr,st-numeric:-2019', 'yr,st-numeric:2005', 'yr,st-numeric:1984-2022' ]
);
is(
$query->{query}{bool}{must}[0]{query_string}{query},
'(date-of-publication:[2019 TO *]) AND (date-of-publication:[* TO 2019]) AND (date-of-publication:2005) AND (date-of-publication:[1984 TO 2022])',
'Limit on year search is handled properly when colon used'
);
# Enable auto-truncation
t::lib::Mocks::mock_preference( 'QueryAutoTruncate', '1' );
( undef, $query ) = $qb->build_query_compat( undef, ['donald duck'] );
is(
$query->{query}{bool}{must}[0]{query_string}{query},
"(donald* duck*)",
"simple query is auto truncated when QueryAutoTruncate enabled"
);
# Ensure reserved words are not truncated
( undef, $query ) = $qb->build_query_compat(
undef,
['donald or duck and mickey not mouse']
);
is(
$query->{query}{bool}{must}[0]{query_string}{query},
"(donald* or duck* and mickey* not mouse*)",
"reserved words are not affected by QueryAutoTruncate"
);
( undef, $query ) = $qb->build_query_compat( undef, ['donald* duck*'] );
is(
$query->{query}{bool}{must}[0]{query_string}{query},
"(donald* duck*)",
"query with '*' is unaltered when QueryAutoTruncate is enabled"
);
( undef, $query ) = $qb->build_query_compat( undef, ['donald duck and the mouse'] );
is(
$query->{query}{bool}{must}[0]{query_string}{query},
"(donald* duck* and the* mouse*)",
"individual words are all truncated and stopwords ignored"
);
( undef, $query ) = $qb->build_query_compat( undef, ['*'] );
is(
$query->{query}{bool}{must}[0]{query_string}{query},
"(*)",
"query of just '*' is unaltered when QueryAutoTruncate is enabled"
);
( undef, $query ) = $qb->build_query_compat( undef, ['"donald duck"'], undef, ['available'] );
is(
$query->{query}{bool}{must}[0]{query_string}{query},
'("donald duck") AND available:true',
"query with quotes is unaltered when QueryAutoTruncate is enabled"
);
( undef, $query ) = $qb->build_query_compat( undef, ['"donald duck" and "the mouse"'] );
is(
$query->{query}{bool}{must}[0]{query_string}{query},
'("donald duck" and "the mouse")',
"all quoted strings are unaltered if more than one in query"
);
# Reset ElasticsearchPreventAutoTruncate syspref
t::lib::Mocks::mock_preference( 'ElasticsearchPreventAutoTruncate', '' );
( undef, $query ) = $qb->build_query_compat( undef, ['barcode:123456'] );
is(
$query->{query}{bool}{must}[0]{query_string}{query},
'(barcode:123456*)',
"query of specific field is truncated"
);
( undef, $query ) = $qb->build_query_compat( undef, ['Personal-name:"donald"'] );
is(
$query->{query}{bool}{must}[0]{query_string}{query},
'(personal-name:"donald")',
"query of specific field including hyphen and quoted is not truncated, field name is converted to lower case"
);
( undef, $query ) = $qb->build_query_compat( undef, ['Personal-name:donald'] );
is(
$query->{query}{bool}{must}[0]{query_string}{query},
'(personal-name:donald*)',
"query of specific field including hyphen and not quoted is truncated, field name is converted to lower case"
);
( undef, $query ) = $qb->build_query_compat( undef, ['Personal-name.raw:donald'] );
is(
$query->{query}{bool}{must}[0]{query_string}{query},
'(personal-name.raw:donald*)',
"query of specific field including period and not quoted is truncated, field name is converted to lower case"
);
( undef, $query ) = $qb->build_query_compat( undef, ['Personal-name.raw:"donald"'] );
is(
$query->{query}{bool}{must}[0]{query_string}{query},
'(personal-name.raw:"donald")',
"query of specific field including period and quoted is not truncated, field name is converted to lower case"
);
# Set ElasticsearchPreventAutoTruncate syspref
t::lib::Mocks::mock_preference( 'ElasticsearchPreventAutoTruncate', 'barcode' );
( undef, $query ) = $qb->build_query_compat( undef, ['barcode:123456'] );
is(
$query->{query}{bool}{must}[0]{query_string}{query},
'(barcode:123456)',
"query of specific field excluded by ElasticsearchPreventAutoTruncate is not truncated"
);
( undef, $query ) = $qb->build_query_compat( undef, ['Local-number:123456'] );
is(
$query->{query}{bool}{must}[0]{query_string}{query},
'(local-number:123456)',
"query of identifier is not truncated even if QueryAutoTruncate is set"
);
( undef, $query ) = $qb->build_query_compat( undef, ['onloan:true'] );
is(
$query->{query}{bool}{must}[0]{query_string}{query},
'(onloan:true)',
"query of boolean type field is not truncated even if QueryAutoTruncate is set"
);
subtest 'removal of punctuation surrounded by spaces when autotruncate enabled' => sub {
plan tests => 7;
t::lib::Mocks::mock_preference( 'QueryAutoTruncate', '1' );
t::lib::Mocks::mock_preference( 'QueryRegexEscapeOptions', 'escape' );
( undef, $query ) = $qb->build_query_compat(
undef,
['First title ; subtitle : some & subtitle / Authors Name. Second title ; Third title / Second Author']
);
is(
$query->{query}{bool}{must}[0]{query_string}{query},
'(First* title* subtitle* some* subtitle* Authors* Name. Second* title* Third* title* Second* Author*)',
"ISBD punctuation and problematic characters surrounded by spaces properly removed"
);
t::lib::Mocks::mock_preference( 'QueryRegexEscapeOptions', 'dont_escape' );
( undef, $query ) = $qb->build_query_compat(
undef,
['First title ; subtitle : some & subtitle / Authors Name. Second title ; Third title / Second Author']
);
is(
$query->{query}{bool}{must}[0]{query_string}{query},
'(First* title* subtitle* some* subtitle* / Authors* Name. Second* title* ; Third* title* / Second* Author*)',
"ISBD punctuation and problematic characters surrounded by spaces properly removed, RE saved"
);
( undef, $query ) =
$qb->build_query_compat( undef, ['Lorem / ipsum dolor / sit ; / amet'] );
is(
$query->{query}{bool}{must}[0]{query_string}{query},
'(Lorem* / ipsum* dolor* / sit* amet*)',
"RE saved, last odd unescaped slash preceded by a semicolon removed"
);
t::lib::Mocks::mock_preference( 'QueryRegexEscapeOptions', 'escape' );
( undef, $query ) =
$qb->build_query_compat( undef, ['Lorem \/ ipsum dolor \/ sit ; \/ amet'] );
is(
$query->{query}{bool}{must}[0]{query_string}{query},
'(Lorem* ipsum* dolor* sit* amet*)',
"Escaped slashes (also preceded by another punctuation followed by a space) removed"
);
( undef, $query ) =
$qb->build_query_compat( undef, ['comma , period . equal = hyphen - slash / escaped_slash \/'] );
is(
$query->{query}{bool}{must}[0]{query_string}{query},
'(comma* period* equal* hyphen* slash* escaped_slash* \/)',
"Other problematic characters surrounded by spaces properly removed"
);
( undef, $query ) =
$qb->build_query_compat( undef, [' &;,:=-/ // \/\/ /&&&==&& ::-:: '] );
is(
$query->{query}{bool}{must}[0]{query_string}{query},
'()',
"Repeated problematic characters surrounded by spaces removed"
);
( undef, $query ) = $qb->build_query_compat(
undef,
[
'&amp amp& semicolon; ;colonsemi full: :full comma, ,comma dot. .dot =equal equal= hyphen- -hypen slash\/ \/slash'
]
);
is(
$query->{query}{bool}{must}[0]{query_string}{query},
'(&amp* amp& semicolon; ;colonsemi* full* full* comma, ,comma* dot. .dot* equal* equal* hyphen- -hypen* slash\/ \/slash*)',
"ISBD punctuation and problematic characters not removed when not surrounded by spaces."
);
# Note above: semicolons and equals removed asthose are search field indicators - terms ending in punctuation
# are not truncated.
# Note that (colons/equal signs)/spaces glued to words are not removed by the feature under test but before.
};
# Reset SearchCancelledAndInvalidISBNandISSN syspref
t::lib::Mocks::mock_preference( 'SearchCancelledAndInvalidISBNandISSN', '0' );
( undef, $query ) = $qb->build_query_compat( undef, ['nb:"9780141930848"'] );
is(
$query->{query}{bool}{must}[0]{query_string}{query},
'(isbn:"9780141930848")',
"nb query transformed into isbn search field"
);
# Set SearchCancelledAndInvalidISBNandISSN syspref
t::lib::Mocks::mock_preference( 'SearchCancelledAndInvalidISBNandISSN', '1' );
( undef, $query ) = $qb->build_query_compat( undef, ['nb:"9780141930848"'] );
is(
$query->{query}{bool}{must}[0]{query_string}{query},
'(isbn-all:"9780141930848")',
"nb query transformed into isbn-all search field"
);
( undef, $query ) = $qb->build_query_compat( undef, ['nb:"9780141930848" ns:"1089-6891"'] );
is(
$query->{query}{bool}{must}[0]{query_string}{query},
'(isbn-all:"9780141930848" issn-all:"1089-6891")',
"nb and ns query transformed into isbn-all and issn-all search field"
);
( undef, $query ) = $qb->build_query_compat( undef, ['J.R.R'] );
is(
$query->{query}{bool}{must}[0]{query_string}{query},
'(J.R.R*)',
"query including period is truncated but not split at periods"
);
( undef, $query ) = $qb->build_query_compat( undef, ['title:"donald duck"'] );
is(
$query->{query}{bool}{must}[0]{query_string}{query},
'(title:"donald duck")',
"query of specific field is not truncated when surrounded by quotes"
);
( undef, $query ) = $qb->build_query_compat( undef, ['donald duck'], ['title'] );
is(
$query->{query}{bool}{must}[0]{query_string}{query},
'(title:(donald* duck*))',
'words of a multi-word term are properly truncated'
);
( undef, $query ) = $qb->build_query_compat( ['AND'], [ 'donald duck', 'disney' ], [ 'title', 'author' ] );
is(
$query->{query}{bool}{must}[0]{query_string}{query},
'(title:(donald* duck*)) AND (author:disney*)',
'words of a multi-word term and single-word term are properly truncated'
);
( undef, $query ) =
$qb->build_query_compat( undef, ['title:"donald duck"'], undef, undef, undef, undef, undef, { suppress => 1 } );
is(
$query->{query}{bool}{must}[0]{query_string}{query},
'(title:"donald duck") AND suppress:false',
"query of specific field is added AND suppress:false"
);
( undef, $query, $simple_query, $query_cgi, $query_desc ) =
$qb->build_query_compat( undef, ['title:"donald duck"'], undef, undef, undef, undef, undef, { suppress => 0 } );
is(
$query->{query}{bool}{must}[0]{query_string}{query},
'(title:"donald duck")',
"query of specific field is not added AND suppress:0"
);
( undef, $query ) =
$qb->build_query_compat( ['AND'], ['title:"donald duck"'], undef, ['author:Dillinger Escaplan'] );
is(
$query->{query}{bool}{must}[0]{query_string}{query},
'(title:"donald duck") AND author:("Dillinger Escaplan")',
"Simple query with limit term quoted in parentheses"
);
( undef, $query ) = $qb->build_query_compat(
['AND'], ['title:"donald duck"'], undef,
[ 'author:Dillinger Escaplan', 'itype:BOOK' ]
);
is(
$query->{query}{bool}{must}[0]{query_string}{query},
'(title:"donald duck") AND (author:("Dillinger Escaplan")) AND (itype:("BOOK"))',
"Simple query with each limit's term quoted in parentheses"
);
is( $query_cgi, 'idx=&q=title%3A%22donald%20duck%22', 'query cgi' );
is( $query_desc, 'title:"donald duck"', 'query desc ok' );
( undef, $query ) = $qb->build_query_compat(
['AND'], ['title:"donald duck"'], undef,
[ 'author:Dillinger Escaplan', 'mc-itype,phr:BOOK', 'mc-itype,phr:CD' ]
);
is(
$query->{query}{bool}{must}[0]{query_string}{query},
'(title:"donald duck") AND (author:("Dillinger Escaplan")) AND itype:(("BOOK") OR ("CD"))',
"Limits quoted correctly when passed as phrase"
);
( undef, $query ) = $qb->build_query_compat(
['OR'], [ 'title:"donald duck"', 'author:"Dillinger Escaplan"' ], undef,
['itype:BOOK']
);
is(
$query->{query}{bool}{must}[0]{query_string}{query},
'((title:"donald duck") OR (author:"Dillinger Escaplan")) AND itype:("BOOK")',
"OR query with limit"
);
( undef, $query ) = $qb->build_query_compat( undef, undef, undef, ['itype:BOOK'] );
is(
$query->{query}{bool}{must}[0]{query_string}{query},
'itype:("BOOK")',
"Limit only"
);
# Scan queries
( undef, $query, $simple_query, $query_cgi, $query_desc ) =
$qb->build_query_compat( undef, ['new'], ['au'], undef, undef, 1 );
is(
$query->{query}{query_string}{query},
'*',
"scan query is properly formed"
);
is_deeply(
$query->{aggregations}{'author'}{'terms'},
{
field => 'author__facet',
order => { '_key' => 'asc' },
include => '[nN][eE][wW].*'
},
"scan aggregation request is properly formed"
);
is( $query_cgi, 'idx=au&q=new&scan=1', 'query cgi' );
is( $query_desc, 'new', 'query desc ok' );
( undef, $query, $simple_query, $query_cgi, $query_desc ) =
$qb->build_query_compat( undef, ['new'], [], undef, undef, 1 );
is(
$query->{query}{query_string}{query},
'*',
"scan query is properly formed"
);
is_deeply(
$query->{aggregations}{'subject'}{'terms'},
{
field => 'subject__facet',
order => { '_key' => 'asc' },
include => '[nN][eE][wW].*'
},
"scan aggregation request is properly formed"
);
is( $query_cgi, 'idx=&q=new&scan=1', 'query cgi' );
is( $query_desc, 'new', 'query desc ok' );
my ( $limit, $limit_cgi, $limit_desc );
( undef, $query, $simple_query, $query_cgi, $query_desc, $limit, $limit_cgi, $limit_desc ) =
$qb->build_query_compat(
['AND'], ['kw:""'], undef,
[ 'author:Dillinger Escaplan', 'mc-itype,phr:BOOK', 'mc-itype,phr:CD' ]
);
is(
$limit, '(author:("Dillinger Escaplan")) AND itype:(("BOOK") OR ("CD"))',
"Limit formed correctly when no search terms"
);
is(
$limit_cgi, '&limit=author%3ADillinger%20Escaplan&limit=mc-itype%2Cphr%3ABOOK&limit=mc-itype%2Cphr%3ACD',
"Limit CGI formed correctly when no search terms"
);
is(
$limit_desc, '(author:("Dillinger Escaplan")) AND itype:(("BOOK") OR ("CD"))',
"Limit desc formed correctly when no search terms"
);
( undef, $query ) = $qb->build_query_compat(
undef, ['barcode123123'], ['bc'],
['acqdate,st-date-normalized= - ']
);
is(
$query->{query}{bool}{must}[0]{query_string}{query},
'(barcode:barcode123123) AND date-of-acquisition.raw:[* TO *]',
'If no date all date-of-acquisition are selected'
);
( undef, $query ) = $qb->build_query_compat(
undef, ['barcode123123'], ['bc'],
['acqdate,st-date-normalized=2024-08-01 - ']
);
is(
$query->{query}{bool}{must}[0]{query_string}{query},
'(barcode:barcode123123) AND date-of-acquisition.raw:[2024-08-01 TO *]',
'Open start date in date range of an st-date-normalized search is handled properly'
);
( undef, $query ) = $qb->build_query_compat(
undef, ['barcode123123'], ['bc'],
['acqdate,st-date-normalized= - 2024-08-30']
);
is(
$query->{query}{bool}{must}[0]{query_string}{query},
'(barcode:barcode123123) AND date-of-acquisition.raw:[* TO 2024-08-30]',
'Open end date in date range of an st-date-normalized search is handled properly'
);
( undef, $query ) = $qb->build_query_compat(
undef, ['barcode123123'], ['bc'],
['acqdate,st-date-normalized=2024-08-01 - 2024-08-30']
);
is(
$query->{query}{bool}{must}[0]{query_string}{query},
'(barcode:barcode123123) AND date-of-acquisition.raw:[2024-08-01 TO 2024-08-30]',
'Date range in an st-date-normalized search is handled properly'
);
};
subtest 'build query from form subtests' => sub {
plan tests => 5;
my $qb = Koha::SearchEngine::Elasticsearch::QueryBuilder->new( { 'index' => 'authorities' } ),
#when searching for authorities from a record the form returns marclist with blanks for unentered terms
my @marclist = ( 'mainmainentry', 'mainentry', 'match', 'all' );
my @values = ( undef, 'Hamilton', undef, undef );
my @operator = ( 'contains', 'contains', 'contains', 'contains' );
my $query = $qb->build_authorities_query_compat(
\@marclist, undef,
undef, \@operator, \@values, 'AUTH_TYPE', 'asc'
);
is( $query->{query}->{bool}->{must}[0]->{query_string}->{query}, "Hamilton*", "Expected search is populated" );
is( scalar @{ $query->{query}->{bool}->{must} }, 1, "Only defined search is populated" );
@values[2] = 'Jefferson';
$query = $qb->build_authorities_query_compat(
\@marclist, undef,
undef, \@operator, \@values, 'AUTH_TYPE', 'asc'
);
is( $query->{query}->{bool}->{must}[0]->{query_string}->{query}, "Hamilton*", "First index searched as expected" );
is(
$query->{query}->{bool}->{must}[1]->{query_string}->{query}, "Jefferson*",
"Second index searched when populated"
);
is( scalar @{ $query->{query}->{bool}->{must} }, 2, "Only defined searches are populated" );
};
subtest 'build_query with weighted fields tests' => sub {
plan tests => 6;
$se->mock(
'_load_elasticsearch_mappings',
sub {
return {
authorities => {
Heading => {
label => 'heading',
type => 'string',
opac => 0,
staff_client => 1,
mappings => [
{
marc_field => '150',
marc_type => 'marc21',
}
]
},
Headingmain => {
label => 'headingmain',
type => 'string',
opac => 1,
staff_client => 1,
mappings => [
{
marc_field => '150',
marc_type => 'marc21',
}
]
}
},
biblios => {
abstract => {
label => 'abstract',
type => 'string',
opac => 1,
staff_client => 0,
mappings => [
{
marc_field => '520',
marc_type => 'marc21',
}
]
},
acqdate => {
label => 'acqdate',
type => 'string',
opac => 0,
staff_client => 1,
mappings => [
{
marc_field => '952d',
marc_type => 'marc21',
search => 0,
},
{
marc_field => '9955',
marc_type => 'marc21',
search => 0,
}
]
},
title => {
label => 'title',
type => 'string',
opac => 0,
staff_client => 1,
mappings => [
{
marc_field => '130',
marc_type => 'marc21'
}
]
},
subject => {
label => 'subject',
type => 'string',
opac => 0,
staff_client => 1,
mappings => [
{
marc_field => '600a',
marc_type => 'marc21'
}
]
}
}
};
}
);
my $qb = Koha::SearchEngine::Elasticsearch::QueryBuilder->new( { index => 'biblios' } );
Koha::SearchFields->search( {} )->delete;
Koha::SearchEngine::Elasticsearch->reset_elasticsearch_mappings();
my $search_field;
$search_field = Koha::SearchFields->find( { name => 'title' } );
$search_field->update( { weight => 25.0 } );
$search_field = Koha::SearchFields->find( { name => 'subject' } );
$search_field->update( { weight => 15.5 } );
Koha::SearchEngine::Elasticsearch->clear_search_fields_cache();
my ( undef, $query ) = $qb->build_query_compat(
undef, ['title:"donald duck"'], undef, undef,
undef, undef, undef, { weighted_fields => 1 }
);
my $fields = $query->{query}{bool}{must}[0]{query_string}{fields};
is( @{$fields}, 2, 'Search field with no searchable mappings has been excluded' );
my @found = grep { $_ eq 'title^25.00' } @{$fields};
is( @found, 1, 'Search field title has correct weight' );
@found = grep { $_ eq 'subject^15.50' } @{$fields};
is( @found, 1, 'Search field subject has correct weight' );
( undef, $query ) = $qb->build_query_compat(
undef, ['title:"donald duck"'], undef, undef,
undef, undef, undef, { weighted_fields => 1, is_opac => 1 }
);
$fields = $query->{query}{bool}{must}[0]{query_string}{fields};
is_deeply(
$fields,
['abstract'],
'Only OPAC search fields are used when opac search is performed'
);
$qb = Koha::SearchEngine::Elasticsearch::QueryBuilder->new( { index => 'authorities' } );
( undef, $query ) = $qb->build_query_compat(
undef, ['title:"donald duck"'], undef, undef,
undef, undef, undef, { weighted_fields => 1 }
);
$fields = $query->{query}{bool}{must}[0]{query_string}{fields};
is_deeply( [ sort @$fields ], [ 'heading', 'headingmain' ], 'Authorities fields retrieve for authorities index' );
( undef, $query ) = $qb->build_query_compat(
undef, ['title:"donald duck"'], undef, undef,
undef, undef, undef, { weighted_fields => 1, is_opac => 1 }
);
$fields = $query->{query}{bool}{must}[0]{query_string}{fields};
is_deeply( $fields, ['headingmain'], 'Only opac authorities fields retrieved for authorities index is is_opac' );
};
subtest 'build_query_compat() SearchLimitLibrary tests' => sub {
plan tests => 18;
$schema->storage->txn_begin;
my $builder = t::lib::TestBuilder->new;
my $branch_1 = $builder->build_object( { class => 'Koha::Libraries' } );
my $branch_2 = $builder->build_object( { class => 'Koha::Libraries' } );
my $group = $builder->build_object(
{
class => 'Koha::Library::Groups',
value => {
ft_search_groups_opac => 1,
ft_search_groups_staff => 1,
parent_id => undef,
branchcode => undef
}
}
);
my $group_1 = $builder->build_object(
{
class => 'Koha::Library::Groups',
value => {
parent_id => $group->id,
branchcode => $branch_1->id
}
}
);
my $group_2 = $builder->build_object(
{
class => 'Koha::Library::Groups',
value => {
parent_id => $group->id,
branchcode => $branch_2->id
}
}
);
my $groupid = $group->id;
my @branchcodes = sort { $a cmp $b } ( $branch_1->id, $branch_2->id );
my $query_builder =
Koha::SearchEngine::Elasticsearch::QueryBuilder->new( { index => $Koha::SearchEngine::BIBLIOS_INDEX } );
t::lib::Mocks::mock_preference( 'SearchLimitLibrary', 'both' );
my ( undef, undef, undef, undef, undef, $limit, $limit_cgi, $limit_desc, undef ) =
$query_builder->build_query_compat( undef, undef, undef, ["branch:CPL"], undef, undef, undef, undef );
is( $limit, '(homebranch: "CPL" OR holdingbranch: "CPL")', "Branch limit expanded to home/holding branch" );
is( $limit_desc, '(homebranch: "CPL" OR holdingbranch: "CPL")', "Limit description correctly expanded" );
is( $limit_cgi, '&limit=branch%3ACPL', "Limit cgi does not get expanded" );
( undef, undef, undef, undef, undef, $limit, $limit_cgi, $limit_desc, undef ) = $query_builder->build_query_compat(
undef, undef, undef, ["multibranchlimit:$groupid"], undef, undef, undef,
undef
);
is(
$limit,
"(homebranch: \"$branchcodes[0]\" OR homebranch: \"$branchcodes[1]\" OR holdingbranch: \"$branchcodes[0]\" OR holdingbranch: \"$branchcodes[1]\")",
"Multibranch limit expanded to home/holding branches"
);
is(
$limit_desc,
"(homebranch: \"$branchcodes[0]\" OR homebranch: \"$branchcodes[1]\" OR holdingbranch: \"$branchcodes[0]\" OR holdingbranch: \"$branchcodes[1]\")",
"Multibranch limit description correctly expanded"
);
is( $limit_cgi, "&limit=multibranchlimit%3A$groupid", "Multibranch limit cgi does not get expanded" );
t::lib::Mocks::mock_preference( 'SearchLimitLibrary', 'homebranch' );
( undef, undef, undef, undef, undef, $limit, $limit_cgi, $limit_desc, undef ) =
$query_builder->build_query_compat( undef, undef, undef, ["branch:CPL"], undef, undef, undef, undef );
is( $limit, "(homebranch: \"CPL\")", "branch limit expanded to home branch" );
is( $limit_desc, "(homebranch: \"CPL\")", "limit description correctly expanded" );
is( $limit_cgi, "&limit=branch%3ACPL", "limit cgi does not get expanded" );
( undef, undef, undef, undef, undef, $limit, $limit_cgi, $limit_desc, undef ) = $query_builder->build_query_compat(
undef, undef, undef, ["multibranchlimit:$groupid"], undef, undef, undef,
undef
);
is(
$limit, "(homebranch: \"$branchcodes[0]\" OR homebranch: \"$branchcodes[1]\")",
"branch limit expanded to home branch"
);
is(
$limit_desc, "(homebranch: \"$branchcodes[0]\" OR homebranch: \"$branchcodes[1]\")",
"limit description correctly expanded"
);
is( $limit_cgi, "&limit=multibranchlimit%3A$groupid", "Limit cgi does not get expanded" );
t::lib::Mocks::mock_preference( 'SearchLimitLibrary', 'holdingbranch' );
( undef, undef, undef, undef, undef, $limit, $limit_cgi, $limit_desc, undef ) =
$query_builder->build_query_compat( undef, undef, undef, ["branch:CPL"], undef, undef, undef, undef );
is( $limit, "(holdingbranch: \"CPL\")", "branch limit expanded to holding branch" );
is( $limit_desc, "(holdingbranch: \"CPL\")", "Limit description correctly expanded" );
is( $limit_cgi, "&limit=branch%3ACPL", "Limit cgi does not get expanded" );
( undef, undef, undef, undef, undef, $limit, $limit_cgi, $limit_desc, undef ) = $query_builder->build_query_compat(
undef, undef, undef, ["multibranchlimit:$groupid"], undef, undef, undef,
undef
);
is(
$limit, "(holdingbranch: \"$branchcodes[0]\" OR holdingbranch: \"$branchcodes[1]\")",
"branch limit expanded to holding branch"
);
is(
$limit_desc, "(holdingbranch: \"$branchcodes[0]\" OR holdingbranch: \"$branchcodes[1]\")",
"Limit description correctly expanded"
);
is( $limit_cgi, "&limit=multibranchlimit%3A$groupid", "Limit cgi does not get expanded" );
};
subtest "Handle search filters" => sub {
plan tests => 7;
my $qb;
ok(
$qb = Koha::SearchEngine::Elasticsearch::QueryBuilder->new( { 'index' => 'biblios' } ),
'Creating new query builder object for biblios'
);
my $filter = Koha::SearchFilter->new(
{
name => "test",
query => q|{"operands":["cat","bat","rat"],"indexes":["kw","ti","au"],"operators":["AND","OR"]}|,
limits => q|{"limits":["mc-itype,phr:BK","mc-itype,phr:MU","available"]}|,
}
)->store;
my $filter_id = $filter->id;
my ( undef, undef, undef, undef, undef, $limit, $limit_cgi, $limit_desc ) =
$qb->build_query_compat( undef, undef, undef, ["search_filter:$filter_id"] );
is(
$limit, q{(available:true) AND (((cat) AND title:(bat) OR author:(rat))) AND itype:(("BK") OR ("MU"))},
"Limit correctly formed"
);
is( $limit_cgi, "&limit=search_filter%3A$filter_id", "CGI limit is not expanded" );
is(
$limit_desc, q{(available:true) AND (((cat) AND title:(bat) OR author:(rat))) AND itype:(("BK") OR ("MU"))},
"Limit description is correctly expanded"
);
$filter = Koha::SearchFilter->new(
{
name => "test",
query => q|{"operands":["su:biography"],"indexes":[],"operators":[]}|,
limits => q|{"limits":[]}|,
}
)->store;
$filter_id = $filter->id;
( undef, undef, undef, undef, undef, $limit, $limit_cgi, $limit_desc ) =
$qb->build_query_compat( undef, undef, undef, ["search_filter:$filter_id"] );
is( $limit, q{((subject:biography))}, "Limit correctly formed for ccl type query" );
is( $limit_cgi, "&limit=search_filter%3A$filter_id", "CGI limit is not expanded" );
is( $limit_desc, q{((subject:biography))}, "Limit description is correctly handled for ccl type query" );
};
subtest "_convert_sort_fields() tests" => sub {
plan tests => 3;
my $qb;
ok(
$qb = Koha::SearchEngine::Elasticsearch::QueryBuilder->new( { 'index' => 'biblios' } ),
'Creating new query builder object for biblios'
);
my @sort_by = $qb->_convert_sort_fields(qw( call_number_asc author_dsc ));
is_deeply(
\@sort_by,
[
{ field => 'cn-sort', direction => 'asc' },
{ field => 'author', direction => 'desc' }
],
'sort fields should have been split correctly'
);
# We could expect this to pass, but direction is undef instead of 'desc'
@sort_by = $qb->_convert_sort_fields(qw( call_number_asc author_desc ));
is_deeply(
\@sort_by,
[
{ field => 'cn-sort', direction => 'asc' },
{ field => 'author', direction => 'desc' }
],
'sort fields should have been split correctly'
);
};
subtest "_sort_field() tests" => sub {
plan tests => 5;
my $qb;
ok(
$qb = Koha::SearchEngine::Elasticsearch::QueryBuilder->new( { 'index' => 'biblios' } ),
'Creating new query builder object for biblios'
);
my $f = $qb->_sort_field('title');
is(
$f,
'title__sort',
'title sort mapped correctly'
);
$f = $qb->_sort_field('subject');
is(
$f,
'subject.raw',
'subject sort mapped correctly'
);
$f = $qb->_sort_field('itemnumber');
is(
$f,
'itemnumber',
'itemnumber sort mapped correctly'
);
$f = $qb->_sort_field('sortablenumber');
is(
$f,
'sortablenumber__sort',
'sortablenumber sort mapped correctly'
);
};
subtest "_build_field_match_boost_query() tests" => sub {
plan tests => 10;
my $qb;
ok(
$qb = Koha::SearchEngine::Elasticsearch::QueryBuilder->new( { 'index' => 'biblios' } ),
'Creating new query builder object for biblios'
);
my $field_match_boost_query = $qb->_build_field_match_boost_query( { indexes => [], operands => [] } );
is_deeply(
$field_match_boost_query,
[],
'Empty array is returned when no indexes or operands passed'
);
$field_match_boost_query = $qb->_build_field_match_boost_query();
is_deeply(
$field_match_boost_query,
[],
'Empty array is returned when no parameters passed'
);
my @indexes = ( 'kw', 'subject', 'title' );
my @operands;
$field_match_boost_query = $qb->_build_field_match_boost_query( { indexes => \@indexes, operands => \@operands } );
is_deeply(
$field_match_boost_query,
[],
'Empty array is returned when no parameters passed'
);
push @operands, "turkey";
$field_match_boost_query = $qb->_build_field_match_boost_query( { indexes => \@indexes, operands => \@operands } );
is_deeply(
$field_match_boost_query,
[ { match => { 'title-cover' => { query => 'turkey' } } } ],
'Keyword is converted to title-cover'
);
push @operands, "gravy";
$field_match_boost_query = $qb->_build_field_match_boost_query( { indexes => \@indexes, operands => \@operands } );
is_deeply(
$field_match_boost_query,
[
{ match => { 'title-cover' => { query => 'turkey' } } },
{ match => { 'subject' => { query => 'gravy' } } }
],
'Subject is not converted'
);
push @operands, "mashed";
$field_match_boost_query = $qb->_build_field_match_boost_query( { indexes => \@indexes, operands => \@operands } );
is_deeply(
$field_match_boost_query,
[
{ match => { 'title-cover' => { query => 'turkey' } } },
{ match => { 'subject' => { query => 'gravy' } } },
{ match => { 'title-cover' => { query => 'mashed' } } },
],
'Title is not converted to title-cover'
);
t::lib::Mocks::mock_preference( 'ElasticsearchBoostFieldMatch', '0' );
t::lib::Mocks::mock_preference( 'QueryAutoTruncate', '1' );
my ( undef, $query ) = $qb->build_query_compat( ['AND'], [ 'donald duck', 'disney' ], [ 'title', 'author' ] );
is(
$query->{query}{bool}{must}[0]{query_string}{query},
'(title:(donald* duck*)) AND (author:disney*)',
'words of a multi-word term and single-word term are properly truncated'
);
is(
$query->{query}{bool}{should},
undef,
'No should query added for boosting'
);
t::lib::Mocks::mock_preference( 'ElasticsearchBoostFieldMatch', '1' );
( undef, $query ) = $qb->build_query_compat( ['AND'], [ 'donald duck', 'disney' ], [ 'title', 'author' ] );
is_deeply(
$query->{query}{bool}{should},
[
{ match => { 'title-cover' => { query => 'donald duck' } } },
{ match => { 'author' => { query => 'disney' } } }
],
'SHould query is correctly added'
);
};
$schema->storage->txn_rollback;