gh-434 New APIs to get a list of input/output data plug-ins

New PluginAttribute to provide names for the plug-ins

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

Author: mocsharp

src/Api/PluginNameAttribute.cs

@@ -0,0 +1,33 @@
+/*
+ * Copyright 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.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+using System;
+using Ardalis.GuardClauses;
+
+namespace Monai.Deploy.InformaticsGateway.Api
+{
+    public class PluginNameAttribute : Attribute
+    {
+        public string Name { get; set; }
+
+        public PluginNameAttribute(string name)
+        {
+            Guard.Against.NullOrWhiteSpace(name, nameof(name));
+
+            Name = name;
+        }
+    }
+}

src/InformaticsGateway/Logging/Log.5000.DataPlugins.cs

@@ -0,0 +1,30 @@
+/*
+ * Copyright 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.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+using Microsoft.Extensions.Logging;
+
+namespace Monai.Deploy.InformaticsGateway.Logging
+{
+    public static partial class Log
+    {
+        [LoggerMessage(EventId = 5000, Level = LogLevel.Information, Message = "Loading assembly from {filename}.")]
+        public static partial void LoadingAssembly(this ILogger logger, string filename);
+
+        [LoggerMessage(EventId = 5001, Level = LogLevel.Information, Message = "{type} data plug-in found {name}: {plugin}.")]
+        public static partial void DataPluginFound(this ILogger logger, string type, string name, string plugin);
+
+    }
+}

src/InformaticsGateway/Logging/Log.8000.HttpServices.cs

@@ -42,6 +42,9 @@ public static partial class Log
         [LoggerMessage(EventId = 8005, Level = LogLevel.Information, Message = "MONAI SCP AE Title {name} updated AE Title={aeTitle}.")]
         public static partial void MonaiApplicationEntityUpdated(this ILogger logger, string name, string aeTitle);
 
+        [LoggerMessage(EventId = 8006, Level = LogLevel.Error, Message = "Error reading data input plug-ins.")]
+        public static partial void ErrorReadingDataInputPlugins(this ILogger logger, Exception ex);
+
 
         // Destination AE Title Controller
         [LoggerMessage(EventId = 8010, Level = LogLevel.Information, Message = "DICOM destination added AE Title={aeTitle}, Host/IP={hostIp}.")]

src/InformaticsGateway/Program.cs

@@ -113,6 +113,8 @@ internal static IHostBuilder CreateHostBuilder(string[] args) =>
                     services.AddScoped<IPayloadNotificationActionHandler, PayloadNotificationActionHandler>();
                     services.AddScoped<IInputDataPluginEngine, InputDataPluginEngine>();
                     services.AddScoped<IOutputDataPluginEngine, OutputDataPluginEngine>();
+                    services.AddScoped<IDataPluginEngineFactory<IInputDataPlugin>, InputDataPluginEngineFactory>();
+                    services.AddScoped<IDataPluginEngineFactory<IOutputDataPlugin>, OutputDataPluginEngineFactory>();
 
                     services.AddMonaiDeployStorageService(hostContext.Configuration.GetSection("InformaticsGateway:storage:serviceAssemblyName").Value, Monai.Deploy.Storage.HealthCheckOptions.ServiceHealthCheck);
 

src/InformaticsGateway/Services/Common/IInputDataPluginEngineFactory.cs

@@ -0,0 +1,116 @@
+/*
+ * Copyright 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.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+using System;
+using System.Collections.Generic;
+using System.IO.Abstractions;
+using System.Linq;
+using System.Reflection;
+using Ardalis.GuardClauses;
+using Microsoft.Extensions.Logging;
+using Monai.Deploy.InformaticsGateway.Api;
+using Monai.Deploy.InformaticsGateway.Common;
+using Monai.Deploy.InformaticsGateway.Logging;
+
+namespace Monai.Deploy.InformaticsGateway.Services.Common
+{
+    public interface IDataPluginEngineFactory<T>
+    {
+        IReadOnlyDictionary<string, string> RegisteredPlugins();
+    }
+
+    public abstract class DataPluginEngineFactoryBase<T> : IDataPluginEngineFactory<T>
+    {
+        private readonly IFileSystem _fileSystem;
+        private readonly ILogger<DataPluginEngineFactoryBase<T>> _logger;
+        private readonly Type _type;
+
+        /// <summary>
+        /// A dictionary mapping of input data plug-ins where:
+        /// key: <see cref="PluginNameAttribute.Name"/> if available or name of the class.
+        /// value: fully qualified assembly type
+        /// </summary>
+        private readonly Dictionary<string, string> _cachedTypeNames;
+
+        public DataPluginEngineFactoryBase(IFileSystem fileSystem, ILogger<DataPluginEngineFactoryBase<T>> logger)
+        {
+            _fileSystem = fileSystem ?? throw new ArgumentNullException(nameof(fileSystem));
+            _logger = logger ?? throw new System.ArgumentNullException(nameof(logger));
+            _type = typeof(T);
+            _cachedTypeNames = new Dictionary<string, string>();
+        }
+
+        public IReadOnlyDictionary<string, string> RegisteredPlugins()
+        {
+            LoadAssembliesFromPluginDirectory();
+
+            var types = AppDomain.CurrentDomain.GetAssemblies()
+                .SelectMany(s => s.GetTypes())
+                .Where(p => _type.IsAssignableFrom(p) && p != _type).ToList();
+
+            AddToCache(types);
+
+            return _cachedTypeNames;
+        }
+
+        private void AddToCache(List<Type> types)
+        {
+            Guard.Against.Null(types, nameof(types));
+
+            if (types.Any())
+            {
+                types.ForEach(p =>
+                {
+                    if (!_cachedTypeNames.ContainsValue(p.AssemblyQualifiedName))
+                    {
+                        var nameAttribute = p.GetCustomAttribute<PluginNameAttribute>();
+
+                        var name = nameAttribute is null ? p.Name : nameAttribute.Name;
+                        _cachedTypeNames.Add(name, p.AssemblyQualifiedName);
+                        _logger.DataPluginFound(_type.Name, name, p.AssemblyQualifiedName);
+                    }
+                });
+            }
+        }
+
+        private void LoadAssembliesFromPluginDirectory()
+        {
+            var files = _fileSystem.Directory.GetFiles(SR.PlugInDirectoryPath, "*.dll", System.IO.SearchOption.TopDirectoryOnly);
+
+            foreach (var file in files)
+            {
+                _logger.LoadingAssembly(file);
+                var assembly = Assembly.LoadFile(file);
+                var matchingTypes = assembly.GetTypes().Where(p => _type.IsAssignableFrom(p) && p != _type).ToList();
+                AddToCache(matchingTypes);
+            }
+        }
+    }
+
+    public class InputDataPluginEngineFactory : DataPluginEngineFactoryBase<IInputDataPlugin>
+    {
+        public InputDataPluginEngineFactory(IFileSystem fileSystem, ILogger<DataPluginEngineFactoryBase<IInputDataPlugin>> logger) : base(fileSystem, logger)
+        {
+        }
+    }
+
+    public class OutputDataPluginEngineFactory : DataPluginEngineFactoryBase<IOutputDataPlugin>
+    {
+        public OutputDataPluginEngineFactory(IFileSystem fileSystem, ILogger<DataPluginEngineFactoryBase<IOutputDataPlugin>> logger) : base(fileSystem, logger)
+        {
+        }
+    }
+}

src/InformaticsGateway/Services/Http/DestinationAeTitleController.cs

@@ -27,6 +27,7 @@
 using Monai.Deploy.InformaticsGateway.Configuration;
 using Monai.Deploy.InformaticsGateway.Database.Api.Repositories;
 using Monai.Deploy.InformaticsGateway.Logging;
+using Monai.Deploy.InformaticsGateway.Services.Common;
 using Monai.Deploy.InformaticsGateway.Services.Scu;
 
 namespace Monai.Deploy.InformaticsGateway.Services.Http
@@ -37,16 +38,19 @@ public class DestinationAeTitleController : ControllerBase
     {
         private readonly ILogger<DestinationAeTitleController> _logger;
         private readonly IDestinationApplicationEntityRepository _repository;
+        private readonly IDataPluginEngineFactory<IOutputDataPlugin> _outputDataPluginEngineFactory;
         private readonly IScuQueue _scuQueue;
 
         public DestinationAeTitleController(
             ILogger<DestinationAeTitleController> logger,
             IDestinationApplicationEntityRepository repository,
-            IScuQueue scuQueue)
+            IScuQueue scuQueue,
+            IDataPluginEngineFactory<IOutputDataPlugin> outputDataPluginEngineFactory)
         {
             _logger = logger ?? throw new ArgumentNullException(nameof(logger));
             _repository = repository ?? throw new ArgumentNullException(nameof(repository));
             _scuQueue = scuQueue ?? throw new ArgumentNullException(nameof(scuQueue));
+            _outputDataPluginEngineFactory = outputDataPluginEngineFactory ?? throw new ArgumentNullException(nameof(outputDataPluginEngineFactory));
         }
 
         [HttpGet]
@@ -253,6 +257,23 @@ public async Task<ActionResult<DestinationApplicationEntity>> Delete(string name
             }
         }
 
+        [HttpGet("plug-ins")]
+        [Produces("application/json")]
+        [ProducesResponseType(StatusCodes.Status200OK)]
+        [ProducesResponseType(StatusCodes.Status500InternalServerError)]
+        public ActionResult<MonaiApplicationEntity> GetPlugins()
+        {
+            try
+            {
+                return Ok(_outputDataPluginEngineFactory.RegisteredPlugins());
+            }
+            catch (Exception ex)
+            {
+                _logger.ErrorReadingDataInputPlugins(ex);
+                return Problem(title: "Error reading data input plug-ins.", statusCode: (int)System.Net.HttpStatusCode.InternalServerError, detail: ex.Message);
+            }
+        }
+
         private async Task ValidateCreateAsync(DestinationApplicationEntity item)
         {
             if (await _repository.ContainsAsync(p => p.Name.Equals(item.Name), HttpContext.RequestAborted).ConfigureAwait(false))

src/InformaticsGateway/Services/Http/MonaiAeTitleController.cs

@@ -19,7 +19,6 @@
 using System.Linq;
 using System.Net.Mime;
 using System.Threading.Tasks;
-using Amazon.Runtime.Internal;
 using Ardalis.GuardClauses;
 using Microsoft.AspNetCore.Http;
 using Microsoft.AspNetCore.Mvc;
@@ -29,6 +28,7 @@
 using Monai.Deploy.InformaticsGateway.Configuration;
 using Monai.Deploy.InformaticsGateway.Database.Api.Repositories;
 using Monai.Deploy.InformaticsGateway.Logging;
+using Monai.Deploy.InformaticsGateway.Services.Common;
 using Monai.Deploy.InformaticsGateway.Services.Scp;
 
 namespace Monai.Deploy.InformaticsGateway.Services.Http
@@ -39,15 +39,18 @@ public class MonaiAeTitleController : ControllerBase
     {
         private readonly ILogger<MonaiAeTitleController> _logger;
         private readonly IMonaiApplicationEntityRepository _repository;
+        private readonly IDataPluginEngineFactory<IInputDataPlugin> _inputDataPluginEngineFactory;
         private readonly IMonaiAeChangedNotificationService _monaiAeChangedNotificationService;
 
         public MonaiAeTitleController(
             ILogger<MonaiAeTitleController> logger,
             IMonaiAeChangedNotificationService monaiAeChangedNotificationService,
-            IMonaiApplicationEntityRepository repository)
+            IMonaiApplicationEntityRepository repository,
+            IDataPluginEngineFactory<IInputDataPlugin> inputDataPluginEngineFactory)
         {
             _logger = logger ?? throw new ArgumentNullException(nameof(logger));
             _repository = repository ?? throw new ArgumentNullException(nameof(repository));
+            _inputDataPluginEngineFactory = inputDataPluginEngineFactory ?? throw new ArgumentNullException(nameof(inputDataPluginEngineFactory));
             _monaiAeChangedNotificationService = monaiAeChangedNotificationService ?? throw new ArgumentNullException(nameof(monaiAeChangedNotificationService));
         }
 
@@ -205,6 +208,23 @@ public async Task<ActionResult<MonaiApplicationEntity>> Delete(string name)
             }
         }
 
+        [HttpGet("plug-ins")]
+        [Produces("application/json")]
+        [ProducesResponseType(StatusCodes.Status200OK)]
+        [ProducesResponseType(StatusCodes.Status500InternalServerError)]
+        public ActionResult<MonaiApplicationEntity> GetPlugins()
+        {
+            try
+            {
+                return Ok(_inputDataPluginEngineFactory.RegisteredPlugins());
+            }
+            catch (Exception ex)
+            {
+                _logger.ErrorReadingDataInputPlugins(ex);
+                return Problem(title: "Error reading data input plug-ins.", statusCode: (int)System.Net.HttpStatusCode.InternalServerError, detail: ex.Message);
+            }
+        }
+
         private async Task ValidateCreateAsync(MonaiApplicationEntity item)
         {
             Guard.Against.Null(item, nameof(item));

src/InformaticsGateway/Test/Plugins/TestInputDataPlugins.cs

@@ -20,6 +20,7 @@
 
 namespace Monai.Deploy.InformaticsGateway.Test.Plugins
 {
+    [PluginName("TestInputDataPluginAddWorkflow")]
     public class TestInputDataPluginAddWorkflow : IInputDataPlugin
     {
         public static readonly string TestString = "TestInputDataPlugin executed!";
@@ -30,10 +31,13 @@ public class TestInputDataPluginAddWorkflow : IInputDataPlugin
             return Task.FromResult((dicomFile, fileMetadata));
         }
     }
+
+    [PluginName("TestInputDataPluginResumeWorkflow")]
     public class TestInputDataPluginResumeWorkflow : IInputDataPlugin
     {
         public static readonly string WorkflowInstanceId = "ee04a4ac-abb3-412b-b3a7-662c96380379";
         public static readonly string TaskId = "45b20f97-2b38-4b9a-baeb-d15f9d496851";
+
         public Task<(DicomFile dicomFile, FileStorageMetadata fileMetadata)> Execute(DicomFile dicomFile, FileStorageMetadata fileMetadata)
         {
             fileMetadata.WorkflowInstanceId = WorkflowInstanceId;
@@ -42,6 +46,7 @@ public class TestInputDataPluginResumeWorkflow : IInputDataPlugin
         }
     }
 
+    [PluginName("TestInputDataPluginModifyDicomFile")]
     public class TestInputDataPluginModifyDicomFile : IInputDataPlugin
     {
         public static readonly DicomTag ExpectedTag = DicomTag.PatientAddress;

src/InformaticsGateway/Test/Plugins/TestOutputDataPlugins.cs

@@ -20,6 +20,7 @@
 namespace Monai.Deploy.InformaticsGateway.Test.Plugins
 {
 
+    [PluginName("TestOutputDataPluginAddMessage")]
     public class TestOutputDataPluginAddMessage : IOutputDataPlugin
     {
         public static readonly string ExpectedValue = "Hello from TestOutputDataPluginAddMessage";
@@ -31,6 +32,7 @@ public class TestOutputDataPluginAddMessage : IOutputDataPlugin
         }
 
     }
+    [PluginName("TestOutputDataPluginModifyDicomFile")]
     public class TestOutputDataPluginModifyDicomFile : IOutputDataPlugin
     {
         public static readonly DicomTag ExpectedTag = DicomTag.PatientAddress;

src/InformaticsGateway/Test/ProgramTest.cs

@@ -17,6 +17,7 @@
 using System;
 using System.IO;
 using System.Reflection;
+using xRetry;
 using Xunit;
 
 namespace Monai.Deploy.InformaticsGateway.Test
@@ -25,7 +26,7 @@ public class ProgramTest
     {
         private const string PlugInDirectoryName = "plug-ins";
 
-        [Fact(DisplayName = "Program - runs properly")]
+        [RetryFact(DisplayName = "Program - runs properly")]
         public void Startup_RunsProperly()
         {
             var workingDirectory = Environment.CurrentDirectory;