HttpBackgroundJob helper component #12009
Conversation
|
|
||
| internal static class ShellContextExtensions | ||
| { | ||
| public static HttpContext CreateHttpContext(this ShellContext shell) |
There was a problem hiding this comment.
| public static HttpContext CreateHttpContext(this ShellContext shell) | |
| private const string Localhost = "localhost"; | |
| private static readonly char[] _urlHostSeparators = new[] { ',', ' ' } | |
| public static HttpContext CreateHttpContext(this ShellContext shell) |
| var context = new DefaultHttpContext().UseShellScopeServices(); | ||
|
|
||
| context.Request.Scheme = "https"; | ||
| var urlHost = settings.RequestUrlHost?.Split(new[] { ',', ' ' }, StringSplitOptions.RemoveEmptyEntries).FirstOrDefault(); |
There was a problem hiding this comment.
| var urlHost = settings.RequestUrlHost?.Split(new[] { ',', ' ' }, StringSplitOptions.RemoveEmptyEntries).FirstOrDefault(); | |
| var urlHost = settings.RequestUrlHost?.Split(_urlHostSeparators, StringSplitOptions.RemoveEmptyEntries).FirstOrDefault(); |
|
|
||
| context.Request.Scheme = "https"; | ||
| var urlHost = settings.RequestUrlHost?.Split(new[] { ',', ' ' }, StringSplitOptions.RemoveEmptyEntries).FirstOrDefault(); | ||
| context.Request.Host = new HostString(urlHost ?? "localhost"); |
There was a problem hiding this comment.
| context.Request.Host = new HostString(urlHost ?? "localhost"); | |
| context.Request.Host = new HostString(urlHost ?? Localhost); |
| using OrchardCore.Environment.Shell.Builders; | ||
| using OrchardCore.Modules; | ||
|
|
||
| namespace OrchardCore.BackgroundTasks; |
There was a problem hiding this comment.
Can we use namespace block for consistency with the entire source
There was a problem hiding this comment.
Hmm, no closed opinion but for now waiting for other feedbacks.
There was a problem hiding this comment.
That's a topic for #10724
For now, we should keep brackets for consistency.
Else, we can plan to do a code cleanup from VS with this new coding style and change them all if we decide so.
src/OrchardCore/OrchardCore.Abstractions/BackgroundTasks/HttpContextExtensions.cs
Show resolved
Hide resolved
| // Wait for the current 'HttpContext' to be released with a timeout of 60s. | ||
| while (httpContextAccessor.HttpContext != null) | ||
| { | ||
| await Task.Delay(1_000); |
There was a problem hiding this comment.
| await Task.Delay(1_000); | |
| await Task.Delay(1_000); | |
There was a problem hiding this comment.
Just a new line before the considtion ;)
| /// <summary> | ||
| /// Executes a background job in an isolated <see cref="ShellScope"/> after the current HTTP request is completed. | ||
| /// </summary> | ||
| public static Task AfterEndOfRequestAsync(string jobName, Func<ShellScope, Task> job) |
There was a problem hiding this comment.
ExecuteAfterEndOfRequestAsync() or RunAfterEndOfRequestAsync
There was a problem hiding this comment.
Hmm, just to not be too long, the usage being
HttpBackgroundJob.AfterEndOfRequestAsync()
In place of
HttpBackgroundJob.ExecuteAfterEndOfRequestAsync()
But why not, no closed opinion but for now waiting for other feedbacks
There was a problem hiding this comment.
We could rename the class to HttpBackgroundJobRunner, but again using verbs for methods is a best practice
There was a problem hiding this comment.
Okay I will think about it and then change the name ;)
For now this component is not used at all in our source code.
It allows to execute a background job in an isolated ShellScope after the current HTTP request is completed. It allows a controller (or razor page) action to return without waiting for a job to complete, and then, if the job update some state data, also allows to render the job state.
And just a copy paste from
ModularBackgroundServiceto make 2 or 3 helper extensions to not have duplicate code.