Merge pull request #195 from servicetitan/upstream/sessionTag

Session.Tag() method with scoped Tagging

Author: alex-kulakov

Orm/Xtensive.Orm.Tests/Linq/TagTest.cs

@@ -93,7 +93,7 @@ public static Domain Demand()
     /// <summary>
     /// Gets the information about provider's capabilities.
     /// </summary>
-    public ProviderInfo StorageProviderInfo { get { return Handlers.ProviderInfo; } }
+    public ProviderInfo StorageProviderInfo => Handlers.ProviderInfo;
 
     /// <summary>
     /// Gets the domain-level service container.
@@ -105,6 +105,13 @@ public static Domain Demand()
     /// </summary>
     public StorageNodeManager StorageNodeManager { get; private set; }
 
+    /// <summary>
+    /// Indicated whether query tagging is enabled by domain configuration
+    /// by <see cref="DomainConfiguration.TagsLocation"/> proprety set to something
+    /// other than <see cref="TagsLocation.Nowhere"/>.
+    /// </summary>
+    public bool TagsEnabled { get; }
+
     #region Private / internal members
 
     internal EntityDataReader EntityDataReader { get; private set; }
@@ -428,6 +435,7 @@ internal Domain(DomainConfiguration configuration, object upgradeContextCookie,
       UpgradeContextCookie = upgradeContextCookie;
       SingleConnection = singleConnection;
       StorageNodeManager = new StorageNodeManager(Handlers);
+      TagsEnabled = configuration.TagsLocation != TagsLocation.Nowhere;
       isDebugEventLoggingEnabled = OrmLog.IsLogged(LogLevel.Debug); // Just to cache this value
     }
 

Orm/Xtensive.Orm/Orm/Domain.cs

@@ -144,6 +144,11 @@ private QueryTask CreateQueryTask(List<Tuple> currentKeySet)
       parameterContext.SetValue(includeParameter, currentKeySet);
       var session = manager.Owner.Session;
       Provider = session.StorageNode.EntityFetchQueryCache.GetOrAdd(cacheKey, CreateRecordSet);
+      if (session.Domain.TagsEnabled && session.Tags != null) {
+        foreach (var tag in session.Tags) {
+          Provider = new TagProvider(Provider, tag);
+        }
+      }
       var executableProvider = session.Compile(Provider);
       return new QueryTask(executableProvider, session.GetLifetimeToken(), parameterContext);
     }

Orm/Xtensive.Orm/Orm/Internals/Prefetch/EntityGroupTask.cs

@@ -177,6 +177,11 @@ private QueryTask CreateQueryTask()
       var session = manager.Owner.Session;
       var scope = new CompiledQueryProcessingScope(null, null, parameterContext, false);
       QueryProvider = session.StorageNode.EntitySetFetchQueryCache.GetOrAdd(cacheKey, CreateRecordSetLoadingItems);
+      if (session.Domain.TagsEnabled && session.Tags != null) {
+        foreach (var tag in session.Tags) {
+          QueryProvider = new TagProvider(QueryProvider, tag);
+        }
+      }
       ExecutableProvider executableProvider;
       using (scope.Enter()) {
         executableProvider = session.Compile(QueryProvider);

Orm/Xtensive.Orm/Orm/Internals/Prefetch/EntitySetTask.cs

@@ -167,9 +167,9 @@ private TranslatedQuery PrepareSubqueryParameters(SubQueryExpression subQueryExp
       var subqueryTupleParameter = context.GetTupleParameter(subQueryExpression.OuterParameter);
       var dataSource = projectionExpression.ItemProjector.DataSource;
 
-      var rootTags = context.GetAllTags();
+      var rootTags = context.GetMainQueryTags();
       if (rootTags.Count > 0) {
-        dataSource = dataSource.Tag($"{RootQueryTagsPrefix} {string.Join(' ', rootTags)}");
+        dataSource = dataSource.Tag($"({RootQueryTagsPrefix} {string.Join(' ', rootTags)})");
       }
 
       var newDataSource = ApplyParameterToTupleParameterRewriter.Rewrite(
@@ -191,7 +191,10 @@ private TranslatedQuery PrepareSubqueryParameters(SubQueryExpression subQueryExp
 
       // 3. Make translation 
       elementType = projectionExpression.ItemProjector.Item.Type;
-      return context.Translator.Translate(projection, tupleParameters.Append(parameterOfTuple));
+
+      using (context.DisableSessionTags()) {
+        return context.Translator.Translate(projection, tupleParameters.Append(parameterOfTuple));
+      }
     }
 
     protected override Expression VisitFieldExpression(FieldExpression expression)

Orm/Xtensive.Orm/Orm/Linq/Materialization/ExpressionMaterializer.cs

@@ -43,8 +43,12 @@ public TranslatedQuery Translate()
     internal TranslatedQuery Translate(ProjectionExpression projection,
       IEnumerable<Parameter<Tuple>> tupleParameterBindings)
     {
-      var newItemProjector = projection.ItemProjector.EnsureEntityIsJoined();
-      var result = projection.Apply(newItemProjector);
+      var result = projection;
+      if (context.SessionTags != null)
+        result = ApplySessionTags(result, context.SessionTags);
+      var newItemProjector = result.ItemProjector.EnsureEntityIsJoined();
+      result = result.Apply(newItemProjector);
+
       var optimized = Optimize(result);
 
       // Prepare cached query, if required
@@ -60,7 +64,7 @@ internal TranslatedQuery Translate(ProjectionExpression projection,
       var materializer = BuildMaterializer(prepared, tupleParameterBindings);
       var translatedQuery = new TranslatedQuery(
         compiled, materializer, prepared.ResultAccessMethod,
-        projection.TupleParameterBindings, tupleParameterBindings);
+        result.TupleParameterBindings, tupleParameterBindings);
 
       // Providing the result to caching layer, if required
       if (compiledQueryScope != null && !translatedQuery.TupleParameters.Any()) {
@@ -104,6 +108,18 @@ private static ProjectionExpression PrepareCachedQuery(
       return origin;
     }
 
+    private static ProjectionExpression ApplySessionTags(ProjectionExpression origin, IReadOnlyList<string> tags)
+    {
+      var currentProjection = origin;
+      foreach (var tag in tags) {
+        var projector = currentProjection.ItemProjector;
+        var newDataSource = projector.DataSource.Tag(tag);
+        var newItemProjector = new ItemProjectorExpression(projector.Item, newDataSource, projector.Context);
+        currentProjection = currentProjection.Apply(newItemProjector);
+      }
+      return currentProjection;
+    }
+
     private Materializer
       BuildMaterializer(ProjectionExpression projection, IEnumerable<Parameter<Tuple>> tupleParameters)
     {
@@ -194,7 +210,7 @@ internal Translator(TranslatorContext context, CompiledQueryProcessingScope comp
     {
       this.compiledQueryScope = compiledQueryScope;
       this.context = context;
-      tagsEnabled = context.Domain.Configuration.TagsLocation != TagsLocation.Nowhere;
+      tagsEnabled = context.Domain.TagsEnabled;
     }
   }
 }

Orm/Xtensive.Orm/Orm/Linq/Translator.Materialization.cs

@@ -54,6 +54,8 @@ internal sealed class TranslatorContext
 
     public LinqBindingCollection Bindings { get; }
 
+    public IReadOnlyList<string> SessionTags { get; private set; }
+
     public bool IsRoot(Expression expression)
     {
       return Query==expression;
@@ -87,12 +89,16 @@ public ApplyParameter GetApplyParameter(CompilableProvider provider)
       return parameter;
     }
 
-    public IReadOnlyList<string> GetAllTags()
-    {
-      if (Domain.Configuration.TagsLocation == TagsLocation.Nowhere)
-        return Array.Empty<string>();
+    public IReadOnlyList<string> GetMainQueryTags() =>
+      Domain.TagsEnabled
+        ? applyParameters.Keys.OfType<TagProvider>().Select(p => p.Tag).ToList()
+        : Array.Empty<string>();
 
-      return applyParameters.Keys.OfType<TagProvider>().Select(p => p.Tag).ToList();
+    public IDisposable DisableSessionTags()
+    {
+      var originalTags = SessionTags;
+      SessionTags = null;
+      return new Disposable((b) => SessionTags = originalTags);
     }
 
     public void RebindApplyParameter(CompilableProvider old, CompilableProvider @new)
@@ -142,6 +148,7 @@ public TranslatorContext(Session session, CompilerConfiguration rseCompilerConfi
 
       Domain = session.Domain;
       RseCompilerConfiguration = rseCompilerConfiguration;
+      SessionTags = (Domain.TagsEnabled) ? session.Tags : null;
 
       // Applying query preprocessors
       query = Domain.Handler.QueryPreprocessors

Orm/Xtensive.Orm/Orm/Linq/TranslatorContext.cs

@@ -20,10 +20,8 @@ public sealed class CompilationService
     private readonly Func<CompilerConfiguration, IPreCompiler> preCompilerProvider;
     private readonly Func<CompilerConfiguration, ICompiler, IPostCompiler> postCompilerProvider;
 
-    public CompilerConfiguration CreateConfiguration(Session session)
-    {
-      return new CompilerConfiguration {StorageNode = session.StorageNode};
-    }
+    public CompilerConfiguration CreateConfiguration(Session session) =>
+      new CompilerConfiguration { StorageNode = session.StorageNode, Tags = session.Tags };
 
     public ExecutableProvider Compile(CompilableProvider provider, CompilerConfiguration configuration)
     {

Orm/Xtensive.Orm/Orm/Providers/CompilationService.cs

@@ -4,11 +4,14 @@
 // Created by: Denis Krjuchkov
 // Created:    2012.02.26
 
+using System.Collections.Generic;
+
 namespace Xtensive.Orm.Providers
 {
   public sealed class CompilerConfiguration
   {
     public bool PrepareRequest { get; set; }
+    public IReadOnlyList<string> Tags { get; init; }
 
     internal StorageNode StorageNode { get; set; }
 

Orm/Xtensive.Orm/Orm/Providers/CompilerConfiguration.cs

@@ -1,6 +1,6 @@
-// Copyright (C) 2003-2010 Xtensive LLC.
-// All rights reserved.
-// For conditions of distribution and use, see license.
+// Copyright (C) 2003-2021 Xtensive LLC.
+// This code is distributed under MIT license terms.
+// See the License.txt file in the project root for more information.
 // Created by: Dmitri Maximov
 // Created:    2008.05.19
 
@@ -20,6 +20,8 @@ namespace Xtensive.Orm.Providers
   /// </summary>
   public abstract class DomainHandler : DomainBoundHandler
   {
+    private static readonly OrderingCorrector OrderingCorrector = new OrderingCorrector(ResolveOrderingDescriptor);
+
     private Dictionary<Type, IMemberCompilerProvider> memberCompilerProviders;
 
     /// <summary>
@@ -97,8 +99,8 @@ protected virtual IPreCompiler CreatePreCompiler(CompilerConfiguration configura
       return new CompositePreCompiler(
         applyCorrector,
         skipTakeCorrector,
-        new RedundantColumnOptimizer(),
-        new OrderingCorrector(ResolveOrderingDescriptor));
+        RedundantColumnOptimizer.Instance,
+        OrderingCorrector);
     }
 
     /// <summary>