✨ Shield now has support for Avalonia UI

Hangfire .NET: Background Tasks and Scheduled Jobs

Jul 2, 2023 | C#, .NET

Do you often find yourself grappling with managing background tasks and scheduled jobs in your .NET or C# applications? Thankfully, there’s Hangfire to simplify this convoluted process and make our lives a whole lot easier. In the forthcoming sections, we will deep dive into the workings of Hangfire, its implementation in .NET and C#, and the future it holds.

Understanding Hangfire: An Overview

The digital sphere is surging towards asynchronous computing, demanding reliable tools to manage background tasks. Hangfire plays hero in charting these unexplored terrains. In the sections that follow, we will unfold what Hangfire truly is, get our hands ‘code-dirty’, and see its impact on Background tasks and scheduled jobs.

What is Hangfire?

Simplicity is the ultimate sophistication. Hangfire personifies this adage by streamlining the management of background tasks in .NET and C#.

Hangfire is an open-source framework that aids developers in executing, arranging, and managing background tasks within any .NET application. It supports both .NET Framework and .NET Core.

// Scheduling a background job using Hangfire 
BackgroundJob.Enqueue(() => Console.WriteLine("Welcome to the Hangfire World!"));

In this simplified example, we use Enqueue method to execute a method asynchronously in the background. When this line of code is hit during program execution, Hangfire will ensure Console.WriteLine("Welcome to the Hangfire World!") is run, no matter how long the application is alive.

But hang on–it’s not just simplicity that Hangfire brings to the table. It boasts some remarkable features like:

  • Task Persistence: Hangfire uses persistent storage, saving tasks to be processed. It keeps your tasks safe and not prone to process recycles, machine restarts, or any unexpected failures.
  • Automatic Retries: Hangfire automatically retries failed tasks, so you don’t have to manually handle exceptions.
  • Dashboard UI: Its intuitive dashboard provides a visual runtime representation of scheduled, processing, succeeded and failed jobs.
  • Support for CRON expressions: For complex scheduling, it even supports CRON expressions!

Now, you might be thinking, “That’s great, but how could 8-year-olds make of this?” Think about Hangfire as a trustworthy chef, cooking up all your favorite dishes (background tasks), following your instructions (job scheduling), and serving them right on time, every time, regardless of problems in the kitchen (crashes, errors, shutdowns).

The Role of Hangfire in Background Tasks and Scheduled Jobs

When it comes to managing background jobs in .NET and C#, you might think of using chron jobs or intricate threading logic. But here’s where Hangfire recalibrates the paradigm and allows you to wave goodbye to those complicated alternatives.

Hangfire enables smoothening of operations that require substantial processing time (such as data exports, email notifications, backups) by executing these tasks asynchronously in the background. This, in turn, significantly improves application responsiveness.

// An example of scheduling recurring email notifications job using Hangfire
RecurringJob.AddOrUpdate(() => EmailService.SendNotifications(), Cron.Daily);

In this snippet, AddOrUpdate schedules EmailService.SendNotifications() to run as a daily recurring job. Hangfire uses the Cron class to express complex schedules as simple Cron expressions.

For another real-life example, imagine a news agency system. Every night, they want to automatically send a summary of the day’s important news to their subscribers. Instead of employing someone to do this manually every night, they could use Hangfire to schedule this operation.

// An example of scheduling a daily news summary email using Hangfire
RecurringJob.AddOrUpdate(() => NewsService.SendDailyNewsSummary(), Cron.Daily);

In this code, RecurringJob.AddOrUpdate is used to run NewsService.SendDailyNewsSummary() as a daily recurring job at midnight. Hangfire will ensure the subscribers receive their news summary email every day like clockwork, regardless of any issues.

Indeed, the revolution of background tasks and scheduled jobs has a new battlefield – Hangfire! Ready to go deeper? Let’s dive in!

Delving Deeper into Hangfire .NET

With the stage set, let’s take a deep dive into the operational waters of Hangfire with .NET. We will unfold how Hangfire breathes life into the architecture, simplifies installs, boasts enthralling features, and offers real-world applications. Buckle up and enjoy the ride!

The Architecture of Hangfire .NET

In the realm of Hangfire, everything revolves around jobs. Jobs in Hangfire are versioned, retried, queued, and distributed across available workers. Let’s break down Hangfire’s architectural components:

  1. Enqueuing: When a job is created, it’s dispatched to queues.
  2. Execution: Workers continuously poll for jobs on these queues.
  3. Retry: If a job fails, it’s moved to a retries queue and attempted later.
  4. Versioning: Older versions of jobs are preserved for a smooth scaling process.

Ever wondered how to create a job that runs every minute? Even 8-year-olds can do this! Here’s a catchy rhyme to remember:

// Schedule a job to print "Hi" every minute
RecurringJob.AddOrUpdate(() => Console.WriteLine("Hi"), Cron.Minutely);

Isn’t it as easy as ABC?

Installing and Configuring Hangfire in .NET

Implementing Hangfire in your .NET application is as simple as setting up a new video game (albeit a little different!). After installing the Hangfire NuGet package, add the following code to Startup.cs:

public void Configuration(IAppBuilder app)
{
    // Configuring Hangfire job storage. Let's use SQL Server.
    GlobalConfiguration.Configuration.UseSqlServerStorage("<connection_string>");

    // Setting up Hangfire Dashboard and Server in a .NET application
    app.UseHangfireDashboard();
    app.UseHangfireServer();
}

Voila! You’ve set up Hangfire successfully. Head to <your_app_url>/hangfire to view the rich inbuilt dashboard where all your jobs live!

Understanding Hangfire .NET Features

Hangfire .NET encapsulates a slew of features that can knock your socks off! From managing job lifecycles to supporting complex task structures, Hangfire has a lot in store. Notable features include:

  1. Automatic Retry: Hangfire automatically retries failed jobs based on an exponential back-off algorithm.
  2. Server Lists: Hangfire servers automatically join or leave the cluster dynamically to maintain high availability.
  3. Job Continuations: You can ensure Job B runs after Job A by utilizing the ContinueWith statement.
  4. Advanced Job Filters: Custom job filters allow you to add event hooks for success and failure cases.

Check out how to queue a background job followed by a continuation job:

// Let's queue a background job and a continuation job
var jobId = BackgroundJob.Enqueue(() => Console.WriteLine("Background job"));
BackgroundJob.ContinueWith(jobId, () => Console.WriteLine("Continuation job"));

You see, Hangfire is your consideration when one job swings into action after another.

Hangfire .NET in Action: Practical Examples

Now, let’s move Hangfire from theoretical discussion to practical action. Ever wanted to send users a welcome email an hour after registration? Or delete inactive users after a month? Hangfire pitchforks asynchronous coding into child’s play.

// Send a welcome email 1 hour after user registration
var userId = "1234";
BackgroundJob.Schedule(() => SendWelcomeEmail(userId), TimeSpan.FromHours(1));

With this, an email will be sent to the user one hour after running the background job—truly asynchronous!

For a more real-life application, consider a system that deletes inactive users after a month. In Hangfire, it’s a cakewalk:

// Delete inactive users after a month
RecurringJob.AddOrUpdate(
    () => DeleteInactiveUsers(), 
    Cron.Monthly);

With Hangfire .NET, you can brew many such recipes, automating tasks and giving your applications a sharp edge.

Hangfire C# and its significance

Who said a simple programming language and a robust task scheduling framework can’t craft magic together? Let’s dive into this enticing fusion of C# and Hangfire and discover how it simplifies our complex coding lives, one task at a time.

How Hangfire Complements C#

While C# is an object-oriented language cherished for its simplicity and power, Hangfire slides into this scenario, adding the cherry of scheduling and managing background tasks efficiently to the C# cake. No more wrestling with threads and timers!

Let’s schedule a task that will run after exactly five minutes:

// Scheduling a background job to run after 5 minutes
BackgroundJob.Schedule(() => Console.WriteLine("Just Hangfiring!"), TimeSpan.FromMinutes(5));

Here, we use Hangfire’s Schedule method, passing our task (printing “Just Hangfiring!”) and the delay time as parameters.

Configuring Hangfire in a C# project

Setting up Hangfire in a C# project is so easy, even a kid could do it!

// Setting up Hangfire in Startup.cs
 public void Configuration(IAppBuilder app)
 {
     app.UseHangfire(config => config.UseSqlServerStorage("<your connection string>"));
     app.UseHangfireDashboard();
     app.UseHangfireServer();
}

In the given code snippet, we configure Hangfire with our SQL Server instance, set up the Hangfire Dashboard for monitoring, and start the Hangfire server. Simple, isn’t it?

Key Features of Hangfire C#

Hangfire shines with its features that empower C# in unique ways:

  • Automatic retries: Tasks fail sometimes, but Hangfire ensures they get another shot at success.
  • Exception handling: Hangfire can gracefully catch and manage exceptions, saving your application from potential downtime.
  • Task prioritization: Because not all tasks are equal, some deserve higher priority.
  • Custom failure strategies: If a task fails, you decide what happens next.
  • Scheduled tasks: Be it daily, weekly, or once in a blue moon, schedule your tasks with great ease.

Real-time Applications of Hangfire in C#

The real magic of Hangfire is observed in real-world applications. For a blogging website, scheduling routine tasks such as sending newsletters, cleaning up old articles, or auto-publishing scheduled blog posts can all be smoothly handled with Hangfire.

// Scheduling a recurring job for clearing old articles
 RecurringJob.AddOrUpdate(() => new ArticleService().ClearOldArticles(), Cron.Monthly);

In this example, we schedule a recurring job using RecurringJob.AddOrUpdate(), which calls the ClearOldArticles method of ArticleService every month.

Bringing this down to a more relatable level, think of Hangfire as your personal assistant. You want to bake cookies but you need to keep stirring the mixture for 15 minutes, well, you just delegate this to Hangfire and voila, you can enjoy your favorite TV show while Hangfire stirs the mixture for you. Now, isn’t that your favorite part of the cookie baking process made simpler?

Debugging and Troubleshooting with Hangfire

Even roses have thorns, and so does coding. Despite the sweetness Hangfire provides, there exist challenges. But no worries, sailing through the storm is easier with the right knowledge. We’ll explore some common issues, debugging tips, and learn how to efficiently monitor jobs.

Common Issues in Hangfire and their Solutions

Let’s not sugarcoat it, you might encounter issues while using Hangfire. Don’t let these derail your progress, though. Here are common ones and their simple solutions:

  1. Stalled Recurring Job: Common, yet puzzling, recurring jobs might halt unexpectedly. Typically caused by an error within the job itself. Investigating the exception log in the Hangfire dashboard usually points to the problem.
//Recurring Job Setup
RecurringJob.AddOrUpdate(() => Console.Write("Daily"), Cron.Daily);

//Let's assume an exception occurs
RecurringJob.AddOrUpdate(() => throw new Exception("Oops!"), Cron.Daily);

In this example, the job fails due to an exception, and Hangfire suspends its execution until the problem is addressed.

  1. Unprocessed Queue: Hangfire custom queues can remain unprocessed if there’s a misconfiguration in the Hangfire server. A classic pitfall that’s easily avoidable through a correct setup.
//Incorrect Server Setup
var options = new BackgroundJobServerOptions
{
    Queues = new[] { "critical", "default" }
};
app.UseHangfireServer(options);

This server will not process jobs in a custom queue named “emailSend”. To fix it, include “emailSend” in the queue list.

  1. Failed Jobs Stuck in Retry State: Hangfire retries failed jobs automatically. However, there can be cases where jobs remain stuck in the retry state. The reason could be an unhandled exception within your job code.

Looking into the exception log should provide information on handling the error and getting your jobs back on track.

Tips for Efficient Debugging in Hangfire

“Just because debugging is twice as hard as writing a program, does that mean if you write a program ineffably well, you won’t have to debug it?” Good question, let’s find out!

  1. Logging: Hangfire supports built-in logging mechanisms such as log4net, NLog, and Serilog. Use these to your advantage for comprehensive monitoring.
  2. Exception handling: Unhandled exceptions will disrupt your job processing. Consider wrapping your job execution codes within try-catch blocks to ensure smooth job processing.
try
{
    BackgroundJob.Enqueue(() => Console.Write("No Errors Here!"));
}
catch (Exception ex)
{
    Console.WriteLine($"Oops, something went wrong: {ex.Message}");
}

This simple safeguard can save you hours of debugging, trust me!

  1. Use Dashboard: The Hangfire Dashboard isn’t just pretty; it’s a powerhouse of tools and utilities for debugging and tracking job progress, failed jobs, and retry attempts.
  2. Employ Good Coding Practices: As always, following good coding practices will help prevent bugs from creeping into your jobs. Stringently validate your input data and anticipate error occurrences.

Maintaining and Monitoring Jobs in Hangfire

Hangfire Dashboard is like a control room, equipped with all you need to monitor and wield power over your jobs. Here are a few pointers to effectively use it:

  • Have a hawk-eye on the Job graph: It provides a bird’s-eye view of your jobs, their states, success rates, and failures, if any.
  • Check queues: If jobs seem to be stuck, the queue status might have a hint for you.
  • Failed jobs: Hangfire classifies failed jobs differently. Examine the exceptions encountered by the “Failed” jobs to fix and resume them.

Advanced Concepts in Hangfire

“But wait, there’s more!” Let’s lift the hood and delve into the advanced mechanics of Hangfire. In this section, we will walk you through scaling with distributed processing, getting insights into security considerations, and enhancing Hangfire with extensions and improvements. So buckle up and brace for a deep dive!

Scaling with Hangfire – Distributed Background Job Processing

Unleash the power of distributed processing with Hangfire! This concept hugely benefits large scale applications with a massive job load. But how does it work exactly?

// Setting up distributed Hangfire servers across different machines
services.AddHangfire(configuration => configuration
    .SetDataCompatibilityLevel(CompatibilityLevel.Version_170)
    .UseSimpleAssemblyNameTypeSerializer()
    .UseRecommendedSerializerSettings()
    .UseSqlServerStorage(Configuration.GetConnectionString("HangfireConnection"),
        new SqlServerStorageOptions
        {
            CommandBatchMaxTimeout = TimeSpan.FromMinutes(5),
            JobExpirationCheckInterval = TimeSpan.FromHours(1),
            CountersAggregateInterval = TimeSpan.FromMinutes(5),
            PrepareSchemaIfNecessary = true,
            QueuePollInterval = TimeSpan.Zero,
            UseRecommendedIsolationLevel = true,
            UsePageLocksOnDequeue = true,
            DisableGlobalLocks = true
        }));

This is an instance of how to set up a distributed Hangfire server system. The UseSqlServerStorage function is configuring the connection towards SQL Server and the DisableGlobalLocks facilitates distributed locks for the servers.

Now, imagine slicing up a giant pizza (the job) among your friends (the distributed servers). More hands, less time to devour the pizza, same concept!

Security Aspects of Using Hangfire

Security and programming go hand in hand. Hangfire isn’t an exception; it offers a secure dashboard that prevents unauthorized access. But how secure is it, you ask?

// Set up strict Dashboard access authorization rules
app.UseHangfireDashboard("/hangfire", new DashboardOptions
{
    DashboardTitle = "My Hangfire Dashboard",
    Authorization = new[]
    {
       new HangfireCustomAuthorizeFilter()
    }
});

public class HangfireCustomAuthorizeFilter: IDashboardAuthorizationFilter
{
   public bool Authorize(DashboardContext context)
   {
      // Check user authorization here, return true if authorized
      return HttpContext.Current.User.IsInRole("Admin");
   }
}

This code snippet configures the Hangfire dashboard and includes an authorization filter. It ensures that only users in the “Admin” role can access the dashboard. The consequences of an unauthorized user invading the dashboard? Let’s just say, it’s like a dog getting hold of your homework, not pretty!

Enhancements and Extensions in Hangfire

Hangfire is more than just a tool; it’s a playground for developers. With numerous extensions at disposal, you can tailor Hangfire to your specific needs. Want to see how it’s done?

// Logging job events using Hangfire.Console extension
BackgroundJob.Enqueued += (sender, args) =>
{
    Log.Information($"Job {args.JobId} has been enqueued");
};

// Sample job using Hangfire.Console
BackgroundJob.Enqueue(() => ConsoleJob());

public void ConsoleJob(PerformContext context)
{
    context.WriteLine("Hello, Hangfire Console!");
}

In this example, we used the Hangfire.Console extension to log job events back to the console. The ConsoleJob is logging a greeting message on execution

Conclusion: Summarizing the Power of Hangfire in .NET and C#

Our journey with Hangfire seems to be taking off just as we are wrapping up. But fret not, there’s always more to explore and learn! Hangfire surely seems like the afterburner we needed to take our .NET and C# projects to the skies, doesn’t it?

You May Also Like