Add TickerQ Background Worker Integration

.github/workflows/build-and-test.yml

@@ -51,11 +51,14 @@ jobs:
     timeout-minutes: 50
     if: ${{ !github.event.pull_request.draft }}
     steps:
+    - uses: jlumbroso/free-disk-space@main
+    - uses: PSModule/install-powershell@v1
+      with:
+        Version: latest
     - uses: actions/checkout@v2
     - uses: actions/setup-dotnet@master
       with:
         dotnet-version: 10.0.x
-
     - name: Build All
       run: ./build-all.ps1
       working-directory: ./build

Directory.Packages.props

@@ -182,6 +182,10 @@
     <PackageVersion Include="System.Threading.Tasks.Extensions" Version="4.6.3" />
     <PackageVersion Include="TencentCloudSDK.Sms" Version="3.0.1273" />
     <PackageVersion Include="TimeZoneConverter" Version="7.0.0" />
+    <PackageVersion Include="TickerQ" Version="2.5.3" />
+    <PackageVersion Include="TickerQ.Dashboard" Version="2.5.3" />
+    <PackageVersion Include="TickerQ.Utilities" Version="2.5.3" />
+    <PackageVersion Include="TickerQ.EntityFrameworkCore" Version="2.5.3" />
     <PackageVersion Include="Unidecode.NET" Version="2.1.0" />
     <PackageVersion Include="xunit" Version="2.9.3" />
     <PackageVersion Include="xunit.extensibility.execution" Version="2.9.3" />

docs/en/docs-nav.json

@@ -571,6 +571,10 @@
                 {
                   "text": "Quartz Integration",
                   "path": "framework/infrastructure/background-jobs/quartz.md"
+                },
+                {
+                  "text": "TickerQ Integration",
+                  "path": "framework/infrastructure/background-jobs/tickerq.md"
                 }
               ]
             },
@@ -589,6 +593,10 @@
                 {
                   "text": "Hangfire Integration",
                   "path": "framework/infrastructure/background-workers/hangfire.md"
+                },
+                {
+                  "text": "TickerQ Integration",
+                  "path": "framework/infrastructure/background-workers/tickerq.md"
                 }
               ]
             },

docs/en/framework/infrastructure/background-jobs/index.md

@@ -348,6 +348,7 @@ See pre-built job manager alternatives:
 * [Hangfire Background Job Manager](./hangfire.md)
 * [RabbitMQ Background Job Manager](./rabbitmq.md)
 * [Quartz Background Job Manager](./quartz.md)
+* [TickerQ Background Job Manager](./tickerq.md) 
 
 ## See Also
 * [Background Workers](../background-workers)

docs/en/framework/infrastructure/background-jobs/tickerq.md

@@ -0,0 +1,125 @@
+# TickerQ Background Job Manager
+
+[TickerQ](https://tickerq.net/) is a fast, reflection-free background task scheduler for .NET — built with source generators, EF Core integration, cron + time-based execution, and a real-time dashboard. You can integrate TickerQ with the ABP to use it instead of the [default background job manager](../background-jobs). In this way, you can use the same background job API for TickerQ and your code will be independent of TickerQ. If you like, you can directly use TickerQ's API, too.
+
+> See the [background jobs document](../background-jobs) to learn how to use the background job system. This document only shows how to install and configure the TickerQ integration.
+
+## Installation
+
+It is suggested to use the [ABP CLI](../../../cli) to install this package.
+
+### Using the ABP CLI
+
+Open a command line window in the folder of the project (.csproj file) and type the following command:
+
+````bash
+abp add-package Volo.Abp.BackgroundJobs.TickerQ
+````
+
+>  If you haven't done it yet, you first need to install the [ABP CLI](../../../cli). For other installation options, see [the package description page](https://abp.io/package-detail/Volo.Abp.BackgroundJobs.TickerQ).
+
+## Configuration
+
+### AddTickerQ
+
+You can call the `AddTickerQ` extension method in the `ConfigureServices` method of your module to configure TickerQ services:
+
+> This is optional. ABP will automatically register TickerQ services.
+
+```csharp
+public override void ConfigureServices(ServiceConfigurationContext context)
+{
+	context.Services.AddTickerQ(x =>
+	{
+		// Configure TickerQ options here
+	});
+}
+```
+
+### UseAbpTickerQ
+
+You need to call the `UseAbpTickerQ` extension method instead of `AddTickerQ` in the `OnApplicationInitialization` method of your module:
+
+```csharp
+// (default: TickerQStartMode.Immediate)
+app.UseAbpTickerQ(startMode: ...);
+```
+
+### AbpBackgroundJobsTickerQOptions
+
+You can configure the `TimeTicker` properties for specific jobs. For example, you can change `Priority`, `Retries` and `RetryIntervals` properties as shown below:
+
+```csharp
+Configure<AbpBackgroundJobsTickerQOptions>(options =>
+{
+	options.AddJobConfiguration<MyBackgroundJob>(new AbpBackgroundJobsTimeTickerConfiguration()
+	{
+		Retries = 3,
+		RetryIntervals = new[] {30, 60, 120}, // Retry after 30s, 60s, then 2min
+		Priority = TickerTaskPriority.High
+
+		// Optional batching
+		//BatchParent = Guid.Parse("...."),
+		//BatchRunCondition = BatchRunCondition.OnSuccess
+	});
+
+	options.AddJobConfiguration<MyBackgroundJob2>(new AbpBackgroundJobsTimeTickerConfiguration()
+	{
+		Retries = 5,
+		RetryIntervals = new[] {30, 60, 120}, // Retry after 30s, 60s, then 2min
+		Priority = TickerTaskPriority.Normal
+	});
+});
+```
+
+### Add your own TickerQ Background Jobs Definitions
+
+ABP will handle the TickerQ job definitions by `AbpTickerQFunctionProvider` service. You shouldn't use `TickerFunction` to add your own job definitions. You can inject and use the `AbpTickerQFunctionProvider` to add your own definitions and use `ITimeTickerManager<TimeTicker>` or `ICronTickerManager<CronTicker>` to manage the jobs.
+
+For example, you can add a `CleanupJobs` job definition in the `OnPreApplicationInitializationAsync` method of your module:
+
+```csharp
+public class CleanupJobs
+{
+    public async Task CleanupLogsAsync(TickerFunctionContext<string> tickerContext, CancellationToken cancellationToken)
+    {
+        var logFileName = tickerContext.Request;
+        Console.WriteLine($"Cleaning up log file: {logFileName} at {DateTime.Now}");
+    }
+}
+```
+
+```csharp
+public override Task OnPreApplicationInitializationAsync(ApplicationInitializationContext context)
+{
+	var abpTickerQFunctionProvider = context.ServiceProvider.GetRequiredService<AbpTickerQFunctionProvider>();
+	abpTickerQFunctionProvider.Functions.TryAdd(nameof(CleanupJobs), (string.Empty, TickerTaskPriority.Normal, new TickerFunctionDelegate(async (cancellationToken, serviceProvider, tickerFunctionContext) =>
+	{
+		var service = new CleanupJobs(); // Or get it from the serviceProvider
+		var request = await TickerRequestProvider.GetRequestAsync<string>(serviceProvider,  tickerFunctionContext.Id, tickerFunctionContext.Type);
+		var genericContext = new TickerFunctionContext<string>(tickerFunctionContext, request);
+		await service.CleanupLogsAsync(genericContext, cancellationToken);
+	})));
+	abpTickerQFunctionProvider.RequestTypes.TryAdd(nameof(CleanupJobs), (typeof(string).FullName, typeof(string)));
+	return Task.CompletedTask;
+}
+```
+
+And then you can add a job by using the `ITimeTickerManager<TimeTicker>`:
+
+```csharp
+var timeTickerManager = context.ServiceProvider.GetRequiredService<ITimeTickerManager<TimeTicker>>();
+await timeTickerManager.AddAsync(new TimeTicker
+{
+	Function = nameof(CleanupJobs),
+	ExecutionTime = DateTime.UtcNow.AddSeconds(5),
+	Request = TickerHelper.CreateTickerRequest<string>("cleanup_example_file.txt"),
+	Retries = 3,
+	RetryIntervals = new[] { 30, 60, 120 }, // Retry after 30s, 60s, then 2min
+});
+```
+
+### TickerQ Dashboard and EF Core Integration
+
+You can install the [TickerQ dashboard](https://tickerq.net/setup/dashboard.html) and [Entity Framework Core](https://tickerq.net/setup/tickerq-ef-core.html) integration by its documentation. There is no specific configuration needed for the ABP integration.
+

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 `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).
+> 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), [Quartz Background Worker Manager](./quartz.md), or [TickerQ Background Worker Manager](./tickerq.md).
 
 ````csharp
 public class PassiveUserCheckerWorker : AsyncPeriodicBackgroundWorkerBase
@@ -216,7 +216,8 @@ Background worker system is extensible and you can change the default background
 See pre-built worker manager alternatives:
 
 * [Quartz Background Worker Manager](./quartz.md) 
-* [Hangfire Background Worker Manager](./hangfire.md) 
+* [Hangfire Background Worker Manager](./hangfire.md)
+* [TickerQ Background Worker Manager](./tickerq.md) 
 
 ## See Also
 

docs/en/framework/infrastructure/background-workers/tickerq.md

@@ -0,0 +1,119 @@
+# TickerQ Background Worker Manager
+
+[TickerQ](https://tickerq.net/) is a fast, reflection-free background task scheduler for .NET — built with source generators, EF Core integration, cron + time-based execution, and a real-time dashboard. You can integrate TickerQ with the ABP to use it instead of the [default background worker manager](../background-workers).
+
+## Installation
+
+It is suggested to use the [ABP CLI](../../../cli) to install this package.
+
+### Using the ABP CLI
+
+Open a command line window in the folder of the project (.csproj file) and type the following command:
+
+````bash
+abp add-package Volo.Abp.BackgroundWorkers.TickerQ
+````
+
+>  If you haven't done it yet, you first need to install the [ABP CLI](../../../cli). For other installation options, see [the package description page](https://abp.io/package-detail/Volo.Abp.BackgroundWorkers.TickerQ).
+
+## Configuration
+
+### AddTickerQ
+
+You can call the `AddTickerQ` extension method in the `ConfigureServices` method of your module to configure TickerQ services:
+
+> This is optional. ABP will automatically register TickerQ services.
+
+```csharp
+public override void ConfigureServices(ServiceConfigurationContext context)
+{
+	context.Services.AddTickerQ(x =>
+	{
+		// Configure TickerQ options here
+	});
+}
+```
+
+### UseAbpTickerQ
+
+You need to call the `UseAbpTickerQ` extension method instead of `AddTickerQ` in the `OnApplicationInitialization` method of your module:
+
+```csharp
+// (default: TickerQStartMode.Immediate)
+app.UseAbpTickerQ(startMode: ...);
+```
+
+### AbpBackgroundWorkersTickerQOptions
+
+You can configure the `CronTicker` properties for specific jobs. For example, Change `Priority`, `Retries` and `RetryIntervals` properties:
+
+```csharp
+Configure<AbpBackgroundWorkersTickerQOptions>(options =>
+{
+	options.AddConfiguration<MyBackgroundWorker>(new AbpBackgroundWorkersCronTickerConfiguration()
+	{
+		Retries = 3,
+		RetryIntervals = new[] {30, 60, 120}, // Retry after 30s, 60s, then 2min,
+		Priority = TickerTaskPriority.High
+	});
+});
+```
+
+### Add your own TickerQ Background Worker Definitions
+
+ABP will handle the TickerQ job definitions by `AbpTickerQFunctionProvider` service. You shouldn't use `TickerFunction` to add your own job definitions. You can inject and use the `AbpTickerQFunctionProvider` to add your own definitions and use `ITimeTickerManager<TimeTicker>` or `ICronTickerManager<CronTicker>` to manage the jobs.
+
+For example, you can add a `CleanupJobs` job definition in the `OnPreApplicationInitializationAsync` method of your module:
+
+```csharp
+public class CleanupJobs
+{
+    public async Task CleanupLogsAsync(TickerFunctionContext<string> tickerContext, CancellationToken cancellationToken)
+    {
+        var logFileName = tickerContext.Request;
+        Console.WriteLine($"Cleaning up log file: {logFileName} at {DateTime.Now}");
+    }
+}
+```
+
+```csharp
+public override Task OnPreApplicationInitializationAsync(ApplicationInitializationContext context)
+{
+	var abpTickerQFunctionProvider = context.ServiceProvider.GetRequiredService<AbpTickerQFunctionProvider>();
+	abpTickerQFunctionProvider.Functions.TryAdd(nameof(CleanupJobs), (string.Empty, TickerTaskPriority.Normal, new TickerFunctionDelegate(async (cancellationToken, serviceProvider, tickerFunctionContext) =>
+	{
+		var service = new CleanupJobs(); // Or get it from the serviceProvider
+		var request = await TickerRequestProvider.GetRequestAsync<string>(serviceProvider,  tickerFunctionContext.Id, tickerFunctionContext.Type);
+		var genericContext = new TickerFunctionContext<string>(tickerFunctionContext, request);
+		await service.CleanupLogsAsync(genericContext, cancellationToken);
+	})));
+	abpTickerQFunctionProvider.RequestTypes.TryAdd(nameof(CleanupJobs), (typeof(string).FullName, typeof(string)));
+	return Task.CompletedTask;
+}
+```
+
+And then you can add a job by using the `ICronTickerManager<CronTicker>`:
+
+```csharp
+var cronTickerManager = context.ServiceProvider.GetRequiredService<ICronTickerManager<CronTicker>>();
+await cronTickerManager.AddAsync(new CronTicker
+{
+	Function = nameof(CleanupJobs),
+	Expression = "0 */6 * * *", // Every 6 hours
+	Request = TickerHelper.CreateTickerRequest<string>("cleanup_example_file.txt"),
+	Retries = 2,
+	RetryIntervals = new[] { 60, 300 }
+});
+```
+
+You can specify a cron expression instead of use `ICronTickerManager<CronTicker>` to add a worker:
+
+```csharp
+abpTickerQFunctionProvider.Functions.TryAdd(nameof(CleanupJobs), (string.Empty, TickerTaskPriority.Normal, new TickerFunctionDelegate(async (cancellationToken, serviceProvider, tickerFunctionContext) =>
+{
+	var service = new CleanupJobs();
+	var request = await TickerRequestProvider.GetRequestAsync<string>(serviceProvider,  tickerFunctionContext.Id, tickerFunctionContext.Type);
+	var genericContext = new TickerFunctionContext<string>(tickerFunctionContext, request);
+	await service.CleanupLogsAsync(genericContext, cancellationToken);
+})));
+```

framework/Volo.Abp.slnx

@@ -166,6 +166,9 @@
     <Project Path="src/Volo.Abp/Volo.Abp.csproj" />
     <Project Path="src/Volo.Abp.AI.Abstractions/Volo.Abp.AI.Abstractions.csproj" />
     <Project Path="src/Volo.Abp.AI/Volo.Abp.AI.csproj" />
+    <Project Path="src/Volo.Abp.TickerQ/Volo.Abp.TickerQ.csproj" />
+    <Project Path="src/Volo.Abp.BackgroundJobs.TickerQ/Volo.Abp.BackgroundJobs.TickerQ.csproj" />
+    <Project Path="src/Volo.Abp.BackgroundWorkers.TickerQ/Volo.Abp.BackgroundWorkers.TickerQ.csproj" />
   </Folder>
   <Folder Name="/test/">
     <Project Path="test/AbpTestBase/AbpTestBase.csproj" />
@@ -252,4 +255,4 @@
     <Project Path="test/Volo.Abp.Validation.Tests/Volo.Abp.Validation.Tests.csproj" />
     <Project Path="test/Volo.Abp.VirtualFileSystem.Tests/Volo.Abp.VirtualFileSystem.Tests.csproj" />
   </Folder>
-</Solution>
+</Solution>

framework/src/Volo.Abp.BackgroundJobs.TickerQ/FodyWeavers.xml

@@ -0,0 +1,3 @@
+<Weavers xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="FodyWeavers.xsd">
+  <ConfigureAwait ContinueOnCapturedContext="false" />
+</Weavers>

framework/src/Volo.Abp.BackgroundJobs.TickerQ/FodyWeavers.xsd

@@ -0,0 +1,30 @@
+<?xml version="1.0" encoding="utf-8"?>
+<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
+  <!-- This file was generated by Fody. Manual changes to this file will be lost when your project is rebuilt. -->
+  <xs:element name="Weavers">
+    <xs:complexType>
+      <xs:all>
+        <xs:element name="ConfigureAwait" minOccurs="0" maxOccurs="1">
+          <xs:complexType>
+            <xs:attribute name="ContinueOnCapturedContext" type="xs:boolean" />
+          </xs:complexType>
+        </xs:element>
+      </xs:all>
+      <xs:attribute name="VerifyAssembly" type="xs:boolean">
+        <xs:annotation>
+          <xs:documentation>'true' to run assembly verification (PEVerify) on the target assembly after all weavers have been executed.</xs:documentation>
+        </xs:annotation>
+      </xs:attribute>
+      <xs:attribute name="VerifyIgnoreCodes" type="xs:string">
+        <xs:annotation>
+          <xs:documentation>A comma-separated list of error codes that can be safely ignored in assembly verification.</xs:documentation>
+        </xs:annotation>
+      </xs:attribute>
+      <xs:attribute name="GenerateXsd" type="xs:boolean">
+        <xs:annotation>
+          <xs:documentation>'false' to turn off automatic generation of the XML Schema file.</xs:documentation>
+        </xs:annotation>
+      </xs:attribute>
+    </xs:complexType>
+  </xs:element>
+</xs:schema>