Merge pull request #3546 from swegele/LocalProxy_InheritFromDataPortalProxy_2861

rockfordlhotka · web-flow · commit 384da1f8359c · 2023-11-13T15:56:29.000-06:00
Normalize LocalProxy by subclassing DataPortalProxy #2861
diff --git a/Source/Csla/DataPortalClient/DataPortalProxy.cs b/Source/Csla/DataPortalClient/DataPortalProxy.cs
@@ -100,6 +100,13 @@ public async virtual Task<DataPortalResult> Create(Type objectType, object crite
       {
         result = new DataPortalResult(ApplicationContext, null, ex);
       }
+
+      var operation = DataPortalOperations.Create;
+      OnServerComplete(result, objectType, operation);
+
+      if (ExecutionIsNotOnLogicalOrPhysicalServer)
+        OnServerCompleteClient(result, objectType, operation);
+
       if (result.Error != null)
         throw result.Error;
       return result;
@@ -154,6 +161,13 @@ public async virtual Task<DataPortalResult> Fetch(Type objectType, object criter
       {
         result = new DataPortalResult(ApplicationContext, null, ex);
       }
+
+      var operation = DataPortalOperations.Fetch;
+      OnServerComplete(result, objectType, operation);
+
+      if (ExecutionIsNotOnLogicalOrPhysicalServer)
+        OnServerCompleteClient(result, objectType, operation);
+
       if (result.Error != null)
         throw result.Error;
       return result;
@@ -202,6 +216,13 @@ public async virtual Task<DataPortalResult> Update(object obj, DataPortalContext
       {
         result = new DataPortalResult(ApplicationContext, null, ex);
       }
+
+      var operation = DataPortalOperations.Update;
+      OnServerComplete(result, obj.GetType(), operation);
+
+      if (ExecutionIsNotOnLogicalOrPhysicalServer)
+        OnServerCompleteClient(result, obj.GetType(), operation);
+
       if (result.Error != null)
         throw result.Error;
       return result;
@@ -256,6 +277,13 @@ public async virtual Task<DataPortalResult> Delete(Type objectType, object crite
       {
         result = new DataPortalResult(ApplicationContext, null, ex);
       }
+
+      var operation = DataPortalOperations.Delete;
+      OnServerComplete(result, objectType, operation);
+
+      if (ExecutionIsNotOnLogicalOrPhysicalServer)
+        OnServerCompleteClient(result, objectType, operation);
+
       if (result.Error != null)
         throw result.Error;
       return result;
@@ -311,6 +339,38 @@ private string GetRoutingToken(Type objectType)
       return result;
     }
 
+    /// <summary>
+    /// Called after completion of DataPortal operation regardless if operation was originated from the client or from chained calls on the server side.
+    /// </summary>
+    /// <param name="result">Result from DataPortal operation.</param>
+    /// <param name="objectType">Type of business object.</param>
+    /// <param name="operationType">The requested data portal operation type</param>
+    protected virtual void OnServerComplete(DataPortalResult result, Type objectType, DataPortalOperations operationType)
+    {
+
+    }
+
+    /// <summary>
+    /// Called after completion of a DataPortal operation which was initiated from the <see cref="ApplicationContext.ExecutionLocations.Client"/> 
+    /// This is NOT called on completion of chained DataPortal operations initiated on the server side.
+    /// </summary>
+    /// <param name="result">Result from DataPortal operation.</param>
+    /// <param name="objectType">Type of business object.</param>
+    /// <param name="operationType">The requested data portal operation type</param>
+    protected virtual void OnServerCompleteClient(DataPortalResult result, Type objectType, DataPortalOperations operationType)
+    {
+
+    }
+
+    internal bool ExecutionIsNotOnLogicalOrPhysicalServer
+    {
+      get
+      {
+        return ApplicationContext.LogicalExecutionLocation != ApplicationContext.LogicalExecutionLocations.Server
+          && ApplicationContext.ExecutionLocation != ApplicationContext.ExecutionLocations.Server;
+      }
+    }
+
     #region Criteria
 
     private CriteriaRequest GetBaseCriteriaRequest()
diff --git a/Source/Csla/DataPortalClient/LocalProxy.cs b/Source/Csla/DataPortalClient/LocalProxy.cs
@@ -10,6 +10,7 @@
 using System.Threading;
 using System.Threading.Tasks;
 using Csla.Core;
+using Csla.DataPortalClient;
 using Csla.Runtime;
 using Csla.Server;
 using Microsoft.Extensions.DependencyInjection;
@@ -21,16 +22,16 @@ namespace Csla.Channels.Local
   /// calls to an application server hosted locally 
   /// in the client process and AppDomain.
   /// </summary>
-  public class LocalProxy : DataPortalClient.IDataPortalProxy
+  public class LocalProxy : DataPortalProxy
   {
     /// <summary>
     /// Creates an instance of the type
     /// </summary>
     /// <param name="applicationContext">ApplicationContext</param>
     /// <param name="options">Options instance</param>
     public LocalProxy(ApplicationContext applicationContext, LocalProxyOptions options)
+      : base(applicationContext)
     {
-      OriginalApplicationContext = applicationContext;
       Options = options;
     }
 
@@ -57,13 +58,27 @@ private void InitializeContext()
       _portal = currentServiceProvider.GetRequiredService<Server.IDataPortalServer>();
     }
 
-    private ApplicationContext OriginalApplicationContext { get; set; }
-    private ApplicationContext CurrentApplicationContext { get; set; }
-    private readonly LocalProxyOptions Options;
+    /// <summary>
+    /// Application Context supplied in CTOR.  If this LocalProxy was created on client side or 
+    /// if <see cref="LocalProxyOptions.UseLocalScope"/> is false then it is the client ApplicationContext 
+    /// </summary>
+    protected ApplicationContext OriginalApplicationContext {
+      get { return base.ApplicationContext; }
+    }
+
+    /// <summary>
+    /// ApplicationContext currently in use for this proxy.
+    /// If <see cref="LocalProxyOptions.UseLocalScope"/> is true, this is the ApplicationContext created in a new scope for 
+    /// logical server side data portal operations.
+    /// If <see cref="LocalProxyOptions.UseLocalScope"/> is false, this is same as <see cref="OriginalApplicationContext"/>
+    /// </summary>
+    protected ApplicationContext CurrentApplicationContext { get; set; }
 
+    private readonly LocalProxyOptions Options;
     private IServiceScope _scope;
     private Server.IDataPortalServer _portal;
 
+
     private void SetApplicationContext(object obj, ApplicationContext applicationContext)
     {
       // if there's no isolated scope, there's no reason to 
@@ -81,14 +96,14 @@ private void SetApplicationContext(IUseApplicationContext useApplicationContext,
       // change the object graph's ApplicationContext
       if (!Options.UseLocalScope)
         return;
-  
+
       if (useApplicationContext != null && !ReferenceEquals(useApplicationContext.ApplicationContext, applicationContext))
       {
         useApplicationContext.ApplicationContext = applicationContext;
 
         if (useApplicationContext is IUseFieldManager useFieldManager)
           SetApplicationContext(useFieldManager.FieldManager, applicationContext);
-        
+
         if (useApplicationContext is IUseBusinessRules useBusinessRules)
           SetApplicationContext(useBusinessRules.BusinessRules, applicationContext);
 
@@ -97,10 +112,10 @@ private void SetApplicationContext(IUseApplicationContext useApplicationContext,
           foreach (var managedProperty in target.GetManagedProperties())
           {
             var isLazyLoadedProperty = (managedProperty.RelationshipType & RelationshipTypes.LazyLoad) == RelationshipTypes.LazyLoad;
-           
+
             //only dig into property if its not a lazy loaded property 
             //  or if it is, then only if its loaded
-            if (!isLazyLoadedProperty 
+            if (!isLazyLoadedProperty
               || (isLazyLoadedProperty && target.FieldExists(managedProperty)))
             {
               if (typeof(IUseApplicationContext).IsAssignableFrom(managedProperty.Type))
@@ -143,7 +158,15 @@ private void SetApplicationContext(IUseApplicationContext useApplicationContext,
     private void ResetApplicationContext()
     {
       if (Options.UseLocalScope)
+      {
+        if (CurrentApplicationContext is not null
+          && CurrentApplicationContext.LogicalExecutionLocation == ApplicationContext.LogicalExecutionLocations.Client)
+        {
+          RestoringClientSideApplicationContext(CurrentApplicationContext, OriginalApplicationContext);
+        }
+
         CurrentApplicationContext.ApplicationContextAccessor = OriginalApplicationContext.ApplicationContextAccessor;
+      }
     }
 
     private async Task DisposeScope()
@@ -164,7 +187,7 @@ private async Task DisposeScope()
     /// <see cref="Server.DataPortalContext" /> object passed to the server.
     /// </param>
     /// <param name="isSync">True if the client-side proxy should synchronously invoke the server.</param>
-    public async Task<DataPortalResult> Create(
+    public override async Task<DataPortalResult> Create(
       Type objectType, object criteria, DataPortalContext context, bool isSync)
     {
       DataPortalResult result;
@@ -192,6 +215,13 @@ public async Task<DataPortalResult> Create(
       {
         await DisposeScope();
       }
+
+      var operation = DataPortalOperations.Create;
+      OnServerComplete(result, objectType, operation);
+
+      if (ExecutionIsNotOnLogicalOrPhysicalServer)
+        OnServerCompleteClient(result, objectType, operation);
+
       return result;
     }
 
@@ -205,7 +235,7 @@ public async Task<DataPortalResult> Create(
     /// <see cref="Server.DataPortalContext" /> object passed to the server.
     /// </param>
     /// <param name="isSync">True if the client-side proxy should synchronously invoke the server.</param>
-    public async Task<DataPortalResult> Fetch(Type objectType, object criteria, DataPortalContext context, bool isSync)
+    public override async Task<DataPortalResult> Fetch(Type objectType, object criteria, DataPortalContext context, bool isSync)
     {
       DataPortalResult result;
       try
@@ -232,6 +262,13 @@ public async Task<DataPortalResult> Fetch(Type objectType, object criteria, Data
       {
         await DisposeScope();
       }
+
+      var operation = DataPortalOperations.Fetch;
+      OnServerComplete(result, objectType, operation);
+
+      if (ExecutionIsNotOnLogicalOrPhysicalServer)
+        OnServerCompleteClient(result, objectType, operation);
+
       return result;
     }
 
@@ -244,7 +281,7 @@ public async Task<DataPortalResult> Fetch(Type objectType, object criteria, Data
     /// <see cref="Server.DataPortalContext" /> object passed to the server.
     /// </param>
     /// <param name="isSync">True if the client-side proxy should synchronously invoke the server.</param>
-    public async Task<DataPortalResult> Update(object obj, DataPortalContext context, bool isSync)
+    public override async Task<DataPortalResult> Update(object obj, DataPortalContext context, bool isSync)
     {
       DataPortalResult result;
       try
@@ -271,6 +308,13 @@ public async Task<DataPortalResult> Update(object obj, DataPortalContext context
       {
         await DisposeScope();
       }
+
+      var operation = DataPortalOperations.Update;
+      OnServerComplete(result, obj.GetType(), operation);
+
+      if (ExecutionIsNotOnLogicalOrPhysicalServer)
+        OnServerCompleteClient(result, obj.GetType(), operation);
+
       return result;
     }
 
@@ -284,7 +328,7 @@ public async Task<DataPortalResult> Update(object obj, DataPortalContext context
     /// <see cref="Server.DataPortalContext" /> object passed to the server.
     /// </param>
     /// <param name="isSync">True if the client-side proxy should synchronously invoke the server.</param>
-    public async Task<DataPortalResult> Delete(Type objectType, object criteria, DataPortalContext context, bool isSync)
+    public override async Task<DataPortalResult> Delete(Type objectType, object criteria, DataPortalContext context, bool isSync)
     {
       DataPortalResult result;
       try
@@ -311,17 +355,45 @@ public async Task<DataPortalResult> Delete(Type objectType, object criteria, Dat
       {
         await DisposeScope();
       }
+
+      var operation = DataPortalOperations.Delete;
+      OnServerComplete(result, objectType, operation);
+
+      if (ExecutionIsNotOnLogicalOrPhysicalServer)
+        OnServerCompleteClient(result, objectType, operation);
+
       return result;
     }
 
+    /// <summary>
+    /// Not needed/implemented for Local Data Portal - throws not implemented exception
+    /// </summary>
+    /// <param name="serialized">Serialised request</param>
+    /// <param name="operation">DataPortal operation</param>
+    /// <param name="routingToken">Routing Tag for server</param>
+    /// <param name="isSync">True if the client-side proxy should synchronously invoke the server.</param>
+    /// <returns>Serialised response from server</returns>
+    protected override Task<byte[]> CallDataPortalServer(byte[] serialized, string operation, string routingToken, bool isSync)
+    {
+      throw new NotImplementedException();
+    }
+
     /// <summary>
     /// Gets a value indicating whether this proxy will invoke
     /// a remote data portal server, or run the "server-side"
     /// data portal in the caller's process and AppDomain.
     /// </summary>
-    public bool IsServerRemote
+    public override bool IsServerRemote => false;
+
+    /// <summary>
+    /// Method called once when execution returns to <see cref="ApplicationContext.LogicalExecutionLocations.Client"/> after a call to 
+    /// the dataportal.  Only called when <see cref="LocalProxyOptions.UseLocalScope"/> is true.
+    /// </summary>
+    /// <param name="serverScopedApplicationContext">Context created in a new scope for use during logical server side operations</param>
+    /// <param name="clientSideApplicationContext">Original context from the client side</param>
+    protected virtual void RestoringClientSideApplicationContext(ApplicationContext serverScopedApplicationContext, ApplicationContext clientSideApplicationContext)
     {
-      get { return false; }
+
     }
   }
 }
