Merge pull request #42 from jdunkerley/streaming

IOutputHelper interface and factory

Author: jdunkerley

AlteryxAddIns.Framework/AlteryxAddIns.Framework.csproj

@@ -74,6 +74,7 @@
     <Compile Include="ConfigWithIncomingConnection.cs" />
     <Compile Include="ConnectionState.cs" />
     <Compile Include="Factories\InputPropertyFactory.cs" />
+    <Compile Include="Factories\OutputHelperFactory.cs" />
     <Compile Include="Factories\RecordCopierFactory.cs" />
     <Compile Include="FieldBaseHelpers.cs" />
     <Compile Include="FieldDescription.cs" />
@@ -83,6 +84,7 @@
     <Compile Include="ConfigWindows\InputFieldTypeConverter.cs" />
     <Compile Include="InputProperty.cs" />
     <Compile Include="Interfaces\IInputPropertyFactory.cs" />
+    <Compile Include="Interfaces\IOutputHelperFactory.cs" />
     <Compile Include="Interfaces\IRecordCopier.cs" />
     <Compile Include="Interfaces\IRecordCopierFactory.cs" />
     <Compile Include="Interfaces\ProgressUpdatedEventArgs.cs" />
@@ -91,6 +93,7 @@
     <Compile Include="Interfaces\RecordPushedEventHandler.cs" />
     <Compile Include="Interfaces\SuccessEventArgs.cs" />
     <Compile Include="Interfaces\SuccessEventHandler.cs" />
+    <Compile Include="Interfaces\IOutputHelper.cs" />
     <Compile Include="OutputHelper.cs" />
     <Compile Include="OutputType.cs" />
     <Compile Include="OutputTypeHelpers.cs" />

AlteryxAddIns.Framework/BaseEngine.cs

@@ -15,6 +15,8 @@ namespace JDunkerley.AlteryxAddIns.Framework
     public abstract class BaseEngine<TConfig> : AlteryxRecordInfoNet.INetPlugin, IBaseEngine
         where TConfig : new()
     {
+        private readonly IOutputHelperFactory _outputHelperFactory;
+
         private readonly Dictionary<string, PropertyInfo> _inputs;
         private readonly Dictionary<string, PropertyInfo> _outputs;
 
@@ -26,13 +28,20 @@ public abstract class BaseEngine<TConfig> : AlteryxRecordInfoNet.INetPlugin, IBa
         /// Initializes a new instance of the <see cref="BaseEngine{T}"/> class.
         /// </summary>
         /// <param name="recordCopierFactory">Factory to create copiers</param>
-        protected BaseEngine(IRecordCopierFactory recordCopierFactory)
+        /// <param name="outputHelperFactory">Factory to create output helpers</param>
+        protected BaseEngine(IRecordCopierFactory recordCopierFactory, IOutputHelperFactory outputHelperFactory)
         {
             this.RecordCopierFactory = recordCopierFactory;
+            this._outputHelperFactory = outputHelperFactory;
 
             var type = this.GetType();
             this._inputs = type.GetProperties<AlteryxRecordInfoNet.IIncomingConnectionInterface>();
-            this._outputs = type.GetProperties<OutputHelper>();
+            this._outputs = type.GetProperties<IOutputHelper>();
+
+            if (this._outputHelperFactory == null && this._outputs.Count > 0)
+            {
+                throw new ArgumentNullException(nameof(outputHelperFactory), "Tool has an output but no factory has been provided.");
+            }
         }
 
         /// <summary>
@@ -88,7 +97,7 @@ public void PI_Init(int nToolId, AlteryxRecordInfoNet.EngineInterface engineInte
 
             foreach (var kvp in this._outputs)
             {
-                kvp.Value.SetValue(this, new OutputHelper(this, kvp.Key), null);
+                kvp.Value.SetValue(this, this._outputHelperFactory.CreateOutputHelper(this, kvp.Key), null);
             }
 
             this.OnInitCalled();

AlteryxAddIns.Framework/BaseTool.cs

@@ -17,6 +17,7 @@
     /// <seealso cref="AlteryxGuiToolkit.Plugins.IPlugin" />
     public abstract class BaseTool<TConfig, TEngine>
         where TConfig : new()
+        where TEngine : AlteryxRecordInfoNet.INetPlugin
     {
         private readonly Lazy<Image> _icon;
 

AlteryxAddIns.Framework/BaseTool.pdn

@@ -0,0 +1,19 @@
+namespace JDunkerley.AlteryxAddIns.Framework.Factories
+{
+    using Interfaces;
+
+    /// <summary>
+    /// Factory For Creating <see cref="IOutputHelper"/> objects.
+    /// </summary>
+    public class OutputHelperFactory : IOutputHelperFactory
+    {
+        /// <summary>
+        /// Creates a new instance of an <see cref="IOutputHelper"/>
+        /// </summary>
+        /// <param name="hostEngine">The host engine.</param>
+        /// <param name="connectionName">Name of the outgoing connection.</param>
+        /// <returns>A configured instance of an <see cref="IOutputHelper"/></returns>
+        public IOutputHelper CreateOutputHelper(IBaseEngine hostEngine, string connectionName)
+            => new OutputHelper(hostEngine, connectionName);
+    }
+}

AlteryxAddIns.Framework/Factories/OutputHelperFactory.cs

@@ -0,0 +1,57 @@
+namespace JDunkerley.AlteryxAddIns.Framework.Interfaces
+{
+    using System.Xml;
+    using AlteryxRecordInfoNet;
+
+    /// <summary>
+    /// Interface Defining An Output Helper
+    /// </summary>
+    public interface IOutputHelper
+    {
+        /// <summary>
+        /// Gets a reusable <see cref="Record"/> object
+        /// </summary>
+        Record Record { get; }
+
+        /// <summary>
+        /// Gets the <see cref="RecordInfo"/> describing the Output records
+        /// </summary>
+        RecordInfo RecordInfo { get; }
+
+        /// <summary>
+        /// Given a fieldName, gets the <see cref="FieldBase"/> for it
+        /// </summary>
+        /// <param name="fieldName">Name of field</param>
+        /// <returns><see cref="FieldBase"/> representing the field</returns>
+        FieldBase this[string fieldName] { get; }
+
+        /// <summary>
+        /// Initializes the output stream.
+        /// </summary>
+        /// <param name="recordInfo">RecordInfo defining the fields and outputs of the connection.</param>
+        /// <param name="sortConfig">Sort configuration to pass onto Alteryx.</param>
+        /// <param name="oldConfig">XML configuration of the tool.</param>
+        void Init(RecordInfo recordInfo, XmlElement sortConfig = null, XmlElement oldConfig = null);
+
+        /// <summary>
+        /// Pushes a record to Alteryx to hand onto over tools.
+        /// </summary>
+        /// <param name="record">Record object to push to the stream.</param>
+        /// <param name="close">Value indicating whether to close the connection after pushing the record.</param>
+        /// <param name="updateCountMod">How often to update Row Count and Data</param>
+        void Push(Record record, bool close = false, ulong updateCountMod = 250);
+
+        /// <summary>
+        /// Update The Progress Of A Connection
+        /// </summary>
+        /// <param name="percentage">Percentage Progress from 0.0 to 1.0</param>
+        /// <param name="setToolProgress">Set Tool Progress As Well</param>
+        void UpdateProgress(double percentage, bool setToolProgress = false);
+
+        /// <summary>
+        /// Tell Alteryx We Are Finished
+        /// </summary>
+        /// <param name="executionComplete">Tell Alteryx Tool Execution Is Complete</param>
+        void Close(bool executionComplete = false);
+    }
+}

AlteryxAddIns.Framework/Interfaces/IOutputHelper.cs

@@ -0,0 +1,16 @@
+namespace JDunkerley.AlteryxAddIns.Framework.Interfaces
+{
+    /// <summary>
+    /// Interface to decouple the construction of <see cref="IOutputHelper"/> objects from <see cref="BaseEngine{TConfig}"/>.
+    /// </summary>
+    public interface IOutputHelperFactory
+    {
+        /// <summary>
+        /// Creates a new instance of an <see cref="IOutputHelper"/>
+        /// </summary>
+        /// <param name="hostEngine">The host engine.</param>
+        /// <param name="connectionName">Name of the outgoing connection.</param>
+        /// <returns>A configured instance of an <see cref="IOutputHelper"/></returns>
+        IOutputHelper CreateOutputHelper(IBaseEngine hostEngine, string connectionName);
+    }
+}

AlteryxAddIns.Framework/Interfaces/IOutputHelperFactory.cs

@@ -1,7 +1,7 @@
 namespace JDunkerley.AlteryxAddIns.Framework.Interfaces
 {
     /// <summary>
-    /// Interface to decouple the construction of <see cref="IRecordCopier"/> objects from the engines.
+    /// Interface to decouple the construction of <see cref="IRecordCopier"/> objects from <see cref="BaseEngine{TConfig}"/>.
     /// </summary>
     public interface IRecordCopierFactory
     {

AlteryxAddIns.Framework/Interfaces/IRecordCopierFactory.cs

@@ -5,10 +5,12 @@ namespace JDunkerley.AlteryxAddIns.Framework
 
     using AlteryxRecordInfoNet;
 
+    using Interfaces;
+
     /// <summary>
     /// Output Helper Class
     /// </summary>
-    public sealed class OutputHelper : IDisposable
+    internal sealed class OutputHelper : IDisposable, IOutputHelper
     {
         private readonly IBaseEngine _hostEngine;
 
@@ -70,7 +72,7 @@ public void AddConnection(OutgoingConnection connection)
         public void Init(RecordInfo recordInfo, XmlElement sortConfig = null, XmlElement oldConfig = null)
         {
             this.RecordInfo = recordInfo;
-            this._lazyRecord = new Lazy<Record>(this.CreateRecord);
+            this._lazyRecord = new Lazy<Record>(() => this.RecordInfo?.CreateRecord());
 
             this._recordCount = 0;
             this._recordLength = 0;
@@ -79,12 +81,6 @@ public void Init(RecordInfo recordInfo, XmlElement sortConfig = null, XmlElement
             this._hostEngine.Engine.OutputMessage(this._hostEngine.NToolId, MessageStatus.STATUS_Info, $"Init called back on {this._connectionName}");
         }
 
-        /// <summary>
-        /// Create A New Record (Can be reused)
-        /// </summary>
-        /// <returns>An empty record based off the RecordInfo.</returns>
-        public Record CreateRecord() => this.RecordInfo?.CreateRecord();
-
         /// <summary>
         /// Pushes a record to Alteryx to hand onto over tools.
         /// </summary>

AlteryxAddIns.Framework/OutputHelper.cs

@@ -108,10 +108,10 @@
     </ProjectReference>
   </ItemGroup>
   <ItemGroup>
-    <None Include="Install.bat" />
-    <None Include="InstallRelease.bat">
+    <None Include="Install.bat">
       <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
     </None>
+    <None Include="InstallRelease.bat" />
     <None Include="packages.config" />
     <None Include="Uninstall.bat">
       <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
@@ -135,8 +135,8 @@
   <PropertyGroup>
     <PostBuildEvent>rmdir "$(SolutionDir)\Release\Roslyn" /s /q
 mkdir "$(SolutionDir)\Release\Roslyn"
-copy "$(TargetDir)\*.dll" "$(SolutionDir)\Release\Roslyn\"
-copy "$(TargetDir)\InstallRelease.bat" "$(SolutionDir)\Release\RoslynInstall.bat"
+copy "$(ProjectDir)\*.dll" "$(SolutionDir)\Release\Roslyn\"
+copy "$(ProjectDir)\InstallRelease.bat" "$(SolutionDir)\Release\RoslynInstall.bat"
 </PostBuildEvent>
   </PropertyGroup>
   <!-- To modify your build process, add your task inside one of the targets below and uncomment it.