Hangfire.Core
1.8.17
Prefix Reserved
dotnet add package Hangfire.Core --version 1.8.17
NuGet\Install-Package Hangfire.Core -Version 1.8.17
<PackageReference Include="Hangfire.Core" Version="1.8.17" />
paket add Hangfire.Core --version 1.8.17
#r "nuget: Hangfire.Core, 1.8.17"
// Install Hangfire.Core as a Cake Addin #addin nuget:?package=Hangfire.Core&version=1.8.17 // Install Hangfire.Core as a Cake Tool #tool nuget:?package=Hangfire.Core&version=1.8.17
Hangfire
Build Status
main |
dev |
|
---|---|---|
AppVeyor |
Overview
Incredibly easy way to perform fire-and-forget, delayed and recurring jobs in .NET applications. CPU and I/O intensive, long-running and short-running jobs are supported. No Windows Service / Task Scheduler required. Backed by Redis, SQL Server, SQL Azure and MSMQ.
Hangfire provides a unified programming model to handle background tasks in a reliable way and run them on shared hosting, dedicated hosting or in cloud. You can start with a simple setup and grow computational power for background jobs with time for these scenarios:
- mass notifications/newsletters
- batch import from xml, csv or json
- creation of archives
- firing off web hooks
- deleting users
- building different graphs
- image/video processing
- purging temporary files
- recurring automated reports
- database maintenance
- …and so on
Hangfire is a .NET alternative to Resque, Sidekiq, delayed_job, Celery.
Installation
Hangfire is available as a NuGet package. You can install it using the NuGet Package Console window:
PM> Install-Package Hangfire
After installation, update your existing OWIN Startup file with the following lines of code. If you do not have this class in your project or don't know what is it, please read the Quick start guide to learn about how to install Hangfire.
public void Configuration(IAppBuilder app)
{
GlobalConfiguration.Configuration.UseSqlServerStorage("<connection string or its name>");
app.UseHangfireServer();
app.UseHangfireDashboard();
}
Usage
This is an incomplete list of features; to see all of them, check the official site and the documentation.
Dedicated worker pool threads execute queued background jobs as soon as possible, shortening your request's processing time.
BackgroundJob.Enqueue(() => Console.WriteLine("Simple!"));
Scheduled background jobs are executed only after a given amount of time.
BackgroundJob.Schedule(() => Console.WriteLine("Reliable!"), TimeSpan.FromDays(7));
Recurring jobs have never been simpler; just call the following method to perform any kind of recurring task using the CRON expressions.
RecurringJob.AddOrUpdate(() => Console.WriteLine("Transparent!"), Cron.Daily);
Continuations
Continuations allow you to define complex workflows by chaining multiple background jobs together.
var id = BackgroundJob.Enqueue(() => Console.WriteLine("Hello, "));
BackgroundJob.ContinueWith(id, () => Console.WriteLine("world!"));
Process background tasks inside a web application…
You can process background tasks in any OWIN-compatible application framework, including ASP.NET MVC, ASP.NET Web API, FubuMvc, Nancy, etc. Forget about AppDomain unloads, Web Garden & Web Farm issues – Hangfire is reliable for web applications from scratch, even on shared hosting.
app.UseHangfireServer();
… or anywhere else
In console applications, Windows Service, Azure Worker Role, etc.
using (new BackgroundJobServer())
{
Console.WriteLine("Hangfire Server started. Press ENTER to exit...");
Console.ReadLine();
}
Questions? Problems?
Open-source projects develop more smoothly when discussions are public.
If you have any questions, problems related to Hangfire usage or if you want to discuss new features, please visit the discussion forum. You can sign in there using your existing Google or GitHub account, so it's very simple to start using it.
If you've discovered a bug, please report it to the Hangfire GitHub Issues. Detailed reports with stack traces, actual and expected behaviours are welcome.
Related Projects
Please see the Extensions page on the official site.
Building the sources
Prerequisites:
- Razor Generator: Required if you intend to edit the cshtml files.
- Install the MSMQ service (Microsoft Message Queue Server), if not already installed.
Then, create an environment variable with Variable name Hangfire_SqlServer_ConnectionStringTemplate
and put your connection string in the Variable value field. Example:
- Variable name:
Hangfire_SqlServer_ConnectionStringTemplate
- Variable value:
Data Source=.\sqlexpress;Initial Catalog=Hangfire.SqlServer.Tests;Integrated Security=True;
To build a solution and get assembly files, just run the following command. All build artifacts, including *.pdb
files, will be placed into the build
folder. Before proposing a pull request, please use this command to ensure everything is ok. Btw, you can execute this command from the Package Manager Console window.
build
To build NuGet packages as well as an archive file, use the pack
command as shown below. You can find the result files in the build
folder.
build pack
To see the full list of available commands, pass the -docs
switch:
build -docs
Hangfire uses psake build automation tool. All psake tasks and functions defined in psake-build.ps1
(for this project) and psake-common.ps1
(for other Hangfire projects) files. Thanks to the psake project, they are very simple to use and modify!
Razor templates are compiled upon save with the Razor Generator Visual Studio extension. You will need this installed if you want to modify the Dashboard UI.
Reporting security issues
In order to give the community time to respond and upgrade we strongly urge you report all security issues privately. Please email us at security@hangfire.io with details and we will respond ASAP. Security issues always take precedence over bug fixes and feature work. We can and do mark releases as "urgent" if they contain serious security fixes.
License
Copyright © 2013-2024 Hangfire OÜ.
This program is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License along with this program. If not, see https://www.gnu.org/licenses/.
Legal
By submitting a Pull Request, you disavow any rights or claims to any changes submitted to the Hangfire project and assign the copyright of those changes to Hangfire OÜ.
If you cannot or do not want to reassign those rights (your employment contract for your employer may not allow this), you should not submit a PR. Open an issue and someone else can do the work.
This is a legal way of saying "If you submit a PR to us, that code becomes ours". 99.9% of the time that's what you intend anyways; we hope it doesn't scare you away from contributing.
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net5.0 was computed. net5.0-windows was computed. net6.0 was computed. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. |
.NET Core | netcoreapp1.0 was computed. netcoreapp1.1 was computed. netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
.NET Standard | netstandard1.3 is compatible. netstandard1.4 was computed. netstandard1.5 was computed. netstandard1.6 was computed. netstandard2.0 is compatible. netstandard2.1 was computed. |
.NET Framework | net451 is compatible. net452 was computed. net46 is compatible. net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed. |
MonoAndroid | monoandroid was computed. |
MonoMac | monomac was computed. |
MonoTouch | monotouch was computed. |
Tizen | tizen30 was computed. tizen40 was computed. tizen60 was computed. |
Universal Windows Platform | uap was computed. uap10.0 was computed. |
Xamarin.iOS | xamarinios was computed. |
Xamarin.Mac | xamarinmac was computed. |
Xamarin.TVOS | xamarintvos was computed. |
Xamarin.WatchOS | xamarinwatchos was computed. |
-
.NETFramework 4.5.1
- Newtonsoft.Json (>= 5.0.1)
- Owin (>= 1.0.0)
-
.NETFramework 4.6
- Newtonsoft.Json (>= 5.0.1)
- Owin (>= 1.0.0)
-
.NETStandard 1.3
- NETStandard.Library (>= 1.6.0)
- Newtonsoft.Json (>= 9.0.1)
- System.Threading.Thread (>= 4.0.0)
- System.Threading.ThreadPool (>= 4.0.10)
-
.NETStandard 2.0
- Newtonsoft.Json (>= 11.0.1)
NuGet packages (452)
Showing the top 5 NuGet packages that depend on Hangfire.Core:
Package | Downloads |
---|---|
Hangfire.SqlServer
SQL Server 2008+ (including Express), SQL Server LocalDB and SQL Azure storage support for Hangfire, a background job framework for .NET applications. |
|
Hangfire
An easy and reliable way to perform fire-and-forget, delayed and recurring, long-running, short-running, CPU or I/O intensive tasks inside ASP.NET applications. No Windows Service / Task Scheduler required. Even ASP.NET is not required. Backed by Redis, SQL Server, SQL Azure or MSMQ. This is a .NET alternative to Sidekiq, Resque and Celery. https://www.hangfire.io/ |
|
Hangfire.NetCore
.NET Core's Worker Service host support for Hangfire, a background job framework for .NET applications. |
|
Hangfire.PostgreSql
PostgreSql storage implementation for Hangfire (background job system for ASP.NET and aspnet core applications). |
|
Hangfire.MemoryStorage
A memory storage for Hangfire |
GitHub repositories (45)
Showing the top 5 popular GitHub repositories that depend on Hangfire.Core:
Repository | Stars |
---|---|
aspnetboilerplate/aspnetboilerplate
ASP.NET Boilerplate - Web Application Framework
|
|
MassTransit/MassTransit
Distributed Application Framework for .NET
|
|
Xabaril/AspNetCore.Diagnostics.HealthChecks
Enterprise HealthChecks for ASP.NET Core Diagnostics Package
|
|
fullstackhero/blazor-starter-kit
Clean Architecture Template for Blazor WebAssembly Built with MudBlazor Components.
|
|
eventflow/EventFlow
Async/await first CQRS+ES and DDD framework for .NET
|
Version | Downloads | Last updated | |
---|---|---|---|
1.8.17 | 155,084 | 12/3/2024 | |
1.8.16 | 99,902 | 11/27/2024 | |
1.8.15 | 820,548 | 10/23/2024 | |
1.8.14 | 5,149,669 | 6/11/2024 | |
1.8.12 | 3,719,030 | 4/3/2024 | |
1.8.11 | 2,068,763 | 2/23/2024 | |
1.8.10 | 998,144 | 2/12/2024 | |
1.8.9 | 1,203,082 | 1/24/2024 | |
1.8.7 | 1,357,063 | 12/29/2023 | |
1.8.6 | 4,269,860 | 10/18/2023 | |
1.8.5 | 3,667,268 | 8/11/2023 | |
1.8.4 | 991,188 | 7/27/2023 | |
1.8.3 | 1,622,810 | 6/27/2023 | |
1.8.2 | 2,613,285 | 5/26/2023 | |
1.8.1 | 518,494 | 5/18/2023 | |
1.8.0 | 6,411,328 | 4/28/2023 | |
1.7.37 | 147,017 | 4/8/2024 | |
1.7.36 | 477,805 | 6/29/2023 | |
1.7.35 | 2,161,802 | 5/18/2023 | |
1.7.34 | 2,199,316 | 3/30/2023 | |
1.7.33 | 3,700,353 | 1/31/2023 | |
1.7.32 | 3,857,845 | 11/21/2022 | |
1.7.31 | 7,291,373 | 8/19/2022 | |
1.7.30 | 4,186,384 | 6/10/2022 | |
1.7.29 | 1,539,282 | 5/23/2022 | |
1.7.28 | 12,605,669 | 12/18/2021 | |
1.7.27 | 5,487,075 | 11/3/2021 | |
1.7.26 | 491,568 | 10/27/2021 | |
1.7.25 | 3,654,179 | 8/30/2021 | |
1.7.24 | 3,528,929 | 6/28/2021 | |
1.7.23 | 1,679,820 | 5/28/2021 | |
1.7.22 | 2,698,809 | 4/13/2021 | |
1.7.21 | 55,040 | 4/12/2021 | |
1.7.20 | 1,250,101 | 3/19/2021 | |
1.7.19 | 5,178,616 | 1/15/2021 | |
1.7.18 | 5,041,442 | 11/20/2020 | |
1.7.17 | 2,607,756 | 10/20/2020 | |
1.7.16 | 438,820 | 10/14/2020 | |
1.7.15 | 339,540 | 10/8/2020 | |
1.7.14 | 904,727 | 9/24/2020 | |
1.7.13 | 528,891 | 9/15/2020 | |
1.7.12 | 2,250,734 | 7/24/2020 | |
1.7.11 | 7,926,336 | 4/15/2020 | |
1.7.10 | 1,226,793 | 4/2/2020 | |
1.7.9 | 11,948,468 | 1/20/2020 | |
1.7.8 | 2,232,245 | 12/5/2019 | |
1.7.7 | 2,172,015 | 10/22/2019 | |
1.7.6 | 4,961,669 | 8/5/2019 | |
1.7.5 | 592,481 | 7/18/2019 | |
1.7.4 | 696,241 | 6/28/2019 | |
1.7.3 | 2,153,525 | 5/23/2019 | |
1.7.2 | 2,492,517 | 4/29/2019 | |
1.7.1 | 767,707 | 4/16/2019 | |
1.7.0 | 4,413,390 | 3/29/2019 | |
1.6.30 | 55,923 | 4/29/2021 | |
1.6.29 | 102,009 | 4/15/2020 | |
1.6.28 | 100,961 | 1/14/2020 | |
1.6.27 | 83,009 | 6/27/2019 | |
1.6.26 | 113,084 | 5/23/2019 | |
1.6.25 | 51,801 | 4/9/2019 | |
1.6.24 | 180,619 | 3/27/2019 | |
1.6.23 | 336,379 | 3/13/2019 | |
1.6.22 | 1,371,176 | 1/25/2019 | |
1.6.21 | 5,080,096 | 11/1/2018 | |
1.6.20 | 3,366,398 | 7/31/2018 | |
1.6.19 | 1,962,947 | 4/6/2018 | |
1.6.18 | 50,449 | 4/5/2018 | |
1.6.17 | 3,604,333 | 9/19/2017 | |
1.6.16 | 614,030 | 9/2/2017 | |
1.6.15 | 481,838 | 8/8/2017 | |
1.6.14 | 850,130 | 6/16/2017 | |
1.6.13 | 135,612 | 6/7/2017 | |
1.6.12 | 1,503,016 | 3/22/2017 | |
1.6.11 | 59,297 | 3/14/2017 | |
1.6.10 | 60,204 | 3/13/2017 | |
1.6.9 | 106,225 | 3/2/2017 | |
1.6.8 | 543,160 | 12/21/2016 | |
1.6.7 | 306,521 | 11/25/2016 | |
1.6.6 | 428,884 | 10/13/2016 | |
1.6.5 | 191,635 | 9/24/2016 | |
1.6.4 | 132,129 | 8/30/2016 | |
1.6.3 | 204,538 | 8/19/2016 | |
1.6.2 | 95,547 | 8/5/2016 | |
1.6.1 | 2,567,315 | 7/27/2016 | |
1.6.0 | 14,064,344 | 7/15/2016 | |
1.5.9 | 347,099 | 7/11/2016 | |
1.5.8 | 77,414 | 6/17/2016 | |
1.5.7 | 47,992 | 5/30/2016 | |
1.5.6 | 138,918 | 4/22/2016 | |
1.5.5 | 33,724 | 4/14/2016 | |
1.5.4 | 77,175 | 3/22/2016 | |
1.5.3 | 556,128 | 11/6/2015 | |
1.5.2 | 89,885 | 10/15/2015 | |
1.5.1 | 10,889 | 10/14/2015 | |
1.5.0 | 778,628 | 10/1/2015 | |
1.4.7 | 11,074 | 10/1/2015 | |
1.4.6 | 65,193 | 8/29/2015 | |
1.4.5 | 64,440 | 7/24/2015 | |
1.4.4 | 9,670 | 7/23/2015 | |
1.4.3 | 105,366 | 5/27/2015 | |
1.4.2 | 30,113 | 5/6/2015 | |
1.4.1 | 57,242 | 4/14/2015 | |
1.3.4 | 96,040 | 2/4/2015 | |
1.3.3 | 13,767 | 1/28/2015 | |
1.3.2 | 10,205 | 1/27/2015 | |
1.3.1 | 16,273 | 1/13/2015 | |
1.3.0 | 18,046 | 12/10/2014 | |
1.2.2 | 19,073 | 11/24/2014 | |
1.2.1 | 9,362 | 11/22/2014 | |
1.2.0 | 12,368 | 11/17/2014 | |
1.1.1 | 234,498 | 9/5/2014 | |
1.1.0 | 11,981 | 9/3/2014 | |
1.0.2 | 14,310 | 7/1/2014 | |
1.0.1 | 41,124 | 6/30/2014 | |
1.0.0 | 11,307 | 6/30/2014 | |
0.9.1 | 11,570 | 6/12/2014 | |
0.9.0 | 9,440 | 6/7/2014 | |
0.8.3 | 10,351 | 5/23/2014 | |
0.8.2 | 9,503 | 5/21/2014 | |
0.8.1 | 11,366 | 5/17/2014 | |
0.8.0 | 10,759 | 5/2/2014 | |
0.7.5 | 10,605 | 4/10/2014 | |
0.7.4 | 8,993 | 4/7/2014 | |
0.7.3 | 8,770 | 4/4/2014 | |
0.7.1 | 9,338 | 4/1/2014 | |
0.7.0 | 17,107 | 3/22/2014 | |
0.6.2 | 5,434 | 1/28/2014 | |
0.6.1 | 5,322 | 1/27/2014 | |
0.5.2 | 5,366 | 11/19/2013 | |
0.5.1 | 5,402 | 11/12/2013 | |
0.5.0 | 6,043 | 11/10/2013 |
Release notes are available in our blog https://www.hangfire.io/blog/
Please see https://docs.hangfire.io/en/latest/upgrade-guides/upgrading-to-hangfire-1.8.html to learn how to upgrade.
1.8.16
• Changed – Include fewer stack frames in exceptions come from `IServerFilter` implementations.
• Changed – Don't include file information in the `ExceptionDetails` property of a FailedState instance.
• Changed – Switch back to `CancellationEvent` usage instead of `CancellationToken.WaitHandle`.
• Fixed – Don't commit external transaction in the `BackgroundJobStateChanger` implementation.
• Fixed – Use safe default serializer settings for Newtonsoft.Json 12.X and below.
• Project – Fix builds for the `net451` platform when using .NET 9.0.
• Project – Significantly reduce execution time of unit tests in the `RecurringJobSchedulerFacts` class.
• Project – Bump `Microsoft.CodeAnalysis.NetAnalyzers` package to version 9.0.0.
1.8.15
• Added – New `AutomaticRetryAttribute.ExceptOn` property to skip retries for specific exceptions.
• Changed – Refactor filters pipeline to use less LINQ magic and fewer allocations.
• Changed – Use `GetCultureInfo` instead of creating an instance in the `CaptureCultureAttribute` filter.
• Changed – Cache some immutable data to avoid extra allocations.
• Fixed – Improve loopback address detection (by @meziantou).
• Fixed – Reformulate misleading error messages regarding retry timings (by @RGFuaWVs).
• Fixed – Problem with missing localizations in the previous version.
• Fixed – Don't hide exception details on Failed Jobs page when the exception message is empty.
• Fixed – Problems with the first restore when using the `build.bat` command.
• Fixed – Better display of canceled recurring jobs in dashboard.
• Fixed – Less overall allocations with using static delegates and struct-based iterators.
• Fixed – Improve precision of some diagnostic messages in the wait protection logic.
• Fixed – Make all private and internal classes sealed to improve code consistency.
• Fixed – Less overall pressure on garbage collector.
1.8.13 and 1.8.14
• Changed – Partial cache for serialization and deserialization in `InvocationData` to produce less strings.
• Changed – Add caching for default type serializer and resolver.
• Changed – Don't let `JobFilter`-related logic to show up in profilers.
• Changed – Modify `IProfiler` to be less allocatey for diagnostic purposes that almost never run.
• Changed – Prefer using `CancellationToken.WaitHandle` again, since early .NET Core days are gone.
• Changed – Fewer allocations when working with `IStateHandler` collections in a state machine.
• Fixed – Redirect the "System.Private.Xml.Linq" assembly to the "System.Xml.Linq" one for better interoperability.
• Fixed – Don't throw `KeyNotFoundException` when recurring job is malformed.
• Fixed – Proper relative path calculation in `UrlHelper.To` for OWIN-based Dashboard UI (by @LordJZ).
• Fixed – Typo in the Turkish localization file (by @ismkdc).
• Project – Switch to a modern PowerShell 7+ to speed up SignPath installation on AppVeyor.
1.8.12
• Added – `MaxDegreeOfParallelismForSchedulers` experimental server option if supported by storage.
• Added – Experimental support for parallel execution of the delayed job scheduler.
• Added – Experimental support for parallel execution of the recurring job scheduler.
• Fixed – Recurring job is scheduled to the past after recovering from error with `AddOrUpdate`.
• Fixed – `AddOrUpdate` triggers execution of a recurring job, even if its next execution is in the future.
• Fixed – Two very minor errors in the Swedish localization file (by @Uglack).
1.8.11
• Changed – Add icons and fix metadata for NuGet packages.
• Changed – Bump ILRepack to version 2.0.27 to avoid problems with internalizing.
• Fixed – "Type exists in both Cronos and Hangfire.Core" exception.
1.8.10
• Changed – Added Norwegian translations for new keys (by @khellang).
• Changed – Update Brazilian Portuguese translation (by @HugoAlames).
• Changed – Bump Cronos dependency to version 0.8.3.
• Project – Enable NuGet package and DLL signing with a company certificate.
• Project – Require NuGet package signature validation on restore for dependencies.
• Project – Add `HangfireIO` as a package owner.
1.8.9
• Changed – Use `Environment.MachineName` as a server name if other environment vars aren't available.
• Changed – Bump the Cronos package version from 0.7.1 to 0.8.1.
• Changed – Improve portuguese translations (by @filipe-silva).
• Fixed – Possible `NullReferenceException` on the Deleted Jobs page (regression from 1.8.7).
• Project – Enable full source link support with embedded symbols and repository-based sources.
• Project – Enable repeatable package restore using a lock file.
• Project – Run unit tests against the `net6.0` platform.
• Project – Modernise the build system and clean up the build scripts.
1.8.7
• Added – Allow using macro expressions like `@hourly` for recurring jobs (by @MuhamedAbdalla).
• Added – Show storage time in page footer when supported by storage implementation.
• Added – Show duration and latency columns separately on the Succeeded Jobs page when supported.
• Added – Show the exception column on the Deleted Jobs page when available and supported by storage.
• Changed – Reduce package size by stripping unnecessary locales in Moment.js.
• Changed – Bump Microsoft.Owin package to version 4.2.2.
• Changed – Log a warning message when a server listens to unsupported queue names.
• Changed – Use storage time, if available, to show delay warnings in the Dashboard UI.
• Fixed – Proper rendering of generic arguments on the Job Details page (by @olivermue).
• Fixed – Language inconsistency in the Dashboard UI related to date/time description.
• Fixed – Big stack traces take too long time to be formatted.
• Fixed – Don't throw `NullReferenceException` from the Scheduled Jobs page when there's a job with missing data.
• Fixed – Don't throw `NullReferenceException` from the Processing Jobs page when there's a job with missing data.
• Fixed – CSS for Enqueued and Deleted state cards in dark theme.
• Fixed – Log errors instead of throwing an exception when a particular table can't be cleaned.
• Fixed – Avoid logging fatal exceptions when stopping a faulting background process.
• Fixed – Don't display checkboxes in the Dashboard UI when job details can not be fetched.
• Fixed – Scrollbars in WebKit-based browsers are now dark in dark mode.
• Project – Disable tests for `netcoreapp1.0` and `netcoreapp2.1` targets since they aren't supported in AppVeyor.
• Project – Add a `net6.0` target for unit tests instead of the removed ones.
• Project – Modernise projects and build environments to use the newest features.
1.8.6
• Changed – Update jQuery library in Dashboard UI to version 3.7.1.
• Changed – Mark all types in Hangfire.Annotations with `EditorBrowsableAttribute(Never)`.
• Changed – Change state card colors for the Awaiting state to match the Scheduled state.
• Fixed – Exception when deserializing an instance of the `AutomaticRetryAttribute` class from JSON.
• Fixed – Add serialization-related constructors for all the exception classes.
• Fixed – Use invariant culture or ordinal comparisons for internal strings.
• Fixed – Use invariant culture when formatting key names for metrics.
• Fixed – Use `CurrentCulture` instead of `CurrentUICulture` when displaying time.
• Project – Enable running static analysis by Coverity Scan weekly.
• Project – Enable mandatory static analysis by the Microsoft.CodeAnalysis.NetAnalyzers package.
• Project – Change MSBuild path when building using newer .NET SDKs for Razor views.
1.8.5
• Added – Possibility to inform a `FaviconPath` on `DashboardOptions` (by @cezar-pimentel).
• Fixed – Inability to restore a disabled recurring job, regression in version 1.8.3.
• Fixed – Make it possible to serialize the `AutomaticRetryAttribute` filter to JSON.
1.8.4
• Added – Pass server id from a worker to the `PerformContext.ServerId` property available in filters.
• Fixed – Send heartbeats until full background processing server shutdown.
1.8.3
• Changed – Allow to configure `MaxLinesInStackTrace` for a particular `FailedState` instance.
• Fixed – Remove job id from schedule when it's not in the Scheduled state for some reason.
• Fixed – Missing invocations of recurring jobs when the new "Ignorable" option is used.
• Fixed – Make `DisableConcurrentExecutionAttribute` and `LatencyTimeoutAttribute` serializable.
1.8.2
• Changed – Disable transactional job creation feature appeared in 1.8.0.
• Fixed – "Can not start continuation XXX" error when storage supports transactional job creation.
1.8.1
• Added – `MisfireHandlingMode.Ignorable` to avoid scheduling recurring jobs on missed schedules.
• Added – Support disabling dark mode via the `DashboardOptions.DarkModeEnabled` property.
• Changed – Remove the 1-hour limitation for the `WithJobExpirationTimeout` configuration method.
• Fixed – Add missing `UseDefaultCulture` configuration method overloads.
• Fixed – Add missing `UseDashboardStylesheet` and `UseJobDetailsRenderer` configuration methods.
• Fixed – Give even more space for identifiers on the Recurring Jobs page.
• Fixed – `state-card-state-active` color is not very dark (by @coolhome).
• Fixed – Slightly change chart proportions to fit 4K in Dashboard UI.
1.8.0
• Breaking – Dropped the `NET45` platform target in favor of the `NET451` target to support Visual Studio 2022.
• Added – Introduce the `Job.Queue` property, so jobs now can have their own queue specified.
• Added – Method overloads to create background jobs directly with a custom default queue.
• Added – Method overloads to create recurring jobs directly with a custom default queue.
• Added – `IBackgroundJobClient.Create` method overloads with the new `queue` parameter.
• Added – Allow to filter exception types in `AutomaticRetryAttribute` by using the new `OnlyOn` property.
• Added – `DeletedState` now has the persisted `Exception` property populated after a failure.
• Added – `JobContinuationOptions.OnlyOnDeletedState` to create continuations after a failure.
• Added – `Exception` job parameter is passed to continuation when `UseResultsInContinuations` method is used.
• Added – `FromExceptionAttribute` to deal with an antecedent exception in a background job continuation.
• Added – Make it possible to specify multiple `JobContinuationOptions` values for a continuation.
• Added – `BackgroundJobServerOptions.IsLightweightServer` option to run a server with no storage processes.
• Added – Ability to use custom formattable resource identifiers for the `DisableConcurrentExecution` filter.
• Added – Pass `ServerId` to `FailedState` instances to simplify the debugging on different servers.
• Added – Allow to pass job parameters when creating a job (by @brian-knoll-micronetonline).
• Added – `MisfireHandlingMode.Strict` to create a job for each missed recurring job occurrence.
• Added – Support for default culture and UI culture via the `UseDefaultCulture` configuration method.
• Added – Introduce the `captureDefault` parameter in the `CaptureCulture` filter.
• Added – `IGlobalConfiguration.UseFilterProvider` extension method to unify the configuration.
• Added – Built-in `Remove` method for `JobFilterCollection` to remove global filters based on their type.
• Added – `CompatibilityLevel.Version_180` flag to avoid storing culture parameters when they are the same as the default ones.
• Changed – Create job atomically when `Transaction.CreateJob` feature is supported by the storage.
• Changed – Query time from storage in recurring and delayed schedulers when supported by storage.
• Changed – Move job to the `DeletedState` instead of `SucceededState` when its invocation was canceled by a filter.
• Changed – Speedup delayed jobs when a custom default queue is specified by avoiding extra state transition.
• Changed – Use UI culture from `CurrentCulture` parameter when `CurrentUICulture` one is missing.
• Changed – Increase the default value for the `BackgroundJobServerOptions.StopTimeout` to 500 ms.
• Deprecated – `AddOrUpdate` overloads with optional params defined in the `RecurringJobManagerExtensions` class.
• Deprecated – `AddOrUpdate` overloads with optional parameters defined in the `RecurringJob` class.
• Deprecated – `AddOrUpdate` method overloads with no `recurringJobId` parameter.
• Deprecated – `RecurringJobOptions.QueueName` property, new methods should be used instead.
• Breaking – Dropped `NET45` platform target in favor of `NET451` target to support Visual Studio 2022.
Dashboard UI
• Added – Dark mode support for Dashboard UI depending on the system settings (by @danillewin).
• Added – Dashboard UI now has a full-width layout to display more data (by @danillewin).
• Added – Allow to add custom JavaScript and CSS files to the Dashboard UI via the `DashboardRoutes` class.
• Added – `DefaultRecordsPerPage` property on the `DashboardOptions` class (by @PaulARoy).
• Added – `IGlobalConfiguration.UseJobDetailsRenderer` method for custom renderers for the Job Details page.
• Added – Display deleted jobs in the Realtime and History graphs when supported by storage.
• Added – `IGlobalConfiguration.UseDashboardMetrics` extension method to pass multiple metrics at once.
• Added – State renderer for the `DeletedState` to display its new exception property.
• Added – Support for new `MonitoringApi` methods for the Awaiting Jobs page.
• Changed – Make it possible to display methods of non-loaded jobs in the Dashboard UI when supported by storage.
• Changed – Improved display of realtime chart with more accents on failed and deleted jobs.
• Changed – Don't display the queue name in the state transition list when it's the `default` one.
• Changed – Display scheduled job count when the enqueued count is zero on the main metric.
Extensibility
• Added – `Factory`, `StateMachine`, and `Performer` properties to context classes to avoid injecting services.
• Added – Allow to pass custom data to `ApplyStateContext` and `ElectStateContext` instances.
• Added – Preserve custom data dictionary between the entire filter chain.
• Added – Allow to pass a transaction to background job state changer when new methods are implemented.
• Changed – Ignore some members when serializing a `JobFilterAttribute` instance to decrease the payload size.
Storage
• Added – Virtual `JobStorage.GetReadOnlyConnection` method intended to return `JobStorageConnection` for replicas.
• Added – Virtual `JobStorage.HasFeature` method for querying optional features.
• Added – The `JobStorageFeatures` class to avoid using magic strings in storage features.
• Added – Optional `GetSetCount`, `GetSetContains`, and `GetUtcDateTime` methods for the `JobStorageConnection` class.
• Added – Optional `AcquireDistributedLock` and `RemoveFromQueue` methods for the `JobStorageTransaction` class.
• Added – Optional `CreateJob` and `SetJobParameter` methods for the `JobStorageTransaction` class.
• Added – Optional `ParametersSnapshot` property for `BackgroundJob` and `JobData` classes to minimize roundtrips in the future.
• Added – Support for transactional acknowledgment using a new storage method for better handling some data loss scenarios.
• Added – Fetch `Retries` and `Awaiting` metrics in `StatisticsDto` properties when supported by storage.
• Added – The `JobStorageMonitor` class with more available methods for the new features.
• Changed – Allow to query job parameters without additional roundtrip when supported by storage.
• Changed – Expose state data dictionaries in list DTOs when supported by storage.
• Changed – Rely on storage indexing with the `Monitoring.AwaitingJobs` feature.
Internals
• Added – `IBackgroundProcess.UseBackgroundPool` now allows to pass thread configuration logic.
• Added – `BackgroundJobServerOptions.WorkerThreadConfigurationAction` option for custom thread configuration.
• Changed – Allow changing queues on the fly with custom worker configuration.
• Changed – Avoid storage roundtrip to query job data in worker, take data from previous state change.
• Changed – `FromParameterAttribute`-based logic now always overwrites arguments, even with non-null values.
• Changed – Turn the `JobContinuationOptions` enum into flags while still possible.
• Changed – Re-implement `TaskExtensions.WaitOneAsync` only with the `RegisterWaitForSingleObject` method.
• Changed – `ServerHeartbeatProcess` now uses `ThreadPriority.AboveNormal` to prioritize heartbeats.