Browse Source

Fix typo in property name from 'CornExpression' to 'CronExpression' in background worker classes

pull/23071/head
maliming 1 year ago
parent
commit
5262828dd3
No known key found for this signature in database GPG Key ID: A646B9CB645ECEA4
  1. 4
      docs/en/framework/infrastructure/background-workers/index.md
  2. 10
      framework/src/Volo.Abp.BackgroundWorkers.Hangfire/Volo/Abp/BackgroundWorkers/Hangfire/HangfireBackgroundWorkerManager.cs
  3. 12
      framework/src/Volo.Abp.BackgroundWorkers.Quartz/Volo/Abp/BackgroundWorkers/Quartz/QuartzPeriodicBackgroundWorkerAdapter.cs
  4. 4
      framework/src/Volo.Abp.BackgroundWorkers/Volo/Abp/BackgroundWorkers/AsyncPeriodicBackgroundWorkerBase.cs
  5. 4
      framework/src/Volo.Abp.BackgroundWorkers/Volo/Abp/BackgroundWorkers/PeriodicBackgroundWorkerBase.cs

4
docs/en/framework/infrastructure/background-workers/index.md

@ -41,7 +41,7 @@ Start your worker in the `StartAsync` (which is called when the application begi
Assume that we want to make a user passive, if the user has not logged in to the application in last 30 days. `AsyncPeriodicBackgroundWorkerBase` class simplifies to create periodic workers, so we will use it for the example below:
> You can use `CornExpression` property to set the cron expression for the background worker if you will use the [Hangfire Background Worker Manager](./hangfire.md) or [Quartz Background Worker Manager](./quartz.md).
> You can use `CronExpression` property to set the cron expression for the background worker if you will use the [Hangfire Background Worker Manager](./hangfire.md) or [Quartz Background Worker Manager](./quartz.md).
````csharp
public class PassiveUserCheckerWorker : AsyncPeriodicBackgroundWorkerBase
@ -54,7 +54,7 @@ public class PassiveUserCheckerWorker : AsyncPeriodicBackgroundWorkerBase
serviceScopeFactory)
{
Timer.Period = 600000; //10 minutes
//CornExpression = "0 0/10 * * * ?"; //Run every 10 minutes, Only for Quartz or Hangfire integration.
//CronExpression = "0 0/10 * * * ?"; //Run every 10 minutes, Only for Quartz or Hangfire integration.
}
protected async override Task DoWorkAsync(

10
framework/src/Volo.Abp.BackgroundWorkers.Hangfire/Volo/Abp/BackgroundWorkers/Hangfire/HangfireBackgroundWorkerManager.cs

@ -57,20 +57,20 @@ public class HangfireBackgroundWorkerManager : BackgroundWorkerManager, ISinglet
case AsyncPeriodicBackgroundWorkerBase or PeriodicBackgroundWorkerBase:
{
int? period = null;
string? cornExpression = null;
string? CronExpression = null;
if (worker is AsyncPeriodicBackgroundWorkerBase asyncPeriodicBackgroundWorkerBase)
{
period = asyncPeriodicBackgroundWorkerBase.Period;
cornExpression = asyncPeriodicBackgroundWorkerBase.CornExpression;
CronExpression = asyncPeriodicBackgroundWorkerBase.CronExpression;
}
else if (worker is PeriodicBackgroundWorkerBase periodicBackgroundWorkerBase)
{
period = periodicBackgroundWorkerBase.Period;
cornExpression = periodicBackgroundWorkerBase.CornExpression;
CronExpression = periodicBackgroundWorkerBase.CronExpression;
}
if (period == null && cornExpression.IsNullOrWhiteSpace())
if (period == null && CronExpression.IsNullOrWhiteSpace())
{
return;
}
@ -85,7 +85,7 @@ public class HangfireBackgroundWorkerManager : BackgroundWorkerManager, ISinglet
recurringJobId,
workerAdapter.Queue.IsNullOrWhiteSpace() ? defaultQueue : defaultQueuePrefix + workerAdapter.Queue,
methodCall,
cornExpression ?? GetCron(period!.Value),
CronExpression ?? GetCron(period!.Value),
new RecurringJobOptions
{
TimeZone = workerAdapter.TimeZone

12
framework/src/Volo.Abp.BackgroundWorkers.Quartz/Volo/Abp/BackgroundWorkers/Quartz/QuartzPeriodicBackgroundWorkerAdapter.cs

@ -26,20 +26,20 @@ public class QuartzPeriodicBackgroundWorkerAdapter<TWorker> : QuartzBackgroundWo
public virtual void BuildWorker(IBackgroundWorker worker)
{
int? period = null;
string? cornExpression = null;
string? CronExpression = null;
if (worker is AsyncPeriodicBackgroundWorkerBase asyncPeriodicBackgroundWorkerBase)
{
period = asyncPeriodicBackgroundWorkerBase.Period;
cornExpression = asyncPeriodicBackgroundWorkerBase.CornExpression;
CronExpression = asyncPeriodicBackgroundWorkerBase.CronExpression;
}
else if (worker is PeriodicBackgroundWorkerBase periodicBackgroundWorkerBase)
{
period = periodicBackgroundWorkerBase.Period;
cornExpression = periodicBackgroundWorkerBase.CornExpression;
CronExpression = periodicBackgroundWorkerBase.CronExpression;
}
if (period == null && cornExpression.IsNullOrWhiteSpace())
if (period == null && CronExpression.IsNullOrWhiteSpace())
{
return;
}
@ -53,9 +53,9 @@ public class QuartzPeriodicBackgroundWorkerAdapter<TWorker> : QuartzBackgroundWo
.ForJob(JobDetail)
.WithIdentity(BackgroundWorkerNameAttribute.GetName<TWorker>());
if (!cornExpression.IsNullOrWhiteSpace())
if (!CronExpression.IsNullOrWhiteSpace())
{
triggerBuilder.WithCronSchedule(cornExpression);
triggerBuilder.WithCronSchedule(CronExpression);
}
else
{

4
framework/src/Volo.Abp.BackgroundWorkers/Volo/Abp/BackgroundWorkers/AsyncPeriodicBackgroundWorkerBase.cs

@ -15,9 +15,9 @@ public abstract class AsyncPeriodicBackgroundWorkerBase : BackgroundWorkerBase
protected CancellationToken StartCancellationToken { get; set; }
public int Period => Timer.Period;
/// <summary>
/// CornExpression has high priority over Period.
/// CronExpression has high priority over Period.
/// </summary>
public string? CornExpression { get; protected set; }
public string? CronExpression { get; protected set; }
protected AsyncPeriodicBackgroundWorkerBase(
AbpAsyncTimer timer,

4
framework/src/Volo.Abp.BackgroundWorkers/Volo/Abp/BackgroundWorkers/PeriodicBackgroundWorkerBase.cs

@ -17,9 +17,9 @@ public abstract class PeriodicBackgroundWorkerBase : BackgroundWorkerBase
protected AbpTimer Timer { get; }
public int Period => Timer.Period;
/// <summary>
/// CornExpression has high priority over Period.
/// CronExpression has high priority over Period.
/// </summary>
public string? CornExpression { get; protected set; }
public string? CronExpression { get; protected set; }
protected PeriodicBackgroundWorkerBase(
AbpTimer timer,

Loading…
Cancel
Save