IBX-10675: Document Ibexa Messenger and discount re-indexing in the background #2909

dabrt · 2025-09-20T03:14:14Z

Question	Answer
JIRA Ticket	IBX-10675
Versions	4.6, 5.0
Edition	Commerce-ish

Document Ibexa Messenger and discount re-indexing in the background

Checklist

Text renders correctly
Text has been checked with vale
Description metadata is up to date
Redirects cover removed/moved pages
Code samples are working
PHP code samples have been fixed with PHP CS fixer
Added link to this PR in relevant JIRA ticket or code PR

github-actions · 2025-09-20T03:21:39Z

Preview of modified files

Preview of modified Markdown:

docs/discounts/configure_discounts.md

code_samples/background_tasks/src/MessageHandler/SomeHandler.php

…veloper into IBX-10160

docs/discounts/configure_discounts.md

docs/infrastructure_and_maintenance/background_tasks.md

dabrt · 2025-10-01T07:43:40Z

Thank you @konradoboza for your comments

adriendupuis

Few links to add, some precisions about the code, but over all very good.

docs/api/event_reference/discounts_events.md

docs/discounts/configure_discounts.md

docs/infrastructure_and_maintenance/background_tasks.md

code_samples/background_tasks/src/Dispatcher/SomeClassThatSchedulesExecutionInTheBackground.php

Co-authored-by: Adrien Dupuis <[email protected]>

mnocon

I love it already, thank you for preparing this! 🙇

Added a couple of suggestions, but the overall shape is great

One sugggestion that does not apply to a particular line:

For v5, everyone using Commerce should set this up (or at least know that it needs to be set up). I'd mention it in the post install steps: https://github.com/ibexa/documentation-developer/blob/5.0/docs/getting_started/install_ibexa_dxp.md#post-installation-steps
For 4.6, it's the same but when installing the Discounts LTS update (I assume you'll adjust it when cherry-picking to 4.6)

On a different note, @Steveb-p what do you think about adding some (commented out) configuration for Ibexa Cloud to make setting up Messenger easier? I mean https://github.com/ibexa/post-install/blob/main/resources/platformsh/ibexa-commerce/5.0/.platform.app.yaml

code_samples/background_tasks/src/Dispatcher/SomeClassThatSchedulesExecutionInTheBackground.php

docs/api/event_reference/discounts_events.md

docs/search/discounts_search_reference/discounts_criteria.md

mnocon · 2025-10-01T16:08:02Z

code_samples/background_tasks/src/MessageHandler/SomeHandler.php

+
+use App\Message\SomeMessage;
+
+final class SomeHandler


Asking just to be sure: Symfony doc mentions that if you choose to avoid using the Attribute, then the MessageHandlerInterface interface needs to be implemented.

Can we skip it in this case?

This is only true for Symfony 5.x. On Symfony 6 and above, that interface does not exist.

Ok, so this is ok for v5, but the interface should be added when backporting to 4.6?

On 4.6 MessageHandlerInterface is indeed required. I don't remember if you can create handlers without it, or just tag the service properly. I think it's mostly used to mark service, but unsure.

docs/infrastructure_and_maintenance/background_tasks.md

Co-authored-by: Marek Nocoń <[email protected]>

…veloper into IBX-10160

github-actions · 2025-10-02T14:45:40Z

code_samples/ change report

Before (on target branch)	After (in current PR)
`code_samples/background_tasks/src/Dispatcher/SomeClassThatSchedulesExecutionInTheBackground.php`	`code_samples/background_tasks/src/Dispatcher/SomeClassThatSchedulesExecutionInTheBackground.php`
	docs/infrastructure_and_maintenance/background_tasks.md@82:``` php `docs/infrastructure_and_maintenance/background_tasks.md@83:[[= include_file("code_samples/background_tasks/src/Dispatcher/SomeClassThatSchedulesExecutionInTheBackground.php") =]]` docs/infrastructure_and_maintenance/background_tasks.md@84:``` `The following line doesn't include file correctly: [[= include_file("code_samples/background_tasks/src/Dispatcher/SomeClassThatSchedulesExecutionInTheBackground.php") =]]`
`code_samples/background_tasks/src/Message/SomeMessage.php` `code_samples/background_tasks/src/MessageHandler/SomeHandler.php`	`code_samples/background_tasks/src/Message/SomeMessage.php` `code_samples/background_tasks/src/MessageHandler/SomeHandler.php`
	docs/infrastructure_and_maintenance/background_tasks.md@90:``` php `docs/infrastructure_and_maintenance/background_tasks.md@91:[[= include_file("code_samples/background_tasks/src/MessageHandler/SomeHandler.php") =]]` docs/infrastructure_and_maintenance/background_tasks.md@92:``` `The following line doesn't include file correctly: [[= include_file("code_samples/background_tasks/src/MessageHandler/SomeHandler.php") =]]`

Download colorized diff

mnocon

Thank you!

…ackground (#2909) * API changes documented * Add messenger description * Modify configure_discounts.md * Add dispatchers to discount events * Mention discount re-indexing in post install steps --------- Co-authored-by: dabrt <[email protected]> Co-authored-by: Adrien Dupuis <[email protected]> Co-authored-by: Marek Nocoń <[email protected]>

dabrt added 4 commits September 19, 2025 21:00

API changes documented

59d3a0d

Add messenger description

d812b76

Modify configure_discounts.md

302bd07

Typos fix

cc7267e

Typos

de5b13c

dabrt assigned mnocon Sep 20, 2025

dabrt added the Work in progress label Sep 20, 2025

dabrt requested a review from Steveb-p September 20, 2025 03:34

Steveb-p reviewed Sep 22, 2025

View reviewed changes

docs/discounts/configure_discounts.md Outdated Show resolved Hide resolved

docs/discounts/configure_discounts.md Outdated Show resolved Hide resolved

Move code to code_samples

7539ab7

dabrt requested a review from Steveb-p September 30, 2025 10:24

dabrt added Needs DEV review and removed Work in progress labels Sep 30, 2025

Steveb-p reviewed Sep 30, 2025

View reviewed changes

code_samples/background_tasks/src/MessageHandler/SomeHandler.php Outdated Show resolved Hide resolved

PHP & JS CS Fixes

abdd2c0

dabrt requested a review from Steveb-p September 30, 2025 10:57

dabrt and others added 3 commits September 30, 2025 12:59

Implement Paweł's comments

7fde47a

Merge branch 'IBX-10160' of https://github.com/ibexa/documentation-de…

3477e8d

…veloper into IBX-10160

PHP & JS CS Fixes

56d1deb

dabrt requested a review from a team September 30, 2025 11:50

ezrobot requested review from adamwojs, mikadamczyk, alongosz, ciastektk, ViniTou, barw4, wiewiurdp and konradoboza and removed request for a team September 30, 2025 11:50

ezrobot requested a review from tbialcz September 30, 2025 11:50

konradoboza reviewed Sep 30, 2025

View reviewed changes

docs/discounts/configure_discounts.md Outdated Show resolved Hide resolved

docs/infrastructure_and_maintenance/background_tasks.md Outdated Show resolved Hide resolved

docs/infrastructure_and_maintenance/background_tasks.md Outdated Show resolved Hide resolved

Implement reviewer comments

d9bd01e

dabrt requested a review from konradoboza October 1, 2025 07:43

konradoboza approved these changes Oct 1, 2025

View reviewed changes

dabrt added Needs DOC review and removed Needs DEV review labels Oct 1, 2025

adriendupuis requested changes Oct 1, 2025

View reviewed changes

dabrt and others added 2 commits October 1, 2025 15:38

Apply suggestions from code review

3656c15

Co-authored-by: Adrien Dupuis <[email protected]>

Added dispatchers to discount events

5e75f6f

dabrt requested a review from adriendupuis October 1, 2025 14:31

mnocon reviewed Oct 1, 2025

View reviewed changes

dabrt and others added 4 commits October 2, 2025 09:21

Apply suggestions from code review

c3d7c29

Co-authored-by: Marek Nocoń <[email protected]>

Add links to configuration

9db3eb1

Merge branch 'IBX-10160' of https://github.com/ibexa/documentation-de…

1844eec

…veloper into IBX-10160

Mention discount re-indexing in post instaall steps

ced8ff0

dabrt requested a review from mnocon October 2, 2025 14:34

mnocon approved these changes Oct 3, 2025

View reviewed changes

Steveb-p approved these changes Oct 3, 2025

View reviewed changes

dabrt merged commit 75b57e3 into 5.0 Oct 3, 2025
6 of 7 checks passed

dabrt deleted the IBX-10160 branch October 3, 2025 08:13

IBX-10675: Document Ibexa Messenger and discount re-indexing in the background #2909

IBX-10675: Document Ibexa Messenger and discount re-indexing in the background #2909

Uh oh!

Conversation

dabrt commented Sep 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Checklist

Uh oh!

github-actions bot commented Sep 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Preview of modified files

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

dabrt commented Oct 1, 2025

Uh oh!

adriendupuis left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

mnocon left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

mnocon Oct 1, 2025

Choose a reason for hiding this comment

Uh oh!

Steveb-p Oct 2, 2025

Choose a reason for hiding this comment

Uh oh!

mnocon Oct 2, 2025

Choose a reason for hiding this comment

Uh oh!

Steveb-p Oct 2, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Oct 2, 2025

code_samples/ change report

Uh oh!

mnocon left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

dabrt commented Sep 20, 2025 •

edited

Loading

github-actions bot commented Sep 20, 2025 •

edited

Loading

mnocon left a comment •

edited

Loading