Add display order column (#865)

* Add display order column

* Update Fake.Form.cs

Author: idormenco

api/src/Feature.Forms/Create/Endpoint.cs

@@ -40,11 +40,11 @@ await monitoringNgoRepository.FirstOrDefaultAsync(
             .AsReadOnly();
 
         var form = FormAggregate.Create(req.ElectionRoundId, monitoringNgo.Id, req.FormType, req.Code, req.Name,
-            req.Description, req.DefaultLanguage, req.Languages, req.Icon, questions);
+            req.Description, req.DefaultLanguage, req.Languages, req.Icon, displayOrder: 0, questions);
 
         await monitoringNgoRepository.UpdateAsync(monitoringNgo, ct);
 
         await formsRepository.AddAsync(form, ct);
         return TypedResults.Ok(FormFullModel.FromEntity(form));
     }
-}
+}

api/src/Feature.Forms/FetchAll/Endpoint.cs

@@ -54,7 +54,8 @@ public override async Task<Results<Ok<NgoFormsResponseModel>, NotFound>> Execute
         {
             resultForms.AddRange(await context.CoalitionFormAccess
                 .Include(x => x.Form)
-                .Where(x => x.MonitoringNgoId == monitoringNgo.MonitoringNgoId && x.Coalition.ElectionRoundId == req.ElectionRoundId)
+                .Where(x => x.MonitoringNgoId == monitoringNgo.MonitoringNgoId &&
+                            x.Coalition.ElectionRoundId == req.ElectionRoundId)
                 .Where(x => x.Form.FormType != FormType.CitizenReporting)
                 .Select(f => FormFullModel.FromEntity(f.Form))
                 .AsNoTracking()
@@ -77,7 +78,7 @@ public override async Task<Results<Ok<NgoFormsResponseModel>, NotFound>> Execute
         {
             ElectionRoundId = monitoringNgo.ElectionRoundId,
             Version = DeterministicGuid.Create(resultForms.Select(x => x.Id)).ToString(),
-            Forms = resultForms
+            Forms = resultForms.OrderBy(x => x.DisplayOrder).ToList()
         });
     }
 }

api/src/Feature.Forms/FetchCitizenReportingForms/Endpoint.cs

@@ -59,10 +59,10 @@ public override async Task<Results<NotFound, Ok<NgoFormsResponseModel>>> Execute
             {
                 ElectionRoundId = monitoringNgo.ElectionRoundId,
                 Version = monitoringNgo.FormsVersion.ToString(),
-                Forms = forms.Select(FormFullModel.FromEntity).ToList()
+                Forms = forms.Select(FormFullModel.FromEntity).OrderBy(x => x.DisplayOrder).ToList()
             };
         });
 
         return TypedResults.Ok(cachedResponse!);
     }
-}
+}

api/src/Feature.Forms/Models/FormFullModel.cs

@@ -25,10 +25,13 @@ public class FormFullModel
     public required string DefaultLanguage { get; init; }
     public required string[] Languages { get; init; } = [];
     public int NumberOfQuestions { get; init; }
-    public string? Icon { get; set; }
+    public string? Icon { get; init; }
+    public IReadOnlyList<BaseQuestionModel> Questions { get; init; } = [];
 
     public LanguagesTranslationStatus LanguagesTranslationStatus { get; init; }
 
+    public int DisplayOrder { get; init; }
+
     public static FormFullModel FromEntity(FormAggregate form) => form == null
         ? null
         : new FormFullModel
@@ -46,7 +49,4 @@ public static FormFullModel FromEntity(FormAggregate form) => form == null
             LanguagesTranslationStatus = form.LanguagesTranslationStatus,
             Icon = form.Icon
         };
-
-
-    public IReadOnlyList<BaseQuestionModel> Questions { get; init; } = [];
 }

api/src/Feature.Forms/Update/Endpoint.cs

@@ -49,7 +49,7 @@ public override async Task<Results<NoContent, NotFound>> ExecuteAsync(Request re
             .AsReadOnly();
 
         form.UpdateDetails(req.Code, req.Name, req.Description, req.FormType, req.DefaultLanguage, req.Languages,
-            req.Icon, questions);
+            req.Icon, displayOrder: 0, questions);
 
         await formsRepository.UpdateAsync(form, ct);
 

api/src/Feature.PollingStation.Information.Form/Upsert/Endpoint.cs

@@ -37,7 +37,8 @@ private async Task<Results<Ok<PollingStationInformationFormModel>, NotFound>> Up
         CancellationToken ct)
     {
         pollingStationInformationForm.UpdateDetails("PSI", TranslatedString.New(languages, "PSI"),
-            TranslatedString.New(languages, "PSI"), FormType.PSI, defaultLanguage, languages, null, questions);
+            TranslatedString.New(languages, "PSI"), FormType.PSI, defaultLanguage, languages, null, displayOrder: 0,
+            questions);
         await repository.UpdateAsync(pollingStationInformationForm, ct);
 
         return TypedResults.Ok(PollingStationInformationFormModel.FromEntity(pollingStationInformationForm));
@@ -62,4 +63,4 @@ private async Task<Results<Ok<PollingStationInformationFormModel>, NotFound>> Ad
 
         return TypedResults.Ok(PollingStationInformationFormModel.FromEntity(pollingStationInformationForm));
     }
-}
+}

api/src/Vote.Monitor.Domain/Entities/FormAggregate/Form.cs

@@ -28,6 +28,7 @@ private Form(
         string defaultLanguage,
         IEnumerable<string> languages,
         string? icon,
+        int displayOrder,
         IEnumerable<BaseQuestion> questions) : base(electionRound,
         formType,
         code,
@@ -37,7 +38,8 @@ private Form(
         languages,
         icon,
         questions,
-        FormStatus.Drafted)
+        FormStatus.Drafted,
+        displayOrder)
     {
         MonitoringNgoId = monitoringNgo.Id;
         MonitoringNgo = monitoringNgo;
@@ -53,6 +55,7 @@ private Form(
         string defaultLanguage,
         IEnumerable<string> languages,
         string? icon,
+        int displayOrder,
         IEnumerable<BaseQuestion> questions) : base(
         electionRoundId,
         formType,
@@ -63,7 +66,8 @@ private Form(
         languages,
         icon,
         questions,
-        FormStatus.Drafted)
+        FormStatus.Drafted,
+        displayOrder)
     {
         MonitoringNgoId = monitoringNgoId;
     }
@@ -81,7 +85,8 @@ public Form(Guid id,
         string[] languages,
         string? icon,
         int numberOfQuestions,
-        LanguagesTranslationStatus languagesTranslationStatus) : base(id,
+        LanguagesTranslationStatus languagesTranslationStatus,
+        int displayOrder) : base(id,
         electionRoundId,
         formType,
         code,
@@ -92,7 +97,8 @@ public Form(Guid id,
         languages,
         icon,
         numberOfQuestions,
-        languagesTranslationStatus)
+        languagesTranslationStatus,
+        displayOrder)
     {
         MonitoringNgoId = monitoringNgoId;
     }
@@ -107,9 +113,10 @@ public static Form Create(
         string defaultLanguage,
         IEnumerable<string> languages,
         string? icon,
+        int displayOrder,
         IEnumerable<BaseQuestion> questions) =>
         new(electionRound, monitoringNgo, formType, code, name, description, defaultLanguage, languages, icon,
-            questions);
+            displayOrder, questions);
 
     public static Form Create(
         Guid electionRoundId,
@@ -121,13 +128,14 @@ public static Form Create(
         string defaultLanguage,
         IEnumerable<string> languages,
         string? icon,
+        int displayOrder,
         IEnumerable<BaseQuestion> questions) =>
         new(electionRoundId, monitoringNgoId, formType, code, name, description, defaultLanguage, languages, icon,
-            questions);
+            displayOrder, questions);
 
     public Form Duplicate() =>
         new(ElectionRoundId, MonitoringNgoId, FormType, Code, Name, Description, DefaultLanguage, Languages, Icon,
-            Questions);
+            DisplayOrder, Questions);
 
     public FormSubmission CreateFormSubmission(
         PollingStation pollingStation,

api/src/Vote.Monitor.Domain/Entities/FormBase/BaseForm.cs

@@ -27,7 +27,8 @@ public class BaseForm : AuditableBaseEntity, IAggregateRoot
     public FormStatus Status { get; private set; }
     public string DefaultLanguage { get; private set; }
     public string[] Languages { get; private set; } = [];
-    public string? Icon { get; set; }
+    public string? Icon { get; private set; }
+    public int DisplayOrder { get; private set; }
     public int NumberOfQuestions { get; private set; }
 
     public LanguagesTranslationStatus LanguagesTranslationStatus { get; private set; } = new();
@@ -43,7 +44,8 @@ protected BaseForm(
         IEnumerable<string> languages,
         string? icon,
         IEnumerable<BaseQuestion> questions,
-        FormStatus status) : this(electionRound.Id,
+        FormStatus status,
+        int displayOrder) : this(electionRound.Id,
         formType,
         code,
         name,
@@ -52,7 +54,8 @@ protected BaseForm(
         languages,
         icon,
         questions,
-        status)
+        status,
+        displayOrder)
     {
         ElectionRound = electionRound;
         ElectionRoundId = electionRound.Id;
@@ -68,7 +71,8 @@ protected BaseForm(
         IEnumerable<string> languages,
         string? icon,
         IEnumerable<BaseQuestion> questions,
-        FormStatus status)
+        FormStatus status,
+        int displayOrder)
     {
         Id = Guid.NewGuid();
         ElectionRoundId = electionRoundId;
@@ -84,6 +88,7 @@ protected BaseForm(
         NumberOfQuestions = Questions.Count;
         Icon = icon;
         LanguagesTranslationStatus = ComputeLanguagesTranslationStatus();
+        DisplayOrder = displayOrder;
     }
 
     [JsonConstructor]
@@ -98,7 +103,8 @@ public BaseForm(Guid id,
         string[] languages,
         string? icon,
         int numberOfQuestions,
-        LanguagesTranslationStatus languagesTranslationStatus)
+        LanguagesTranslationStatus languagesTranslationStatus,
+        int displayOrder)
     {
         Id = id;
         ElectionRoundId = electionRoundId;
@@ -112,6 +118,7 @@ public BaseForm(Guid id,
         Icon = icon;
         NumberOfQuestions = numberOfQuestions;
         LanguagesTranslationStatus = languagesTranslationStatus;
+        DisplayOrder = displayOrder;
     }
 
     public PublishResult Publish()
@@ -146,6 +153,7 @@ public void UpdateDetails(string code,
         string defaultLanguage,
         IEnumerable<string> languages,
         string? icon,
+        int displayOrder,
         IEnumerable<BaseQuestion> questions)
     {
         Code = code;
@@ -157,6 +165,7 @@ public void UpdateDetails(string code,
         Questions = questions.ToList().AsReadOnly();
         NumberOfQuestions = Questions.Count;
         Icon = icon;
+        DisplayOrder = displayOrder;
         LanguagesTranslationStatus = ComputeLanguagesTranslationStatus();
     }
 
@@ -298,7 +307,7 @@ public Form Clone(Guid electionRoundId, Guid monitoringNgoId, string defaultLang
                 new ValidationFailure(nameof(Status), "Form is not published.")
             ]);
         }
-        
+
         if (!Languages.Contains(defaultLanguage))
         {
             throw new ValidationException([
@@ -325,9 +334,10 @@ public Form Clone(Guid electionRoundId, Guid monitoringNgoId, string defaultLang
             defaultLanguage,
             languages,
             null,
+            DisplayOrder,
             Questions.Select(x => x.DeepClone().TrimTranslations(languages)).ToList());
     }
-    
+
     private LanguagesTranslationStatus ComputeLanguagesTranslationStatus()
     {
         var languagesTranslationStatus = new LanguagesTranslationStatus();

api/src/Vote.Monitor.Domain/Entities/FormTemplateAggregate/FormTemplate.cs

@@ -165,7 +165,8 @@ public void SetDefaultLanguage(string languageCode)
     public FormTemplate Duplicate() =>
         new(FormType, Code, DefaultLanguage, Name, Description, Languages, Questions);
 
-    public FormAggregate.Form Clone(Guid electionRoundId, Guid monitoringNgoId, string defaultLanguage, string[] languages)
+    public FormAggregate.Form Clone(Guid electionRoundId, Guid monitoringNgoId, string defaultLanguage,
+        string[] languages)
     {
         if (Status != FormTemplateStatus.Published)
         {
@@ -201,6 +202,7 @@ public FormAggregate.Form Clone(Guid electionRoundId, Guid monitoringNgoId, stri
             defaultLanguage,
             languages,
             null,
+            0,
             Questions.Select(x => x.DeepClone().TrimTranslations(languages)).ToList());
     }
 

api/src/Vote.Monitor.Domain/Entities/PollingStationInfoFormAggregate/PollingStationInformationForm.cs

@@ -25,7 +25,8 @@ private PollingStationInformationForm(
         languages,
         null,
         questions,
-        FormStatus.Published)
+        FormStatus.Published,
+        displayOrder: 0)
     {
     }