feat: configurable queue consummation delay #411
Conversation
There was a problem hiding this comment.
Hey, thanks for the contribution!
I have a few improvements that I think will (a) help the code and (b) enable us to add some tests here.
Also, let's add some user documentation for this! In the file DocsV2/docs/Queuing/README.md you can add the following to the Adjusting Consummation Delay section:
Alternatively, you can adjust the consummation delay using AddQueue:
services.AddQueue(queueOptions => {
// Consume queue every 5 seconds.
queueOptions.ConsummationDelay = 5;
});:::tip
QueueOptions will take precedence over your configuration file if both are defined.
:::
| { | ||
| public class QueueOptions | ||
| { | ||
| public int? ConsummationDelay { get; set; } |
There was a problem hiding this comment.
Could we add an XML comment here "This determines how often (in seconds) the queue host will consume all pending tasks."
| if (this._queueOptions.ConsummationDelay.HasValue) return this._queueOptions.ConsummationDelay.Value; | ||
| var configurationSection = this._configuration.GetSection("Coravel:Queue:ConsummationDelay"); | ||
| bool couldParseDelay = int.TryParse(configurationSection.Value, out var parsedDelay); | ||
| return couldParseDelay ? parsedDelay : 30; |
There was a problem hiding this comment.
Given that we now have an object handling queue options, I think it would be better to encapsulate this method inside of QueueOptions and pass the IConfiguration object as a param. So:
int consummationDelay = this._queueOptions.GetConsummationDelay(this._configuration);Then, we could add a few tests against this method - probably under a new test file Src/UnitTests/CoravelUnitTests/Queuing/QueueOptionsTest.cs.
Issue: #409