feat: Support log commit stats through SpannerTransactionOptions.

Log commit stats may now be set for all transaction types.

Author: amanda-tarafa

apis/Google.Cloud.Spanner.Data/Google.Cloud.Spanner.Data.Tests/SpannerTransactionOptionsTests.cs

@@ -160,6 +160,24 @@ public void EffectiveTag_ChangesIgnoredAfterStatements(string tag, TransactionMo
         Assert.Equal(expectedEffectiveTag, effectiveTag);
     }
 
+    [Theory]
+    [InlineData(null, true, true)]
+    [InlineData(true, false, true)]
+    public void LogCommitStats_Effective(bool? optionsLogCommitStats, bool connectionLogCommitStats, bool effectiveLogCommitStats)
+    {
+        var options = new SpannerTransactionOptions
+        {
+            LogCommitStats = optionsLogCommitStats
+        };
+
+        SpannerConnectionStringBuilder builder = new SpannerConnectionStringBuilder
+        {
+            LogCommitStats = connectionLogCommitStats
+        };
+
+        Assert.Equal(effectiveLogCommitStats, options.EffectiveLogCommitStats(new SpannerConnection(builder)));
+    }
+
     [Fact]
     public void EffectiveTag_FailsOnStatementExecutionContradiction()
     {
@@ -182,12 +200,14 @@ public void CopyConstructor()
             CommitTimeout = 10,
             CommitPriority = Priority.High,
             Tag = "tag",
+            LogCommitStats = true,
         };
         var optionsCopy = new SpannerTransactionOptions(options);
 
         Assert.Equal(options.MaxCommitDelay, optionsCopy.MaxCommitDelay);
         Assert.Equal(options.CommitTimeout, optionsCopy.CommitTimeout);
         Assert.Equal(options.CommitPriority, optionsCopy.CommitPriority);
         Assert.Equal(options.Tag, optionsCopy.Tag);
+        Assert.True(optionsCopy.LogCommitStats);
     }
 }

apis/Google.Cloud.Spanner.Data/Google.Cloud.Spanner.Data.Tests/SpannerTransactionTests.cs

@@ -88,13 +88,15 @@ public void SpannerTransactionOptions_FromBeginTransaction()
             CommitTimeout = commitTimeout,
             CommitPriority = commitPriority,
             Tag = tag,
-            DisposeBehavior = DisposeBehavior.CloseResources
+            DisposeBehavior = DisposeBehavior.CloseResources,
+            LogCommitStats = true
         });
 
         Assert.Equal(commitDelay, transaction.TransactionOptions.MaxCommitDelay);
         Assert.Equal(commitTimeout, transaction.TransactionOptions.CommitTimeout);
         Assert.Equal(commitPriority, transaction.TransactionOptions.CommitPriority);
         Assert.Equal(tag, transaction.TransactionOptions.Tag);
         Assert.Equal(disposeBehavior, transaction.TransactionOptions.DisposeBehavior);
+        Assert.True(transaction.TransactionOptions.LogCommitStats);
     }
 }

apis/Google.Cloud.Spanner.Data/Google.Cloud.Spanner.Data/SpannerTransaction.cs

@@ -211,7 +211,6 @@ internal SpannerTransaction(
             bool isRetriable)
         {
             SpannerConnection = GaxPreconditions.CheckNotNull(connection, nameof(connection));
-            LogCommitStats = SpannerConnection.LogCommitStats;
             _session = GaxPreconditions.CheckNotNull(session, nameof(session));
             _creationOptions = GaxPreconditions.CheckNotNull(creationOptions, nameof(creationOptions));
             TransactionOptions = transactionOptions is null ? new SpannerTransactionOptions() : new SpannerTransactionOptions(transactionOptions);
@@ -247,7 +246,12 @@ public DisposeBehavior DisposeBehavior
         /// and log these. This property is by default equal to the value set on the SpannerConnection
         /// of this transaction, but can be overridden for a specific transaction.
         /// </summary>
-        public bool LogCommitStats { get; set; }
+        [Obsolete("Use SpannerTransactionOptions.DisposeBehavior instead.")]
+        public bool LogCommitStats
+        {
+            get => TransactionOptions.EffectiveLogCommitStats(SpannerConnection);
+            set => TransactionOptions.LogCommitStats = value;
+        }
 
         /// <summary>
         /// Creates a new <see cref="SpannerBatchCommand"/> to execute batched DML statements within this transaction.
@@ -433,7 +437,7 @@ Task<IEnumerable<long>> ISpannerTransaction.ExecuteBatchDmlAsync(ExecuteBatchDml
             var request = new CommitRequest
             {
                 Mutations = { _mutations },
-                ReturnCommitStats = LogCommitStats,
+                ReturnCommitStats = TransactionOptions.EffectiveLogCommitStats(SpannerConnection),
                 RequestOptions = BuildCommitRequestOptions(),
                 MaxCommitDelay = TransactionOptions.MaxCommitDelayDuration,
             };
@@ -450,7 +454,7 @@ Task<IEnumerable<long>> ISpannerTransaction.ExecuteBatchDmlAsync(ExecuteBatchDml
                 {
                     throw new SpannerException(ErrorCode.Internal, "Commit succeeded, but returned a response with no commit timestamp");
                 }
-                if (LogCommitStats)
+                if (TransactionOptions.EffectiveLogCommitStats(SpannerConnection))
                 {
                     SpannerConnection.Logger.LogCommitStats(request, response);
                 }

apis/Google.Cloud.Spanner.Data/Google.Cloud.Spanner.Data/SpannerTransactionOptions.cs

@@ -53,6 +53,7 @@ public SpannerTransactionOptions(SpannerTransactionOptions other)
         CommitPriority = other.CommitPriority;
         Tag = other.Tag;
         DisposeBehavior = other.DisposeBehavior;
+        LogCommitStats = other.LogCommitStats;
     }
 
     /// <summary>
@@ -162,4 +163,14 @@ public DisposeBehavior DisposeBehavior
             _disposeBehavior = GaxPreconditions.CheckEnumValue(value, nameof(DisposeBehavior));
         }
     }
+
+    /// <summary>
+    /// Specifies whether this transaction should request commit statistics from the backend
+    /// and log these. If unset, the value set on the SpannerConnection
+    /// of this transaction will be used.
+    /// </summary>
+    public bool? LogCommitStats { get; set; }
+
+    internal bool EffectiveLogCommitStats(SpannerConnection spannerConnection) =>
+        LogCommitStats ?? GaxPreconditions.CheckNotNull(spannerConnection, nameof(spannerConnection)).Builder.LogCommitStats;
 }