constants

Author: KSemenenko

ManagedCode.Communication.Tests/Results/ResultJsonInteropTests.cs

@@ -47,7 +47,7 @@ internal static CollectionResult<T> CreateFailed(Problem problem, T[]? collectio
     ///     Whether the operation succeeded.
     /// </summary>
     [JsonInclude]
-    [JsonPropertyName("isSuccess")]
+    [JsonPropertyName(CommunicationJsonNames.IsSuccess)]
     [JsonPropertyOrder(1)]
     [MemberNotNullWhen(true, nameof(Collection))]
     [MemberNotNullWhen(false, nameof(Problem))]
@@ -63,7 +63,7 @@ internal static CollectionResult<T> CreateFailed(Problem problem, T[]? collectio
     /// <summary>
     ///     The items on this page. Empty when the result failed.
     /// </summary>
-    [JsonPropertyName("collection")]
+    [JsonPropertyName(CommunicationJsonNames.Collection)]
     [JsonPropertyOrder(2)]
     [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
     public T[] Collection { get; init; } = [];
@@ -77,33 +77,33 @@ internal static CollectionResult<T> CreateFailed(Problem problem, T[]? collectio
     /// <summary>
     ///     1-based index of this page.
     /// </summary>
-    [JsonPropertyName("pageNumber")]
+    [JsonPropertyName(CommunicationJsonNames.PageNumber)]
     [JsonPropertyOrder(3)]
     public int PageNumber { get; init; }
 
     /// <summary>
     ///     Maximum number of items per page.
     /// </summary>
-    [JsonPropertyName("pageSize")]
+    [JsonPropertyName(CommunicationJsonNames.PageSize)]
     [JsonPropertyOrder(4)]
     public int PageSize { get; init; }
 
     /// <summary>
     ///     Total number of items across all pages.
     /// </summary>
-    [JsonPropertyName("totalItems")]
+    [JsonPropertyName(CommunicationJsonNames.TotalItems)]
     [JsonPropertyOrder(5)]
     public int TotalItems { get; init; }
 
     /// <summary>
     ///     Total number of pages.
     /// </summary>
-    [JsonPropertyName("totalPages")]
+    [JsonPropertyName(CommunicationJsonNames.TotalPages)]
     [JsonPropertyOrder(6)]
     public int TotalPages { get; init; }
 
     [JsonInclude]
-    [JsonPropertyName("problem")]
+    [JsonPropertyName(CommunicationJsonNames.Problem)]
     [JsonPropertyOrder(7)]
     [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
     private Problem? _problem;

ManagedCode.Communication/CollectionResultT/CollectionResult.cs

@@ -33,76 +33,76 @@ protected Command(Guid commandId, string commandType)
     ///     Identity of the command. Generated as a time-ordered UUIDv7 unless supplied.
     /// </summary>
 
-    [JsonPropertyName("commandId")]
+    [JsonPropertyName(CommunicationJsonNames.CommandId)]
     [JsonPropertyOrder(1)]
     public Guid CommandId { get; set; }
     /// <summary>
     ///     Logical name of the command.
     /// </summary>
 
-    [JsonPropertyName("commandType")]
+    [JsonPropertyName(CommunicationJsonNames.CommandType)]
     [JsonPropertyOrder(2)]
     public string CommandType { get; set; }
     /// <summary>
     ///     When the command was created (UTC).
     /// </summary>
 
-    [JsonPropertyName("timestamp")]
+    [JsonPropertyName(CommunicationJsonNames.Timestamp)]
     [JsonPropertyOrder(3)]
     public DateTime Timestamp { get; set; } = DateTime.UtcNow;
     /// <summary>
     ///     Ties this command to every other operation in the same logical flow. Not generated — set it yourself.
     /// </summary>
 
-    [JsonPropertyName("correlationId")]
+    [JsonPropertyName(CommunicationJsonNames.CorrelationId)]
     [JsonPropertyOrder(4)]
     [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
     public string? CorrelationId { get; set; }
     /// <summary>
     ///     Identity of the command that caused this one. Not generated — set it yourself.
     /// </summary>
 
-    [JsonPropertyName("causationId")]
+    [JsonPropertyName(CommunicationJsonNames.CausationId)]
     [JsonPropertyOrder(5)]
     [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
     public string? CausationId { get; set; }
     /// <summary>
     ///     Distributed-tracing trace identifier.
     /// </summary>
 
-    [JsonPropertyName("traceId")]
+    [JsonPropertyName(CommunicationJsonNames.TraceId)]
     [JsonPropertyOrder(6)]
     [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
     public string? TraceId { get; set; }
     /// <summary>
     ///     Distributed-tracing span identifier.
     /// </summary>
 
-    [JsonPropertyName("spanId")]
+    [JsonPropertyName(CommunicationJsonNames.SpanId)]
     [JsonPropertyOrder(7)]
     [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
     public string? SpanId { get; set; }
     /// <summary>
     ///     User on whose behalf the command runs.
     /// </summary>
 
-    [JsonPropertyName("userId")]
+    [JsonPropertyName(CommunicationJsonNames.UserId)]
     [JsonPropertyOrder(8)]
     [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
     public string? UserId { get; set; }
     /// <summary>
     ///     Session the command belongs to.
     /// </summary>
 
-    [JsonPropertyName("sessionId")]
+    [JsonPropertyName(CommunicationJsonNames.SessionId)]
     [JsonPropertyOrder(9)]
     [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
     public string? SessionId { get; set; }
     /// <summary>
     ///     Execution policy and free-form metadata.
     /// </summary>
 
-    [JsonPropertyName("metadata")]
+    [JsonPropertyName(CommunicationJsonNames.Metadata)]
     [JsonPropertyOrder(10)]
     [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
     public CommandMetadata? Metadata { get; set; }

ManagedCode.Communication/Commands/Command.cs

@@ -23,108 +23,108 @@ public CommandMetadata()
     /// <summary>
     ///     Schema version of this metadata, so consumers can evolve the shape.
     /// </summary>
-    [JsonPropertyName("version")]
+    [JsonPropertyName(CommunicationJsonNames.Version)]
     public uint Version { get; set; } = 1;
 
     /// <summary>
     ///     Arbitrary properties attached by the application.
     /// </summary>
-    [JsonPropertyName("properties")]
+    [JsonPropertyName(CommunicationJsonNames.Properties)]
     public Dictionary<string, object?> Properties { get; set; }
 
     /// <summary>
     ///     Who or what issued the command.
     /// </summary>
-    [JsonPropertyName("initiatedBy")]
+    [JsonPropertyName(CommunicationJsonNames.InitiatedBy)]
     public string? InitiatedBy { get; set; }
 
     /// <summary>
     ///     System or component the command came from.
     /// </summary>
-    [JsonPropertyName("source")]
+    [JsonPropertyName(CommunicationJsonNames.Source)]
     public string? Source { get; set; }
 
     /// <summary>
     ///     System or component the command is aimed at.
     /// </summary>
-    [JsonPropertyName("target")]
+    [JsonPropertyName(CommunicationJsonNames.Target)]
     public string? Target { get; set; }
 
     /// <summary>
     ///     Caller's IP address, when known.
     /// </summary>
-    [JsonPropertyName("ipAddress")]
+    [JsonPropertyName(CommunicationJsonNames.IpAddress)]
     public string? IpAddress { get; set; }
 
     /// <summary>
     ///     Caller's user agent, when known.
     /// </summary>
-    [JsonPropertyName("userAgent")]
+    [JsonPropertyName(CommunicationJsonNames.UserAgent)]
     public string? UserAgent { get; set; }
 
     /// <summary>
     ///     Session the command belongs to.
     /// </summary>
-    [JsonPropertyName("sessionId")]
+    [JsonPropertyName(CommunicationJsonNames.SessionId)]
     public string? SessionId { get; set; }
 
     /// <summary>
     ///     Distributed-tracing trace identifier.
     /// </summary>
-    [JsonPropertyName("traceId")]
+    [JsonPropertyName(CommunicationJsonNames.TraceId)]
     public string? TraceId { get; set; }
 
     /// <summary>
     ///     Distributed-tracing span identifier.
     /// </summary>
-    [JsonPropertyName("spanId")]
+    [JsonPropertyName(CommunicationJsonNames.SpanId)]
     public string? SpanId { get; set; }
 
     /// <summary>
     ///     Relative execution priority. Defaults to <c>Normal</c>.
     /// </summary>
-    [JsonPropertyName("priority")]
+    [JsonPropertyName(CommunicationJsonNames.Priority)]
     public CommandPriority Priority { get; set; } = CommandPriority.Normal;
 
     /// <summary>
     ///     How many times execution has already been retried.
     /// </summary>
-    [JsonPropertyName("retryCount")]
+    [JsonPropertyName(CommunicationJsonNames.RetryCount)]
     public int RetryCount { get; set; }
 
     /// <summary>
     ///     Retry budget before the command is abandoned. Defaults to 3.
     /// </summary>
-    [JsonPropertyName("maxRetries")]
+    [JsonPropertyName(CommunicationJsonNames.MaxRetries)]
     public int MaxRetries { get; set; } = 3;
 
     /// <summary>
     ///     Execution timeout in seconds. Defaults to 30.
     /// </summary>
-    [JsonPropertyName("timeoutSeconds")]
+    [JsonPropertyName(CommunicationJsonNames.TimeoutSeconds)]
     public int TimeoutSeconds { get; set; } = 30;
 
     /// <summary>
     ///     How long execution took, filled in once the command completes.
     /// </summary>
-    [JsonPropertyName("executionTime")]
+    [JsonPropertyName(CommunicationJsonNames.ExecutionTime)]
     public TimeSpan ExecutionTime { get; set; }
 
     /// <summary>
     ///     How long the command stays valid; <c>null</c> means it does not expire.
     /// </summary>
-    [JsonPropertyName("timeToLiveSeconds")]
+    [JsonPropertyName(CommunicationJsonNames.TimeToLiveSeconds)]
     public int? TimeToLiveSeconds { get; set; }
 
     /// <summary>
     ///     String tags for routing, filtering or reporting.
     /// </summary>
-    [JsonPropertyName("tags")]
+    [JsonPropertyName(CommunicationJsonNames.Tags)]
     public Dictionary<string, string> Tags { get; set; }
 
     /// <summary>
     ///     Extension slot for data that does not fit the fields above.
     /// </summary>
-    [JsonPropertyName("extensions")]
+    [JsonPropertyName(CommunicationJsonNames.Extensions)]
     public Dictionary<string, object?> Extensions { get; set; }
 }

ManagedCode.Communication/Commands/CommandMetadata.cs

@@ -45,84 +45,84 @@ protected Command(Guid commandId, string commandType, T? value)
     ///     Identity of the command. Generated as a time-ordered UUIDv7 unless supplied.
     /// </summary>
 
-    [JsonPropertyName("commandId")]
+    [JsonPropertyName(CommunicationJsonNames.CommandId)]
     [JsonPropertyOrder(1)]
     public Guid CommandId { get; set; }
     /// <summary>
     ///     Logical name of the command.
     /// </summary>
 
-    [JsonPropertyName("commandType")]
+    [JsonPropertyName(CommunicationJsonNames.CommandType)]
     [JsonPropertyOrder(2)]
     public string CommandType { get; set; }
     /// <summary>
     ///     The payload.
     /// </summary>
 
-    [JsonPropertyName("value")]
+    [JsonPropertyName(CommunicationJsonNames.Value)]
     [JsonPropertyOrder(3)]
     [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
     public T? Value { get; set; }
     /// <summary>
     ///     When the command was created (UTC).
     /// </summary>
 
-    [JsonPropertyName("timestamp")]
+    [JsonPropertyName(CommunicationJsonNames.Timestamp)]
     [JsonPropertyOrder(4)]
     public DateTime Timestamp { get; set; } = DateTime.UtcNow;
     /// <summary>
     ///     Ties this command to every other operation in the same logical flow. Not generated — set it yourself.
     /// </summary>
 
-    [JsonPropertyName("correlationId")]
+    [JsonPropertyName(CommunicationJsonNames.CorrelationId)]
     [JsonPropertyOrder(5)]
     [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
     public string? CorrelationId { get; set; }
     /// <summary>
     ///     Identity of the command that caused this one. Not generated — set it yourself.
     /// </summary>
 
-    [JsonPropertyName("causationId")]
+    [JsonPropertyName(CommunicationJsonNames.CausationId)]
     [JsonPropertyOrder(6)]
     [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
     public string? CausationId { get; set; }
     /// <summary>
     ///     Distributed-tracing trace identifier.
     /// </summary>
 
-    [JsonPropertyName("traceId")]
+    [JsonPropertyName(CommunicationJsonNames.TraceId)]
     [JsonPropertyOrder(7)]
     [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
     public string? TraceId { get; set; }
     /// <summary>
     ///     Distributed-tracing span identifier.
     /// </summary>
 
-    [JsonPropertyName("spanId")]
+    [JsonPropertyName(CommunicationJsonNames.SpanId)]
     [JsonPropertyOrder(8)]
     [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
     public string? SpanId { get; set; }
     /// <summary>
     ///     User on whose behalf the command runs.
     /// </summary>
 
-    [JsonPropertyName("userId")]
+    [JsonPropertyName(CommunicationJsonNames.UserId)]
     [JsonPropertyOrder(9)]
     [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
     public string? UserId { get; set; }
     /// <summary>
     ///     Session the command belongs to.
     /// </summary>
 
-    [JsonPropertyName("sessionId")]
+    [JsonPropertyName(CommunicationJsonNames.SessionId)]
     [JsonPropertyOrder(10)]
     [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
     public string? SessionId { get; set; }
     /// <summary>
     ///     Execution policy and free-form metadata.
     /// </summary>
 
-    [JsonPropertyName("metadata")]
+    [JsonPropertyName(CommunicationJsonNames.Metadata)]
     [JsonPropertyOrder(11)]
     [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
     public CommandMetadata? Metadata { get; set; }