Support new Workflow Request event data structure.

Signed-off-by: Victor Chang <[email protected]>

Author: mocsharp

.editorconfig

@@ -1,4 +1,4 @@
-# Copyright 2022 MONAI Consortium
+# Copyright 2022-2023 MONAI Consortium
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -18,7 +18,7 @@
 root = true
 
 # Copyright File Header
-file_header_template                = SPDX-FileCopyrightText: © [year file created] - [last year file modified], MONAI Consortium\nSPDX-License-Identifier: Apache License 2.0
+file_header_template                = SPDX-FileCopyrightText: © [year file created] - [last year file modified], MONAI Consortium\nSPDX-License-Identifier: Apache License 2.0
 dotnet_diagnostic.IDE0073.severity  = error
 
 # Default settings:
@@ -309,3 +309,7 @@ max_line_length                 = 88
 [*.json]
 indent_size                     = 2
 insert_final_newline            = ignore
+
+
+# Spelling
+spelling_error_severity         = information

src/Api/Monai.Deploy.InformaticsGateway.Api.csproj

@@ -1,5 +1,5 @@
 <!--
-  ~ Copyright 2021-2022 MONAI Consortium
+  ~ Copyright 2021-2023 MONAI Consortium
   ~
   ~ Licensed under the Apache License, Version 2.0 (the "License");
   ~ you may not use this file except in compliance with the License.
@@ -31,7 +31,7 @@
     <PackageReference Include="fo-dicom" Version="5.1.1" />
     <PackageReference Include="Macross.Json.Extensions" Version="3.0.0" />
     <PackageReference Include="Microsoft.EntityFrameworkCore.Abstractions" Version="6.0.21" />
-    <PackageReference Include="Monai.Deploy.Messaging" Version="0.1.25" />
+    <PackageReference Include="Monai.Deploy.Messaging" Version="1.0.0" />
     <PackageReference Include="Monai.Deploy.Storage" Version="0.2.18" />
   </ItemGroup>
 

src/Api/Storage/DicomFileStorageMetadata.cs

@@ -17,6 +17,7 @@
 using System;
 using System.Text.Json.Serialization;
 using Ardalis.GuardClauses;
+using Monai.Deploy.Messaging.Events;
 
 namespace Monai.Deploy.InformaticsGateway.Api.Storage
 {
@@ -31,21 +32,6 @@ public sealed record DicomFileStorageMetadata : FileStorageMetadata
         public static readonly string DicomContentType = "application/dicom";
         public static readonly string DicomJsonContentType = System.Net.Mime.MediaTypeNames.Application.Json;
 
-        /// <summary>
-        /// The calling AE title of the DICOM instance.
-        /// For ACR, this is the Transaction ID of the original request.
-        /// Note: this value is same as <see cref="FileStorageMetadata.Source"/>
-        /// </summary>
-        [JsonIgnore]
-        public string CallingAeTitle { get => Source; }
-
-        /// <summary>
-        /// The MONAI AE Title that received the DICOM instance.
-        /// For ACR request, this field is empty.
-        /// </summary>
-        [JsonPropertyName("calledAeTitle")]
-        public string CalledAeTitle { get; set; } = default!;
-
         /// <summary>
         /// Gets or set the Study Instance UID of the DICOM instance.
         /// </summary>
@@ -95,7 +81,7 @@ public sealed record DicomFileStorageMetadata : FileStorageMetadata
         [JsonConstructor]
         public DicomFileStorageMetadata() { }
 
-        public DicomFileStorageMetadata(string associationId, string identifier, string studyInstanceUid, string seriesInstanceUid, string sopInstanceUid)
+        public DicomFileStorageMetadata(string associationId, string identifier, string studyInstanceUid, string seriesInstanceUid, string sopInstanceUid, DataService dataService, string callingAeTitle, string calledAeTitle)
             : base(associationId.ToString(), identifier)
         {
             Guard.Against.NullOrWhiteSpace(associationId, nameof(associationId));
@@ -120,6 +106,10 @@ public DicomFileStorageMetadata(string associationId, string identifier, string
                 UploadPath = $"{File.UploadPath}{DicomJsonFileExtension}",
                 ContentType = DicomJsonContentType,
             };
+
+            DataOrigin.DataService = dataService;
+            DataOrigin.Source = callingAeTitle;
+            DataOrigin.Destination = calledAeTitle;
         }
 
         public override void SetFailed()
@@ -128,4 +118,4 @@ public override void SetFailed()
             JsonFile.SetFailed();
         }
     }
-}
+}

src/Api/Storage/FhirFileStorageMetadata.cs

@@ -18,6 +18,7 @@
 using System.Text.Json.Serialization;
 using Ardalis.GuardClauses;
 using Monai.Deploy.InformaticsGateway.Api.Rest;
+using Monai.Deploy.Messaging.Events;
 
 namespace Monai.Deploy.InformaticsGateway.Api.Storage
 {
@@ -30,13 +31,6 @@ public sealed record FhirFileStorageMetadata : FileStorageMetadata
         public const string JsonFilExtension = ".json";
         public const string XmlFileExtension = ".xml";
 
-        /// <summary>
-        /// The transaction ID of the original ACR request.
-        /// Note: this value is same as <see cref="FileStorageMetadata.Source"/>
-        /// </summary>
-        [JsonIgnore]
-        public string TransactionId { get => Source; }
-
         /// <summary>
         /// Gets or set the FHIR resource type.
         /// </summary>
@@ -66,17 +60,20 @@ public sealed record FhirFileStorageMetadata : FileStorageMetadata
         [JsonConstructor]
         public FhirFileStorageMetadata() { }
 
-        public FhirFileStorageMetadata(string transactionId, string resourceType, string resourceId, FhirStorageFormat fhirFileFormat)
+        public FhirFileStorageMetadata(string transactionId, string resourceType, string resourceId, FhirStorageFormat fhirFileFormat, DataService dataType, string dataOrigin)
             : base(transactionId, $"{resourceType}{PathSeparator}{resourceId}")
         {
             Guard.Against.NullOrWhiteSpace(transactionId, nameof(transactionId));
             Guard.Against.NullOrWhiteSpace(resourceType, nameof(resourceType));
             Guard.Against.NullOrWhiteSpace(resourceId, nameof(resourceId));
 
-            Source = transactionId;
             ResourceType = resourceType;
             ResourceId = resourceId;
 
+            DataOrigin.DataService = dataType;
+            DataOrigin.Source = dataOrigin;
+            DataOrigin.Destination = IpAddress();
+
             var fileExtension = fhirFileFormat == FhirStorageFormat.Json ? JsonFilExtension : XmlFileExtension;
             File = new StorageObjectMetadata(fileExtension)
             {
@@ -86,4 +83,4 @@ public FhirFileStorageMetadata(string transactionId, string resourceType, string
             };
         }
     }
-}
+}

src/Api/Storage/FileStorageMetadata.cs

@@ -16,9 +16,11 @@
 
 using System;
 using System.Collections.Generic;
+using System.Net;
 using System.Text.Json.Serialization;
 using Ardalis.GuardClauses;
 using Microsoft.Extensions.Logging;
+using Monai.Deploy.Messaging.Events;
 
 namespace Monai.Deploy.InformaticsGateway.Api.Storage
 {
@@ -64,10 +66,10 @@ public abstract record FileStorageMetadata
         public string CorrelationId { get; set; } = default!;
 
         /// <summary>
-        /// Gets or sets the source of the file.
+        /// Gets or sets the data origin of this file.
         /// </summary>
-        [JsonPropertyName("source")]
-        public string Source { get; set; } = default!;
+        [JsonPropertyName("dataOrigin"), JsonInclude]
+        public DataOrigin DataOrigin { get; private set; }
 
         /// <summary>
         /// Gets a list of workflows designated for the file.
@@ -96,6 +98,12 @@ public abstract record FileStorageMetadata
         [JsonPropertyName("taskId")]
         public string? TaskId { get; set; }
 
+        /// <summary>
+        /// Gets or sets the PayloadId associated with this file.
+        /// </summary>
+        [JsonPropertyName("payloadId")]
+        public string? PayloadId { get; set; }
+
         /// <summary>
         /// DO NOT USE
         /// This constructor is intended for JSON serializer.
@@ -114,6 +122,7 @@ protected FileStorageMetadata(string correlationId, string identifier)
             Id = identifier;
             DateReceived = DateTime.UtcNow;
             Workflows = new List<string>();
+            DataOrigin = new DataOrigin();
         }
 
         /// <summary>
@@ -138,6 +147,19 @@ public void ChangeCorrelationId(ILogger logger, string correlationId)
             CorrelationId = correlationId;
         }
 
-        public string? PayloadId { get; set; }
+        public static string IpAddress()
+        {
+            var entry = Dns.GetHostEntry(Dns.GetHostName());
+
+            foreach (var ip in entry.AddressList)
+            {
+                if (ip.AddressFamily == System.Net.Sockets.AddressFamily.InterNetwork)
+                {
+                    return ip.ToString();
+                }
+            }
+
+            return "127.0.0.1";
+        }
     }
-}
+}

src/Api/Storage/Hl7FileStorageMetadata.cs

@@ -1,5 +1,5 @@
 /*
- * Copyright 2021-2022 MONAI Consortium
+ * Copyright 2021-2023 MONAI Consortium
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -17,6 +17,7 @@
 using System;
 using System.Text.Json.Serialization;
 using Ardalis.GuardClauses;
+using Monai.Deploy.Messaging.Events;
 
 namespace Monai.Deploy.InformaticsGateway.Api.Storage
 {
@@ -45,12 +46,14 @@ public sealed record Hl7FileStorageMetadata : FileStorageMetadata
         [JsonConstructor]
         public Hl7FileStorageMetadata() { }
 
-        public Hl7FileStorageMetadata(string connectionId)
+        public Hl7FileStorageMetadata(string connectionId, DataService dataType, string dataOrigin)
             : base(connectionId, Guid.NewGuid().ToString())
         {
             Guard.Against.NullOrWhiteSpace(connectionId, nameof(connectionId));
 
-            Source = connectionId;
+            DataOrigin.DataService = dataType;
+            DataOrigin.Source = dataOrigin;
+            DataOrigin.Destination = IpAddress();
 
             File = new StorageObjectMetadata(FileExtension)
             {
@@ -60,4 +63,4 @@ public Hl7FileStorageMetadata(string connectionId)
             };
         }
     }
-}
+}

src/Api/Storage/Payload.cs

@@ -19,6 +19,7 @@
 using System.Diagnostics;
 using System.Linq;
 using Ardalis.GuardClauses;
+using Monai.Deploy.Messaging.Events;
 
 namespace Monai.Deploy.InformaticsGateway.Api.Storage
 {
@@ -68,31 +69,29 @@ public enum PayloadState
 
         public string? TaskId { get; init; }
 
+        public DataOrigin DataTrigger { get; init; }
+
+        public HashSet<DataOrigin> DataOrigins { get; init; }
+
         public int Count { get => Files.Count; }
 
         public bool HasTimedOut { get => ElapsedTime().TotalSeconds >= Timeout; }
 
         public TimeSpan Elapsed
-        { get { return DateTime.UtcNow.Subtract(DateTimeCreated); } }
-
-        public string? CallingAeTitle { get => Files.OfType<DicomFileStorageMetadata>().Select(p => p.CallingAeTitle).FirstOrDefault(); }
-
-        public string? CalledAeTitle { get => Files.OfType<DicomFileStorageMetadata>().Select(p => p.CalledAeTitle).FirstOrDefault(); }
+        {
+            get { return DateTime.UtcNow.Subtract(DateTimeCreated); }
+        }
 
         public int FilesUploaded { get => Files.Count(p => p.IsUploaded); }
 
         public int FilesFailedToUpload { get => Files.Count(p => p.IsUploadFailed); }
 
-        public Payload(string key, string correlationId, uint timeout)
-            : this(key, correlationId, null, null, timeout)
-        {
-        }
-
-        public Payload(string key, string correlationId, string? workflowInstanceId, string? taskId, uint timeout)
+        public Payload(string key, string correlationId, string? workflowInstanceId, string? taskId, DataOrigin dataTrigger, uint timeout)
         {
             Guard.Against.NullOrWhiteSpace(key, nameof(key));
 
             Files = new List<FileStorageMetadata>();
+            DataOrigins = new HashSet<DataOrigin>();
             _lastReceived = new Stopwatch();
 
             CorrelationId = correlationId;
@@ -105,13 +104,20 @@ public Payload(string key, string correlationId, string? workflowInstanceId, str
             State = PayloadState.Created;
             RetryCount = 0;
             Timeout = timeout;
+            DataTrigger = dataTrigger;
         }
 
         public void Add(FileStorageMetadata value)
         {
             Guard.Against.Null(value, nameof(value));
 
             Files.Add(value);
+
+            if (!DataTrigger.Equals(value.DataOrigin))
+            {
+                DataOrigins.Add(value.DataOrigin);
+            }
+
             _lastReceived.Reset();
             _lastReceived.Start();
         }
@@ -152,4 +158,4 @@ public void Dispose()
             GC.SuppressFinalize(this);
         }
     }
-}
+}

src/Api/Test/Monai.Deploy.InformaticsGateway.Api.Test.csproj

@@ -1,5 +1,5 @@
 <!--
-  ~ Copyright 2021-2022 MONAI Consortium
+  ~ Copyright 2021-2023 MONAI Consortium
   ~
   ~ Licensed under the Apache License, Version 2.0 (the "License");
   ~ you may not use this file except in compliance with the License.
@@ -33,7 +33,7 @@
       <PrivateAssets>all</PrivateAssets>
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
     </PackageReference>
-    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.6.3" />
+    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.7.1" />
     <PackageReference Include="System.IO.Abstractions.TestingHelpers" Version="17.2.3" />
     <PackageReference Include="xRetry" Version="1.9.0" />
     <PackageReference Include="xunit" Version="2.5.0" />