Decouple Change from Image

Zhiyuan-Amos · Nov 28, 2021 · cd6d1e9 · cd6d1e9
1 parent 51c11b0
commit cd6d1e9
Show file tree

Hide file tree

Showing 24 changed files with 225 additions and 28 deletions.
diff --git a/.github/workflows/azure-messaging-function.yml b/.github/workflows/azure-messaging-function.yml
@@ -0,0 +1,37 @@
+# https://docs.microsoft.com/en-us/azure/azure-functions/functions-how-to-github-actions?tabs=dotnet#deploy-the-function-app
+
+name: Deploy DotNet project to function app with a Linux environment
+
+on:
+  [push]
+
+env:
+  AZURE_FUNCTIONAPP_NAME: change-event
+  AZURE_FUNCTIONAPP_PACKAGE_PATH: '.\Messaging'
+  DOTNET_VERSION: '6.0.x'
+
+jobs:
+  build-and-deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - name: 'Checkout GitHub Action'
+        uses: actions/checkout@v2
+
+      - name: Setup DotNet ${{ env.DOTNET_VERSION }} Environment
+        uses: actions/setup-dotnet@v1
+        with:
+          dotnet-version: ${{ env.DOTNET_VERSION }}
+
+      - name: 'Resolve Project Dependencies Using Dotnet'
+        shell: bash
+        run: |
+          pushd './${{ env.AZURE_FUNCTIONAPP_PACKAGE_PATH }}'
+          dotnet build --configuration Release --output ./output
+          popd
+      - name: 'Run Azure Functions Action'
+        uses: Azure/functions-action@v1
+        id: fa
+        with:
+          app-name: ${{ env.AZURE_FUNCTIONAPP_NAME }}
+          package: '${{ env.AZURE_FUNCTIONAPP_PACKAGE_PATH }}/output'
+          publish-profile: ${{ secrets.AZURE_MESSAGING_FUNCTIONAPP_PUBLISH_PROFILE }}
diff --git a/Api/Data/ChangeContext.cs b/Api/Data/ChangeContext.cs
@@ -21,6 +21,10 @@ protected override void OnModelCreating(ModelBuilder modelBuilder)
                 .Property(change => change.Id)
                 .ToJsonProperty("id")
                 .HasConversion<string>();
+
+            modelBuilder.Entity<Change>()
+                .Property(change => change.Ttl)
+                .ToJsonProperty("ttl");
         }
     }
 }
diff --git a/Api/Features/Change/DeleteChangeFunction.cs b/Api/Features/Change/DeleteChangeFunction.cs
@@ -1,12 +1,8 @@
-using System;
 using System.Linq;
 using System.Net;
-using System.Text.Json;
 using System.Threading.Tasks;
-using Azure.Storage.Blobs;
 using Couple.Api.Data;
 using Couple.Api.Infrastructure;
-using Couple.Shared.Model;
 using Couple.Shared.Model.Change;
 using FluentValidation;
 using Microsoft.Azure.Functions.Worker;
@@ -22,7 +18,7 @@ public class DeleteChangesFunction
         private readonly ChangeContext _context;
 
         public DeleteChangesFunction(ICurrentUserService currentUserService,
-                                     ChangeContext context)
+            ChangeContext context)
         {
             _currentUserService = currentUserService;
             _context = context;
@@ -53,13 +49,6 @@ public async Task<HttpResponseData> Run(
                 .Where(change => model.Guids.Contains(change.Id))
                 .ToListAsync();
 
-            var areIdsValid = model.Guids.Count == toDelete.Count;
-
-            if (!areIdsValid)
-            {
-                return req.CreateResponse(HttpStatusCode.BadRequest);
-            }
-
             var claims = _currentUserService.GetClaims(req.Headers);
             var canDelete = toDelete.All(change => change.UserId == claims.Id);
 
@@ -68,24 +57,16 @@ public async Task<HttpResponseData> Run(
                 return req.CreateResponse(HttpStatusCode.Forbidden);
             }
 
+            foreach (var change in toDelete)
+            {
+                change.Ttl = 3600;
+            }
+
             _context
                 .Changes
-                .RemoveRange(toDelete);
-            await _context.SaveChangesAsync();
-
-            var imageIdsToDelete = toDelete
-                .Where(change => change.Command == Command.CreateImage || change.Command == Command.UpdateImage)
-                .Select(change => change.Content)
-                .Select(content => JsonSerializer.Deserialize<Model.Image>(content))
-                .Select(image => image.Id.ToString())
-                .ToList();
+                .UpdateRange(toDelete);
 
-            var connectionString = Environment.GetEnvironmentVariable("ImagesConnectionString");
-            foreach (var id in imageIdsToDelete)
-            {
-                var client = new BlobClient(connectionString, "images", id);
-                await client.DeleteIfExistsAsync();
-            }
+            await _context.SaveChangesAsync();
 
             return req.CreateResponse(HttpStatusCode.OK);
         }

diff --git a/Api/Features/Change/SynchronizeChangeFunction.cs b/Api/Features/Change/SynchronizeChangeFunction.cs
@@ -46,6 +46,7 @@ public async Task<HttpResponseData> Run(
             var toReturn = await _context
                 .Changes
                 .Where(change => change.UserId == claims.Id)
+                .Where(change => change.Ttl == -1)
                 .OrderBy(change => change.Timestamp)
                 .ProjectTo<ChangeDto>(_mapper.ConfigurationProvider)
                 .ToListAsync();

diff --git a/Api/Features/Event/CreateEventFunction.cs b/Api/Features/Event/CreateEventFunction.cs
@@ -56,6 +56,7 @@ public async Task<HttpResponseData> Run(
                 Command.CreateEvent,
                 claims.PartnerId,
                 _dateTimeService.Now,
+                form.Value.Event.Id,
                 form.Json);
 
             _context

diff --git a/Api/Features/Event/DeleteEventFunction.cs b/Api/Features/Event/DeleteEventFunction.cs
@@ -41,6 +41,7 @@ public async Task<HttpResponseData> Run(
                 Command.DeleteEvent,
                 claims.PartnerId,
                 _dateTimeService.Now,
+                id,
                 JsonSerializer.Serialize(id));
 
             _context

diff --git a/Api/Features/Event/UpdateEventFunction.cs b/Api/Features/Event/UpdateEventFunction.cs
@@ -56,6 +56,7 @@ public async Task<HttpResponseData> Run(
                 Command.UpdateEvent,
                 claims.PartnerId,
                 _dateTimeService.Now,
+                form.Value.Event.Id,
                 form.Json);
 
             _changeContext

diff --git a/Api/Features/Image/CreateImageFunction.cs b/Api/Features/Image/CreateImageFunction.cs
@@ -65,6 +65,7 @@ public async Task<HttpResponseData> Run(
                 Command.CreateImage,
                 claims.PartnerId,
                 _dateTimeService.Now,
+                dto.Id,
                 JsonSerializer.Serialize(_mapper.Map<Model.Image>(dto)));
 
             _context

diff --git a/Api/Features/Image/DeleteImageFunction.cs b/Api/Features/Image/DeleteImageFunction.cs
@@ -41,6 +41,7 @@ public async Task<HttpResponseData> Run(
                 Command.DeleteImage,
                 claims.PartnerId,
                 _dateTimeService.Now,
+                id,
                 JsonSerializer.Serialize(id));
 
             _context

diff --git a/Api/Features/Image/UpdateImageFunction.cs b/Api/Features/Image/UpdateImageFunction.cs
@@ -64,6 +64,7 @@ public async Task<HttpResponseData> Run(
                 Command.UpdateImage,
                 claims.PartnerId,
                 _dateTimeService.Now,
+                dto.Id,
                 JsonSerializer.Serialize(_mapper.Map<Model.Image>(dto)));
 
             _context

diff --git a/Api/Features/Issue/CompleteTaskFunction.cs b/Api/Features/Issue/CompleteTaskFunction.cs
@@ -55,6 +55,7 @@ public async Task<HttpResponseData> Run(
                 Command.CompleteTask,
                 claims.PartnerId,
                 _dateTimeService.Now,
+                form.Value.Id,
                 form.Json);
 
             _context

diff --git a/Api/Features/Issue/CreateIssueFunction.cs b/Api/Features/Issue/CreateIssueFunction.cs
@@ -55,6 +55,7 @@ public async Task<HttpResponseData> Run(
                 Command.CreateIssue,
                 claims.PartnerId,
                 _dateTimeService.Now,
+                form.Value.Id,
                 form.Json);
 
             _context

diff --git a/Api/Features/Issue/DeleteIssueFunction.cs b/Api/Features/Issue/DeleteIssueFunction.cs
@@ -41,6 +41,7 @@ public async Task<HttpResponseData> Run(
                 Command.DeleteIssue,
                 claims.PartnerId,
                 _dateTimeService.Now,
+                id,
                 JsonSerializer.Serialize(id));
 
             _context

diff --git a/Api/Features/Issue/UpdateIssueFunction.cs b/Api/Features/Issue/UpdateIssueFunction.cs
@@ -55,6 +55,7 @@ public async Task<HttpResponseData> Run(
                 Command.UpdateIssue,
                 claims.PartnerId,
                 _dateTimeService.Now,
+                form.Value.Id,
                 form.Json);
 
             _context

diff --git a/Api/Model/Change.cs b/Api/Model/Change.cs
@@ -8,17 +8,27 @@ public class Change
         public string Command { get; init; }
         public string UserId { get; init; }
         public DateTime Timestamp { get; init; }
+        public Guid ContentId { get; init; }
         public string Content { get; init; }
+        public int? Ttl { get; set; }
 
         private Change() { }
 
-        public Change(Guid id, string command, string userId, DateTime timestamp, string content)
+        public Change(Guid id, string command, string userId, DateTime timestamp, Guid contentId, string content)
         {
             Id = id;
             Command = command;
             UserId = userId;
             Timestamp = timestamp;
+            ContentId = contentId;
             Content = content;
+
+            // 1. Annotating this property with Json Attributes don't seem to work e.g.
+            // [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] and [JsonPropertyName("ttl")]
+            // 2. The alternative is to implement the converter
+            // https://docs.microsoft.com/en-us/dotnet/standard/serialization/system-text-json-migrate-from-newtonsoft-how-to?pivots=dotnet-6-0#conditionally-ignore-a-property
+            // which is much more troublesome than this solution.
+            Ttl = -1;
         }
     }
 }
diff --git a/Couple.sln b/Couple.sln
@@ -9,6 +9,8 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Couple.Api", "Api\Couple.Ap
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Couple.Shared", "Shared\Couple.Shared.csproj", "{BF40FDE1-00B3-420B-B3C8-3AC60A075A85}"
 EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Couple.Messaging", "Messaging\Couple.Messaging.csproj", "{B6CF82EB-15D6-4E71-BEAE-F52FC2190109}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -27,6 +29,10 @@ Global
 		{BF40FDE1-00B3-420B-B3C8-3AC60A075A85}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{BF40FDE1-00B3-420B-B3C8-3AC60A075A85}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{BF40FDE1-00B3-420B-B3C8-3AC60A075A85}.Release|Any CPU.Build.0 = Release|Any CPU
+		{B6CF82EB-15D6-4E71-BEAE-F52FC2190109}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{B6CF82EB-15D6-4E71-BEAE-F52FC2190109}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{B6CF82EB-15D6-4E71-BEAE-F52FC2190109}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{B6CF82EB-15D6-4E71-BEAE-F52FC2190109}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE

diff --git a/Messaging/Couple.Messaging.csproj b/Messaging/Couple.Messaging.csproj
@@ -0,0 +1,21 @@
+<Project Sdk="Microsoft.NET.Sdk">
+  <PropertyGroup>
+    <TargetFramework>net6.0</TargetFramework>
+    <AzureFunctionsVersion>v4</AzureFunctionsVersion>
+    <AnalysisLevel>latest</AnalysisLevel>
+    <Nullable>enable</Nullable>
+  </PropertyGroup>
+  <ItemGroup>
+    <PackageReference Include="Azure.Storage.Blobs" Version="12.10.0" />
+    <PackageReference Include="Microsoft.Azure.WebJobs.Extensions.CosmosDB" Version="3.0.10" />
+    <PackageReference Include="Microsoft.Azure.WebJobs.Extensions.EventGrid" Version="3.0.0" />
+    <PackageReference Include="Microsoft.NET.Sdk.Functions" Version="4.0.1" />
+  </ItemGroup>
+  <ItemGroup>
+    <ProjectReference Include="..\Shared\Couple.Shared.csproj" />
+  </ItemGroup>
+  <ItemGroup>
+    <None Update="host.json" CopyToOutputDirectory="PreserveNewest" />
+    <None Update="local.settings.json" CopyToOutputDirectory="PreserveNewest" CopyToPublishDirectory="Never" />
+  </ItemGroup>
+</Project>
diff --git a/Messaging/Features/ChangeDeletedEventFunction.cs b/Messaging/Features/ChangeDeletedEventFunction.cs
@@ -0,0 +1,40 @@
+using Azure.Messaging.EventGrid;
+using Couple.Messaging.Model;
+using Couple.Shared.Model;
+using Microsoft.Azure.Documents;
+using Microsoft.Azure.WebJobs;
+using Microsoft.Azure.WebJobs.Extensions.EventGrid;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text.Json;
+using System.Threading.Tasks;
+
+namespace Couple.Messaging.Features
+{
+    public class DeletedEventFunction
+    {
+        [FunctionName("ChangeDeletedEventFunction")]
+        public async Task Run([CosmosDBTrigger("%DatabaseName%",
+            "%CollectionName%",
+            ConnectionStringSetting = "DatabaseConnectionString",
+            CreateLeaseCollectionIfNotExists = true)] IReadOnlyList<Document> documents,
+            [EventGrid(TopicEndpointUri = "EventGridEndpoint",
+                TopicKeySetting = "EventGridKey")] IAsyncCollector<EventGridEvent> eventCollector)
+        {
+            var changes = documents.Select(d => d.ToString())
+                .Select(json => JsonSerializer.Deserialize<Change>(json)!)
+                .Where(change => change.Ttl != -1)
+                .Where(change => change.Command is Command.CreateImage or Command.UpdateImage)
+                .ToList();
+
+            List<Task> tasks = new();
+            foreach (var change in changes)
+            {
+                var task = eventCollector.AddAsync(new(change.ContentId.ToString(), "ImageDeleted", "1", new { }));
+                tasks.Add(task);
+            }
+
+            await Task.WhenAll(tasks);
+        }
+    }
+}
diff --git a/Messaging/Features/ImageDeletedEventFunction.cs b/Messaging/Features/ImageDeletedEventFunction.cs
@@ -0,0 +1,20 @@
+using Azure.Storage.Blobs;
+using Couple.Messaging.Model;
+using Microsoft.Azure.WebJobs;
+using Microsoft.Azure.WebJobs.Extensions.EventGrid;
+using System;
+using System.Threading.Tasks;
+
+namespace Couple.Messaging.Features
+{
+    public class ImageDeletedEventFunction
+    {
+        [FunctionName("ImageDeletedEventFunction")]
+        public async Task Run([EventGridTrigger] Event @event)
+        {
+            var connectionString = Environment.GetEnvironmentVariable("ImagesConnectionString");
+            var client = new BlobClient(connectionString, "images", @event.Subject);
+            await client.DeleteIfExistsAsync();
+        }
+    }
+}
diff --git a/Messaging/Model/Change.cs b/Messaging/Model/Change.cs
@@ -0,0 +1,18 @@
+using System;
+using System.Text.Json.Serialization;
+
+namespace Couple.Messaging.Model
+{
+    public class Change
+    {
+        public Guid Id { get; init; }
+        public string? Command { get; init; }
+        public string? UserId { get; init; }
+        public DateTime Timestamp { get; init; }
+        public Guid ContentId { get; init; }
+        public string? Content { get; init; }
+
+        [JsonPropertyName("ttl")]
+        public int? Ttl { get; set; }
+    }
+}
diff --git a/Messaging/Model/Event.cs b/Messaging/Model/Event.cs
@@ -0,0 +1,14 @@
+using System;
+using System.Collections.Generic;
+
+namespace Couple.Messaging.Model
+{
+    public class Event
+    {
+        public string? Topic { get; init; }
+        public string? Subject { get; init; }
+        public string? EventType { get; init; }
+        public DateTime EventTime { get; init; }
+        public IDictionary<string, object>? Data { get; init; }
+    }
+}
diff --git a/Messaging/Properties/launchSettings.json b/Messaging/Properties/launchSettings.json
@@ -0,0 +1,9 @@
+{
+  "profiles": {
+    "Api": {
+      "commandName": "Executable",
+      "executablePath": "func",
+      "commandLineArgs": "start"
+    }
+  }
+}
diff --git a/Messaging/host.json b/Messaging/host.json
@@ -0,0 +1,10 @@
+{
+    "version": "2.0",
+    "logging": {
+        "applicationInsights": {
+            "samplingSettings": {
+                "isEnabled": true
+            }
+        }
+    }
+}