Merge pull request #39 from dynamicweb/mss/20500-AddIn

Added new add-in to fail the job when endpoint is busy.
dynamicweb · Aug 27, 2024 · 6040331 · 6040331
2 parents 8ee1bf9 + 32ae96d
commit 6040331
Show file tree

Hide file tree

Showing 3 changed files with 32 additions and 6 deletions.
diff --git a/src/Dynamicweb.DataIntegration.Providers.ODataProvider.csproj b/src/Dynamicweb.DataIntegration.Providers.ODataProvider.csproj
@@ -1,6 +1,6 @@
 <Project Sdk="Microsoft.NET.Sdk">
 	<PropertyGroup>
-		<Version>10.6.4</Version>
+		<Version>10.6.5</Version>
 		<AssemblyVersion>1.0.0.0</AssemblyVersion>
 		<Title>OData Provider</Title>
 		<Description>The Odata Provider lets you fetch and map data from or to any OData endpoint.</Description>

diff --git a/src/ODataProvider.cs b/src/ODataProvider.cs
@@ -102,6 +102,12 @@ public string EndpointId
     [AddInParameterSection("Advanced activity settings")]
     public string DeltaModifier { get; set; }
 
+    [AddInParameter("Fail job if endpoint is busy or down")]
+    [AddInParameterEditor(typeof(YesNoParameterEditor), "Tooltip=If endpoint is busy or down during the run time, it will not insert already imported rows.")]
+    [AddInParameterGroup("Source")]
+    [AddInParameterSection("Advanced activity settings")]
+    public bool FailJobOnEndpointIsBusy { get; set; }
+
     #endregion
 
     #region AddInManager/ConfigurableAddIn Destination
@@ -455,7 +461,7 @@ public override ISourceReader GetReader(Mapping mapping)
             DoNotStoreLastResponseInLogFile = false;
         }
 
-        return new ODataSourceReader(new HttpRestClient(_credentials, RequestTimeout), Logger, mapping, _endpoint, Mode, DeltaModifier, MaximumPageSize, RunLastRequest, RequestIntervals, DoNotStoreLastResponseInLogFile);
+        return new ODataSourceReader(new HttpRestClient(_credentials, RequestTimeout), Logger, mapping, _endpoint, Mode, DeltaModifier, MaximumPageSize, RunLastRequest, RequestIntervals, DoNotStoreLastResponseInLogFile, FailJobOnEndpointIsBusy);
     }
 
     /// <inheritdoc />
@@ -541,6 +547,7 @@ public override void UpdateSourceSettings(ISource source)
         RequestIntervals = newProvider.RequestIntervals;
         DoNotStoreLastResponseInLogFile = newProvider.DoNotStoreLastResponseInLogFile;
         EndpointId = newProvider.EndpointId;
+        FailJobOnEndpointIsBusy = newProvider.FailJobOnEndpointIsBusy;
     }
 
     public ODataProvider() { }
@@ -614,6 +621,12 @@ public ODataProvider(XmlNode xmlNode) : this()
                         ContinueOnError = node.FirstChild.Value == "True";
                     }
                     break;
+                case "Failjobonendpointisbusy":
+                    if (node.HasChildNodes)
+                    {
+                        FailJobOnEndpointIsBusy = node.FirstChild.Value == "True";
+                    }
+                    break;
             }
         }
     }
@@ -633,6 +646,7 @@ public override string Serialize()
         root.Add(CreateParameterNode(GetType(), "Predefined endpoint", EndpointId));
         root.Add(CreateParameterNode(GetType(), "Destination endpoint", DestinationEndpointId));
         root.Add(CreateParameterNode(GetType(), "Continue on error", ContinueOnError.ToString()));
+        root.Add(CreateParameterNode(GetType(), "Fail job if endpoint is busy or down", FailJobOnEndpointIsBusy.ToString()));
         return document.ToString();
     }
 
@@ -649,6 +663,7 @@ public override void SaveAsXml(XmlTextWriter textWriter)
         textWriter.WriteElementString("Predefinedendpoint", EndpointId);
         textWriter.WriteElementString("Destinationendpoint", DestinationEndpointId);
         textWriter.WriteElementString("Continueonerror", ContinueOnError.ToString());
+        textWriter.WriteElementString("Failjobonendpointisbusy", FailJobOnEndpointIsBusy.ToString());
         GetSchema().SaveAsXml(textWriter);
     }
 

diff --git a/src/ODataSourceReader.cs b/src/ODataSourceReader.cs
@@ -8,7 +8,6 @@
 using System;
 using System.Collections.Generic;
 using System.Data;
-using System.Globalization;
 using System.IO;
 using System.Linq;
 using System.Net;
@@ -44,6 +43,7 @@ internal class ODataSourceReader : ISourceReader
     private bool _requestTimedOutFromGlobalSettings;
     private readonly int _maximumCharacterLengthOfAutoAddedSelectStatement = 1250;
     private readonly int _timeoutInMilliseconds;
+    private readonly bool _failJobOnEndpointIsBusy;
 
     internal void SaveRequestResponseFile()
     {
@@ -95,7 +95,7 @@ private void DeleteHighWaterMarkFile()
     /// <param name="mapping">The mapping.</param>
     /// <param name="endpoint">The endpoint.</param>
     /// <param name="nextPaginationUrlName">Name of the next pagination URL. "odata.nextLink" (case insensitive) is supposed to be a standard.</param>
-    internal ODataSourceReader(IHttpRestClient httpRestClient, ILogger logger, Mapping mapping, Endpoint endpoint, string mode, string deltaModifier, int maximumPageSize, bool readFromLastRequestResponse, int requestIntervals, bool doNotStoreLastResponseInLogFile, string nextPaginationUrlName = "odata.nextLink")
+    internal ODataSourceReader(IHttpRestClient httpRestClient, ILogger logger, Mapping mapping, Endpoint endpoint, string mode, string deltaModifier, int maximumPageSize, bool readFromLastRequestResponse, int requestIntervals, bool doNotStoreLastResponseInLogFile, bool failJobOnEndpointIsBusy, string nextPaginationUrlName = "odata.nextLink")
     {
         _totalResponseResult = new List<Dictionary<string, object>>();
         _httpRestClient = httpRestClient;
@@ -109,6 +109,7 @@ internal ODataSourceReader(IHttpRestClient httpRestClient, ILogger logger, Mappi
         _requestIntervals = requestIntervals;
         _doNotStoreLastResponseInLogFile = doNotStoreLastResponseInLogFile;
         _timeoutInMilliseconds = GetTimeOutInMilliseconds();
+        _failJobOnEndpointIsBusy = failJobOnEndpointIsBusy;
         string logFileName = Scheduling.Task.MakeSafeFileName(mapping.Job.Name) + $"_{_mapping.SourceTable.Name}.log";
 
         IDictionary<string, string> headers = GetAllHeaders();
@@ -604,7 +605,7 @@ private bool HandleRequest(string url, string loggerInfo, IDictionary<string, st
                 _logger?.Info($"This is retry {retryCounter} out of 2");
                 HandleRequest(url, loggerInfo, headers, retryCounter);
             }
-            
+
             return false;
         }
     }
@@ -720,7 +721,17 @@ void HandleResponse(Stream responseStream, HttpStatusCode responseStatusCode, Di
             }
             else
             {
-                _logger?.Info($"{checkUrl} returned the HttpStatusCode of: '{responseStatusCode}' ");
+                using var stream = new StreamReader(responseStream);
+                var streamResponse = stream.ReadToEnd();
+
+                if (_failJobOnEndpointIsBusy)
+                {
+                    throw new WebException($"{checkUrl} returned: {streamResponse} with the HttpStatusCode of: '{responseStatusCode}' ");
+                }
+                else
+                {
+                    _logger?.Info($"{checkUrl} returned: {streamResponse} with the HttpStatusCode of: '{responseStatusCode}' ");
+                }
             }
         }
         return result;