Merge pull request #962 from colinin/webhook-timeout

feat(webhooks): user subscription rewrite timeout.

aspnet-core/migrations/LY.MicroService.WebhooksManagement.EntityFrameworkCore/Migrations/20240605074803_Add-Timeout-Duration-To-Subscription.cs

@@ -0,0 +1,28 @@
+using Microsoft.EntityFrameworkCore.Migrations;
+
+#nullable disable
+
+namespace LY.MicroService.WebhooksManagement.EntityFrameworkCore.Migrations
+{
+ /// <inheritdoc />
+ public partial class AddTimeoutDurationToSubscription : Migration
+ {
+ /// <inheritdoc />
+ protected override void Up(MigrationBuilder migrationBuilder)
+ {
+ migrationBuilder.AddColumn<int>(
+ name: "TimeoutDuration",
+ table: "AbpWebhooksSubscriptions",
+ type: "int",
+ nullable: true);
+ }
+
+ /// <inheritdoc />
+ protected override void Down(MigrationBuilder migrationBuilder)
+ {
+ migrationBuilder.DropColumn(
+ name: "TimeoutDuration",
+ table: "AbpWebhooksSubscriptions");
+ }
+ }
+}

aspnet-core/migrations/LY.MicroService.WebhooksManagement.EntityFrameworkCore/Migrations/WebhooksManagementMigrationsDbContextModelSnapshot.cs

@@ -18,7 +18,7 @@ protected override void BuildModel(ModelBuilder modelBuilder)
 #pragma warning disable 612, 618
  modelBuilder
  .HasAnnotation("_Abp_DatabaseProvider", EfCoreDatabaseProvider.MySql)
- .HasAnnotation("ProductVersion", "7.0.2")
+ .HasAnnotation("ProductVersion", "8.0.0")
  .HasAnnotation("Relational:MaxIdentifierLength", 64);
 
  modelBuilder.Entity("LINGYUN.Abp.WebhooksManagement.WebhookDefinitionRecord", b =>
@@ -226,6 +226,9 @@ protected override void BuildModel(ModelBuilder modelBuilder)
  b.Property<Guid?>("TenantId")
  .HasColumnType("char(36)");
 
+ b.Property<int?>("TimeoutDuration")
+ .HasColumnType("int");
+
  b.Property<string>("WebhookUri")
  .IsRequired()
  .HasMaxLength(255)

aspnet-core/modules/webhooks/LINGYUN.Abp.Webhooks.Core/LINGYUN/Abp/Webhooks/AbpWebhooksOptions.cs

@@ -58,13 +58,13 @@ public AbpWebhooksOptions()
  { "X-Requested-From", "abp-webhooks" },
  };
 
- DefaultAgentIdentifier = "Abp Webhooks";
+ DefaultAgentIdentifier = "Abp-Webhooks";
 
  var assembly = typeof(AbpWebhooksOptions).Assembly;
- var versionAttr = assembly.GetCustomAttribute<AssemblyInformationalVersionAttribute>();
+ var versionAttr = assembly.GetCustomAttribute<AssemblyFileVersionAttribute>();
  if (versionAttr != null)
  {
- DefaultAgentIdentifier += " " + versionAttr.InformationalVersion;
+ DefaultAgentIdentifier += "/" + versionAttr.Version;
  }
  }
 

aspnet-core/modules/webhooks/LINGYUN.Abp.Webhooks/LINGYUN/Abp/Webhooks/DefaultWebhookPublisher.cs

@@ -111,7 +111,8 @@ await _backgroundJobManager.EnqueueAsync(new WebhookSenderArgs
  Headers = headersToSend,
  Secret = webhookSubscription.Secret,
  WebhookUri = webhookSubscription.WebhookUri,
- SendExactSameData = sendExactSameData
+ SendExactSameData = sendExactSameData,
+ TimeoutDuration = webhookSubscription.TimeoutDuration,
  });
  }
  }

aspnet-core/modules/webhooks/LINGYUN.Abp.Webhooks/LINGYUN/Abp/Webhooks/DefaultWebhookSender.cs

@@ -64,7 +64,9 @@ public async Task<Guid> SendWebhookAsync(WebhookSenderArgs webhookSenderArgs)
 
  try
  {
- var response = await SendHttpRequest(request);
+ var client = CreateWebhookClient(webhookSenderArgs);
+
+ var response = await SendHttpRequest(client, request);
 
  isSucceed = response.IsSuccessStatusCode;
  statusCode = response.StatusCode;
@@ -112,6 +114,18 @@ protected virtual HttpRequestMessage CreateWebhookRequestMessage(WebhookSenderAr
  return new HttpRequestMessage(HttpMethod.Post, webhookSenderArgs.WebhookUri);
  }
 
+ protected virtual HttpClient CreateWebhookClient(WebhookSenderArgs webhookSenderArgs)
+ {
+ var client = _httpClientFactory.CreateClient(AbpWebhooksModule.WebhooksClient);
+ if (webhookSenderArgs.TimeoutDuration.HasValue && 
+ (webhookSenderArgs.TimeoutDuration >= 10 && webhookSenderArgs.TimeoutDuration <= 300))
+ {
+ client.Timeout = TimeSpan.FromSeconds(webhookSenderArgs.TimeoutDuration.Value);
+ }
+
+ return client;
+ }
+
  protected virtual void AddAdditionalHeaders(HttpRequestMessage request, WebhookSenderArgs webhookSenderArgs)
  {
  foreach (var header in _options.DefaultHttpHeaders)
@@ -169,10 +183,8 @@ protected virtual void AddAdditionalHeaders(HttpRequestMessage request, WebhookS
  }
  }
 
- protected async virtual Task<HttpResponseMessage> SendHttpRequest(HttpRequestMessage request)
+ protected async virtual Task<HttpResponseMessage> SendHttpRequest(HttpClient client, HttpRequestMessage request)
  {
- var client = _httpClientFactory.CreateClient(AbpWebhooksModule.WebhooksClient);
-
  return await client.SendAsync(request);
  }
 

aspnet-core/modules/webhooks/LINGYUN.Abp.Webhooks/LINGYUN/Abp/Webhooks/WebhookSenderArgs.cs

@@ -58,6 +58,10 @@ public class WebhookSenderArgs
  /// </para>
  /// </summary>
  public bool SendExactSameData { get; set; }
+ /// <summary>
+ /// Request timeout time, in seconds
+ /// </summary>
+ public int? TimeoutDuration { get; set; }
 
  public WebhookSenderArgs()
  {