Add support for a formatted display name for dynamic jobs

samples/Hangfire.Microservices.OrdersService/Startup.cs

@@ -1,3 +1,4 @@
+using System;
 using Hangfire.Microservices.NewsletterService;
 using Microsoft.AspNetCore.Builder;
 using Microsoft.AspNetCore.Hosting;
@@ -20,13 +21,16 @@ public void ConfigureServices(IServiceCollection services)
 
         public void Configure(IApplicationBuilder app, IWebHostEnvironment env, IRecurringJobManager manager)
         {
+            var campaignId = 1111;
+
             manager.AddOrUpdateDynamic(
                 "periodic-newsletter",
-                () => NewsletterSender.Execute(1111),
+                () => NewsletterSender.Execute(campaignId),
                 "* * * * *",
                 new DynamicRecurringJobOptions
                 {
-                    Filters = new [] { new QueueAttribute("newsletter") }
+                    Filters = new [] { new QueueAttribute("newsletter") },
+                    DisplayName = $"Process newsletter '{campaignId}'"
                 });
 
             if (env.IsDevelopment())

src/Hangfire.DynamicJobs/DynamicJob.cs

@@ -18,13 +18,15 @@ public DynamicJob(
             [NotNull] string method,
             [CanBeNull] string parameterTypes,
             [CanBeNull] string args,
-            [CanBeNull] JobFilterAttribute[] filters)
+            [CanBeNull] JobFilterAttribute[] filters,
+            [CanBeNull] string displayName)
         {
             Type = type ?? throw new ArgumentNullException(nameof(type));
             Method = method ?? throw new ArgumentNullException(nameof(method));
             ParameterTypes = parameterTypes;
             Args = args;
             Filters = filters;
+            DisplayName = displayName;
         }
 
         [NotNull]
@@ -49,6 +51,10 @@ public DynamicJob(
         [SuppressMessage("Security", "CA2326:Do not use TypeNameHandling values other than None")]
         public JobFilterAttribute[] Filters { get; }
 
+        [CanBeNull]
+        [JsonProperty("d", NullValueHandling = NullValueHandling.Ignore)]
+        public string DisplayName { get; }
+
         [PublicAPI]
         [DynamicJobDisplayName]
         public static object Execute(DynamicJob dynamicJob, PerformContext context)

src/Hangfire.DynamicJobs/DynamicJobDisplayNameAttribute.cs

@@ -23,6 +23,11 @@ public override string Format([NotNull] DashboardContext context, [NotNull] Job
             {
                 if (arg is DynamicJob dynamicJob)
                 {
+                    if (dynamicJob.DisplayName != null)
+                    {
+                        return dynamicJob.DisplayName;
+                    }
+
                     return $"Dynamic: {ExtractTypeName(dynamicJob.Type, out _, out _)}.{dynamicJob.Method}";
                 }
             }

src/Hangfire.DynamicJobs/DynamicJobRecurringJobManagerExtensions.cs

@@ -28,7 +28,7 @@ public static void AddOrUpdateDynamic(
 
             manager.AddOrUpdate(
                 recurringJobId,
-                ToDynamicJob(job, options?.Filters),
+                ToDynamicJob(job, options?.Filters, options?.DisplayName),
                 cronExpression,
                 options ?? new RecurringJobOptions());
         }
@@ -133,7 +133,7 @@ public static void AddOrUpdateDynamic<T>(
             AddOrUpdateDynamic(manager, recurringJobId, job, cronExpression, options);
         }
 
-        private static Job ToDynamicJob([NotNull] Job job, [CanBeNull] IEnumerable<JobFilterAttribute> filters)
+        private static Job ToDynamicJob([NotNull] Job job, [CanBeNull] IEnumerable<JobFilterAttribute> filters, [CanBeNull] string displayName)
         {
             if (job == null) throw new ArgumentNullException(nameof(job));
 
@@ -142,7 +142,8 @@ private static Job ToDynamicJob([NotNull] Job job, [CanBeNull] IEnumerable<JobFi
                 invocationData.Method,
                 !String.IsNullOrEmpty(invocationData.ParameterTypes) ? invocationData.ParameterTypes : null,
                 invocationData.Arguments,
-                filters?.ToArray());
+                filters?.ToArray(),
+                !String.IsNullOrEmpty(displayName) ? displayName : null);
 
             return Job.FromExpression(() => DynamicJob.Execute(dynamicJob, default));
         }

src/Hangfire.DynamicJobs/DynamicRecurringJobOptions.cs

@@ -11,5 +11,8 @@ public class DynamicRecurringJobOptions : RecurringJobOptions
     {
         [CanBeNull]
         public IEnumerable<JobFilterAttribute> Filters { get; set; }
+
+        [CanBeNull]
+        public string DisplayName { get; set; }
     }
 }