DynamicsValue · jordimontana82 · Jun 15, 2024 · Feb 14, 2024 · Feb 14, 2024 · Feb 14, 2024
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,24 @@
+## [3.5.0]
+
+### Added
+
+- Ability to prevent infinite loops in plugin executions - https://github.com/DynamicsValue/fake-xrm-easy/issues/70
+- Event Pipeline Scopes : Introducing new capability to capture the 'scope' or stack of plugin executions. This will enable many features including - https://github.com/DynamicsValue/fake-xrm-easy/issues/70
+- Pipeline Simulation: Add support for pre images and post image collections - https://github.com/DynamicsValue/fake-xrm-easy/issues/122
+- Pipeline Simulation: Update Plugin Step Validator to include bulk operations - https://github.com/DynamicsValue/fake-xrm-easy/issues/122
+- Pipeline Simulation: Add support for merged pipeline of bulk operations (trigger bulk plugins from non-bulk messages and vice-versa) - https://github.com/DynamicsValue/fake-xrm-easy/issues/122
+- Pipeline Simulation: Add support specific attribute filtering of bulk operation plugin steps - https://github.com/DynamicsValue/fake-xrm-easy/issues/122
+- Pipeline Simulation: Add support for bulk operations in pipeline simulation - https://github.com/DynamicsValue/fake-xrm-easy/issues/122
+- Added support for new IPluginExecutionContext2, IPluginExecutionContext3, and IPluginExecutionContext4 interfaces - https://github.com/DynamicsValue/fake-xrm-easy/issues/122
+
+### Changed
+
+- Massively refactored Pipeline Simulation due to bulk operations changes
+- Resolves issue where a DeleteRequest was not triggering plugin steps when using late bound entities - https://github.com/DynamicsValue/fake-xrm-easy/issues/144
+- ExecutePluginWith* methods now return the new XrmFakedPluginExecutionContext4 class which implements IPluginExecutionContext4 for v9 versions. 
+- Upgraded dependency "Microsoft.CrmSdk.CoreAssemblies" to 9.0.2.52
+- Upgraded dependency "Microsoft.CrmSdk.XrmTooling.CoreAssembly" to 9.1.1.45
+
 ## [3.4.1]
 
 ### Changed

diff --git a/FakeXrmEasy.Plugins.sln.DotSettings b/FakeXrmEasy.Plugins.sln.DotSettings
@@ -1,3 +1,6 @@
 <wpf:ResourceDictionary xml:space="preserve" xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml" xmlns:s="clr-namespace:System;assembly=mscorlib" xmlns:ss="urn:shemas-jetbrains-com:settings-storage-xaml" xmlns:wpf="http://schemas.microsoft.com/winfx/2006/xaml/presentation">
+	<s:Boolean x:Key="/Default/UserDictionary/Words/=accountid/@EntryIndexedValue">True</s:Boolean>
+	<s:Boolean x:Key="/Default/UserDictionary/Words/=modifiedby/@EntryIndexedValue">True</s:Boolean>
+	<s:Boolean x:Key="/Default/UserDictionary/Words/=modifiedon/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=postoperation/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=preoperation/@EntryIndexedValue">True</s:Boolean></wpf:ResourceDictionary>
diff --git a/README.md b/README.md
@@ -5,6 +5,8 @@
 --------------------------------------------------
 This repo contains the source code for the FakeXrmEasy.Plugins package.
 
+**NOTE: We centrally manage and prioritize issues in the DynamicsValue/fake-xrm-easy repo, if you need to raise an issue related to this package
+please do so at: https://github.com/DynamicsValue/fake-xrm-easy**
 
 |Build|Quality Gate|Coverage|Security|Maintainability|Reliability|
 |-----| ---------- | ------ | ------ | ------------- | --------- |

diff --git a/performance/FakeXrmEasy.Plugins.Performance/FakeXrmEasy.Plugins.Performance.csproj b/performance/FakeXrmEasy.Plugins.Performance/FakeXrmEasy.Plugins.Performance.csproj
@@ -36,8 +36,8 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="Microsoft.PowerPlatform.Dataverse.Client" Version="1.0.39" />
-    <PackageReference Include="Microsoft.PowerPlatform.Dataverse.Client.Dynamics" Version="1.0.39" />
+    <PackageReference Include="Microsoft.PowerPlatform.Dataverse.Client" Version="1.1.22" />
+    <PackageReference Include="Microsoft.PowerPlatform.Dataverse.Client.Dynamics" Version="1.1.22" />
   </ItemGroup>
 
   <ItemGroup>
@@ -50,48 +50,48 @@
   </ItemGroup>
 
   <ItemGroup Condition="'$(Configuration)'=='FAKE_XRM_EASY_2013'">
-    <PackageReference Include="FakeXrmEasy.Abstractions.v2013" Version="3.4.0-*" />
-    <PackageReference Include="FakeXrmEasy.Core.v2013" Version="3.4.2-*" />
+    <PackageReference Include="FakeXrmEasy.Abstractions.v2013" Version="3.5.0-*" />
+    <PackageReference Include="FakeXrmEasy.Core.v2013" Version="3.5.0-*" />
   </ItemGroup>
   <ItemGroup Condition="'$(Configuration)'=='FAKE_XRM_EASY_2015'">
-    <PackageReference Include="FakeXrmEasy.Abstractions.v2015" Version="3.4.0-*" />
-    <PackageReference Include="FakeXrmEasy.Core.v2015" Version="3.4.2-*" />
+    <PackageReference Include="FakeXrmEasy.Abstractions.v2015" Version="3.5.0-*" />
+    <PackageReference Include="FakeXrmEasy.Core.v2015" Version="3.5.0-*" />
   </ItemGroup>
   <ItemGroup Condition="'$(Configuration)'=='FAKE_XRM_EASY_2016'">
-    <PackageReference Include="FakeXrmEasy.Abstractions.v2016" Version="3.4.0-*" />
-    <PackageReference Include="FakeXrmEasy.Core.v2016" Version="3.4.2-*" />
+    <PackageReference Include="FakeXrmEasy.Abstractions.v2016" Version="3.5.0-*" />
+    <PackageReference Include="FakeXrmEasy.Core.v2016" Version="3.5.0-*" />
   </ItemGroup>
   <ItemGroup Condition="'$(Configuration)'=='FAKE_XRM_EASY_365'">
-    <PackageReference Include="FakeXrmEasy.Abstractions.v365" Version="3.4.0-*" />
-    <PackageReference Include="FakeXrmEasy.Core.v365" Version="3.4.2-*" />
+    <PackageReference Include="FakeXrmEasy.Abstractions.v365" Version="3.5.0-*" />
+    <PackageReference Include="FakeXrmEasy.Core.v365" Version="3.5.0-*" />
   </ItemGroup>
   <ItemGroup Condition="'$(Configuration)'=='FAKE_XRM_EASY_9'">
-    <PackageReference Include="FakeXrmEasy.Abstractions.v9" Version="3.4.0-*" />
-    <PackageReference Include="FakeXrmEasy.Core.v9" Version="3.4.2-*" />
+    <PackageReference Include="FakeXrmEasy.Abstractions.v9" Version="3.5.0-*" />
+    <PackageReference Include="FakeXrmEasy.Core.v9" Version="3.5.0-*" />
   </ItemGroup>
   <ItemGroup Condition="'$(Configuration)'=='Debug'">
-    <PackageReference Include="FakeXrmEasy.Abstractions.v9" Version="3.4.0-*" />
-    <PackageReference Include="FakeXrmEasy.Core.v9" Version="3.4.2-*" />
+    <PackageReference Include="FakeXrmEasy.Abstractions.v9" Version="3.5.0-*" />
+    <PackageReference Include="FakeXrmEasy.Core.v9" Version="3.5.0-*" />
   </ItemGroup>
 
 
   <ItemGroup Condition="'$(PackTests)' == 'true' And '$(Configuration)'=='FAKE_XRM_EASY_2013'">
-    <PackageReference Include="FakeXrmEasy.Plugins.v2013" Version="3.4.1-*" />
+    <PackageReference Include="FakeXrmEasy.Plugins.v2013" Version="3.5.0-*" />
   </ItemGroup>
   <ItemGroup Condition="'$(PackTests)' == 'true' And '$(Configuration)'=='FAKE_XRM_EASY_2015'">
-    <PackageReference Include="FakeXrmEasy.Plugins.v2015" Version="3.4.1-*" />
+    <PackageReference Include="FakeXrmEasy.Plugins.v2015" Version="3.5.0-*" />
   </ItemGroup>
   <ItemGroup Condition="'$(PackTests)' == 'true' And '$(Configuration)'=='FAKE_XRM_EASY_2016'">
-    <PackageReference Include="FakeXrmEasy.Plugins.v2016" Version="3.4.1-*" />
+    <PackageReference Include="FakeXrmEasy.Plugins.v2016" Version="3.5.0-*" />
   </ItemGroup>
   <ItemGroup Condition="'$(PackTests)' == 'true' And '$(Configuration)'=='FAKE_XRM_EASY_365'">
-    <PackageReference Include="FakeXrmEasy.Plugins.v365" Version="3.4.1-*" />
+    <PackageReference Include="FakeXrmEasy.Plugins.v365" Version="3.5.0-*" />
   </ItemGroup>
   <ItemGroup Condition="'$(PackTests)' == 'true' And '$(Configuration)'=='FAKE_XRM_EASY_9'">
-    <PackageReference Include="FakeXrmEasy.Plugins.v9" Version="3.4.1-*" />
+    <PackageReference Include="FakeXrmEasy.Plugins.v9" Version="3.5.0-*" />
   </ItemGroup>
   <ItemGroup Condition="'$(PackTests)' == 'true' And '$(Configuration)'=='Debug'">
-    <PackageReference Include="FakeXrmEasy.Plugins.v9" Version="3.4.1-*" />
+    <PackageReference Include="FakeXrmEasy.Plugins.v9" Version="3.5.0-*" />
   </ItemGroup>
 
 </Project>
diff --git a/performance/FakeXrmEasy.Plugins.Performance/PipelineBenchmarks.cs b/performance/FakeXrmEasy.Plugins.Performance/PipelineBenchmarks.cs
@@ -42,28 +42,38 @@ public PipelineBenchmarks()
             }
         }
 
+        /* Significantly slower than GetPluginStepsWithQuery below
         [Benchmark]
         public void GetPluginStepsWithRetrieveMultiple()
         {
-            _context.GetPluginStepsForOrganizationRequestWithRetrieveMultiple("Create", ProcessingStepStage.Postoperation, ProcessingStepMode.Synchronous, _createRequest);
+            RegisteredPluginStepsRetriever.GetPluginStepsForOrganizationRequestWithRetrieveMultiple(_context, "Create", ProcessingStepStage.Postoperation, ProcessingStepMode.Synchronous, _createRequest);
         }
-
+        */
+
         [Benchmark]
         public void GetPluginStepsWithQuery()
         {
-            _context.GetPluginStepsForOrganizationRequest("Create", ProcessingStepStage.Postoperation, ProcessingStepMode.Synchronous, _createRequest);
+            var parameters = new PipelineStageExecutionParameters()
+            {
+                Stage = ProcessingStepStage.Postoperation,
+                Mode = ProcessingStepMode.Synchronous,
+                Request = _createRequest
+            };
+            RegisteredPluginStepsRetriever.GetPluginStepsForOrganizationRequest(_context, parameters);
         }
 
+        /*
         [Benchmark]
         public void GetPluginStepImageWithRetrieveMultiple()
         {
-            _context.GetPluginImageDefinitionsWithRetrieveMultiple(_lastPluginStepId, ProcessingStepImageType.PostImage).ToList();
+            RegisteredPluginStepsRetriever.GetPluginImageDefinitionsWithRetrieveMultiple(_context, _lastPluginStepId, ProcessingStepImageType.PostImage).ToList();
         }
-
+        */
+
         [Benchmark]
         public void GetPluginStepImageWithQuery()
         {
-            _context.GetPluginImageDefinitionsWithQuery(_lastPluginStepId, ProcessingStepImageType.PostImage).ToList();
+            RegisteredPluginStepsRetriever.GetPluginImageDefinitionsWithQuery(_context, _lastPluginStepId, ProcessingStepImageType.PostImage).ToList();
         }
     }
 }
diff --git a/src/FakeXrmEasy.Plugins/Audit/PluginStepAuditDetails.cs b/src/FakeXrmEasy.Plugins/Audit/PluginStepAuditDetails.cs
@@ -24,6 +24,11 @@ public class PluginStepAuditDetails
         /// Stage that triggered this plugin execution
         /// </summary>
         public ProcessingStepStage Stage { get; set; }
+
+        /// <summary>
+        /// The mode the in which the plugin step was executed
+        /// </summary>
+        public ProcessingStepMode Mode { get; set; }
 
         /// <summary>
         /// Message that triggered this execution (i.e. Create, Update, and so on...)
@@ -59,5 +64,10 @@ public class PluginStepAuditDetails
         /// The plugin step definition that triggered the plugin execution
         /// </summary>
         public IPluginStepDefinition PluginStepDefinition { get; set; }
+
+        /// <summary>
+        /// The plugin execution context that was passed into the plugin when it was executed to check any other necessary properties
+        /// </summary>
+        public IPluginExecutionContext PluginContext { get; set; }
     }
 }
diff --git a/src/FakeXrmEasy.Plugins/EntityLogicalNameConstants.cs b/src/FakeXrmEasy.Plugins/EntityLogicalNameConstants.cs
@@ -0,0 +1,25 @@
+namespace FakeXrmEasy.Plugins
+{
+    internal static class EntityLogicalNameConstants
+    {
+        internal const string AppNotification = "appnotification";
+        internal const string BackgroundOperation = "backgroundoperation";
+        internal const string CardStateItem = "cardstateitem";
+        internal const string ComponentVersionNrdDataSource = "componentversionnrddatasource";
+        internal const string ElasticFileAttachment = "elasticfileattachment";
+        internal const string EventExpanderBreadcrumb = "eventexpanderbreadcrumb";
+        internal const string FlowLog = "flowlog";
+        internal const string FlowRun = "flowrun";
+        internal const string MsDynTimelinePin = "msdyn_timelinepin";
+        internal const string NlsqRegistration = "nlsqregistration";
+        internal const string None = "none";
+        internal const string PowerPagesLog = "powerpageslog";
+        internal const string RecentlyUsed = "recentlyused";
+        internal const string SearchResultsCache = "searchresultscache";
+        internal const string SearchTelemetry = "searchtelemetry";
+        internal const string SharedWorkspaceAccessToken = "sharedworkspaceaccesstoken";
+        internal const string SharedWorkspaceNr = "sharedworkspacenr";
+
+        internal const string Account = "account";
+    }
+}
diff --git a/src/FakeXrmEasy.Plugins/EntityLogicalNameContants.cs b/src/FakeXrmEasy.Plugins/EntityLogicalNameContants.cs
diff --git a/src/FakeXrmEasy.Plugins/Extensions/GetAssociatedNonBulkRequestNameException.cs b/src/FakeXrmEasy.Plugins/Extensions/GetAssociatedNonBulkRequestNameException.cs
@@ -0,0 +1,21 @@
+using System;
+using Microsoft.Xrm.Sdk;
+
+namespace FakeXrmEasy.Plugins.Extensions
+{
+    /// <summary>
+    /// Exception thrown when a method was invoked on an organization request that is not a bulk operation
+    /// </summary>
+    public class GetAssociatedNonBulkRequestNameException: Exception
+    {
+        /// <summary>
+        /// Default constructor
+        /// </summary>
+        /// <param name="request"></param>
+        public GetAssociatedNonBulkRequestNameException(OrganizationRequest request): 
+            base($"GetAssociatedNonBulkRequestName can not be called on a non-bulk organization request '{request.RequestName}'")
+        {
+
+        }
+    }
+}
diff --git a/src/FakeXrmEasy.Plugins/Extensions/InvalidBulkOperationExtensionException.cs b/src/FakeXrmEasy.Plugins/Extensions/InvalidBulkOperationExtensionException.cs
@@ -0,0 +1,15 @@
+using System;
+
+namespace FakeXrmEasy.Plugins.Extensions
+{
+    /// <summary>
+    /// Exception raised when a bulk request is converted to a non bulk request but the original request wasn't a valid bulk request
+    /// </summary>
+    public class InvalidBulkOperationExtensionException: Exception
+    {
+        internal InvalidBulkOperationExtensionException() : base("Bulk Operations Organization Request extensions are not supported on non-bulk OrganizationRequests")
+        {
+
+        }
+    }
+}