Use HttpBackgroundJob instead of Deferred Tasks during search indexing #14063

hyzx86 · 2023-08-03T03:28:54Z

Summary by CodeRabbit

New Features
- Enhanced search indexing to be handled asynchronously post-HTTP request across various modules, improving performance without blocking user interactions.
Refactor
- Transitioned from immediate to deferred indexing methods in several backend processes to optimize system responsiveness and resource management.
Tests
- Updated test scenarios to adapt to new asynchronous indexing behavior, ensuring reliability and accuracy in search functionalities.

jtkech · 2023-08-03T04:11:35Z

I will review soon, maybe also in ElasticIndexingContentHandler, maybe some other places.

In the meantime I see one problem, e.g. when we publish an item from a BackgroundTask, in this context we can't trigger a BackgroundJob, we would need the same check done in the extension itself.

if (httpContextAccessor.HttpContext == null ||
    httpContextAccessor.HttpContext.Items.TryGetValue("IsBackground", out _))

Need to check why unit tests fail.

Also, will need to be reviewed by @Skrypt.

Hmm, also when executing recipes, each step is executed in its own scope, a step may update content items, then a subsequent step may need these items to be already indexed, which would not be the case if we wait the end of the request in place of waiting the end of the step scope.

Maybe this is why unit tests are failing, will think about it tomorrow.

jtkech · 2023-08-08T03:36:54Z

@hyzx86 Okay I fixed the unit tests by adding a delay in 3 places.

// Search indexes are no longer updated in a deferred task at the end of a shell scope
// but in a background job after the http request, so they are not already up to date.
await Task.Delay(1_500);

Not sure it's a common case to update an index and just after do a query that should rely on this index update, but at least it will break those that are using the same kind of unit tests.

Hmm, finally maybe okay when executed through a recipe.

But still the problem when for example we publish an item in a background task, we would need to check it (easy to do) and then still use the deferred task.

OR at the end of a background task, in the same way we set an HttpContext, we could clear it (as aspnetcore does at the end of a request) and maybe the ActionContext too (as aspnetcore doesn't).

Piedone

I sincerely apologize for us taking so much time here. I checked out the PR, going over old ones, and it needs changes before it can be merged.

test/OrchardCore.Tests/Apis/ContentManagement/DeploymentPlans/ContentStepLuceneQueryTests.cs

Piedone · 2024-03-21T22:30:06Z

Is this something you'd like to revisit any time soon @hyzx86 or should we close?

Skrypt · 2024-03-22T16:13:15Z

This should work after merging #13721 as it will no longer do a SQL query in the LuceneIndexingContentHandler. Though same logic needs to be replied in ElasticIndexingContentHandler and AzureAISearch one too.

…x86/OrchardCore into LuceneIndexingContentHandler

Piedone · 2024-03-24T21:56:13Z

test/OrchardCore.Tests/Apis/ContentManagement/DeploymentPlans/ContentStepLuceneQueryTests.cs

+                    && "new version".Equals(nodes[0]["displayText"].ToString())
+                    && "second content item display text".Equals(nodes[1]["displayText"].ToString())


Put the strings to the right of the operator, and simply use ==.

Piedone · 2024-03-24T21:56:30Z

test/OrchardCore.Tests/Apis/ContentManagement/DeploymentPlans/ContentStepLuceneQueryTests.cs

+                    && "second content item display text".Equals(nodes[1]["displayText"].ToString())
+                    )
+                {
+                    Assert.True(true);


This is a no-op.

Sorry, I don't see what you mean. Do I need to change the code here?

test/OrchardCore.Tests/Apis/ContentManagement/DeploymentPlans/ContentStepLuceneQueryTests.cs

Piedone · 2024-03-24T21:59:04Z

So, let's revisit this after #13721 is merged. @Skrypt will you be able to review this one after that too, or should somebody else do it?

…ContentStepLuceneQueryTests.cs Co-authored-by: Zoltán Lehóczky <[email protected]>

Piedone · 2024-03-25T16:03:18Z

While I pointed out some small issues, I'll only review this is Jasmin won't.

coderabbitai

Actionable comments posted: 3

test/OrchardCore.Tests/Apis/GraphQL/Queries/RecentBlogPostsQueryTests.cs

test/OrchardCore.Tests/Apis/ContentManagement/DeploymentPlans/ContentStepLuceneQueryTests.cs

test/OrchardCore.Tests/Apis/Context/SiteContext.cs

hyzx86 · 2024-04-30T06:56:33Z

@coderabbitai review

coderabbitai

Actionable comments posted: 2

Out of diff range and nitpick comments (1)

test/OrchardCore.Tests/Utilities/TimeoutTaskRunner.cs (1)

14-14: Reduce the delay interval or make it configurable.

Currently, there is a hardcoded delay of 500 milliseconds in each iteration of the loop. This might not be optimal for all scenarios and could lead to unnecessary delays in tests. Consider making this delay configurable or reducing it to speed up the checks.

test/OrchardCore.Tests/Utilities/TimeoutTaskRunner.cs

hyzx86 · 2024-05-01T05:39:13Z

@Piedone , This PR is ready to review. 😊

Piedone · 2024-05-02T01:05:25Z

This is meant to be applicable only after #13721, no?

hyzx86 · 2024-05-02T05:15:37Z

This is meant to be applicable only after #13721, no?

Okay, I did get the order wrong, but this PR I think is done.

Piedone · 2024-05-02T14:02:55Z

Please let me know when the other one is merged and we can get back to this.

github-actions · 2024-05-25T15:18:33Z

This pull request has merge conflicts. Please resolve those before requesting a review.

github-actions · 2024-08-14T13:22:09Z

This pull request has merge conflicts. Please resolve those before requesting a review.

MikeAlhayek · 2024-08-15T17:44:56Z

for instructions on how to resolve the merge conflicts due to #16572 please follow the step listed in this comment.

github-actions · 2024-10-14T20:40:44Z

It seems that this pull request didn't really move for quite a while. Is this something you'd like to revisit any time soon or should we close? Please comment if you'd like to pick it up.

github-actions · 2024-10-30T00:57:41Z

Closing this pull request because it has been stale for very long. If you think this is still relevant, feel free to reopen it.

Use HttpBackgourndJob replace ShellScope AddDeferredTask

3136ea5

hyzx86 and others added 3 commits August 8, 2023 01:15

Merge branch 'origin_main' into LuceneIndexingContentHandler

848e63e

update ElasticIndexingContentHandler

adbcc5c

Fixes unit tests

d7f9d99

jtkech added 2 commits August 8, 2023 05:39

Minor change

7e2558d

Increase the delay

6fc95a0

MikeAlhayek approved these changes Aug 24, 2023

View reviewed changes

Merge branch 'main' into LuceneIndexingContentHandler

b536827

Piedone changed the title ~~Use HttpBackgourndJob to replace ShellScope AddDeferredTask~~ Use HttpBackgroundJob to replace ShellScope AddDeferredTask Jan 10, 2024

Piedone requested changes Jan 10, 2024

View reviewed changes

test/OrchardCore.Tests/Apis/ContentManagement/DeploymentPlans/ContentStepLuceneQueryTests.cs Outdated Show resolved Hide resolved

Merge branch 'main' into LuceneIndexingContentHandler

be5bc69

hyzx86 added 3 commits March 23, 2024 17:14

Merge branch 'main' into LuceneIndexingContentHandler

d4b89d6

update test case

e25416b

Merge branch 'LuceneIndexingContentHandler' of https://github.com/hyz…

5c87657

…x86/OrchardCore into LuceneIndexingContentHandler

Piedone reviewed Mar 24, 2024

View reviewed changes

test/OrchardCore.Tests/Apis/ContentManagement/DeploymentPlans/ContentStepLuceneQueryTests.cs Outdated Show resolved Hide resolved

hyzx86 and others added 3 commits March 25, 2024 14:14

Update test/OrchardCore.Tests/Apis/ContentManagement/DeploymentPlans/…

31b973e

…ContentStepLuceneQueryTests.cs Co-authored-by: Zoltán Lehóczky <[email protected]>

update code

aa6f5f4

Merge branch 'main' into LuceneIndexingContentHandler

c85f67e

hyzx86 requested a review from Piedone March 25, 2024 06:19

hyzx86 and others added 2 commits April 2, 2024 23:18

Merge branch 'main' into LuceneIndexingContentHandler

72be022

Merge branch 'main' into LuceneIndexingContentHandler

353ad25

Piedone changed the title ~~Use HttpBackgroundJob to replace ShellScope AddDeferredTask~~ Use HttpBackgroundJob instead of Deferred Tasks during search indexing Apr 21, 2024

coderabbitai bot reviewed Apr 30, 2024

View reviewed changes

add TimeoutTaskRunner

5395aa0

coderabbitai bot reviewed Apr 30, 2024

View reviewed changes

test/OrchardCore.Tests/Utilities/TimeoutTaskRunner.cs Show resolved Hide resolved

test/OrchardCore.Tests/Utilities/TimeoutTaskRunner.cs Show resolved Hide resolved

update TimeoutTaskRunner

8f4a2da

hyzx86 requested review from Piedone and MikeAlhayek April 30, 2024 07:19

Merge branch 'main' into LuceneIndexingContentHandler

dbbca42

This comment was marked as off-topic.

Sign in to view

Merge branch 'main' into LuceneIndexingContentHandler

49ee107

hyzx86 marked this pull request as draft May 2, 2024 05:18

github-actions bot added the merge conflict label May 25, 2024

hyzx86 mentioned this pull request Jun 15, 2024

Rebuilding elastic index takes a lot of time #16308

Closed

Merge branch 'main' into LuceneIndexingContentHandler

38fa7ce

github-actions bot removed the merge conflict label Jun 15, 2024

Merge branch 'main' into LuceneIndexingContentHandler

d5957a9

github-actions bot added the merge conflict label Aug 14, 2024

github-actions bot added the stale label Oct 14, 2024

github-actions bot closed this Oct 30, 2024

Skrypt reopened this Oct 30, 2024

github-actions bot removed the stale label Oct 30, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Use HttpBackgroundJob instead of Deferred Tasks during search indexing #14063

Use HttpBackgroundJob instead of Deferred Tasks during search indexing #14063

hyzx86 commented Aug 3, 2023 •

edited by coderabbitai bot

Loading

jtkech commented Aug 3, 2023 •

edited

Loading

jtkech commented Aug 8, 2023

Piedone left a comment

Piedone commented Mar 21, 2024

Skrypt commented Mar 22, 2024 •

edited

Loading

Piedone Mar 24, 2024

Piedone Mar 24, 2024

hyzx86 Mar 25, 2024

hyzx86 Mar 25, 2024

Piedone commented Mar 24, 2024

Piedone commented Mar 25, 2024

coderabbitai bot left a comment

hyzx86 commented Apr 30, 2024

coderabbitai bot left a comment

hyzx86 commented May 1, 2024

Piedone commented May 2, 2024

This comment was marked as off-topic.

hyzx86 commented May 2, 2024

Piedone commented May 2, 2024

github-actions bot commented May 25, 2024

github-actions bot commented Aug 14, 2024

MikeAlhayek commented Aug 15, 2024

github-actions bot commented Oct 14, 2024

github-actions bot commented Oct 30, 2024

		&& "new version".Equals(nodes[0]["displayText"].ToString())
		&& "second content item display text".Equals(nodes[1]["displayText"].ToString())

Use HttpBackgroundJob instead of Deferred Tasks during search indexing #14063

Are you sure you want to change the base?

Use HttpBackgroundJob instead of Deferred Tasks during search indexing #14063

Conversation

hyzx86 commented Aug 3, 2023 • edited by coderabbitai bot Loading

Summary by CodeRabbit

jtkech commented Aug 3, 2023 • edited Loading

jtkech commented Aug 8, 2023

Piedone left a comment

Choose a reason for hiding this comment

Piedone commented Mar 21, 2024

Skrypt commented Mar 22, 2024 • edited Loading

Piedone Mar 24, 2024

Choose a reason for hiding this comment

Piedone Mar 24, 2024

Choose a reason for hiding this comment

hyzx86 Mar 25, 2024

Choose a reason for hiding this comment

hyzx86 Mar 25, 2024

Choose a reason for hiding this comment

Piedone commented Mar 24, 2024

Piedone commented Mar 25, 2024

coderabbitai bot left a comment

Choose a reason for hiding this comment

hyzx86 commented Apr 30, 2024

coderabbitai bot left a comment

Choose a reason for hiding this comment

hyzx86 commented May 1, 2024

Piedone commented May 2, 2024

This comment was marked as off-topic.

hyzx86 commented May 2, 2024

Piedone commented May 2, 2024

github-actions bot commented May 25, 2024

github-actions bot commented Aug 14, 2024

MikeAlhayek commented Aug 15, 2024

github-actions bot commented Oct 14, 2024

github-actions bot commented Oct 30, 2024

hyzx86 commented Aug 3, 2023 •

edited by coderabbitai bot

Loading

jtkech commented Aug 3, 2023 •

edited

Loading

Skrypt commented Mar 22, 2024 •

edited

Loading