[refactor] rename message components to announcements (#129)

Author: paul-fresquet

docs/client-deployment.md

@@ -28,7 +28,7 @@ These projects are written in **C#** and target a specific version of **.NET**.
   "StagingUrl": "",
   "ProductionUrl": "",
   "UpdatesDefinitionUrl": "",
-  "MessagesDefinitionsUrl": ""
+  "AnnouncementsUrl": ""
   }
   ```
 

docs/server-deployment.md

@@ -72,7 +72,7 @@ Below is the JSON structure indicating which properties must be set. In particul
   },
   "AppSettings": {
     "Secret": "YOUR_UNIQUE_RANDOM_SEED",
-    "MessagesDefinitionsUrl": ""
+    "AnnouncementsUrl": ""
   }
 }
 ```
@@ -99,7 +99,7 @@ Below is the JSON structure indicating which properties must be set. In particul
     "CosmosDb:ConnectionString": "<your-cosmosdb-connection-string>",
     "CosmosDb:DatabaseName": "<your-database-name>",
     "AppSettings:Secret": "YOUR_UNIQUE_RANDOM_SEED",
-    "AppSettings:MessagesDefinitionsUrl": ""
+    "AppSettings:AnnouncementsUrl": ""
   }
 }
 ```
@@ -138,7 +138,7 @@ cd ByteSync.Functions
 
 # App Settings
   dotnet user-secrets set "AppSettings:Secret" "YOUR_UNIQUE_RANDOM_SEED"
-  dotnet user-secrets set "AppSettings:MessagesDefinitionsUrl" ""
+  dotnet user-secrets set "AppSettings:AnnouncementsUrl" ""
 ```
 
 Repeat these steps for **ByteSync.Functions.IntegrationTests** and **ByteSync.ServerCommon.Tests**, navigating to each project's directory and setting the same secrets.

src/ByteSync.Client/local.settings.template.json

@@ -4,5 +4,5 @@
   "StagingUrl": "",
   "ProductionUrl": "",
   "UpdatesDefinitionUrl": "",
-  "MessagesDefinitionsUrl": ""
+  "AnnouncementsUrl": ""
 }

src/ByteSync.Functions/Helpers/Middlewares/JwtMiddleware.cs

@@ -27,8 +27,8 @@ public class JwtMiddleware : IFunctionsWorkerMiddleware
     public JwtMiddleware(IOptions<AppSettings> appSettings, IClientsRepository clientsRepository, ILogger<JwtMiddleware> logger)
     {
         var loginFunctionEntryPoint = GetEntryPoint<AuthFunction>(nameof(AuthFunction.Login));
-        var getMessagesFunctionEntryPoint = GetEntryPoint<MessageDefinitionFunction>(nameof(MessageDefinitionFunction.GetMessages));
-        _allowedAnonymousFunctionEntryPoints = [loginFunctionEntryPoint, getMessagesFunctionEntryPoint];
+        var getAnnouncementsFunctionEntryPoint = GetEntryPoint<AnnouncementFunction>(nameof(AnnouncementFunction.GetAnnouncements));
+        _allowedAnonymousFunctionEntryPoints = [loginFunctionEntryPoint, getAnnouncementsFunctionEntryPoint];
 
         _secret = appSettings.Value.Secret;
         _clientsRepository = clientsRepository;

…ctions/Http/MessageDefinitionFunction.cs …c.Functions/Http/AnnouncementFunction.cssrc/ByteSync.Functions/Http/MessageDefinitionFunction.cs renamed to src/ByteSync.Functions/Http/AnnouncementFunction.cs src/ByteSync.Functions/Http/MessageDefinitionFunction.cs renamed to src/ByteSync.Functions/Http/AnnouncementFunction.cs

@@ -1,29 +1,29 @@
 using System.Net;
-using ByteSync.ServerCommon.Commands.Messages;
+using ByteSync.ServerCommon.Commands.Announcements;
 using MediatR;
 using Microsoft.Azure.Functions.Worker;
 using Microsoft.Azure.Functions.Worker.Http;
 
 namespace ByteSync.Functions.Http;
 
-public class MessageDefinitionFunction
+public class AnnouncementFunction
 {
     private readonly IMediator _mediator;
 
-    public MessageDefinitionFunction(IMediator mediator)
+    public AnnouncementFunction(IMediator mediator)
     {
         _mediator = mediator;
     }
 
-    [Function("GetMessages")]
-    public async Task<HttpResponseData> GetMessages(
-        [HttpTrigger(AuthorizationLevel.Anonymous, "get", Route = "messages")] HttpRequestData req,
+    [Function("GetAnnouncements")]
+    public async Task<HttpResponseData> GetAnnouncements(
+        [HttpTrigger(AuthorizationLevel.Anonymous, "get", Route = "announcements")] HttpRequestData req,
         FunctionContext executionContext)
     {
-        var messages = await _mediator.Send(new GetActiveMessagesRequest());
+        var announcements = await _mediator.Send(new GetActiveAnnouncementsRequest());
 
         var response = req.CreateResponse();
-        await response.WriteAsJsonAsync(messages, HttpStatusCode.OK);
+        await response.WriteAsJsonAsync(announcements, HttpStatusCode.OK);
         return response;
     }
 }

src/ByteSync.Functions/Timer/RefreshAnnouncementsFunction.cs

@@ -0,0 +1,40 @@
+using ByteSync.ServerCommon.Business.Announcements;
+using ByteSync.ServerCommon.Interfaces.Loaders;
+using ByteSync.ServerCommon.Interfaces.Repositories;
+using Microsoft.Azure.Functions.Worker;
+using Microsoft.Extensions.Logging;
+
+namespace ByteSync.Functions.Timer;
+
+public class RefreshAnnouncementsFunction
+{
+    private readonly IAnnouncementsLoader _loader;
+    private readonly IAnnouncementRepository _repository;
+    private readonly ILogger<RefreshAnnouncementsFunction> _logger;
+
+    public RefreshAnnouncementsFunction(IAnnouncementsLoader loader, IAnnouncementRepository repository,
+        ILogger<RefreshAnnouncementsFunction> logger)
+    {
+        _loader = loader;
+        _repository = repository;
+        _logger = logger;
+    }
+
+    [Function("RefreshAnnouncementsFunction")]
+    public async Task<int> RunAsync([TimerTrigger("0 0 */2 * * *"
+#if DEBUG
+        , RunOnStartup = true
+#endif
+        )] TimerInfo timerInfo)
+    {
+        var currentUtcTime = DateTime.UtcNow;
+        _logger.LogInformation("Refreshing announcements at: {Now}", currentUtcTime);
+
+        var announcements = await _loader.Load();
+        var validAnnouncements = announcements.Where(d => d.EndDate > currentUtcTime).ToList();
+
+        await _repository.SaveAll(validAnnouncements);
+
+        return validAnnouncements.Count;
+    }
+}

src/ByteSync.Functions/Timer/RefreshMessageDefinitionsFunction.cs

@@ -1,6 +1,6 @@
-namespace ByteSync.ServerCommon.Business.Messages;
+namespace ByteSync.ServerCommon.Business.Announcements;
 
-public class MessageDefinition
+public class Announcement
 {
     public string Id { get; set; }
 

…n/Business/Messages/MessageDefinition.cs …n/Business/Announcements/Announcement.cssrc/ByteSync.ServerCommon/Business/Messages/MessageDefinition.cs renamed to src/ByteSync.ServerCommon/Business/Announcements/Announcement.cs src/ByteSync.ServerCommon/Business/Messages/MessageDefinition.cs renamed to src/ByteSync.ServerCommon/Business/Announcements/Announcement.cs

@@ -10,5 +10,5 @@ public class AppSettings
 
     public string UpdatesDefinitionUrl { get; set; } = "";
 
-    public string MessagesDefinitionsUrl { get; set; } = "";
+    public string AnnouncementsUrl { get; set; } = "";
 }

src/ByteSync.ServerCommon/Business/Settings/AppSettings.cs

@@ -0,0 +1,27 @@
+using ByteSync.ServerCommon.Business.Announcements;
+using ByteSync.ServerCommon.Interfaces.Repositories;
+using MediatR;
+
+namespace ByteSync.ServerCommon.Commands.Announcements;
+
+public class GetActiveAnnouncementsCommandHandler : IRequestHandler<GetActiveAnnouncementsRequest, List<Announcement>>
+{
+    private readonly IAnnouncementRepository _repository;
+
+    public GetActiveAnnouncementsCommandHandler(IAnnouncementRepository repository)
+    {
+        _repository = repository;
+    }
+
+    public async Task<List<Announcement>> Handle(GetActiveAnnouncementsRequest request, CancellationToken cancellationToken)
+    {
+        var allAnnouncements = await _repository.GetAll();
+        if (allAnnouncements is null)
+        {
+            return new List<Announcement>();
+        }
+
+        var now = DateTime.UtcNow;
+        return allAnnouncements.Where(m => m.StartDate <= now && now < m.EndDate).ToList();
+    }
+}