Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix: typesense missing scoutmetadata #868

Draft
wants to merge 11 commits into
base: 10.x
Choose a base branch
from
Draft

Fix: typesense missing scoutmetadata #868

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
7c4fd18
fix: missing scout metadata for typesense search
arminwinkt Sep 24, 2024
acb57e3
Merge pull request #1 from arminwinkt/fix/typesenses-missing-metadata
arminwinkt Sep 24, 2024
27191c8
Revert "fix: missing scout metadata for typesense search"
arminwinkt Sep 24, 2024
e3283cb
Merge pull request #2 from arminwinkt/revert-1-fix/typesenses-missing…
arminwinkt Sep 24, 2024
8e70c54
fix: missing scout metadata for typesense search
arminwinkt Sep 24, 2024
558ff31
fix: add more unittest for mapping scout metadata
arminwinkt Oct 3, 2024
3841436
Merge branch 'laravel:10.x' into 10.x
arminwinkt Oct 3, 2024
bddac47
Merge branch '10.x' into fix/typesense-missing-scoutmetadata
arminwinkt Oct 3, 2024
bcbc773
fix: add more unittest for mapping scout metadata
arminwinkt Oct 3, 2024
c8a7bb8
fix: add more unittest for mapping scout metadata
arminwinkt Oct 3, 2024
5fd05e0
fix: add more unittest for mapping scout metadata
arminwinkt Oct 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions src/Engines/TypesenseEngine.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -458,6 +458,19 @@ public function map(Builder $builder, $results, $model)
->filter(static function ($model) use ($objectIds) {
return in_array($model->getScoutKey(), $objectIds, false);
})
->map(static function ($model) use ($hits, $objectIdPositions) {
$result = $hits[$objectIdPositions[$model->getScoutKey()]] ?? [];
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There should be a test for the fallback of the empty array


foreach ($result as $key => $value) {
if ($key === 'document') {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you add a test for this case specifically?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When using a join between 2 collections and including fields of a joined collection in your search response, you get those nested objects in the document (https://typesense.org/docs/27.1/api/joins.html#merging-nesting-joined-fields). If the 'document' key is also added to the scout metadata, then there is a way to access the fields of those joined collection objects.

continue;
}

$model->withScoutMetadata($key, $value);
}

return $model;
})
->sortBy(static function ($model) use ($objectIdPositions) {
return $objectIdPositions[$model->getScoutKey()];
})
Expand Down
146 changes: 146 additions & 0 deletions tests/Unit/TypesenseEngineTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -183,6 +183,152 @@ public function test_map_ids_method(): void
$this->assertEquals([1, 2, 3], $mappedIds->toArray());
}

public function test_map_correctly_maps_results_to_models()
{
$engine = new TypesenseEngine($this->createMock(TypesenseClient::class), 10);

$model = m::mock(stdClass::class);
$model->shouldReceive(['getScoutKeyName' => 'id']);
$model->shouldReceive('getScoutModelsByIds')->andReturn(
Collection::make([
new SearchableModel(['id' => 1, 'name' => 'test']),
])
);

$builder = m::mock(Builder::class);

$results = $engine->map($builder, [
'found' => 1,
'hits' => [
[
'document' => ['id' => 1, 'name' => 'test'],
'geo_distance_meters' => ['location' => 5],
'highlights' => [],
],
],
], $model);

$this->assertCount(1, $results);
$this->assertEquals(['id' => 1, 'name' => 'test'], $results->first()->toArray());
$this->assertEquals(
['geo_distance_meters' => ['location' => 5], 'highlights' => []],
$results->first()->scoutMetadata()
);
}

public function test_map_correctly_maps_results_to_models_with_multiple_hits()
{
$engine = new TypesenseEngine($this->createMock(TypesenseClient::class), 10);

$model = m::mock(stdClass::class);
$model->shouldReceive(['getScoutKeyName' => 'id']);
$model->shouldReceive('getScoutModelsByIds')->andReturn(
Collection::make([
new SearchableModel(['id' => 1, 'name' => 'test1']),
new SearchableModel(['id' => 4, 'name' => 'test4']),
new SearchableModel(['id' => 6, 'name' => 'test6']),
])
);

$builder = m::mock(Builder::class);

$results = $engine->map($builder, [
'found' => 3,
'hits' => [
[
'document' => ['id' => 1, 'name' => 'test1'],
'geo_distance_meters' => ['location' => 1],
'highlights' => [1],
],
[
'document' => ['id' => 6, 'name' => 'test6'],
'geo_distance_meters' => ['location' => 6],
'highlights' => [6],
],
[
'document' => ['id' => 4, 'name' => 'test4'],
'geo_distance_meters' => ['location' => 4],
'highlights' => [4],
],
],
], $model);

$this->assertCount(3, $results);
$this->assertEquals(['id' => 6, 'name' => 'test6'], $results[1]->toArray());

foreach ($results as $result) {
$this->assertNotEmpty($result->scoutMetadata());

$this->assertEquals(
['geo_distance_meters' => ['location' => $result->id], 'highlights' => [$result->id]],
$result->scoutMetadata()
);
}
}

public function test_scoutMetadata_is_empty_for_missing_hits()
{
$engine = new TypesenseEngine($this->createMock(TypesenseClient::class), 10);

$model = m::mock(stdClass::class);
$model->shouldReceive(['getScoutKeyName' => 'id']);
$model->shouldReceive('getScoutModelsByIds')->andReturn(
Collection::make([
new SearchableModel(['id' => 1, 'name' => 'test']),
])
);

$builder = m::mock(Builder::class);

$results = $engine->map($builder, [
'found' => 1,
'grouped_hits' => [
1 => [
'hits' => [
[
'document' => ['id' => 1, 'name' => 'test'],
'geo_distance_meters' => ['location' => 5],
'highlights' => [],
],
],
],
],
], $model);

$this->assertCount(1, $results);
$this->assertEquals(['id' => 1, 'name' => 'test'], $results->first()->toArray());
$this->assertEquals([], $results->first()->scoutMetadata());
}

public function test_that_document_result_is_not_added_to_scoutMetadata()
{
$engine = new TypesenseEngine($this->createMock(TypesenseClient::class), 10);

$model = m::mock(stdClass::class);
$model->shouldReceive(['getScoutKeyName' => 'id']);
$model->shouldReceive('getScoutModelsByIds')->andReturn(
Collection::make([
new SearchableModel(['id' => 1, 'name' => 'test']),
])
);

$builder = m::mock(Builder::class);

$results = $engine->map($builder, [
'found' => 1,
'hits' => [
[
'document' => ['id' => 1, 'name' => 'test'],
'highlights' => [],
],
],
], $model);

$this->assertCount(1, $results);
$this->assertArrayNotHasKey('document', $results->first()->scoutMetadata());
$this->assertArrayHasKey('highlights', $results->first()->scoutMetadata());
}

public function test_get_total_count_method(): void
{
// Sample search results with 'found' key
Expand Down