FEATURE: Custom error http codes can be defined in ValidationRule (#2420

) * Added HttpStatusCode field to model * Added api to test custom error code * Custom error http codes can be defined in ValidationRule * Added api call example --------- Co-authored-by: Petr Hrehorovsky <83349812+washibana@users.noreply.github.com>
origam · Jan 24, 2024 · b17ee4e · b17ee4e
1 parent 4002505
commit b17ee4e
Show file tree

Hide file tree

Showing 21 changed files with 93 additions and 25 deletions.
diff --git a/backend/Origam.BI.CrystalReports.NetFx/Origam.BI.CrystalReports.NetFx.csproj b/backend/Origam.BI.CrystalReports.NetFx/Origam.BI.CrystalReports.NetFx.csproj
@@ -1,4 +1,4 @@
-<?xml version="1.0" encoding="utf-8"?>
+<?xml version="1.0" encoding="utf-8"?>
 <Project ToolsVersion="12.0" DefaultTargets="Build" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
   <PropertyGroup>
     <ProjectType>Local</ProjectType>
@@ -210,7 +210,7 @@
       <Version>2.0.15</Version>
     </PackageReference>
     <PackageReference Include="Origam.Service.Core">
-      <Version>2.2.2</Version>
+      <Version>2.3.1</Version>
     </PackageReference>
   </ItemGroup>
   <Import Project="$(MSBuildToolsPath)\Microsoft.CSharp.targets">

diff --git a/backend/Origam.BI.Excel/Origam.BI.Excel.csproj b/backend/Origam.BI.Excel/Origam.BI.Excel.csproj
@@ -52,7 +52,7 @@
 	</PropertyGroup>
 	<ItemGroup>
 	  <PackageReference Include="NPOI" Version="2.6.2" />
-	  <PackageReference Include="Origam.Service.Core" Version="2.2.2" />
+	  <PackageReference Include="Origam.Service.Core" Version="2.3.1" />
 	</ItemGroup>
 	<ItemGroup>
 	  <ProjectReference Include="..\Origam.Workbench.Services\Origam.Workbench.Services.csproj" />

diff --git a/backend/Origam.BI.FastReport/Origam.BI.FastReport.csproj b/backend/Origam.BI.FastReport/Origam.BI.FastReport.csproj
@@ -52,7 +52,7 @@
 
   <ItemGroup>
     <PackageReference Include="FastReport.OpenSource.Export.PdfSimple" Version="2024.1.3" />
-    <PackageReference Include="Origam.Service.Core" Version="2.2.2" />
+    <PackageReference Include="Origam.Service.Core" Version="2.3.1" />
   </ItemGroup>
 
   <ItemGroup>

diff --git a/backend/Origam.BI.PrintIt/Origam.BI.PrintIt.csproj b/backend/Origam.BI.PrintIt/Origam.BI.PrintIt.csproj
@@ -1,4 +1,4 @@
-<?xml version="1.0" encoding="utf-8"?>
+<?xml version="1.0" encoding="utf-8"?>
 <Project ToolsVersion="12.0" DefaultTargets="Build" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
   <PropertyGroup>
     <ProjectType>Local</ProjectType>
@@ -140,7 +140,7 @@
   </ItemGroup>
   <ItemGroup>
     <PackageReference Include="Origam.Service.Core">
-      <Version>2.2.2</Version>
+      <Version>2.3.1</Version>
     </PackageReference>
   </ItemGroup>
   <Import Project="$(MSBuildToolsPath)\Microsoft.CSharp.targets">

diff --git a/backend/Origam.BI/Origam.BI.csproj b/backend/Origam.BI/Origam.BI.csproj
@@ -1,4 +1,4 @@
-<?xml version="1.0" encoding="utf-8"?>
+<?xml version="1.0" encoding="utf-8"?>
 <Project ToolsVersion="12.0" DefaultTargets="Build" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
   <PropertyGroup>
     <ProjectType>Local</ProjectType>
@@ -145,7 +145,7 @@
       <Version>2.0.15</Version>
     </PackageReference>
     <PackageReference Include="Origam.Service.Core">
-      <Version>2.2.2</Version>
+      <Version>2.3.1</Version>
     </PackageReference>
   </ItemGroup>
   <Import Project="$(MSBuildToolsPath)\Microsoft.CSharp.targets">

diff --git a/backend/Origam.Common/Origam.Common.csproj b/backend/Origam.Common/Origam.Common.csproj
@@ -65,7 +65,7 @@
     <PackageReference Include="Microsoft.AspNetCore.StaticFiles" Version="2.2.0" />
     <PackageReference Include="Microsoft.Extensions.Configuration.Binder" Version="6.0.0" />
     <PackageReference Include="Newtonsoft.Json" Version="13.0.3" />
-    <PackageReference Include="Origam.Service.Core" Version="2.2.2" />
+    <PackageReference Include="Origam.Service.Core" Version="2.3.1" />
     <PackageReference Include="System.Drawing.Common" Version="5.0.3" />
     <PackageReference Include="System.IO.FileSystem" Version="4.3.0" />
     <PackageReference Include="System.Net.NameResolution" Version="4.3.0" />

diff --git a/backend/Origam.Gui.Win/Origam.Gui.Win.csproj b/backend/Origam.Gui.Win/Origam.Gui.Win.csproj
@@ -1,4 +1,4 @@
-<?xml version="1.0" encoding="utf-8"?>
+<?xml version="1.0" encoding="utf-8"?>
 <Project ToolsVersion="12.0" DefaultTargets="Build" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
   <PropertyGroup>
     <ProjectType>Local</ProjectType>
@@ -679,7 +679,7 @@
       <Version>3.1.0</Version>
     </PackageReference>
     <PackageReference Include="Origam.Service.Core">
-      <Version>2.2.2</Version>
+      <Version>2.3.1</Version>
     </PackageReference>
   </ItemGroup>
   <Import Project="$(MSBuildToolsPath)\Microsoft.CSharp.targets">

diff --git a/backend/Origam.Server/Origam.Server.csproj b/backend/Origam.Server/Origam.Server.csproj
@@ -75,7 +75,7 @@
     <PackageReference Include="Microsoft.AspNetCore.Mvc.Razor.RuntimeCompilation" Version="6.0.9" />
     <PackageReference Include="Microsoft.Extensions.Logging.Log4Net.AspNetCore" Version="7.0.0" />
     <PackageReference Include="Microsoft.VisualStudio.Web.CodeGeneration.Design" Version="6.0.10" />
-    <PackageReference Include="Origam.Service.Core" Version="2.2.2" />
+    <PackageReference Include="Origam.Service.Core" Version="2.3.1" />
     <PackageReference Include="SoapCore" Version="1.1.0.41" />
     <PackageReference Include="System.Data.DataSetExtensions" Version="4.5.0" />
     <PackageReference Include="UAParser" Version="3.1.47" />

diff --git a/backend/Origam.Server/Pages/UserApiProcessor.cs b/backend/Origam.Server/Pages/UserApiProcessor.cs
@@ -178,13 +178,28 @@ IParameterService parameterService
                     message = JsonConvert.SerializeObject(ex);
                 }
                 context.Response.Clear();
-                context.Response.StatusCode = 400;
+                context.Response.StatusCode = GetStausCode(ex);
                 context.Response.ContentType = "application/json";   
                 context.Response.Write(message);
                 context.Response.End();
             }
         }
 
+        private int GetStausCode(Exception ex)
+        {
+            if (ex is RuleException ruleException)
+            {
+                var dataList = ruleException.RuleResult
+                    .OfType<RuleExceptionData>()
+                    .ToList();
+                if (dataList.Count == 1)
+                {
+                    return dataList[0].HttpStatusCode;
+                }
+            }
+            return 400;
+        }
+
         protected virtual void Handle404(IHttpContextWrapper context)
         { 
             // nothing found, let others handle it

diff --git a/backend/Origam.Workflow.SimplicorService/Origam.Workflow.SimplicorService.csproj b/backend/Origam.Workflow.SimplicorService/Origam.Workflow.SimplicorService.csproj
@@ -1,4 +1,4 @@
-<?xml version="1.0" encoding="utf-8"?>
+<?xml version="1.0" encoding="utf-8"?>
 <Project ToolsVersion="12.0" DefaultTargets="Build" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
   <PropertyGroup>
     <ProjectType>Local</ProjectType>
@@ -159,7 +159,7 @@
   </ItemGroup>
   <ItemGroup>
     <PackageReference Include="Origam.Service.Core">
-      <Version>2.2.2</Version>
+      <Version>2.3.1</Version>
     </PackageReference>
   </ItemGroup>
   <Import Project="$(MSBuildToolsPath)\Microsoft.CSharp.targets">

diff --git a/backend/OrigamArchitect/OrigamArchitect.csproj b/backend/OrigamArchitect/OrigamArchitect.csproj
@@ -489,7 +489,7 @@
       <Version>2.6.2</Version>
     </PackageReference>
     <PackageReference Include="Origam.Service.Core">
-      <Version>2.2.2</Version>
+      <Version>2.3.1</Version>
     </PackageReference>
   </ItemGroup>
   <Import Project="$(MSBuildToolsPath)\Microsoft.CSharp.targets" />

diff --git a/model-root/model/Root/DataEntity/__system/RuleExceptionData.origam b/model-root/model/Root/DataEntity/__system/RuleExceptionData.origam
@@ -12,6 +12,17 @@
     x:id="5643627e-99f8-4df4-bfd6-d31db81cad4a"
     asi:name="RuleExceptionData"
     ade:readOnly="false">
+    <df:DataEntityColumn
+      asi:abstract="false"
+      adec:allowNulls="true"
+      adec:autoIncrement="false"
+      adec:dataType="Integer"
+      adec:excludeFromAllFields="false"
+      x:id="4020bc56-a75e-4da6-87b1-d62af56a25e9"
+      adec:isPrimaryKey="false"
+      asi:name="HttpStatusCode"
+      adec:onCopyAction="Copy"
+      adec:xmlMappingType="Attribute" />
     <df:DataEntityColumn
       asi:abstract="false"
       adec:allowNulls="false"

diff --git a/model-root/model/Root/Rule/_common/ER_ExceptionTemplate.origam b/model-root/model/Root/Rule/_common/ER_ExceptionTemplate.origam
@@ -1,13 +1,13 @@
 <?xml version="1.0" encoding="utf-8"?>
 <x:file
   xmlns:x="http://schemas.origam.com/model-persistence/1.0.0"
-  xmlns:ar="http://schemas.origam.com/Origam.Schema.RuleModel.AbstractRule/6.0.0"
+  xmlns:ar1="http://schemas.origam.com/Origam.Schema.RuleModel.AbstractRule/6.0.0"
   xmlns:asi="http://schemas.origam.com/Origam.Schema.AbstractSchemaItem/6.0.0"
-  xmlns:er="http://schemas.origam.com/Origam.Schema.RuleModel.EndRule/6.0.0"
+  xmlns:er1="http://schemas.origam.com/Origam.Schema.RuleModel.EndRule/6.0.0"
   xmlns:xr="http://schemas.origam.com/Origam.Schema.RuleModel.XslRule/6.0.0">
-  <er:Rule
+  <er1:Rule
     asi:abstract="false"
-    ar:dataType="Boolean"
+    ar1:dataType="Boolean"
     x:id="e1c65fcd-118d-4eb3-9c2f-aa27fec132ba"
     asi:name="ER_ExceptionTemplate"
     xr:xsl="-***-ExternalFile:ER_ExceptionTemplate.origam___xsl___e1c65fcd-118d-4eb3-9c2f-aa27fec132ba.xslt" />

diff --git a/...ule/_common/ER_ExceptionTemplate.origam___xsl___e1c65fcd-118d-4eb3-9c2f-aa27fec132ba.xslt b/...ule/_common/ER_ExceptionTemplate.origam___xsl___e1c65fcd-118d-4eb3-9c2f-aa27fec132ba.xslt
@@ -5,6 +5,7 @@
 		<xsl:param name="EntityName"/>
 		<xsl:param name="Message"/>
 		<xsl:param name="Severity"/>
+		<xsl:param name="HttpStatusCode" select="400"/>
 
 		<RuleExceptionData>
 			<FieldName>
@@ -19,6 +20,9 @@
 			<Severity>
 				<xsl:value-of select="$Severity"/>
 			</Severity>
+			<HttpStatusCode>
+				<xsl:value-of select="$HttpStatusCode"/>
+			</HttpStatusCode>
 		</RuleExceptionData>
 	</xsl:template>
 </xsl:stylesheet>
diff --git a/model-tests/ApiCallExamples/publicApiTestExamples.http b/model-tests/ApiCallExamples/publicApiTestExamples.http
@@ -4,3 +4,6 @@
 GET https://localhost:{{port}}/api/public/Attachment/E65251F1-FD5B-4307-B0A7-4C9F5594A1AF
 
 
+###
+// fails and sends custom http return core
+GET https://localhost:{{port}}/api/public/failingWorkflow
diff --git a/model-tests/model/Root/DataEntity/__system/RuleExceptionData.origam b/model-tests/model/Root/DataEntity/__system/RuleExceptionData.origam
@@ -12,6 +12,17 @@
     x:id="5643627e-99f8-4df4-bfd6-d31db81cad4a"
     asi:name="RuleExceptionData"
     ade:readOnly="false">
+    <df:DataEntityColumn
+      asi:abstract="false"
+      adec:allowNulls="true"
+      adec:autoIncrement="false"
+      adec:dataType="Integer"
+      adec:excludeFromAllFields="false"
+      x:id="4020bc56-a75e-4da6-87b1-d62af56a25e9"
+      adec:isPrimaryKey="false"
+      asi:name="HttpStatusCode"
+      adec:onCopyAction="Copy"
+      adec:xmlMappingType="Attribute" />
     <df:DataEntityColumn
       asi:abstract="false"
       adec:allowNulls="false"

diff --git a/model-tests/model/Root/Rule/_common/ER_ExceptionTemplate.origam b/model-tests/model/Root/Rule/_common/ER_ExceptionTemplate.origam
@@ -1,13 +1,13 @@
 <?xml version="1.0" encoding="utf-8"?>
 <x:file
   xmlns:x="http://schemas.origam.com/model-persistence/1.0.0"
-  xmlns:ar="http://schemas.origam.com/Origam.Schema.RuleModel.AbstractRule/6.0.0"
+  xmlns:ar1="http://schemas.origam.com/Origam.Schema.RuleModel.AbstractRule/6.0.0"
   xmlns:asi="http://schemas.origam.com/Origam.Schema.AbstractSchemaItem/6.0.0"
-  xmlns:er="http://schemas.origam.com/Origam.Schema.RuleModel.EndRule/6.0.0"
+  xmlns:er1="http://schemas.origam.com/Origam.Schema.RuleModel.EndRule/6.0.0"
   xmlns:xr="http://schemas.origam.com/Origam.Schema.RuleModel.XslRule/6.0.0">
-  <er:Rule
+  <er1:Rule
     asi:abstract="false"
-    ar:dataType="Boolean"
+    ar1:dataType="Boolean"
     x:id="e1c65fcd-118d-4eb3-9c2f-aa27fec132ba"
     asi:name="ER_ExceptionTemplate"
     xr:xsl="-***-ExternalFile:ER_ExceptionTemplate.origam___xsl___e1c65fcd-118d-4eb3-9c2f-aa27fec132ba.xslt" />

diff --git a/...ule/_common/ER_ExceptionTemplate.origam___xsl___e1c65fcd-118d-4eb3-9c2f-aa27fec132ba.xslt b/...ule/_common/ER_ExceptionTemplate.origam___xsl___e1c65fcd-118d-4eb3-9c2f-aa27fec132ba.xslt
@@ -5,6 +5,7 @@
 		<xsl:param name="EntityName"/>
 		<xsl:param name="Message"/>
 		<xsl:param name="Severity"/>
+		<xsl:param name="HttpStatusCode" select="400"/>
 
 		<RuleExceptionData>
 			<FieldName>
@@ -19,6 +20,9 @@
 			<Severity>
 				<xsl:value-of select="$Severity"/>
 			</Severity>
+			<HttpStatusCode>
+				<xsl:value-of select="$HttpStatusCode"/>
+			</HttpStatusCode>
 		</RuleExceptionData>
 	</xsl:template>
 </xsl:stylesheet>
diff --git a/model-tests/model/Widgets/Page/FailingWorkflow.origam b/model-tests/model/Widgets/Page/FailingWorkflow.origam
@@ -0,0 +1,18 @@
+<?xml version="1.0" encoding="utf-8"?>
+<x:file
+  xmlns:x="http://schemas.origam.com/model-persistence/1.0.0"
+  xmlns:ap="http://schemas.origam.com/Origam.Schema.GuiModel.AbstractPage/6.0.0"
+  xmlns:asi="http://schemas.origam.com/Origam.Schema.AbstractSchemaItem/6.0.0"
+  xmlns:wp="http://schemas.origam.com/Origam.Schema.WorkflowModel.WorkflowPage/6.0.0">
+  <wp:Page
+    asi:abstract="false"
+    ap:allowDelete="false"
+    ap:allowPut="false"
+    wp:disableConstraintForInputValidation="false"
+    x:id="9bd0c179-64b8-4387-b98d-24d2eb3b3e8e"
+    ap:mimeType="application/json"
+    asi:name="FailingWorkflow"
+    ap:roles="*"
+    ap:url="api/public/failingWorkflow"
+    wp:workflow="Widgets/Workflow/Widgets/FailingWorkQueueTest.origam#FailingWorkQueueTest/ddb1cedf-c05a-472f-bb5d-f5d070e627ed" />
+</x:file>
diff --git a/.../Widgets/ER_IntentionalTestError.origam___xsl___de8fe24a-ce63-4db6-96c1-7e7841fbc447.xslt b/.../Widgets/ER_IntentionalTestError.origam___xsl___de8fe24a-ce63-4db6-96c1-7e7841fbc447.xslt
@@ -13,6 +13,7 @@
 					<xsl:with-param name="EntityName"><xsl:value-of select="'WorkQueueEntry'"/></xsl:with-param>
 					<xsl:with-param name="Message"><xsl:value-of select="AS:GetString('TestError')"/></xsl:with-param>
 					<xsl:with-param name="Severity"><xsl:value-of select="'High'"/></xsl:with-param>
+					<xsl:with-param name="HttpStatusCode"><xsl:value-of select="402"/></xsl:with-param>
 				</xsl:call-template>
 			</xsl:if>
 		</RuleExceptionDataCollection>

diff --git a/test/tests_e2e/package.json b/test/tests_e2e/package.json
@@ -3,9 +3,10 @@
   "version": "0.1.0",
   "private": true,
   "dependencies": {
+    "@babel/helper-get-function-arity": "^7.16.7",
     "jest": "^27.3.1",
     "jest-trx-results-processor": "^3.0.2",
-    "msnodesqlv8": "^2.2.0",
+    "msnodesqlv8": "^4.1.2",
     "mssql": "^7.2.1",
     "puppeteer": "^10.1.0"
   },