IBX-8726: Added IsBookmarked criterion #417

ciastektk · 2024-08-16T08:44:23Z

🎫 Issue	IBX-8726

Description:

This PR adds IsBookmarked criterion which allow to filter by bookmarked locations.
Main use case is DAM, where we need to filter bookmarked locations by content type.

Response will be automatically updated after added new or deleted Bookmark. The BookmarkEventSubscriber is responsible for triggering serach index updates.

Persistence API

New method loadUserIdsByLocation have been added to Bookmark Handler, which allows to load all id of users which already bookmarked given location.

Supported search engines

LSE, Solr, and Elasticsearch supports IsBookmarked criterion.

Examples

Criterion has argument $value type of bool with default value true. Criterion works with current user reference, and id taken from it will be used in query.

new IsBookmarked();

new IsBookmarked(false);

For QA:

Documentation:

src/contracts/Repository/Values/Content/Query/Criterion/Location/IsBookmarked.php

src/contracts/Repository/Values/Content/Query/Criterion/Value/IsBookmarkedValue.php

src/lib/Search/Common/EventSubscriber/BookmarkEventSubscriber.php

src/lib/Search/Legacy/Content/Location/Gateway/CriterionHandler/Location/IsBookmarked.php

tests/integration/Core/Persistence/Legacy/BookmarkHandlerTest.php

tests/integration/Core/Repository/SearchServiceBookmarkTest.php

src/lib/Search/Common/EventSubscriber/BookmarkEventSubscriber.php

tests/integration/Core/Resources/settings/common.yml

src/contracts/Repository/Values/Content/Query/Criterion/Location/IsBookmarked.php

src/lib/Resources/settings/search_engines/common.yml

src/lib/Search/Common/EventSubscriber/BookmarkEventSubscriber.php

src/lib/Persistence/Legacy/Bookmark/Gateway/DoctrineDatabase.php

src/lib/Search/Legacy/Content/Location/Gateway/CriterionHandler/Location/IsBookmarked.php

…on test setup

…on/IsBookmarked.php Co-authored-by: Konrad Oboza <konrad.oboza@ibexa.co>

…IsBookmarkedValue.php Co-authored-by: Konrad Oboza <konrad.oboza@ibexa.co>

Co-authored-by: Konrad Oboza <konrad.oboza@ibexa.co>

…r/Location/IsBookmarked.php Co-authored-by: Konrad Oboza <konrad.oboza@ibexa.co>

Co-authored-by: Konrad Oboza <konrad.oboza@ibexa.co>

…e::loadUserIdsByLocation

…ests setup

…Location

…r/Location/IsBookmarked.php Co-authored-by: Paweł Niedzielski <pawel.niedzielski@ibexa.co>

…yLocation

sonarcloud · 2024-09-04T12:42:39Z

Quality Gate passed

Issues
5 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

github-actions bot assigned alongosz, tischsoic and mikadamczyk Aug 16, 2024

mnocon added the Doc needed The changes require some documentation label Aug 19, 2024

ciastektk force-pushed the ibx-8726-added-is-bookmarked-criterion branch from 28fd67f to dfe7121 Compare August 19, 2024 06:44

ciastektk mentioned this pull request Aug 20, 2024

IBX-8726: Added support for IsBookmarked criterion ibexa/solr#75

Merged

ciastektk force-pushed the ibx-8726-added-is-bookmarked-criterion branch 5 times, most recently from d02f69d to 466737f Compare August 20, 2024 12:02

ciastektk marked this pull request as ready for review August 20, 2024 12:19

ciastektk requested a review from a team August 20, 2024 13:17

ciastektk added Improvement Ready for review labels Aug 20, 2024

konradoboza reviewed Aug 21, 2024

View reviewed changes

konradoboza requested a review from a team August 21, 2024 06:15

ciastektk requested a review from konradoboza August 21, 2024 07:39

konradoboza reviewed Aug 21, 2024

View reviewed changes

src/lib/Search/Common/EventSubscriber/BookmarkEventSubscriber.php Outdated Show resolved Hide resolved

src/lib/Search/Common/EventSubscriber/BookmarkEventSubscriber.php Outdated Show resolved Hide resolved

ciastektk force-pushed the ibx-8726-added-is-bookmarked-criterion branch from 953c58d to 3698368 Compare August 21, 2024 07:47

ciastektk requested review from konradoboza and a team August 21, 2024 07:58

konradoboza reviewed Aug 21, 2024

View reviewed changes

tests/integration/Core/Resources/settings/common.yml Outdated Show resolved Hide resolved

ciastektk requested review from konradoboza and a team August 21, 2024 09:51

konradoboza requested a review from alongosz August 21, 2024 09:55

konradoboza approved these changes Aug 21, 2024

View reviewed changes

konradoboza requested a review from a team August 21, 2024 10:51

alongosz reviewed Aug 21, 2024

View reviewed changes

alongosz requested changes Aug 21, 2024

View reviewed changes

src/lib/Search/Legacy/Content/Location/Gateway/CriterionHandler/Location/IsBookmarked.php Outdated Show resolved Hide resolved

bogusez mentioned this pull request Sep 3, 2024

Run regression for IBX-XXXX ibexa/commerce#1022

Closed

bogusez approved these changes Sep 4, 2024

View reviewed changes

bogusez added QA approved and removed Ready for QA labels Sep 4, 2024

ciastektk and others added 22 commits September 4, 2024 14:39

Added missing BookmarkEventSubscriber service definition in integrati…

c4fff34

…on test setup

Update src/contracts/Repository/Values/Content/Query/Criterion/Locati…

0e148d1

…on/IsBookmarked.php Co-authored-by: Konrad Oboza <konrad.oboza@ibexa.co>

Update src/contracts/Repository/Values/Content/Query/Criterion/Value/…

e63b43e

…IsBookmarkedValue.php Co-authored-by: Konrad Oboza <konrad.oboza@ibexa.co>

Update src/lib/Search/Common/EventSubscriber/BookmarkEventSubscriber.php

14df7c1

Co-authored-by: Konrad Oboza <konrad.oboza@ibexa.co>

Update src/lib/Search/Legacy/Content/Location/Gateway/CriterionHandle…

bd292f1

…r/Location/IsBookmarked.php Co-authored-by: Konrad Oboza <konrad.oboza@ibexa.co>

Update tests/integration/Core/Persistence/Legacy/BookmarkHandlerTest.php

c93a569

Co-authored-by: Konrad Oboza <konrad.oboza@ibexa.co>

Update tests/integration/Core/Repository/SearchServiceBookmarkTest.php

7fe733c

Co-authored-by: Konrad Oboza <konrad.oboza@ibexa.co>

Used IncrementalIndexer instead of Indexer in BookmarkEventSubscriber

cd3c9f3

Improved query in IsBookmarked criterion handler to be more efficient

642318e

Used ParameterType::INTEGER instead Types::INTEGER in DoctrineDatabas…

e35042e

…e::loadUserIdsByLocation

Marked BookmarkEventSubscriber as internal

270701c

[PHPStan] Regenerated baseline

a018380

Reworked criterion

008cfe5

Reworked BookmarkEventSubscriber

72756a7

Dropped ibexa.spi.search.indexer service defintion from integration t…

d35c9b9

…ests setup

Used fetchFirstColumn instead of fetchAllAssociative in loadUserIdsBy…

5998842

…Location

Added check if criterion value is type of array

a2759a9

Update src/lib/Search/Legacy/Content/Location/Gateway/CriterionHandle…

3662f8c

…r/Location/IsBookmarked.php Co-authored-by: Paweł Niedzielski <pawel.niedzielski@ibexa.co>

Added missing comma in IsBookmarked handler

425eff4

Added removal test coverage for BookmarkHandlerTest::testLoadUserIdsB…

d7a712d

…yLocation

Added additional content remote ids check in SearchServiceBookmarkTest

949ab72

Added comment about working with current user to IsBookmarked criterion

1efafe0

ciastektk force-pushed the ibx-8726-added-is-bookmarked-criterion branch from fe32ae8 to 1efafe0 Compare September 4, 2024 12:39

alongosz merged commit 0ba8cd1 into 4.6 Sep 4, 2024
19 of 22 checks passed

alongosz deleted the ibx-8726-added-is-bookmarked-criterion branch September 4, 2024 13:31

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

IBX-8726: Added IsBookmarked criterion #417

IBX-8726: Added IsBookmarked criterion #417

ciastektk commented Aug 16, 2024 •

edited

Loading

sonarcloud bot commented Sep 4, 2024

IBX-8726: Added IsBookmarked criterion #417

IBX-8726: Added IsBookmarked criterion #417

Conversation

ciastektk commented Aug 16, 2024 • edited Loading

Description:

Persistence API

Supported search engines

Examples

For QA:

Documentation:

sonarcloud bot commented Sep 4, 2024

Quality Gate passed

ciastektk commented Aug 16, 2024 •

edited

Loading