webhooks API & client

Author: eiximenis

docker-compose.override.yml

@@ -397,7 +397,6 @@ services:
 
   webhooks.client:
     environment:
-      - ASPNETCORE_ENVIRONMENT=Development
       - ASPNETCORE_URLS=http://0.0.0.0:80
       - Token=6168DB8D-DC58-4094-AF24-483278923590      # Webhooks are registered with this token (any value is valid) but the client won't check it
       - IdentityUrl=http://10.0.75.1:5105

src/Services/Webhooks/Webhooks.API/Controllers/WebhooksController.cs

@@ -38,7 +38,7 @@ public async Task<IActionResult> ListByUser()
         }
 
         [Authorize]
-        [HttpGet("{id:int}", Name = "Get")]
+        [HttpGet("{id:int}")]
         [ProducesResponseType(typeof(WebhookSubscription), (int)HttpStatusCode.OK)]
         [ProducesResponseType((int)HttpStatusCode.NotFound)]
         public async Task<IActionResult> GetByUserAndId(int id)
@@ -82,7 +82,7 @@ public async Task<IActionResult> SubscribeWebhook(WebhookSubscriptionRequest req
 
                 _dbContext.Add(subscription);
                 await _dbContext.SaveChangesAsync();
-                return CreatedAtAction("Get", new { id = subscription.Id });
+                return CreatedAtAction("GetByUserAndId", new { id = subscription.Id }, subscription);
             }
             else
             {

src/Services/Webhooks/Webhooks.API/Services/GrantUrlTesterService.cs

@@ -1,4 +1,5 @@
-using System;
+using Microsoft.Extensions.Logging;
+using System;
 using System.Collections.Generic;
 using System.Linq;
 using System.Net.Http;
@@ -9,19 +10,30 @@ namespace Webhooks.API.Services
     class GrantUrlTesterService : IGrantUrlTesterService
     {
         private readonly IHttpClientFactory _clientFactory;
-        public GrantUrlTesterService(IHttpClientFactory factory)
+        private readonly ILogger _logger;
+        public GrantUrlTesterService(IHttpClientFactory factory, ILogger<IGrantUrlTesterService> logger)
         {
             _clientFactory = factory;
+            _logger = logger;
         }
 
         public async Task<bool> TestGrantUrl(string url, string token)
         {
             var client = _clientFactory.CreateClient("GrantClient");
-
             var msg = new HttpRequestMessage(HttpMethod.Options, url);
             msg.Headers.Add("X-eshop-whtoken", token);
-            var response = await client.SendAsync(msg);
-            return response.IsSuccessStatusCode;
+            _logger.LogTrace($"Sending the OPTIONS message to {url} with token {token ?? string.Empty}");
+            try
+            {
+                var response = await client.SendAsync(msg);
+                _logger.LogInformation($"Response code is {response.StatusCode} for url {url}");
+                return response.IsSuccessStatusCode;
+            }
+            catch (Exception ex)
+            {
+                _logger.LogWarning($"Exception {ex.GetType().Name} when sending OPTIONS request. Url can't be granted.");
+                return false;
+            }
         }
     }
 }

src/Web/WebhookClient/.dockerignore

@@ -0,0 +1 @@
+!wwwroot

src/Web/WebhookClient/Controllers/WebhooksReceivedController.cs

@@ -0,0 +1,43 @@
+using Microsoft.AspNetCore.Http;
+using Microsoft.AspNetCore.Mvc;
+using Microsoft.Extensions.Options;
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Threading.Tasks;
+using WebhookClient.Models;
+
+namespace WebhookClient.Controllers
+{
+    [ApiController]
+    [Route("webhook-received")]
+    public class WebhooksReceivedController : Controller
+    {
+
+        private readonly Settings _settings;
+        
+        public WebhooksReceivedController(IOptions<Settings> settings)
+        {
+            _settings = settings.Value;
+        }
+
+        public IActionResult NewWebhook(WebhookData hook)
+        {
+            var header = Request.Headers[HeaderNames.WebHookCheckHeader];
+            var token = header.FirstOrDefault();
+            if (!_settings.ValidateToken || _settings.Token == token)
+            {
+                var received = HttpContext.Session.Get<IEnumerable<WebHookReceived>>(SessionKeys.HooksKey)?.ToList() ?? new List<WebHookReceived>();
+                received.Add(new WebHookReceived()
+                {
+                    Data = hook.Payload,
+                    When = hook.When,
+                    Token = token
+                });
+                return Ok();
+            }
+
+            return BadRequest();
+        }
+    }
+}

src/Web/WebhookClient/Models/WebHookReceived.cs

@@ -9,5 +9,7 @@ public class WebHookReceived
     {
         public DateTime When { get; set; }
         public string Data { get; set; }
+
+        public string Token { get; set; }
     }
 }

src/Web/WebhookClient/Models/WebhookData.cs

@@ -0,0 +1,16 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Threading.Tasks;
+
+namespace WebhookClient.Models
+{
+    public class WebhookData
+    {
+        public DateTime When { get; }
+
+        public string Payload { get; }
+
+        public string Type { get; }
+    }
+}

src/Web/WebhookClient/Pages/Index.cshtml

@@ -7,21 +7,25 @@
 <div class="text-center">
     <h1 class="display-4">Welcome</h1>
     <p>eShopOnContainers - Webhook client</p>
-    <a class="btn-primary btn" href="@Url.Action("SignIn","Account")">Login</a>
-    <p>Why I need to login? You only need to login <bold>to setup a new webhook</bold>.</p>
+    @if (!User.Identity.IsAuthenticated)
+    {
+        <a class="btn-primary btn" href="@Url.Action("SignIn", "Account")">Login</a>
+        <p>Why I need to login? You only need to login <bold>to setup a new webhook</bold>.</p>
+    }
 </div>
 
 @if (User.Identity.IsAuthenticated)
 {
-
     <div class="table">
-        <h3>Current webhooks invoked</h3>
+        <h3>Current webhooks received</h3>
+        <p>(Data since last time web started up)<p>
         <table class="table">
             @foreach (var webhook in Model.WebHooksReceived)
             {
                 <tr>
                     <td>@webhook.When</td>
                     <td><pre>@webhook.Data</pre></td>
+                    <td>@(webhook.Token ?? "--None--")</td>
                 </tr>
             }
         </table>

src/Web/WebhookClient/Pages/Index.cshtml.cs

@@ -17,7 +17,7 @@ public class IndexModel : PageModel
 
         public void OnGet()
         {
-            WebHooksReceived = HttpContext.Session.Get<IEnumerable<WebHookReceived>>("webhooks.received") ?? Enumerable.Empty<WebHookReceived>();
+            WebHooksReceived = HttpContext.Session.Get<IEnumerable<WebHookReceived>>(SessionKeys.HooksKey) ?? Enumerable.Empty<WebHookReceived>();
         }
     }
 }

src/Web/WebhookClient/Pages/RegisterWebhook.cshtml

@@ -11,4 +11,9 @@
 <form method="post">
     <p>Token: <input type="text" asp-for="Token" /></p>
     <input type="submit" value="send" />
-</form>
+</form>
+
+@if (Model.ResponseCode != (int)System.Net.HttpStatusCode.OK)
+{
+    <p>Error @Model.ResponseCode (@Model.ResponseMessage) when calling the Webhooks API (@Model.RequestUrl) with GrantUrl: @Model.GrantUrl):(</p>
+}