feat: Add idempotentId

docs/schema/V1/schema.verified.graphql

@@ -406,4 +406,4 @@ scalar DateTime @specifiedBy(url: "https:\/\/www.graphql-scalars.com\/date-time"
 
 scalar URL @specifiedBy(url: "https:\/\/tools.ietf.org\/html\/rfc3986")
 
-scalar UUID @specifiedBy(url: "https:\/\/tools.ietf.org\/html\/rfc4122")
+scalar UUID @specifiedBy(url: "https:\/\/tools.ietf.org\/html\/rfc4122")

docs/schema/V1/swagger.verified.json

@@ -2323,6 +2323,11 @@
             "nullable": true,
             "type": "string"
           },
+          "idempotentKey": {
+            "description": "A self-defined Id may be provided to support idempotent creation of dialogs.",
+            "nullable": true,
+            "type": "string"
+          },
           "party": {
             "description": "The party code representing the organization or person that the dialog belongs to in URN format.",
             "example": "urn:altinn:person:identifier-no:01125512345\nurn:altinn:organization:identifier-no:912345678",
@@ -3406,6 +3411,11 @@
             "format": "guid",
             "type": "string"
           },
+          "idempotentKey": {
+            "description": "A self-defined Id may be provided to support idempotent creation of dialogs.\n            ",
+            "nullable": true,
+            "type": "string"
+          },
           "org": {
             "description": "The service owner code representing the organization (service owner) related to this dialog.",
             "example": "ske",
@@ -4057,6 +4067,11 @@
             "format": "guid",
             "type": "string"
           },
+          "idempotentKey": {
+            "description": "A self-defined Id may be provided to support idempotent creation of dialogs.\n            ",
+            "nullable": true,
+            "type": "string"
+          },
           "latestActivity": {
             "description": "The latest entry in the dialog\u0027s activity log.",
             "nullable": true,
@@ -5569,6 +5584,15 @@
         "description": "Performs a search for dialogs, returning a paginated list of dialogs. For more information see the documentation (link TBD).\n\n* All date parameters must contain explicit time zone. Example: 2023-10-27T10:00:00Z or 2023-10-27T10:00:00\u002B01:00\n* See \u0022continuationToken\u0022 in the response for how to get the next page of results.\n* hasNextPage will be set to true if there are more items to get.",
         "operationId": "V1ServiceOwnerDialogsSearch_SearchDialog",
         "parameters": [
+          {
+            "description": "Filter by IdempotentKey ",
+            "in": "query",
+            "name": "idempotentKey",
+            "schema": {
+              "nullable": true,
+              "type": "string"
+            }
+          },
           {
             "description": "Filter by one or more service resources",
             "explode": true,
@@ -5872,6 +5896,9 @@
           "403": {
             "description": "Unauthorized to create a dialog for the given serviceResource (not owned by authenticated organization or has additional scope requirements defined in policy)."
           },
+          "409": {
+            "description": "Dialog with IdempotentKey 01941821-ffca-73a1-9335-435a882be014 has already been created."
+          },
           "422": {
             "content": {
               "application/problem\u002Bjson": {

src/Digdir.Domain.Dialogporten.Application/Common/ReturnTypes/Conflict.cs

@@ -0,0 +1,13 @@
+using FluentValidation.Results;
+
+namespace Digdir.Domain.Dialogporten.Application.Common.ReturnTypes;
+
+public sealed record Conflict(IEnumerable<ConflictError> Conflicts)
+{
+    public Conflict(ConflictError error) : this([error]) { }
+    public List<ValidationFailure> ToValidationResults() => Conflicts
+        .Select(x => new ValidationFailure(x.PropertyName, x.ErrorMessage))
+        .ToList();
+}
+
+public sealed record ConflictError(string PropertyName, string ErrorMessage);

src/Digdir.Domain.Dialogporten.Application/Externals/IDialogDbContext.cs

@@ -45,6 +45,7 @@ public interface IDialogDbContext
     DbSet<LabelAssignmentLog> LabelAssignmentLogs { get; }
     DbSet<ResourcePolicyInformation> ResourcePolicyInformation { get; }
 
+
     /// <summary>
     /// Validate a property on the <typeparamref name="TEntity"/> using a lambda
     /// expression to specify the predicate only when the property is modified.

src/Digdir.Domain.Dialogporten.Application/Features/V1/ServiceOwner/Dialogs/Commands/Create/CreateDialogCommand.cs

@@ -14,6 +14,7 @@
 using Digdir.Domain.Dialogporten.Domain.Parties;
 using Digdir.Library.Entity.Abstractions.Features.Identifiable;
 using MediatR;
+using Microsoft.EntityFrameworkCore;
 using OneOf;
 using OneOf.Types;
 
@@ -22,7 +23,7 @@ namespace Digdir.Domain.Dialogporten.Application.Features.V1.ServiceOwner.Dialog
 public sealed class CreateDialogCommand : CreateDialogDto, IRequest<CreateDialogResult>;
 
 [GenerateOneOf]
-public sealed partial class CreateDialogResult : OneOfBase<Success<Guid>, DomainError, ValidationError, Forbidden>;
+public sealed partial class CreateDialogResult : OneOfBase<Success<Guid>, DomainError, ValidationError, Forbidden, Conflict>;
 
 internal sealed class CreateDialogCommandHandler : IRequestHandler<CreateDialogCommand, CreateDialogResult>
 {
@@ -74,6 +75,23 @@ public async Task<CreateDialogResult> Handle(CreateDialogCommand request, Cancel
             dialog.Org = serviceResourceInformation.OwnOrgShortName;
         }
 
+        if (request.IdempotentKey is not null && !string.IsNullOrEmpty(dialog.Org))
+        {
+            var dialogId = await _db.Dialogs
+                .Where(x => x.IdempotentKey == request.IdempotentKey && x.Org == dialog.Org)
+                .Select(x => x.Id)
+                .FirstOrDefaultAsync(cancellationToken);
+
+            if (dialogId != default)
+            {
+                return new Conflict(
+                    new ConflictError(
+                        nameof(request.IdempotentKey),
+                        $"'{request.IdempotentKey}' already exists with DialogId '{dialogId}'"
+                    ));
+            }
+        }
+
         CreateDialogEndUserContext(request, dialog);
         await EnsureNoExistingUserDefinedIds(dialog, cancellationToken);
 

src/Digdir.Domain.Dialogporten.Application/Features/V1/ServiceOwner/Dialogs/Commands/Create/CreateDialogCommandValidator.cs

@@ -44,6 +44,9 @@ public CreateDialogCommandValidator(
                 .WithMessage($"'{{PropertyName}}' must be greater than or equal to '{nameof(CreateDialogCommand.CreatedAt)}'.")
                 .When(x => x.CreatedAt != default && x.UpdatedAt != default);
 
+        RuleFor(x => x.IdempotentKey)
+            .MaximumLength(36);
+
         RuleFor(x => x.ServiceResource)
             .NotNull()
             .IsValidUri()

src/Digdir.Domain.Dialogporten.Application/Features/V1/ServiceOwner/Dialogs/Commands/Create/CreateDialogDto.cs

@@ -19,6 +19,11 @@ public class CreateDialogDto
     /// <example>01913cd5-784f-7d3b-abef-4c77b1f0972d</example>
     public Guid? Id { get; set; }
 
+    /// <summary>
+    /// A self-defined Id may be provided to support idempotent creation of dialogs.
+    /// </summary>
+    public string? IdempotentKey { get; set; }
+
     /// <summary>
     /// The service identifier for the service that the dialog is related to in URN-format.
     /// This corresponds to a resource in the Altinn Resource Registry, which the authenticated organization

src/Digdir.Domain.Dialogporten.Application/Features/V1/ServiceOwner/Dialogs/Commands/Purge/PurgeDialogCommand.cs

@@ -56,7 +56,6 @@ public async Task<PurgeDialogResult> Handle(PurgeDialogCommand request, Cancella
         {
             return new Forbidden($"User cannot modify resource type {dialog.ServiceResourceType}.");
         }
-
         _db.Dialogs.HardRemove(dialog);
         var saveResult = await _unitOfWork
             .EnableConcurrencyCheck(dialog, request.IfMatchDialogRevision)

src/Digdir.Domain.Dialogporten.Application/Features/V1/ServiceOwner/Dialogs/Queries/Get/DialogDto.cs

@@ -19,6 +19,11 @@ public sealed class DialogDto
     /// <example>01913cd5-784f-7d3b-abef-4c77b1f0972d</example>
     public Guid Id { get; set; }
 
+    /// <summary>
+    ///  A self-defined Id may be provided to support idempotent creation of dialogs.
+    /// </summary>
+    public string? IdempotentKey { get; set; }
+
     /// <summary>
     /// The unique identifier for the revision in UUIDv4 format.
     /// </summary>
@@ -270,7 +275,6 @@ public sealed class DialogSeenLogDto
     public bool IsCurrentEndUser { get; set; }
 }
 
-
 public sealed class ContentDto
 {
     /// <summary>
@@ -372,7 +376,6 @@ public sealed class DialogActivityDto
     public List<LocalizationDto> Description { get; set; } = [];
 }
 
-
 public sealed class DialogApiActionDto
 {
     /// <summary>

src/Digdir.Domain.Dialogporten.Application/Features/V1/ServiceOwner/Dialogs/Queries/Search/DialogDtoBase.cs

@@ -14,6 +14,11 @@ public class DialogDtoBase
     /// <example>01913cd5-784f-7d3b-abef-4c77b1f0972d</example>
     public Guid Id { get; set; }
 
+    /// <summary>
+    ///  A self-defined Id may be provided to support idempotent creation of dialogs.
+    /// </summary>
+    public string? IdempotentKey { get; set; }
+
     /// <summary>
     /// The service owner code representing the organization (service owner) related to this dialog.
     /// </summary>
@@ -158,7 +163,6 @@ public sealed class DialogSeenLogDto
     public bool IsCurrentEndUser { get; set; }
 }
 
-
 public sealed class DialogActivityDto
 {
     /// <summary>
@@ -198,4 +202,3 @@ public sealed class DialogActivityDto
     /// </summary>
     public List<LocalizationDto> Description { get; set; } = [];
 }
-

src/Digdir.Domain.Dialogporten.Application/Features/V1/ServiceOwner/Dialogs/Queries/Search/SearchDialogQuery.cs

@@ -21,6 +21,10 @@ public sealed class SearchDialogQuery : SortablePaginationParameter<SearchDialog
 {
     private string? _searchLanguageCode;
 
+    /// <summary>
+    /// Filter by IdempotentKey 
+    /// </summary>
+    public string? IdempotentKey { get; set; }
     /// <summary>
     /// Filter by one or more service resources
     /// </summary>
@@ -169,6 +173,7 @@ public async Task<SearchDialogResult> Handle(SearchDialogQuery request, Cancella
         var paginatedList = await dialogQuery
             .Include(x => x.Content)
             .ThenInclude(x => x.Value.Localizations)
+            .WhereIf(request.IdempotentKey is not null, x => x.IdempotentKey != null && x.IdempotentKey == request.IdempotentKey)
             .WhereIf(!request.ServiceResource.IsNullOrEmpty(),
                 x => request.ServiceResource!.Contains(x.ServiceResource))
             .WhereIf(!request.Party.IsNullOrEmpty(), x => request.Party!.Contains(x.Party))

src/Digdir.Domain.Dialogporten.Application/Features/V1/ServiceOwner/Dialogs/Queries/Search/SearchDialogQueryValidator.cs

@@ -19,6 +19,10 @@ public SearchDialogQueryValidator()
             .MinimumLength(3)
             .When(x => x.Search is not null);
 
+        RuleFor(x => x.IdempotentKey)
+            .MaximumLength(36)
+            .WithMessage("'{{PropertyName}}' can't be longer than 36 characters.");
+
         RuleFor(x => x.SearchLanguageCode)
             .Must(x => x is null || Localization.IsValidCultureCode(x))
             .WithMessage(searchQuery =>

src/Digdir.Domain.Dialogporten.Domain/Dialogs/Entities/DialogEntity.cs

@@ -23,6 +23,7 @@ public sealed class DialogEntity :
 {
     public Guid Id { get; set; }
     public Guid Revision { get; set; }
+    public string? IdempotentKey { get; set; }
     public DateTimeOffset CreatedAt { get; set; }
     public DateTimeOffset UpdatedAt { get; set; }
     public bool Deleted { get; set; }

src/Digdir.Domain.Dialogporten.GraphQL/EndUser/DialogById/ObjectTypes.cs

@@ -1,5 +1,6 @@
 using Digdir.Domain.Dialogporten.GraphQL.EndUser.Common;
 using Digdir.Domain.Dialogporten.GraphQL.EndUser.MutationTypes;
+using DialogStatus = Digdir.Domain.Dialogporten.GraphQL.EndUser.Common.DialogStatus;
 
 namespace Digdir.Domain.Dialogporten.GraphQL.EndUser.DialogById;
 

src/Digdir.Domain.Dialogporten.Infrastructure/Persistence/Configurations/Dialogs/DialogEntityConfiguration.cs

@@ -22,5 +22,7 @@ public void Configure(EntityTypeBuilder<DialogEntity> builder)
         builder.HasIndex(x => x.ServiceResource);
         builder.HasIndex(x => x.Party);
         builder.HasIndex(x => x.Process);
+        builder.Property(x => x.IdempotentKey).HasMaxLength(36);
+        builder.HasIndex(x => new { x.Org, x.IdempotentKey }).IsUnique().HasFilter(null);
     }
 }

src/Digdir.Domain.Dialogporten.Infrastructure/Persistence/DialogDbContext.cs

@@ -110,6 +110,7 @@ protected override void OnModelCreating(ModelBuilder modelBuilder)
         // Explicitly configure the Actor entity so that it will register as TPH in the database
         modelBuilder.Entity<Actor>();
 
+
         modelBuilder
             .RemovePluralizingTableNameConvention()
             .AddAuditableEntities()