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 <zoltan.lehoczky@lombiq.com>

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

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

Piedone · 2024-04-21T19:17:37Z

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

@@ -81,6 +81,10 @@ public virtual async Task InitializeAsync()
                TenantName = tenantName;
            }

+            // 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(2_000);


This can make the test flaky. Instead, explicitly wait for the process to finish, don't really on occasionally correct time.

See how you fixed this under another PR of yours when I pointed it out.

Also in RecentBlogPostsQueryTests.

coderabbitai · 2024-04-30T05:35:04Z

Walkthrough

The recent updates in OrchardCore involve transitioning indexing operations from executing at the end of a shell scope to a background job after an HTTP request. This change aims to boost performance by running the indexing process asynchronously. It impacts Lucene and Elasticsearch handlers, along with related test scenarios, ensuring indexing aligns with the new asynchronous execution model.

Changes

File Path	Change Summary
`.../Lucene/Handler/LuceneIndexingContentHandler.cs` `.../Elasticsearch.Core/Handlers/ElasticIndexingContentHandler.cs`	Replaced local variable and `ShellScope.AddDeferredTask` with `HttpBackgroundJob.ExecuteAfterEndOfRequestAsync` for asynchronous content indexing. Added `using OrchardCore.BackgroundJobs;`.
`.../ContentManagement/DeploymentPlans/ContentStepLuceneQueryTests.cs` `.../GraphQL/Queries/RecentBlogPostsQueryTests.cs` `.../Context/SiteContext.cs`	Updated the timing of search index updates to use background jobs post-HTTP request, affecting test timings and necessitating delays in test scenarios. Added relevant `using` statements. Adjusted `SiteContext` to include a delay in `InitializeAsync`.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai generate interesting stats about this repository and render them as a table.
- @coderabbitai show all the console.log statements in this repository.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

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.

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 <zoltan.lehoczky@lombiq.com>

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

Piedone mentioned this pull request Apr 21, 2024

Optimize IndexingContentHandlers perf #13721

Draft

Piedone reviewed Apr 21, 2024

View reviewed changes

Merge branch 'main' into LuceneIndexingContentHandler

b7574f4

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

Open

Merge branch 'main' into LuceneIndexingContentHandler

38fa7ce

github-actions bot removed the merge conflict label Jun 15, 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

Piedone Apr 21, 2024

coderabbitai bot commented Apr 30, 2024 •

edited

Loading

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

Documentation and Community

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

		&& "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

Piedone Apr 21, 2024

Choose a reason for hiding this comment

coderabbitai bot commented Apr 30, 2024 • edited Loading

Walkthrough

Changes

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

Documentation and Community

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

hyzx86 commented Aug 3, 2023 •

edited by coderabbitai bot

Loading

jtkech commented Aug 3, 2023 •

edited

Loading

Skrypt commented Mar 22, 2024 •

edited

Loading

coderabbitai bot commented Apr 30, 2024 •

edited

Loading

CodeRabbit Configration File (`.coderabbit.yaml`)