DatabaseClientImplTest.java

/*
 * Copyright 2019 Google LLC
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *       http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.google.cloud.spanner;

import static com.google.cloud.spanner.MockSpannerTestUtil.READ_COLUMN_NAMES;
import static com.google.cloud.spanner.MockSpannerTestUtil.READ_ONE_KEY_VALUE_RESULTSET;
import static com.google.cloud.spanner.MockSpannerTestUtil.READ_ONE_KEY_VALUE_STATEMENT;
import static com.google.cloud.spanner.MockSpannerTestUtil.READ_TABLE_NAME;
import static com.google.cloud.spanner.MockSpannerTestUtil.SELECT1;
import static com.google.cloud.spanner.MockSpannerTestUtil.SELECT1_FROM_TABLE;
import static com.google.cloud.spanner.MockSpannerTestUtil.SELECT1_RESULTSET;
import static com.google.cloud.spanner.SpannerApiFutures.get;
import static com.google.common.truth.Truth.assertThat;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertNotEquals;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertNull;
import static org.junit.Assert.assertThrows;
import static org.junit.Assert.assertTrue;
import static org.junit.Assume.assumeFalse;
import static org.junit.Assume.assumeTrue;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;

import com.google.api.core.ApiFuture;
import com.google.api.core.ApiFutures;
import com.google.api.gax.grpc.testing.LocalChannelProvider;
import com.google.api.gax.retrying.RetrySettings;
import com.google.api.gax.rpc.ApiCallContext;
import com.google.api.gax.rpc.ServerStream;
import com.google.api.gax.rpc.StatusCode;
import com.google.cloud.ByteArray;
import com.google.cloud.NoCredentials;
import com.google.cloud.Timestamp;
import com.google.cloud.spanner.AsyncResultSet.CallbackResponse;
import com.google.cloud.spanner.MockSpannerServiceImpl.SimulatedExecutionTime;
import com.google.cloud.spanner.MockSpannerServiceImpl.StatementResult;
import com.google.cloud.spanner.Options.RpcLockHint;
import com.google.cloud.spanner.Options.RpcOrderBy;
import com.google.cloud.spanner.Options.RpcPriority;
import com.google.cloud.spanner.Options.TransactionOption;
import com.google.cloud.spanner.ReadContext.QueryAnalyzeMode;
import com.google.cloud.spanner.SessionPool.PooledSessionFuture;
import com.google.cloud.spanner.SessionPoolOptions.ActionOnInactiveTransaction;
import com.google.cloud.spanner.SessionPoolOptions.InactiveTransactionRemovalOptions;
import com.google.cloud.spanner.SingerProto.Genre;
import com.google.cloud.spanner.SingerProto.SingerInfo;
import com.google.cloud.spanner.SpannerException.ResourceNotFoundException;
import com.google.cloud.spanner.SpannerOptions.CallContextConfigurator;
import com.google.cloud.spanner.SpannerOptions.SpannerCallContextTimeoutConfigurator;
import com.google.cloud.spanner.Type.Code;
import com.google.cloud.spanner.connection.RandomResultSetGenerator;
import com.google.common.base.Stopwatch;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.Lists;
import com.google.common.io.BaseEncoding;
import com.google.common.util.concurrent.SettableFuture;
import com.google.protobuf.AbstractMessage;
import com.google.protobuf.ByteString;
import com.google.protobuf.ListValue;
import com.google.protobuf.NullValue;
import com.google.rpc.RetryInfo;
import com.google.spanner.v1.BatchWriteRequest;
import com.google.spanner.v1.BatchWriteResponse;
import com.google.spanner.v1.BeginTransactionRequest;
import com.google.spanner.v1.CommitRequest;
import com.google.spanner.v1.CreateSessionRequest;
import com.google.spanner.v1.DeleteSessionRequest;
import com.google.spanner.v1.DirectedReadOptions;
import com.google.spanner.v1.DirectedReadOptions.IncludeReplicas;
import com.google.spanner.v1.DirectedReadOptions.ReplicaSelection;
import com.google.spanner.v1.ExecuteBatchDmlRequest;
import com.google.spanner.v1.ExecuteSqlRequest;
import com.google.spanner.v1.ExecuteSqlRequest.QueryMode;
import com.google.spanner.v1.ExecuteSqlRequest.QueryOptions;
import com.google.spanner.v1.ReadRequest;
import com.google.spanner.v1.ReadRequest.LockHint;
import com.google.spanner.v1.ReadRequest.OrderBy;
import com.google.spanner.v1.RequestOptions.Priority;
import com.google.spanner.v1.ResultSetMetadata;
import com.google.spanner.v1.ResultSetStats;
import com.google.spanner.v1.StructType;
import com.google.spanner.v1.StructType.Field;
import com.google.spanner.v1.TransactionOptions.IsolationLevel;
import com.google.spanner.v1.Type;
import com.google.spanner.v1.TypeAnnotationCode;
import com.google.spanner.v1.TypeCode;
import io.grpc.Context;
import io.grpc.Metadata;
import io.grpc.MethodDescriptor;
import io.grpc.Server;
import io.grpc.ServerInterceptors;
import io.grpc.Status;
import io.grpc.StatusRuntimeException;
import io.grpc.inprocess.InProcessServerBuilder;
import io.grpc.protobuf.lite.ProtoLiteUtils;
import io.opencensus.trace.Tracing;
import io.opentelemetry.api.OpenTelemetry;
import java.io.IOException;
import java.nio.charset.StandardCharsets;
import java.time.Duration;
import java.time.Instant;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Base64;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import java.util.Random;
import java.util.Set;
import java.util.concurrent.ExecutionException;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;
import java.util.concurrent.ScheduledThreadPoolExecutor;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.atomic.AtomicInteger;
import java.util.concurrent.atomic.AtomicLong;
import java.util.function.Function;
import java.util.logging.Level;
import java.util.logging.Logger;
import java.util.stream.Collectors;
import org.junit.After;
import org.junit.AfterClass;
import org.junit.Before;
import org.junit.BeforeClass;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.junit.runners.JUnit4;

@RunWith(JUnit4.class)
public class DatabaseClientImplTest {

  private static final String TEST_PROJECT = "my-project";
  private static final String TEST_INSTANCE = "my-instance";
  private static final String TEST_DATABASE = "my-database";
  private static final String TEST_DATABASE_ROLE = "my-role";
  private static final String INSTANCE_NAME =
      String.format("projects/%s/instances/%s", TEST_PROJECT, TEST_INSTANCE);
  private static final String DATABASE_NAME =
      String.format(
          "projects/%s/instances/%s/databases/%s", TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE);
  private static XGoogSpannerRequestIdTest.ServerHeaderEnforcer xGoogReqIdInterceptor;
  private static MockSpannerServiceImpl mockSpanner;
  private static Server server;
  private static LocalChannelProvider channelProvider;
  private static final Statement UPDATE_STATEMENT =
      Statement.of("UPDATE FOO SET BAR=1 WHERE BAZ=2");
  private static final Statement INVALID_UPDATE_STATEMENT =
      Statement.of("UPDATE NON_EXISTENT_TABLE SET BAR=1 WHERE BAZ=2");
  private static final long UPDATE_COUNT = 1L;
  private static final com.google.rpc.Status STATUS_OK =
      com.google.rpc.Status.newBuilder().setCode(com.google.rpc.Code.OK_VALUE).build();
  private static final Iterable<MutationGroup> MUTATION_GROUPS =
      ImmutableList.of(
          MutationGroup.of(
              Mutation.newInsertBuilder("FOO1").set("ID").to(1L).set("NAME").to("Bar1").build(),
              Mutation.newInsertBuilder("FOO2").set("ID").to(2L).set("NAME").to("Bar2").build()),
          MutationGroup.of(
              Mutation.newInsertBuilder("FOO3").set("ID").to(3L).set("NAME").to("Bar3").build(),
              Mutation.newInsertBuilder("FOO4").set("ID").to(4L).set("NAME").to("Bar4").build()),
          MutationGroup.of(
              Mutation.newInsertBuilder("FOO4").set("ID").to(4L).set("NAME").to("Bar4").build(),
              Mutation.newInsertBuilder("FOO5").set("ID").to(5L).set("NAME").to("Bar5").build()),
          MutationGroup.of(
              Mutation.newInsertBuilder("FOO6").set("ID").to(6L).set("NAME").to("Bar6").build()));
  private static final Iterable<BatchWriteResponse> BATCH_WRITE_RESPONSES =
      ImmutableList.of(
          BatchWriteResponse.newBuilder()
              .setStatus(STATUS_OK)
              .addAllIndexes(ImmutableList.of(0, 1))
              .build(),
          BatchWriteResponse.newBuilder()
              .setStatus(STATUS_OK)
              .addAllIndexes(ImmutableList.of(2, 3))
              .build());
  private static final DirectedReadOptions DIRECTED_READ_OPTIONS1 =
      DirectedReadOptions.newBuilder()
          .setIncludeReplicas(
              IncludeReplicas.newBuilder()
                  .addReplicaSelections(
                      ReplicaSelection.newBuilder().setLocation("us-west1").build()))
          .build();
  private static final DirectedReadOptions DIRECTED_READ_OPTIONS2 =
      DirectedReadOptions.newBuilder()
          .setIncludeReplicas(
              IncludeReplicas.newBuilder()
                  .addReplicaSelections(
                      ReplicaSelection.newBuilder().setLocation("us-east1").build()))
          .build();
  private Spanner spanner;
  private Spanner spannerWithEmptySessionPool;
  private static ExecutorService executor;

  @BeforeClass
  public static void startStaticServer() throws IOException {
    mockSpanner = new MockSpannerServiceImpl();
    mockSpanner.setAbortProbability(0.0D); // We don't want any unpredictable aborted transactions.
    mockSpanner.putStatementResult(StatementResult.update(UPDATE_STATEMENT, UPDATE_COUNT));
    mockSpanner.putStatementResult(
        StatementResult.query(SELECT1, MockSpannerTestUtil.SELECT1_RESULTSET));
    mockSpanner.putStatementResult(
        StatementResult.query(READ_ONE_KEY_VALUE_STATEMENT, READ_ONE_KEY_VALUE_RESULTSET));
    mockSpanner.putStatementResult(
        StatementResult.exception(
            INVALID_UPDATE_STATEMENT,
            Status.INVALID_ARGUMENT.withDescription("invalid statement").asRuntimeException()));
    mockSpanner.putStatementResult(
        StatementResult.query(SELECT1_FROM_TABLE, MockSpannerTestUtil.SELECT1_RESULTSET));
    mockSpanner.setBatchWriteResult(BATCH_WRITE_RESPONSES);

    Set<String> checkMethods =
        new HashSet(
            Arrays.asList(
                "google.spanner.v1.Spanner/BatchCreateSessions",
                "google.spanner.v1.Spanner/BatchWrite",
                "google.spanner.v1.Spanner/BeginTransaction",
                "google.spanner.v1.Spanner/Commit",
                "google.spanner.v1.Spanner/CreateSession",
                "google.spanner.v1.Spanner/DeleteSession",
                "google.spanner.v1.Spanner/ExecuteBatchDml",
                "google.spanner.v1.Spanner/ExecuteSql",
                "google.spanner.v1.Spanner/ExecuteStreamingSql",
                "google.spanner.v1.Spanner/GetSession",
                "google.spanner.v1.Spanner/ListSessions",
                "google.spanner.v1.Spanner/PartitionQuery",
                "google.spanner.v1.Spanner/PartitionRead",
                "google.spanner.v1.Spanner/Read",
                "google.spanner.v1.Spanner/Rollback",
                "google.spanner.v1.Spanner/StreamingRead"));
    xGoogReqIdInterceptor = new XGoogSpannerRequestIdTest.ServerHeaderEnforcer(checkMethods);
    executor = Executors.newSingleThreadExecutor();
    String uniqueName = InProcessServerBuilder.generateName();
    server =
        InProcessServerBuilder.forName(uniqueName)
            // We need to use a real executor for timeouts to occur.
            .scheduledExecutorService(new ScheduledThreadPoolExecutor(1))
            .addService(ServerInterceptors.intercept(mockSpanner, xGoogReqIdInterceptor))
            .build()
            .start();
    channelProvider = LocalChannelProvider.create(uniqueName);
  }

  @AfterClass
  public static void stopServer() throws InterruptedException {
    server.shutdown();
    server.awaitTermination();
    executor.shutdown();
  }

  @Before
  public void setUp() {
    spanner =
        SpannerOptions.newBuilder()
            .setProjectId(TEST_PROJECT)
            .setDatabaseRole(TEST_DATABASE_ROLE)
            .setChannelProvider(channelProvider)
            .setCredentials(NoCredentials.getInstance())
            .setSessionPoolOption(SessionPoolOptions.newBuilder().setFailOnSessionLeak().build())
            .build()
            .getService();
    spannerWithEmptySessionPool =
        spanner.getOptions().toBuilder()
            .setSessionPoolOption(
                SessionPoolOptions.newBuilder().setMinSessions(0).setFailOnSessionLeak().build())
            .build()
            .getService();
  }

  @After
  public void tearDown() {
    mockSpanner.unfreeze();
    spanner.close();
    spannerWithEmptySessionPool.close();
    mockSpanner.reset();
    xGoogReqIdInterceptor.reset();
    mockSpanner.removeAllExecutionTimes();
  }

  @Test
  public void
      testPoolMaintainer_whenInactiveTransactionAndSessionIsNotFoundOnBackend_removeSessionsFromPool() {
    assumeFalse(
        "Session pool maintainer test skipped for multiplexed sessions",
        isMultiplexedSessionsEnabledForRW());
    FakeClock poolMaintainerClock = new FakeClock();
    InactiveTransactionRemovalOptions inactiveTransactionRemovalOptions =
        InactiveTransactionRemovalOptions.newBuilder()
            .setIdleTimeThreshold(
                Duration.ofSeconds(
                    2L)) // any session not used for more than 2s will be long-running
            .setActionOnInactiveTransaction(ActionOnInactiveTransaction.CLOSE)
            .setExecutionFrequency(Duration.ofSeconds(1)) // execute thread every 1s
            .build();
    SessionPoolOptions sessionPoolOptions =
        SessionPoolOptions.newBuilder()
            .setMinSessions(1)
            .setMaxSessions(1) // to ensure there is 1 session and pool is 100% utilized
            .setInactiveTransactionRemovalOptions(inactiveTransactionRemovalOptions)
            .setLoopFrequency(1000L) // main thread runs every 1s
            .setPoolMaintainerClock(poolMaintainerClock)
            .build();
    try (Spanner spanner =
        SpannerOptions.newBuilder()
            .setProjectId(TEST_PROJECT)
            .setDatabaseRole(TEST_DATABASE_ROLE)
            .setChannelProvider(channelProvider)
            .setCredentials(NoCredentials.getInstance())
            .setSessionPoolOption(sessionPoolOptions)
            .build()
            .getService()) {
      DatabaseClientImpl client =
          (DatabaseClientImpl)
              spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
      Instant initialExecutionTime = client.pool.poolMaintainer.lastExecutionTime;

      poolMaintainerClock.currentTimeMillis.addAndGet(Duration.ofMinutes(3).toMillis());

      try (TransactionManager manager = client.transactionManager()) {
        TransactionContext transaction = manager.begin();
        mockSpanner.setCommitExecutionTime(
            SimulatedExecutionTime.ofException(
                mockSpanner.createSessionNotFoundException("TEST_SESSION_NAME")));
        while (true) {
          try {
            transaction.executeUpdate(UPDATE_STATEMENT);

            // Simulate a delay of 3 minutes to ensure that the below transaction is a long-running
            // one.
            // As per this test, anything which takes more than 2s is long-running
            poolMaintainerClock.currentTimeMillis.addAndGet(Duration.ofMinutes(3).toMillis());
            // force trigger pool maintainer to check for long-running sessions
            client.pool.poolMaintainer.maintainPool();

            manager.commit();
            assertNotNull(manager.getCommitTimestamp());
            break;
          } catch (AbortedException e) {
            transaction = manager.resetForRetry();
          }
          mockSpanner.setCommitExecutionTime(SimulatedExecutionTime.ofMinimumAndRandomTime(0, 0));
        }
      }
      Instant endExecutionTime = client.pool.poolMaintainer.lastExecutionTime;

      // first session executed update, session found to be long-running and cleaned up.
      // During commit, SessionNotFound exception from backend caused replacement of session and
      // transaction needs to be retried.
      // On retry, session again found to be long-running and cleaned up.
      // During commit, there was no exception from backend.

      assertNotEquals(
          endExecutionTime,
          initialExecutionTime); // if session clean up task runs then these timings won't match
      assertEquals(2, client.pool.numLeakedSessionsRemoved());
      assertTrue(client.pool.getNumberOfSessionsInPool() <= client.pool.totalSessions());
    }
  }

  @Test
  public void
      testPoolMaintainer_whenInactiveTransactionAndSessionExistsOnBackend_removeSessionsFromPool() {
    assumeFalse(
        "Session leaks tests are skipped for multiplexed sessions",
        isMultiplexedSessionsEnabledForRW());
    FakeClock poolMaintainerClock = new FakeClock();
    InactiveTransactionRemovalOptions inactiveTransactionRemovalOptions =
        InactiveTransactionRemovalOptions.newBuilder()
            .setIdleTimeThreshold(
                Duration.ofSeconds(
                    2L)) // any session not used for more than 2s will be long-running
            .setActionOnInactiveTransaction(ActionOnInactiveTransaction.CLOSE)
            .setExecutionFrequency(Duration.ofSeconds(1)) // execute thread every 1s
            .build();
    SessionPoolOptions sessionPoolOptions =
        SessionPoolOptions.newBuilder()
            .setMinSessions(1)
            .setMaxSessions(1) // to ensure there is 1 session and pool is 100% utilized
            .setInactiveTransactionRemovalOptions(inactiveTransactionRemovalOptions)
            .setLoopFrequency(1000L) // main thread runs every 1s
            .setPoolMaintainerClock(poolMaintainerClock)
            .build();
    try (Spanner spanner =
        SpannerOptions.newBuilder()
            .setProjectId(TEST_PROJECT)
            .setDatabaseRole(TEST_DATABASE_ROLE)
            .setChannelProvider(channelProvider)
            .setCredentials(NoCredentials.getInstance())
            .setSessionPoolOption(sessionPoolOptions)
            .build()
            .getService()) {
      DatabaseClientImpl client =
          (DatabaseClientImpl)
              spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
      Instant initialExecutionTime = client.pool.poolMaintainer.lastExecutionTime;

      poolMaintainerClock.currentTimeMillis.addAndGet(Duration.ofMinutes(3).toMillis());

      try (TransactionManager manager = client.transactionManager()) {
        TransactionContext transaction = manager.begin();
        while (true) {
          try {
            transaction.executeUpdate(UPDATE_STATEMENT);

            // Simulate a delay of 3 minutes to ensure that the below transaction is a long-running
            // one.
            // As per this test, anything which takes more than 2s is long-running
            poolMaintainerClock.currentTimeMillis.addAndGet(Duration.ofMinutes(3).toMillis());
            // force trigger pool maintainer to check for long-running sessions
            client.pool.poolMaintainer.maintainPool();

            manager.commit();
            assertNotNull(manager.getCommitTimestamp());
            break;
          } catch (AbortedException e) {
            transaction = manager.resetForRetry();
          }
        }
      }
      Instant endExecutionTime = client.pool.poolMaintainer.lastExecutionTime;

      // first session executed update, session found to be long-running and cleaned up.
      // During commit, SessionNotFound exception from backend caused replacement of session and
      // transaction needs to be retried.
      // On retry, session again found to be long-running and cleaned up.
      // During commit, there was no exception from backend.
      assertNotEquals(
          endExecutionTime,
          initialExecutionTime); // if session clean up task runs then these timings won't match
      assertEquals(1, client.pool.numLeakedSessionsRemoved());
      assertTrue(client.pool.getNumberOfSessionsInPool() <= client.pool.totalSessions());
    }
  }

  @Test
  public void testPoolMaintainer_whenLongRunningPartitionedUpdateRequest_takeNoAction() {
    FakeClock poolMaintainerClock = new FakeClock();
    InactiveTransactionRemovalOptions inactiveTransactionRemovalOptions =
        InactiveTransactionRemovalOptions.newBuilder()
            .setIdleTimeThreshold(
                Duration.ofSeconds(
                    2L)) // any session not used for more than 2s will be long-running
            .setActionOnInactiveTransaction(ActionOnInactiveTransaction.CLOSE)
            .setExecutionFrequency(Duration.ofSeconds(1)) // execute thread every 1s
            .build();
    SessionPoolOptions sessionPoolOptions =
        SessionPoolOptions.newBuilder()
            .setMinSessions(1)
            .setMaxSessions(1) // to ensure there is 1 session and pool is 100% utilized
            .setInactiveTransactionRemovalOptions(inactiveTransactionRemovalOptions)
            .setLoopFrequency(1000L) // main thread runs every 1s
            .setPoolMaintainerClock(poolMaintainerClock)
            .build();

    try (Spanner spanner =
        SpannerOptions.newBuilder()
            .setProjectId(TEST_PROJECT)
            .setDatabaseRole(TEST_DATABASE_ROLE)
            .setChannelProvider(channelProvider)
            .setCredentials(NoCredentials.getInstance())
            .setSessionPoolOption(sessionPoolOptions)
            .build()
            .getService()) {
      DatabaseClientImpl client =
          (DatabaseClientImpl)
              spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
      Instant initialExecutionTime = client.pool.poolMaintainer.lastExecutionTime;
      poolMaintainerClock.currentTimeMillis.addAndGet(Duration.ofMinutes(3).toMillis());

      client.executePartitionedUpdate(UPDATE_STATEMENT);

      // Simulate a delay of 3 minutes to ensure that the below transaction is a long-running one.
      // As per this test, anything which takes more than 2s is long-running
      poolMaintainerClock.currentTimeMillis.addAndGet(Duration.ofMinutes(3).toMillis());

      // force trigger pool maintainer to check for long-running sessions
      client.pool.poolMaintainer.maintainPool();

      Instant endExecutionTime = client.pool.poolMaintainer.lastExecutionTime;

      assertNotEquals(
          endExecutionTime,
          initialExecutionTime); // if session clean up task runs then these timings won't match
      assertEquals(0, client.pool.numLeakedSessionsRemoved());
      assertTrue(client.pool.getNumberOfSessionsInPool() <= client.pool.totalSessions());
    }
  }

  /**
   * PDML transaction is expected to be long-running. This is indicated through session flag
   * eligibleForLongRunning = true . For all other transactions which are not expected to be
   * long-running eligibleForLongRunning = false.
   *
   * <p>Below tests uses a session for PDML transaction. Post that, the same session is used for
   * executeUpdate(). Both transactions are long-running. The test verifies that
   * eligibleForLongRunning = false for the second transaction, and it's identified as a
   * long-running transaction.
   */
  @Test
  public void testPoolMaintainer_whenPDMLFollowedByInactiveTransaction_removeSessionsFromPool() {
    assumeFalse(
        "Session leaks tests are skipped for multiplexed sessions",
        isMultiplexedSessionsEnabledForRW());
    FakeClock poolMaintainerClock = new FakeClock();
    InactiveTransactionRemovalOptions inactiveTransactionRemovalOptions =
        InactiveTransactionRemovalOptions.newBuilder()
            .setIdleTimeThreshold(
                Duration.ofSeconds(
                    2L)) // any session not used for more than 2s will be long-running
            .setActionOnInactiveTransaction(ActionOnInactiveTransaction.CLOSE)
            .setExecutionFrequency(Duration.ofSeconds(1)) // execute thread every 1s
            .build();
    SessionPoolOptions sessionPoolOptions =
        SessionPoolOptions.newBuilder()
            .setMinSessions(1)
            .setMaxSessions(1) // to ensure there is 1 session and pool is 100% utilized
            .setInactiveTransactionRemovalOptions(inactiveTransactionRemovalOptions)
            .setLoopFrequency(1000L) // main thread runs every 1s
            .setPoolMaintainerClock(poolMaintainerClock)
            .build();
    try (Spanner spanner =
        SpannerOptions.newBuilder()
            .setProjectId(TEST_PROJECT)
            .setDatabaseRole(TEST_DATABASE_ROLE)
            .setChannelProvider(channelProvider)
            .setCredentials(NoCredentials.getInstance())
            .setSessionPoolOption(sessionPoolOptions)
            .build()
            .getService()) {
      DatabaseClientImpl client =
          (DatabaseClientImpl)
              spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
      Instant initialExecutionTime = client.pool.poolMaintainer.lastExecutionTime;

      poolMaintainerClock.currentTimeMillis.addAndGet(Duration.ofMinutes(3).toMillis());

      client.executePartitionedUpdate(UPDATE_STATEMENT);

      // Simulate a delay of 3 minutes to ensure that the below transaction is a long-running one.
      // As per this test, anything which takes more than 2s is long-running
      poolMaintainerClock.currentTimeMillis.addAndGet(Duration.ofMinutes(3).toMillis());

      // force trigger pool maintainer to check for long-running sessions
      client.pool.poolMaintainer.maintainPool();

      Instant endExecutionTime = client.pool.poolMaintainer.lastExecutionTime;

      assertNotEquals(
          endExecutionTime,
          initialExecutionTime); // if session clean up task runs then these timings won't match
      assertEquals(0, client.pool.numLeakedSessionsRemoved());
      assertTrue(client.pool.getNumberOfSessionsInPool() <= client.pool.totalSessions());

      poolMaintainerClock.currentTimeMillis.addAndGet(Duration.ofMinutes(3).toMillis());

      try (TransactionManager manager = client.transactionManager()) {
        TransactionContext transaction = manager.begin();
        while (true) {
          try {
            transaction.executeUpdate(UPDATE_STATEMENT);

            // Simulate a delay of 3 minutes to ensure that the below transaction is a long-running
            // one.
            // As per this test, anything which takes more than 2s is long-running
            poolMaintainerClock.currentTimeMillis.addAndGet(Duration.ofMinutes(3).toMillis());
            // force trigger pool maintainer to check for long-running sessions
            client.pool.poolMaintainer.maintainPool();

            manager.commit();
            assertNotNull(manager.getCommitTimestamp());
            break;
          } catch (AbortedException e) {
            transaction = manager.resetForRetry();
          }
        }
      }
      endExecutionTime = client.pool.poolMaintainer.lastExecutionTime;

      // first session executed update, session found to be long-running and cleaned up.
      // During commit, SessionNotFound exception from backend caused replacement of session and
      // transaction needs to be retried.
      // On retry, session again found to be long-running and cleaned up.
      // During commit, there was no exception from backend.
      assertNotEquals(
          endExecutionTime,
          initialExecutionTime); // if session clean up task runs then these timings won't match
      assertEquals(1, client.pool.numLeakedSessionsRemoved());
      assertTrue(client.pool.getNumberOfSessionsInPool() <= client.pool.totalSessions());
    }
  }

  @Test
  public void
      testPoolMaintainer_whenLongRunningReadsUsingTransactionRunner_retainSessionForTransaction()
          throws Exception {
    FakeClock poolMaintainerClock = new FakeClock();
    InactiveTransactionRemovalOptions inactiveTransactionRemovalOptions =
        InactiveTransactionRemovalOptions.newBuilder()
            .setIdleTimeThreshold(
                Duration.ofSeconds(
                    3L)) // any session not used for more than 3s will be long-running
            .setActionOnInactiveTransaction(ActionOnInactiveTransaction.CLOSE)
            .setExecutionFrequency(Duration.ofSeconds(1)) // execute thread every 1s
            .build();
    SessionPoolOptions sessionPoolOptions =
        SessionPoolOptions.newBuilder()
            .setMinSessions(1)
            .setMaxSessions(1) // to ensure there is 1 session and pool is 100% utilized
            .setInactiveTransactionRemovalOptions(inactiveTransactionRemovalOptions)
            .setLoopFrequency(1000L) // main thread runs every 1s
            .setPoolMaintainerClock(poolMaintainerClock)
            .build();
    try (Spanner spanner =
        SpannerOptions.newBuilder()
            .setProjectId(TEST_PROJECT)
            .setDatabaseRole(TEST_DATABASE_ROLE)
            .setChannelProvider(channelProvider)
            .setCredentials(NoCredentials.getInstance())
            .setSessionPoolOption(sessionPoolOptions)
            .build()
            .getService()) {
      DatabaseClientImpl client =
          (DatabaseClientImpl)
              spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
      Instant initialExecutionTime = client.pool.poolMaintainer.lastExecutionTime;

      TransactionRunner runner = client.readWriteTransaction();
      runner.run(
          transaction -> {
            try (ResultSet resultSet =
                transaction.read(
                    READ_TABLE_NAME,
                    KeySet.singleKey(Key.of(1L)),
                    READ_COLUMN_NAMES,
                    Options.priority(RpcPriority.HIGH))) {
              consumeResults(resultSet);
            }
            poolMaintainerClock.currentTimeMillis.addAndGet(Duration.ofMillis(1050).toMillis());

            try (ResultSet resultSet =
                transaction.read(
                    READ_TABLE_NAME,
                    KeySet.singleKey(Key.of(1L)),
                    READ_COLUMN_NAMES,
                    Options.priority(RpcPriority.HIGH))) {
              consumeResults(resultSet);
            }
            poolMaintainerClock.currentTimeMillis.addAndGet(Duration.ofMillis(2050).toMillis());

            // force trigger pool maintainer to check for long-running sessions
            client.pool.poolMaintainer.maintainPool();

            return null;
          });

      Instant endExecutionTime = client.pool.poolMaintainer.lastExecutionTime;

      assertNotEquals(
          endExecutionTime,
          initialExecutionTime); // if session clean up task runs then these timings won't match
      assertEquals(0, client.pool.numLeakedSessionsRemoved());
    }
  }

  @Test
  public void
      testPoolMaintainer_whenLongRunningQueriesUsingTransactionRunner_retainSessionForTransaction() {
    FakeClock poolMaintainerClock = new FakeClock();
    InactiveTransactionRemovalOptions inactiveTransactionRemovalOptions =
        InactiveTransactionRemovalOptions.newBuilder()
            .setIdleTimeThreshold(
                Duration.ofSeconds(
                    3L)) // any session not used for more than 3s will be long-running
            .setActionOnInactiveTransaction(ActionOnInactiveTransaction.CLOSE)
            .setExecutionFrequency(Duration.ofSeconds(1)) // execute thread every 1s
            .build();
    SessionPoolOptions sessionPoolOptions =
        SessionPoolOptions.newBuilder()
            .setMinSessions(1)
            .setMaxSessions(1) // to ensure there is 1 session and pool is 100% utilized
            .setInactiveTransactionRemovalOptions(inactiveTransactionRemovalOptions)
            .setLoopFrequency(1000L) // main thread runs every 1s
            .setPoolMaintainerClock(poolMaintainerClock)
            .build();
    try (Spanner spanner =
        SpannerOptions.newBuilder()
            .setProjectId(TEST_PROJECT)
            .setDatabaseRole(TEST_DATABASE_ROLE)
            .setChannelProvider(channelProvider)
            .setCredentials(NoCredentials.getInstance())
            .setSessionPoolOption(sessionPoolOptions)
            .build()
            .getService()) {
      DatabaseClientImpl client =
          (DatabaseClientImpl)
              spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
      Instant initialExecutionTime = client.pool.poolMaintainer.lastExecutionTime;

      TransactionRunner runner = client.readWriteTransaction();
      runner.run(
          transaction -> {
            try (ResultSet resultSet = transaction.executeQuery(SELECT1)) {
              consumeResults(resultSet);
            }
            poolMaintainerClock.currentTimeMillis.addAndGet(Duration.ofMillis(1050).toMillis());

            try (ResultSet resultSet = transaction.executeQuery(SELECT1)) {
              consumeResults(resultSet);
            }
            poolMaintainerClock.currentTimeMillis.addAndGet(Duration.ofMillis(2050).toMillis());

            // force trigger pool maintainer to check for long-running sessions
            client.pool.poolMaintainer.maintainPool();

            return null;
          });

      Instant endExecutionTime = client.pool.poolMaintainer.lastExecutionTime;

      assertNotEquals(
          endExecutionTime,
          initialExecutionTime); // if session clean up task runs then these timings won't match
      assertEquals(0, client.pool.numLeakedSessionsRemoved());
    }
  }

  @Test
  public void
      testPoolMaintainer_whenLongRunningUpdatesUsingTransactionManager_retainSessionForTransaction() {
    FakeClock poolMaintainerClock = new FakeClock();
    InactiveTransactionRemovalOptions inactiveTransactionRemovalOptions =
        InactiveTransactionRemovalOptions.newBuilder()
            .setIdleTimeThreshold(
                Duration.ofSeconds(
                    3L)) // any session not used for more than 3s will be long-running
            .setActionOnInactiveTransaction(ActionOnInactiveTransaction.CLOSE)
            .setExecutionFrequency(Duration.ofSeconds(1)) // execute thread every 1s
            .build();
    SessionPoolOptions sessionPoolOptions =
        SessionPoolOptions.newBuilder()
            .setMinSessions(1)
            .setMaxSessions(1) // to ensure there is 1 session and pool is 100% utilized
            .setInactiveTransactionRemovalOptions(inactiveTransactionRemovalOptions)
            .setLoopFrequency(1000L) // main thread runs every 1s
            .setPoolMaintainerClock(poolMaintainerClock)
            .build();
    try (Spanner spanner =
        SpannerOptions.newBuilder()
            .setProjectId(TEST_PROJECT)
            .setDatabaseRole(TEST_DATABASE_ROLE)
            .setChannelProvider(channelProvider)
            .setCredentials(NoCredentials.getInstance())
            .setSessionPoolOption(sessionPoolOptions)
            .build()
            .getService()) {
      DatabaseClientImpl client =
          (DatabaseClientImpl)
              spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
      Instant initialExecutionTime = client.pool.poolMaintainer.lastExecutionTime;

      try (TransactionManager manager = client.transactionManager()) {
        TransactionContext transaction = manager.begin();
        while (true) {
          try {
            transaction.executeUpdate(UPDATE_STATEMENT);
            poolMaintainerClock.currentTimeMillis.addAndGet(Duration.ofMillis(1050).toMillis());

            transaction.executeUpdate(UPDATE_STATEMENT);
            poolMaintainerClock.currentTimeMillis.addAndGet(Duration.ofMillis(2050).toMillis());

            // force trigger pool maintainer to check for long-running sessions
            client.pool.poolMaintainer.maintainPool();

            manager.commit();
            assertNotNull(manager.getCommitTimestamp());
            break;
          } catch (AbortedException e) {
            transaction = manager.resetForRetry();
          }
        }
      }
      Instant endExecutionTime = client.pool.poolMaintainer.lastExecutionTime;

      assertNotEquals(
          endExecutionTime,
          initialExecutionTime); // if session clean up task runs then these timings won't match
      assertEquals(0, client.pool.numLeakedSessionsRemoved());
      assertTrue(client.pool.getNumberOfSessionsInPool() <= client.pool.totalSessions());
    }
  }

  @Test
  public void
      testPoolMaintainer_whenLongRunningReadsUsingTransactionManager_retainSessionForTransaction() {
    FakeClock poolMaintainerClock = new FakeClock();
    InactiveTransactionRemovalOptions inactiveTransactionRemovalOptions =
        InactiveTransactionRemovalOptions.newBuilder()
            .setIdleTimeThreshold(
                Duration.ofSeconds(
                    3L)) // any session not used for more than 3s will be long-running
            .setActionOnInactiveTransaction(ActionOnInactiveTransaction.CLOSE)
            .setExecutionFrequency(Duration.ofSeconds(1)) // execute thread every 1s
            .build();
    SessionPoolOptions sessionPoolOptions =
        SessionPoolOptions.newBuilder()
            .setMinSessions(1)
            .setMaxSessions(1) // to ensure there is 1 session and pool is 100% utilized
            .setInactiveTransactionRemovalOptions(inactiveTransactionRemovalOptions)
            .setLoopFrequency(1000L) // main thread runs every 1s
            .setPoolMaintainerClock(poolMaintainerClock)
            .build();
    try (Spanner spanner =
        SpannerOptions.newBuilder()
            .setProjectId(TEST_PROJECT)
            .setDatabaseRole(TEST_DATABASE_ROLE)
            .setChannelProvider(channelProvider)
            .setCredentials(NoCredentials.getInstance())
            .setSessionPoolOption(sessionPoolOptions)
            .build()
            .getService()) {
      DatabaseClientImpl client =
          (DatabaseClientImpl)
              spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
      Instant initialExecutionTime = client.pool.poolMaintainer.lastExecutionTime;

      try (TransactionManager manager = client.transactionManager()) {
        TransactionContext transaction = manager.begin();
        while (true) {
          try {
            try (ResultSet resultSet =
                transaction.read(
                    READ_TABLE_NAME,
                    KeySet.singleKey(Key.of(1L)),
                    READ_COLUMN_NAMES,
                    Options.priority(RpcPriority.HIGH))) {
              consumeResults(resultSet);
            }
            poolMaintainerClock.currentTimeMillis.addAndGet(Duration.ofMillis(1050).toMillis());

            try (ResultSet resultSet =
                transaction.read(
                    READ_TABLE_NAME,
                    KeySet.singleKey(Key.of(1L)),
                    READ_COLUMN_NAMES,
                    Options.priority(RpcPriority.HIGH))) {
              consumeResults(resultSet);
            }
            poolMaintainerClock.currentTimeMillis.addAndGet(Duration.ofMillis(2050).toMillis());

            // force trigger pool maintainer to check for long-running sessions
            client.pool.poolMaintainer.maintainPool();

            manager.commit();
            assertNotNull(manager.getCommitTimestamp());
            break;
          } catch (AbortedException e) {
            transaction = manager.resetForRetry();
          }
        }
      }
      Instant endExecutionTime = client.pool.poolMaintainer.lastExecutionTime;

      assertNotEquals(
          endExecutionTime,
          initialExecutionTime); // if session clean up task runs then these timings won't match
      assertEquals(0, client.pool.numLeakedSessionsRemoved());
      assertTrue(client.pool.getNumberOfSessionsInPool() <= client.pool.totalSessions());
    }
  }

  @Test
  public void
      testPoolMaintainer_whenLongRunningReadRowUsingTransactionManager_retainSessionForTransaction() {
    FakeClock poolMaintainerClock = new FakeClock();
    InactiveTransactionRemovalOptions inactiveTransactionRemovalOptions =
        InactiveTransactionRemovalOptions.newBuilder()
            .setIdleTimeThreshold(
                Duration.ofSeconds(
                    3L)) // any session not used for more than 3s will be long-running
            .setActionOnInactiveTransaction(ActionOnInactiveTransaction.CLOSE)
            .setExecutionFrequency(Duration.ofSeconds(1)) // execute thread every 1s
            .build();
    SessionPoolOptions sessionPoolOptions =
        SessionPoolOptions.newBuilder()
            .setMinSessions(1)
            .setMaxSessions(1) // to ensure there is 1 session and pool is 100% utilized
            .setInactiveTransactionRemovalOptions(inactiveTransactionRemovalOptions)
            .setLoopFrequency(1000L) // main thread runs every 1s
            .setPoolMaintainerClock(poolMaintainerClock)
            .build();
    try (Spanner spanner =
        SpannerOptions.newBuilder()
            .setProjectId(TEST_PROJECT)
            .setDatabaseRole(TEST_DATABASE_ROLE)
            .setChannelProvider(channelProvider)
            .setCredentials(NoCredentials.getInstance())
            .setSessionPoolOption(sessionPoolOptions)
            .build()
            .getService()) {
      DatabaseClientImpl client =
          (DatabaseClientImpl)
              spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
      Instant initialExecutionTime = client.pool.poolMaintainer.lastExecutionTime;

      try (TransactionManager manager = client.transactionManager()) {
        TransactionContext transaction = manager.begin();
        while (true) {
          try {
            transaction.readRow(READ_TABLE_NAME, Key.of(1L), READ_COLUMN_NAMES);

            poolMaintainerClock.currentTimeMillis.addAndGet(Duration.ofMillis(1050).toMillis());

            transaction.readRow(READ_TABLE_NAME, Key.of(1L), READ_COLUMN_NAMES);

            poolMaintainerClock.currentTimeMillis.addAndGet(Duration.ofMillis(2050).toMillis());

            // force trigger pool maintainer to check for long-running sessions
            client.pool.poolMaintainer.maintainPool();

            manager.commit();
            assertNotNull(manager.getCommitTimestamp());
            break;
          } catch (AbortedException e) {
            transaction = manager.resetForRetry();
          }
        }
      }
      Instant endExecutionTime = client.pool.poolMaintainer.lastExecutionTime;

      assertNotEquals(
          endExecutionTime,
          initialExecutionTime); // if session clean up task runs then these timings won't match
      assertEquals(0, client.pool.numLeakedSessionsRemoved());
      assertTrue(client.pool.getNumberOfSessionsInPool() <= client.pool.totalSessions());
    }
  }

  @Test
  public void
      testPoolMaintainer_whenLongRunningAnalyzeUpdateStatementUsingTransactionManager_retainSessionForTransaction() {
    FakeClock poolMaintainerClock = new FakeClock();
    InactiveTransactionRemovalOptions inactiveTransactionRemovalOptions =
        InactiveTransactionRemovalOptions.newBuilder()
            .setIdleTimeThreshold(
                Duration.ofSeconds(
                    3L)) // any session not used for more than 3s will be long-running
            .setActionOnInactiveTransaction(ActionOnInactiveTransaction.CLOSE)
            .setExecutionFrequency(Duration.ofSeconds(1)) // execute thread every 1s
            .build();
    SessionPoolOptions sessionPoolOptions =
        SessionPoolOptions.newBuilder()
            .setMinSessions(1)
            .setMaxSessions(1) // to ensure there is 1 session and pool is 100% utilized
            .setInactiveTransactionRemovalOptions(inactiveTransactionRemovalOptions)
            .setLoopFrequency(1000L) // main thread runs every 1s
            .setPoolMaintainerClock(poolMaintainerClock)
            .build();
    try (Spanner spanner =
        SpannerOptions.newBuilder()
            .setProjectId(TEST_PROJECT)
            .setDatabaseRole(TEST_DATABASE_ROLE)
            .setChannelProvider(channelProvider)
            .setCredentials(NoCredentials.getInstance())
            .setSessionPoolOption(sessionPoolOptions)
            .build()
            .getService()) {
      DatabaseClientImpl client =
          (DatabaseClientImpl)
              spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
      Instant initialExecutionTime = client.pool.poolMaintainer.lastExecutionTime;

      try (TransactionManager manager = client.transactionManager()) {
        TransactionContext transaction = manager.begin();
        while (true) {
          try {
            try (ResultSet resultSet =
                transaction.analyzeUpdateStatement(UPDATE_STATEMENT, QueryAnalyzeMode.PROFILE)) {
              consumeResults(resultSet);
            }
            poolMaintainerClock.currentTimeMillis.addAndGet(Duration.ofMillis(1050).toMillis());

            try (ResultSet resultSet =
                transaction.analyzeUpdateStatement(UPDATE_STATEMENT, QueryAnalyzeMode.PROFILE)) {
              consumeResults(resultSet);
            }
            poolMaintainerClock.currentTimeMillis.addAndGet(Duration.ofMillis(2050).toMillis());

            // force trigger pool maintainer to check for long-running sessions
            client.pool.poolMaintainer.maintainPool();

            manager.commit();
            assertNotNull(manager.getCommitTimestamp());
            break;
          } catch (AbortedException e) {
            transaction = manager.resetForRetry();
          }
        }
      }
      Instant endExecutionTime = client.pool.poolMaintainer.lastExecutionTime;

      assertNotEquals(
          endExecutionTime,
          initialExecutionTime); // if session clean up task runs then these timings won't match
      assertEquals(0, client.pool.numLeakedSessionsRemoved());
      assertTrue(client.pool.getNumberOfSessionsInPool() <= client.pool.totalSessions());
    }
  }

  @Test
  public void
      testPoolMaintainer_whenLongRunningBatchUpdatesUsingTransactionManager_retainSessionForTransaction() {
    FakeClock poolMaintainerClock = new FakeClock();
    InactiveTransactionRemovalOptions inactiveTransactionRemovalOptions =
        InactiveTransactionRemovalOptions.newBuilder()
            .setIdleTimeThreshold(
                Duration.ofSeconds(
                    3L)) // any session not used for more than 3s will be long-running
            .setActionOnInactiveTransaction(ActionOnInactiveTransaction.CLOSE)
            .setExecutionFrequency(Duration.ofSeconds(1)) // execute thread every 1s
            .build();
    SessionPoolOptions sessionPoolOptions =
        SessionPoolOptions.newBuilder()
            .setMinSessions(1)
            .setMaxSessions(1) // to ensure there is 1 session and pool is 100% utilized
            .setInactiveTransactionRemovalOptions(inactiveTransactionRemovalOptions)
            .setLoopFrequency(1000L) // main thread runs every 1s
            .setPoolMaintainerClock(poolMaintainerClock)
            .build();
    try (Spanner spanner =
        SpannerOptions.newBuilder()
            .setProjectId(TEST_PROJECT)
            .setDatabaseRole(TEST_DATABASE_ROLE)
            .setChannelProvider(channelProvider)
            .setCredentials(NoCredentials.getInstance())
            .setSessionPoolOption(sessionPoolOptions)
            .build()
            .getService()) {
      DatabaseClientImpl client =
          (DatabaseClientImpl)
              spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
      Instant initialExecutionTime = client.pool.poolMaintainer.lastExecutionTime;

      try (TransactionManager manager = client.transactionManager()) {
        TransactionContext transaction = manager.begin();
        while (true) {
          try {
            transaction.batchUpdate(Lists.newArrayList(UPDATE_STATEMENT));

            poolMaintainerClock.currentTimeMillis.addAndGet(Duration.ofMillis(1050).toMillis());

            transaction.batchUpdate(Lists.newArrayList(UPDATE_STATEMENT));

            poolMaintainerClock.currentTimeMillis.addAndGet(Duration.ofMillis(2050).toMillis());

            // force trigger pool maintainer to check for long-running sessions
            client.pool.poolMaintainer.maintainPool();

            manager.commit();
            assertNotNull(manager.getCommitTimestamp());
            break;
          } catch (AbortedException e) {
            transaction = manager.resetForRetry();
          }
        }
      }
      Instant endExecutionTime = client.pool.poolMaintainer.lastExecutionTime;

      assertNotEquals(
          endExecutionTime,
          initialExecutionTime); // if session clean up task runs then these timings won't match
      assertEquals(0, client.pool.numLeakedSessionsRemoved());
      assertTrue(client.pool.getNumberOfSessionsInPool() <= client.pool.totalSessions());
    }
  }

  @Test
  public void
      testPoolMaintainer_whenLongRunningBatchUpdatesAsyncUsingTransactionManager_retainSessionForTransaction() {
    FakeClock poolMaintainerClock = new FakeClock();
    InactiveTransactionRemovalOptions inactiveTransactionRemovalOptions =
        InactiveTransactionRemovalOptions.newBuilder()
            .setIdleTimeThreshold(
                Duration.ofSeconds(
                    3L)) // any session not used for more than 3s will be long-running
            .setActionOnInactiveTransaction(ActionOnInactiveTransaction.CLOSE)
            .setExecutionFrequency(Duration.ofSeconds(1)) // execute thread every 1s
            .build();
    SessionPoolOptions sessionPoolOptions =
        SessionPoolOptions.newBuilder()
            .setMinSessions(1)
            .setMaxSessions(1) // to ensure there is 1 session and pool is 100% utilized
            .setInactiveTransactionRemovalOptions(inactiveTransactionRemovalOptions)
            .setLoopFrequency(1000L) // main thread runs every 1s
            .setPoolMaintainerClock(poolMaintainerClock)
            .build();
    try (Spanner spanner =
        SpannerOptions.newBuilder()
            .setProjectId(TEST_PROJECT)
            .setDatabaseRole(TEST_DATABASE_ROLE)
            .setChannelProvider(channelProvider)
            .setCredentials(NoCredentials.getInstance())
            .setSessionPoolOption(sessionPoolOptions)
            .build()
            .getService()) {
      DatabaseClientImpl client =
          (DatabaseClientImpl)
              spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
      Instant initialExecutionTime = client.pool.poolMaintainer.lastExecutionTime;

      try (TransactionManager manager = client.transactionManager()) {
        TransactionContext transaction = manager.begin();
        while (true) {
          try {
            transaction.batchUpdateAsync(Lists.newArrayList(UPDATE_STATEMENT));

            poolMaintainerClock.currentTimeMillis.addAndGet(Duration.ofMillis(1050).toMillis());

            transaction.batchUpdateAsync(Lists.newArrayList(UPDATE_STATEMENT));

            poolMaintainerClock.currentTimeMillis.addAndGet(Duration.ofMillis(2050).toMillis());

            // force trigger pool maintainer to check for long-running sessions
            client.pool.poolMaintainer.maintainPool();

            manager.commit();
            assertNotNull(manager.getCommitTimestamp());
            break;
          } catch (AbortedException e) {
            transaction = manager.resetForRetry();
          }
        }
      }
      Instant endExecutionTime = client.pool.poolMaintainer.lastExecutionTime;

      assertNotEquals(
          endExecutionTime,
          initialExecutionTime); // if session clean up task runs then these timings won't match
      assertEquals(0, client.pool.numLeakedSessionsRemoved());
      assertTrue(client.pool.getNumberOfSessionsInPool() <= client.pool.totalSessions());
    }
  }

  @Test
  public void
      testPoolMaintainer_whenLongRunningExecuteQueryUsingTransactionManager_retainSessionForTransaction() {
    FakeClock poolMaintainerClock = new FakeClock();
    InactiveTransactionRemovalOptions inactiveTransactionRemovalOptions =
        InactiveTransactionRemovalOptions.newBuilder()
            .setIdleTimeThreshold(
                Duration.ofSeconds(
                    3L)) // any session not used for more than 3s will be long-running
            .setActionOnInactiveTransaction(ActionOnInactiveTransaction.CLOSE)
            .setExecutionFrequency(Duration.ofSeconds(1)) // execute thread every 1s
            .build();
    SessionPoolOptions sessionPoolOptions =
        SessionPoolOptions.newBuilder()
            .setMinSessions(1)
            .setMaxSessions(1) // to ensure there is 1 session and pool is 100% utilized
            .setInactiveTransactionRemovalOptions(inactiveTransactionRemovalOptions)
            .setLoopFrequency(1000L) // main thread runs every 1s
            .setPoolMaintainerClock(poolMaintainerClock)
            .build();
    try (Spanner spanner =
        SpannerOptions.newBuilder()
            .setProjectId(TEST_PROJECT)
            .setDatabaseRole(TEST_DATABASE_ROLE)
            .setChannelProvider(channelProvider)
            .setCredentials(NoCredentials.getInstance())
            .setSessionPoolOption(sessionPoolOptions)
            .build()
            .getService()) {
      DatabaseClientImpl client =
          (DatabaseClientImpl)
              spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
      Instant initialExecutionTime = client.pool.poolMaintainer.lastExecutionTime;

      try (TransactionManager manager = client.transactionManager()) {
        TransactionContext transaction = manager.begin();
        while (true) {
          try {
            try (ResultSet resultSet = transaction.executeQuery(SELECT1)) {
              consumeResults(resultSet);
            }
            poolMaintainerClock.currentTimeMillis.addAndGet(Duration.ofMillis(1050).toMillis());

            try (ResultSet resultSet = transaction.executeQuery(SELECT1)) {
              consumeResults(resultSet);
            }
            poolMaintainerClock.currentTimeMillis.addAndGet(Duration.ofMillis(2050).toMillis());

            // force trigger pool maintainer to check for long-running sessions
            client.pool.poolMaintainer.maintainPool();

            manager.commit();
            assertNotNull(manager.getCommitTimestamp());
            break;
          } catch (AbortedException e) {
            transaction = manager.resetForRetry();
          }
        }
      }
      Instant endExecutionTime = client.pool.poolMaintainer.lastExecutionTime;

      assertNotEquals(
          endExecutionTime,
          initialExecutionTime); // if session clean up task runs then these timings won't match
      assertEquals(0, client.pool.numLeakedSessionsRemoved());
      assertTrue(client.pool.getNumberOfSessionsInPool() <= client.pool.totalSessions());
    }
  }

  @Test
  public void
      testPoolMaintainer_whenLongRunningExecuteQueryAsyncUsingTransactionManager_retainSessionForTransaction() {
    FakeClock poolMaintainerClock = new FakeClock();
    InactiveTransactionRemovalOptions inactiveTransactionRemovalOptions =
        InactiveTransactionRemovalOptions.newBuilder()
            .setIdleTimeThreshold(
                Duration.ofSeconds(
                    3L)) // any session not used for more than 3s will be long-running
            .setActionOnInactiveTransaction(ActionOnInactiveTransaction.CLOSE)
            .setExecutionFrequency(Duration.ofSeconds(1)) // execute thread every 1s
            .build();
    SessionPoolOptions sessionPoolOptions =
        SessionPoolOptions.newBuilder()
            .setMinSessions(1)
            .setMaxSessions(1) // to ensure there is 1 session and pool is 100% utilized
            .setInactiveTransactionRemovalOptions(inactiveTransactionRemovalOptions)
            .setLoopFrequency(1000L) // main thread runs every 1s
            .setPoolMaintainerClock(poolMaintainerClock)
            .build();
    try (Spanner spanner =
        SpannerOptions.newBuilder()
            .setProjectId(TEST_PROJECT)
            .setDatabaseRole(TEST_DATABASE_ROLE)
            .setChannelProvider(channelProvider)
            .setCredentials(NoCredentials.getInstance())
            .setSessionPoolOption(sessionPoolOptions)
            .build()
            .getService()) {
      DatabaseClientImpl client =
          (DatabaseClientImpl)
              spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
      Instant initialExecutionTime = client.pool.poolMaintainer.lastExecutionTime;

      try (TransactionManager manager = client.transactionManager()) {
        TransactionContext transaction = manager.begin();
        while (true) {
          try {
            try (ResultSet resultSet = transaction.executeQueryAsync(SELECT1)) {
              consumeResults(resultSet);
            }
            poolMaintainerClock.currentTimeMillis.addAndGet(Duration.ofMillis(1050).toMillis());

            try (ResultSet resultSet = transaction.executeQueryAsync(SELECT1)) {
              consumeResults(resultSet);
            }
            poolMaintainerClock.currentTimeMillis.addAndGet(Duration.ofMillis(2050).toMillis());

            // force trigger pool maintainer to check for long-running sessions
            client.pool.poolMaintainer.maintainPool();

            manager.commit();
            assertNotNull(manager.getCommitTimestamp());
            break;
          } catch (AbortedException e) {
            transaction = manager.resetForRetry();
          }
        }
      }
      Instant endExecutionTime = client.pool.poolMaintainer.lastExecutionTime;

      assertNotEquals(
          endExecutionTime,
          initialExecutionTime); // if session clean up task runs then these timings won't match
      assertEquals(0, client.pool.numLeakedSessionsRemoved());
      assertTrue(client.pool.getNumberOfSessionsInPool() <= client.pool.totalSessions());
    }
  }

  @Test
  public void
      testPoolMaintainer_whenLongRunningAnalyzeQueryUsingTransactionManager_retainSessionForTransaction() {
    FakeClock poolMaintainerClock = new FakeClock();
    InactiveTransactionRemovalOptions inactiveTransactionRemovalOptions =
        InactiveTransactionRemovalOptions.newBuilder()
            .setIdleTimeThreshold(
                Duration.ofSeconds(
                    3L)) // any session not used for more than 3s will be long-running
            .setActionOnInactiveTransaction(ActionOnInactiveTransaction.CLOSE)
            .setExecutionFrequency(Duration.ofSeconds(1)) // execute thread every 1s
            .build();
    SessionPoolOptions sessionPoolOptions =
        SessionPoolOptions.newBuilder()
            .setMinSessions(1)
            .setMaxSessions(1) // to ensure there is 1 session and pool is 100% utilized
            .setInactiveTransactionRemovalOptions(inactiveTransactionRemovalOptions)
            .setLoopFrequency(1000L) // main thread runs every 1s
            .setPoolMaintainerClock(poolMaintainerClock)
            .build();
    try (Spanner spanner =
        SpannerOptions.newBuilder()
            .setProjectId(TEST_PROJECT)
            .setDatabaseRole(TEST_DATABASE_ROLE)
            .setChannelProvider(channelProvider)
            .setCredentials(NoCredentials.getInstance())
            .setSessionPoolOption(sessionPoolOptions)
            .build()
            .getService()) {
      DatabaseClientImpl client =
          (DatabaseClientImpl)
              spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
      Instant initialExecutionTime = client.pool.poolMaintainer.lastExecutionTime;

      try (TransactionManager manager = client.transactionManager()) {
        TransactionContext transaction = manager.begin();
        while (true) {
          try {
            try (ResultSet resultSet =
                transaction.analyzeQuery(SELECT1, QueryAnalyzeMode.PROFILE)) {
              consumeResults(resultSet);
            }
            poolMaintainerClock.currentTimeMillis.addAndGet(Duration.ofMillis(1050).toMillis());

            try (ResultSet resultSet =
                transaction.analyzeQuery(SELECT1, QueryAnalyzeMode.PROFILE)) {
              consumeResults(resultSet);
            }
            poolMaintainerClock.currentTimeMillis.addAndGet(Duration.ofMillis(2050).toMillis());

            // force trigger pool maintainer to check for long-running sessions
            client.pool.poolMaintainer.maintainPool();

            manager.commit();
            assertNotNull(manager.getCommitTimestamp());
            break;
          } catch (AbortedException e) {
            transaction = manager.resetForRetry();
          }
        }
      }
      Instant endExecutionTime = client.pool.poolMaintainer.lastExecutionTime;

      assertNotEquals(
          endExecutionTime,
          initialExecutionTime); // if session clean up task runs then these timings won't match
      assertEquals(0, client.pool.numLeakedSessionsRemoved());
      assertTrue(client.pool.getNumberOfSessionsInPool() <= client.pool.totalSessions());
    }
  }

  @Test
  public void testWrite() {
    DatabaseClient client =
        spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
    Timestamp timestamp = MockSpannerTestActions.writeInsertMutation(client);
    assertNotNull(timestamp);

    List<BeginTransactionRequest> beginTransactions =
        mockSpanner.getRequestsOfType(BeginTransactionRequest.class);
    assertThat(beginTransactions).hasSize(1);
    BeginTransactionRequest beginTransaction = beginTransactions.get(0);
    assertNotNull(beginTransaction.getOptions());
    assertTrue(beginTransaction.getOptions().hasReadWrite());
    assertFalse(beginTransaction.getOptions().getExcludeTxnFromChangeStreams());

    List<CommitRequest> commitRequests = mockSpanner.getRequestsOfType(CommitRequest.class);
    assertThat(commitRequests).hasSize(1);
    CommitRequest commit = commitRequests.get(0);
    assertNotNull(commit.getRequestOptions());
    assertEquals(Priority.PRIORITY_UNSPECIFIED, commit.getRequestOptions().getPriority());
  }

  @Test
  public void testWriteAborted() {
    DatabaseClient client =
        spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
    // Force the Commit RPC to return Aborted the first time it is called. The exception is cleared
    // after the first call, so the retry should succeed.
    mockSpanner.setCommitExecutionTime(
        SimulatedExecutionTime.ofException(
            mockSpanner.createAbortedException(ByteString.copyFromUtf8("test"))));
    Timestamp timestamp = MockSpannerTestActions.writeInsertMutation(client);
    assertNotNull(timestamp);

    List<CommitRequest> commitRequests = mockSpanner.getRequestsOfType(CommitRequest.class);
    assertEquals(2, commitRequests.size());
  }

  @Test
  public void testWriteAtLeastOnceAborted() {
    DatabaseClient client =
        spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
    // Force the Commit RPC to return Aborted the first time it is called. The exception is cleared
    // after the first call, so the retry should succeed.
    mockSpanner.setCommitExecutionTime(
        SimulatedExecutionTime.ofException(
            mockSpanner.createAbortedException(ByteString.copyFromUtf8("test"))));
    Timestamp timestamp = MockSpannerTestActions.writeAtLeastOnceInsertMutation(client);
    assertNotNull(timestamp);

    List<CommitRequest> commitRequests = mockSpanner.getRequestsOfType(CommitRequest.class);
    assertEquals(2, commitRequests.size());
    xGoogReqIdInterceptor.assertIntegrity();
  }

  @Test
  public void testWriteWithOptions() {
    DatabaseClient client =
        spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
    MockSpannerTestActions.writeInsertMutationWithOptions(
        client, Options.priority(RpcPriority.HIGH));

    List<BeginTransactionRequest> beginTransactions =
        mockSpanner.getRequestsOfType(BeginTransactionRequest.class);
    assertThat(beginTransactions).hasSize(1);
    BeginTransactionRequest beginTransaction = beginTransactions.get(0);
    assertNotNull(beginTransaction.getOptions());
    assertTrue(beginTransaction.getOptions().hasReadWrite());
    assertFalse(beginTransaction.getOptions().getExcludeTxnFromChangeStreams());

    List<CommitRequest> commits = mockSpanner.getRequestsOfType(CommitRequest.class);
    assertThat(commits).hasSize(1);
    CommitRequest commit = commits.get(0);
    assertNotNull(commit.getRequestOptions());
    assertEquals(Priority.PRIORITY_HIGH, commit.getRequestOptions().getPriority());
  }

  @Test
  public void testWriteWithCommitStats() {
    DatabaseClient client =
        spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
    CommitResponse response =
        client.writeWithOptions(
            Collections.singletonList(
                Mutation.newInsertBuilder("FOO").set("ID").to(1L).set("NAME").to("Bar").build()),
            Options.commitStats());
    assertNotNull(response);
    assertNotNull(response.getCommitTimestamp());
    assertNotNull(response.getCommitStats());
  }

  @Test
  public void testWriteWithExcludeTxnFromChangeStreams() {
    DatabaseClient client =
        spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
    MockSpannerTestActions.writeInsertMutationWithOptions(
        client, Options.excludeTxnFromChangeStreams());

    List<BeginTransactionRequest> beginTransactions =
        mockSpanner.getRequestsOfType(BeginTransactionRequest.class);
    assertThat(beginTransactions).hasSize(1);
    BeginTransactionRequest beginTransaction = beginTransactions.get(0);
    assertNotNull(beginTransaction.getOptions());
    assertTrue(beginTransaction.getOptions().hasReadWrite());
    assertTrue(beginTransaction.getOptions().getExcludeTxnFromChangeStreams());
  }

  @Test
  public void testWriteAtLeastOnce() {
    DatabaseClient client =
        spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
    Timestamp timestamp = MockSpannerTestActions.writeAtLeastOnceInsertMutation(client);
    assertNotNull(timestamp);

    List<CommitRequest> commitRequests = mockSpanner.getRequestsOfType(CommitRequest.class);
    assertThat(commitRequests).hasSize(1);
    CommitRequest commit = commitRequests.get(0);
    assertNotNull(commit.getSingleUseTransaction());
    assertTrue(commit.getSingleUseTransaction().hasReadWrite());
    assertFalse(commit.getSingleUseTransaction().getExcludeTxnFromChangeStreams());
    assertNotNull(commit.getRequestOptions());
    assertEquals(Priority.PRIORITY_UNSPECIFIED, commit.getRequestOptions().getPriority());
  }

  @Test
  public void testWriteAtLeastOnceWithCommitStats() {
    DatabaseClient client =
        spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
    CommitResponse response =
        client.writeAtLeastOnceWithOptions(
            Collections.singletonList(
                Mutation.newInsertBuilder("FOO").set("ID").to(1L).set("NAME").to("Bar").build()),
            Options.commitStats());
    assertNotNull(response);
    assertNotNull(response.getCommitTimestamp());
    assertNotNull(response.getCommitStats());

    List<CommitRequest> commitRequests = mockSpanner.getRequestsOfType(CommitRequest.class);
    assertThat(commitRequests).hasSize(1);
    CommitRequest commit = commitRequests.get(0);
    assertNotNull(commit.getSingleUseTransaction());
    assertTrue(commit.getSingleUseTransaction().hasReadWrite());
    assertFalse(commit.getSingleUseTransaction().getExcludeTxnFromChangeStreams());
    assertNotNull(commit.getRequestOptions());
    assertEquals(Priority.PRIORITY_UNSPECIFIED, commit.getRequestOptions().getPriority());
  }

  @Test
  public void testWriteAtLeastOnceWithOptions() {
    DatabaseClient client =
        spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
    MockSpannerTestActions.writeAtLeastOnceWithOptionsInsertMutation(
        client, Options.priority(RpcPriority.LOW));

    List<CommitRequest> commitRequests = mockSpanner.getRequestsOfType(CommitRequest.class);
    assertThat(commitRequests).hasSize(1);
    CommitRequest commit = commitRequests.get(0);
    assertNotNull(commit.getSingleUseTransaction());
    assertTrue(commit.getSingleUseTransaction().hasReadWrite());
    assertFalse(commit.getSingleUseTransaction().getExcludeTxnFromChangeStreams());
    assertNotNull(commit.getRequestOptions());
    assertEquals(Priority.PRIORITY_LOW, commit.getRequestOptions().getPriority());
  }

  @Test
  public void testWriteAtLeastOnceWithTagOptions() {
    DatabaseClient client =
        spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
    MockSpannerTestActions.writeAtLeastOnceWithOptionsInsertMutation(
        client, Options.tag("app=spanner,env=test"));

    List<CommitRequest> commitRequests = mockSpanner.getRequestsOfType(CommitRequest.class);
    assertThat(commitRequests).hasSize(1);
    CommitRequest commit = commitRequests.get(0);
    assertNotNull(commit.getSingleUseTransaction());
    assertTrue(commit.getSingleUseTransaction().hasReadWrite());
    assertFalse(commit.getSingleUseTransaction().getExcludeTxnFromChangeStreams());
    assertNotNull(commit.getRequestOptions());
    assertThat(commit.getRequestOptions().getTransactionTag()).isEqualTo("app=spanner,env=test");
    assertThat(commit.getRequestOptions().getRequestTag()).isEmpty();
  }

  @Test
  public void testWriteAtLeastOnceWithExcludeTxnFromChangeStreams() {
    DatabaseClient client =
        spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
    MockSpannerTestActions.writeAtLeastOnceWithOptionsInsertMutation(
        client, Options.excludeTxnFromChangeStreams());

    List<CommitRequest> commitRequests = mockSpanner.getRequestsOfType(CommitRequest.class);
    assertThat(commitRequests).hasSize(1);
    CommitRequest commit = commitRequests.get(0);
    assertNotNull(commit.getSingleUseTransaction());
    assertTrue(commit.getSingleUseTransaction().hasReadWrite());
    assertTrue(commit.getSingleUseTransaction().getExcludeTxnFromChangeStreams());
  }

  @Test
  public void testBatchWriteAtLeastOnceWithoutOptions() {
    DatabaseClient client =
        spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));

    ServerStream<BatchWriteResponse> responseStream = client.batchWriteAtLeastOnce(MUTATION_GROUPS);
    int idx = 0;
    for (BatchWriteResponse response : responseStream) {
      assertEquals(
          response.getStatus(),
          com.google.rpc.Status.newBuilder().setCode(com.google.rpc.Code.OK_VALUE).build());
      assertEquals(response.getIndexesList(), ImmutableList.of(idx, idx + 1));
      idx += 2;
    }

    assertNotNull(responseStream);
    List<BatchWriteRequest> requests = mockSpanner.getRequestsOfType(BatchWriteRequest.class);
    assertEquals(requests.size(), 1);
    BatchWriteRequest request = requests.get(0);
    assertEquals(request.getMutationGroupsCount(), 4);
    assertEquals(request.getRequestOptions().getPriority(), Priority.PRIORITY_UNSPECIFIED);
    assertFalse(request.getExcludeTxnFromChangeStreams());
  }

  @Test
  public void testBatchWriteAtLeastOnceWithOptions() {
    DatabaseClient client =
        spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
    consumeBatchWriteStream(
        client.batchWriteAtLeastOnce(MUTATION_GROUPS, Options.priority(RpcPriority.LOW)));

    List<BatchWriteRequest> requests = mockSpanner.getRequestsOfType(BatchWriteRequest.class);
    assertEquals(requests.size(), 1);
    BatchWriteRequest request = requests.get(0);
    assertEquals(request.getMutationGroupsCount(), 4);
    assertEquals(request.getRequestOptions().getPriority(), Priority.PRIORITY_LOW);
    assertFalse(request.getExcludeTxnFromChangeStreams());
  }

  @Test
  public void testBatchWriteAtLeastOnceWithTagOptions() {
    DatabaseClient client =
        spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
    consumeBatchWriteStream(
        client.batchWriteAtLeastOnce(MUTATION_GROUPS, Options.tag("app=spanner,env=test")));

    List<BatchWriteRequest> requests = mockSpanner.getRequestsOfType(BatchWriteRequest.class);
    assertEquals(requests.size(), 1);
    BatchWriteRequest request = requests.get(0);
    assertEquals(request.getMutationGroupsCount(), 4);
    assertEquals(request.getRequestOptions().getTransactionTag(), "app=spanner,env=test");
    assertThat(request.getRequestOptions().getRequestTag()).isEmpty();
    assertFalse(request.getExcludeTxnFromChangeStreams());
  }

  @Test
  public void testBatchWriteAtLeastOnceWithExcludeTxnFromChangeStreams() {
    DatabaseClient client =
        spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
    consumeBatchWriteStream(
        client.batchWriteAtLeastOnce(MUTATION_GROUPS, Options.excludeTxnFromChangeStreams()));

    List<BatchWriteRequest> requests = mockSpanner.getRequestsOfType(BatchWriteRequest.class);
    assertEquals(requests.size(), 1);
    BatchWriteRequest request = requests.get(0);
    assertEquals(request.getMutationGroupsCount(), 4);
    assertTrue(request.getExcludeTxnFromChangeStreams());
  }

  @Test
  public void testExecuteQueryWithTag() {
    DatabaseClient client =
        spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
    try (ResultSet resultSet =
        client
            .singleUse()
            .executeQuery(SELECT1, Options.tag("app=spanner,env=test,action=query"))) {
      consumeResults(resultSet);
    }

    List<ExecuteSqlRequest> requests = mockSpanner.getRequestsOfType(ExecuteSqlRequest.class);
    assertThat(requests).hasSize(1);
    ExecuteSqlRequest request = requests.get(0);
    assertNotNull(request.getRequestOptions());
    assertThat(request.getRequestOptions().getRequestTag())
        .isEqualTo("app=spanner,env=test,action=query");
    assertThat(request.getRequestOptions().getTransactionTag()).isEmpty();
  }

  @Test
  public void testExecuteQuery_withDirectedReadOptionsViaRequest() {
    DatabaseClient client =
        spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
    try (ResultSet resultSet =
        client.singleUse().executeQuery(SELECT1, Options.directedRead(DIRECTED_READ_OPTIONS1))) {
      consumeResults(resultSet);
    }

    List<ExecuteSqlRequest> requests = mockSpanner.getRequestsOfType(ExecuteSqlRequest.class);
    assertEquals(1, requests.size());
    ExecuteSqlRequest request = requests.get(0);
    assertTrue(request.hasDirectedReadOptions());
    assertEquals(DIRECTED_READ_OPTIONS1, request.getDirectedReadOptions());
  }

  @Test
  public void testExecuteQuery_withDirectedReadOptionsViaSpannerOptions() {
    Spanner spannerWithDirectedReadOptions =
        spanner.getOptions().toBuilder()
            .setDirectedReadOptions(DIRECTED_READ_OPTIONS2)
            .build()
            .getService();
    DatabaseClient client =
        spannerWithDirectedReadOptions.getDatabaseClient(
            DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
    try (ResultSet resultSet = client.singleUse().executeQuery(SELECT1)) {
      consumeResults(resultSet);
    }

    List<ExecuteSqlRequest> requests = mockSpanner.getRequestsOfType(ExecuteSqlRequest.class);
    assertEquals(requests.size(), 1);
    ExecuteSqlRequest request = requests.get(0);
    assertTrue(request.hasDirectedReadOptions());
    assertEquals(DIRECTED_READ_OPTIONS2, request.getDirectedReadOptions());
  }

  @Test
  public void testExecuteQuery_whenMultipleDirectedReadsOptions_preferRequestOption() {
    Spanner spannerWithDirectedReadOptions =
        spanner.getOptions().toBuilder()
            .setDirectedReadOptions(DIRECTED_READ_OPTIONS2)
            .build()
            .getService();
    DatabaseClient client =
        spannerWithDirectedReadOptions.getDatabaseClient(
            DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
    try (ResultSet resultSet =
        client.singleUse().executeQuery(SELECT1, Options.directedRead(DIRECTED_READ_OPTIONS1))) {
      consumeResults(resultSet);
    }

    List<ExecuteSqlRequest> requests = mockSpanner.getRequestsOfType(ExecuteSqlRequest.class);
    assertEquals(requests.size(), 1);
    ExecuteSqlRequest request = requests.get(0);
    assertTrue(request.hasDirectedReadOptions());
    assertEquals(DIRECTED_READ_OPTIONS1, request.getDirectedReadOptions());
  }

  @Test
  public void testExecuteReadWithTag() {
    DatabaseClient client =
        spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
    try (ResultSet resultSet =
        client
            .singleUse()
            .read(
                READ_TABLE_NAME,
                KeySet.singleKey(Key.of(1L)),
                READ_COLUMN_NAMES,
                Options.tag("app=spanner,env=test,action=read"))) {
      consumeResults(resultSet);
    }

    List<ReadRequest> requests = mockSpanner.getRequestsOfType(ReadRequest.class);
    assertThat(requests).hasSize(1);
    ReadRequest request = requests.get(0);
    assertNotNull(request.getRequestOptions());
    assertThat(request.getRequestOptions().getRequestTag())
        .isEqualTo("app=spanner,env=test,action=read");
    assertThat(request.getRequestOptions().getTransactionTag()).isEmpty();
  }

  @Test
  public void testExecuteReadWithOrderByOption() {
    DatabaseClient client =
        spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
    try (ResultSet resultSet =
        client
            .singleUse()
            .read(
                READ_TABLE_NAME,
                KeySet.singleKey(Key.of(1L)),
                READ_COLUMN_NAMES,
                Options.orderBy(RpcOrderBy.NO_ORDER))) {
      consumeResults(resultSet);
    }

    List<ReadRequest> requests = mockSpanner.getRequestsOfType(ReadRequest.class);
    assertThat(requests).hasSize(1);
    ReadRequest request = requests.get(0);
    assertEquals(OrderBy.ORDER_BY_NO_ORDER, request.getOrderBy());
  }

  @Test
  public void testUnsupportedTransactionWithLockHintOption() {
    DatabaseClient client =
        spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
    try (ResultSet resultSet =
        client
            .singleUse()
            .read(
                READ_TABLE_NAME,
                KeySet.singleKey(Key.of(1L)),
                READ_COLUMN_NAMES,
                Options.lockHint(RpcLockHint.EXCLUSIVE))) {
      consumeResults(resultSet);
    }

    List<ReadRequest> requests = mockSpanner.getRequestsOfType(ReadRequest.class);
    assertThat(requests).hasSize(1);
    ReadRequest request = requests.get(0);
    // lock hint is only supported in  ReadWriteTransaction
    assertEquals(LockHint.LOCK_HINT_UNSPECIFIED, request.getLockHint());
  }

  @Test
  public void testReadWriteTransactionWithLockHint() {
    DatabaseClient client =
        spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));

    TransactionRunner runner = client.readWriteTransaction();
    runner.run(
        transaction -> {
          try (ResultSet resultSet =
              transaction.read(
                  READ_TABLE_NAME,
                  KeySet.singleKey(Key.of(1L)),
                  READ_COLUMN_NAMES,
                  Options.lockHint(RpcLockHint.EXCLUSIVE))) {
            consumeResults(resultSet);
          }
          return null;
        });

    List<ReadRequest> requests = mockSpanner.getRequestsOfType(ReadRequest.class);
    assertThat(requests).hasSize(1);
    ReadRequest request = requests.get(0);
    assertEquals(LockHint.LOCK_HINT_EXCLUSIVE, request.getLockHint());
  }

  @Test
  public void testExecuteReadWithDirectedReadOptions() {
    DatabaseClient client =
        spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
    try (ResultSet resultSet =
        client
            .singleUse()
            .read(
                READ_TABLE_NAME,
                KeySet.singleKey(Key.of(1L)),
                READ_COLUMN_NAMES,
                Options.directedRead(DIRECTED_READ_OPTIONS1))) {
      consumeResults(resultSet);
    }

    List<ReadRequest> requests = mockSpanner.getRequestsOfType(ReadRequest.class);
    assertEquals(1, requests.size());
    ReadRequest request = requests.get(0);
    assertTrue(request.hasDirectedReadOptions());
    assertEquals(DIRECTED_READ_OPTIONS1, request.getDirectedReadOptions());
  }

  @Test
  public void testExecuteReadWithDirectedReadOptionsViaSpannerOptions() {
    Spanner spannerWithDirectedReadOptions =
        spanner.getOptions().toBuilder()
            .setDirectedReadOptions(DIRECTED_READ_OPTIONS2)
            .build()
            .getService();
    DatabaseClient client =
        spannerWithDirectedReadOptions.getDatabaseClient(
            DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
    try (ResultSet resultSet =
        client.singleUse().read(READ_TABLE_NAME, KeySet.singleKey(Key.of(1L)), READ_COLUMN_NAMES)) {
      consumeResults(resultSet);
    }

    List<ReadRequest> requests = mockSpanner.getRequestsOfType(ReadRequest.class);
    assertEquals(requests.size(), 1);
    ReadRequest request = requests.get(0);
    assertTrue(request.hasDirectedReadOptions());
    assertEquals(DIRECTED_READ_OPTIONS2, request.getDirectedReadOptions());
  }

  @Test
  public void testReadWriteExecuteQueryWithDirectedReadOptionsViaSpannerOptions() {
    Spanner spannerWithDirectedReadOptions =
        spanner.getOptions().toBuilder()
            .setDirectedReadOptions(DIRECTED_READ_OPTIONS2)
            .build()
            .getService();
    DatabaseClient client =
        spannerWithDirectedReadOptions.getDatabaseClient(
            DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
    TransactionRunner runner = client.readWriteTransaction();
    runner.run(
        transaction -> {
          try (ResultSet resultSet = transaction.executeQuery(SELECT1)) {
            consumeResults(resultSet);
          }
          return null;
        });

    List<ExecuteSqlRequest> requests = mockSpanner.getRequestsOfType(ExecuteSqlRequest.class);
    assertEquals(requests.size(), 1);
    ExecuteSqlRequest request = requests.get(0);
    assertFalse(request.hasDirectedReadOptions());
  }

  @Test
  public void testReadWriteExecuteQueryWithTag() {
    DatabaseClient client =
        spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
    TransactionRunner runner =
        client.readWriteTransaction(Options.tag("app=spanner,env=test,action=txn"));
    runner.run(
        transaction -> {
          try (ResultSet resultSet =
              transaction.executeQuery(SELECT1, Options.tag("app=spanner,env=test,action=query"))) {
            consumeResults(resultSet);
          }
          return null;
        });

    List<ExecuteSqlRequest> requests = mockSpanner.getRequestsOfType(ExecuteSqlRequest.class);
    assertThat(requests).hasSize(1);
    ExecuteSqlRequest request = requests.get(0);
    assertNotNull(request.getRequestOptions());
    assertThat(request.getRequestOptions().getRequestTag())
        .isEqualTo("app=spanner,env=test,action=query");
    assertThat(request.getRequestOptions().getTransactionTag())
        .isEqualTo("app=spanner,env=test,action=txn");
  }

  @Test
  public void testReadWriteExecuteReadWithTag() {
    DatabaseClient client =
        spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
    TransactionRunner runner =
        client.readWriteTransaction(Options.tag("app=spanner,env=test,action=txn"));
    runner.run(
        transaction -> {
          try (ResultSet resultSet =
              transaction.read(
                  READ_TABLE_NAME,
                  KeySet.singleKey(Key.of(1L)),
                  READ_COLUMN_NAMES,
                  Options.tag("app=spanner,env=test,action=read"))) {
            consumeResults(resultSet);
          }
          return null;
        });

    List<ReadRequest> requests = mockSpanner.getRequestsOfType(ReadRequest.class);
    assertThat(requests).hasSize(1);
    ReadRequest request = requests.get(0);
    assertNotNull(request.getRequestOptions());
    assertThat(request.getRequestOptions().getRequestTag())
        .isEqualTo("app=spanner,env=test,action=read");
    assertThat(request.getRequestOptions().getTransactionTag())
        .isEqualTo("app=spanner,env=test,action=txn");
    assertEquals(
        IsolationLevel.ISOLATION_LEVEL_UNSPECIFIED,
        request.getTransaction().getBegin().getIsolationLevel());
  }

  @Test
  public void testExecuteUpdateWithTag() {
    DatabaseClient client =
        spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
    TransactionRunner runner = client.readWriteTransaction();
    runner.run(
        transaction ->
            transaction.executeUpdate(
                UPDATE_STATEMENT, Options.tag("app=spanner,env=test,action=update")));

    List<ExecuteSqlRequest> requests = mockSpanner.getRequestsOfType(ExecuteSqlRequest.class);
    assertThat(requests).hasSize(1);
    ExecuteSqlRequest request = requests.get(0);
    assertNotNull(request.getRequestOptions());
    assertThat(request.getRequestOptions().getRequestTag())
        .isEqualTo("app=spanner,env=test,action=update");
    assertThat(request.getRequestOptions().getTransactionTag()).isEmpty();
    assertNotNull(request.getTransaction().getBegin());
    assertTrue(request.getTransaction().getBegin().hasReadWrite());
    assertFalse(request.getTransaction().getBegin().getExcludeTxnFromChangeStreams());
    assertEquals(
        IsolationLevel.ISOLATION_LEVEL_UNSPECIFIED,
        request.getTransaction().getBegin().getIsolationLevel());
  }

  @Test
  public void testBatchUpdateWithTag() {
    DatabaseClient client =
        spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
    TransactionRunner runner =
        client.readWriteTransaction(Options.tag("app=spanner,env=test,action=txn"));
    runner.run(
        transaction ->
            transaction.batchUpdate(
                Collections.singletonList(UPDATE_STATEMENT),
                Options.tag("app=spanner,env=test,action=batch")));

    List<ExecuteBatchDmlRequest> requests =
        mockSpanner.getRequestsOfType(ExecuteBatchDmlRequest.class);
    assertThat(requests).hasSize(1);
    ExecuteBatchDmlRequest request = requests.get(0);
    assertNotNull(request.getRequestOptions());
    assertThat(request.getRequestOptions().getRequestTag())
        .isEqualTo("app=spanner,env=test,action=batch");
    assertThat(request.getRequestOptions().getTransactionTag())
        .isEqualTo("app=spanner,env=test,action=txn");
    assertNotNull(request.getTransaction().getBegin());
    assertTrue(request.getTransaction().getBegin().hasReadWrite());
    assertFalse(request.getTransaction().getBegin().getExcludeTxnFromChangeStreams());
    assertEquals(
        IsolationLevel.ISOLATION_LEVEL_UNSPECIFIED,
        request.getTransaction().getBegin().getIsolationLevel());
  }

  @Test
  public void testPartitionedDMLWithTag() {
    DatabaseClient client =
        spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
    client.executePartitionedUpdate(
        UPDATE_STATEMENT, Options.tag("app=spanner,env=test,action=dml"));

    List<BeginTransactionRequest> beginTransactions =
        mockSpanner.getRequestsOfType(BeginTransactionRequest.class);
    assertThat(beginTransactions).hasSize(1);
    BeginTransactionRequest beginTransaction = beginTransactions.get(0);
    assertNotNull(beginTransaction.getOptions());
    assertTrue(beginTransaction.getOptions().hasPartitionedDml());
    assertFalse(beginTransaction.getOptions().getExcludeTxnFromChangeStreams());

    List<ExecuteSqlRequest> requests = mockSpanner.getRequestsOfType(ExecuteSqlRequest.class);
    assertThat(requests).hasSize(1);
    ExecuteSqlRequest request = requests.get(0);
    assertNotNull(request.getRequestOptions());
    assertThat(request.getRequestOptions().getRequestTag())
        .isEqualTo("app=spanner,env=test,action=dml");
    assertThat(request.getRequestOptions().getTransactionTag()).isEmpty();
  }

  @Test
  public void testCommitWithTag() {
    DatabaseClient client =
        spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
    MockSpannerTestActions.commitDeleteTransaction(
        client, Options.tag("app=spanner,env=test,action=commit"));

    List<BeginTransactionRequest> beginTransactions =
        mockSpanner.getRequestsOfType(BeginTransactionRequest.class);
    assertThat(beginTransactions).hasSize(1);
    BeginTransactionRequest beginTransaction = beginTransactions.get(0);
    assertNotNull(beginTransaction.getOptions());
    assertTrue(beginTransaction.getOptions().hasReadWrite());
    assertFalse(beginTransaction.getOptions().getExcludeTxnFromChangeStreams());

    List<CommitRequest> requests = mockSpanner.getRequestsOfType(CommitRequest.class);
    assertThat(requests).hasSize(1);
    CommitRequest request = requests.get(0);
    assertNotNull(request.getRequestOptions());
    assertThat(request.getRequestOptions().getRequestTag()).isEmpty();
    assertThat(request.getRequestOptions().getTransactionTag())
        .isEqualTo("app=spanner,env=test,action=commit");
  }

  @Test
  public void testTransactionManagerCommitWithTag() {
    DatabaseClient client =
        spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
    MockSpannerTestActions.transactionManagerCommit(
        client, Options.tag("app=spanner,env=test,action=manager"));

    List<BeginTransactionRequest> beginTransactions =
        mockSpanner.getRequestsOfType(BeginTransactionRequest.class);
    assertThat(beginTransactions).hasSize(1);
    BeginTransactionRequest beginTransaction = beginTransactions.get(0);
    assertNotNull(beginTransaction.getOptions());
    assertTrue(beginTransaction.getOptions().hasReadWrite());
    assertFalse(beginTransaction.getOptions().getExcludeTxnFromChangeStreams());
    assertEquals(
        IsolationLevel.ISOLATION_LEVEL_UNSPECIFIED,
        beginTransaction.getOptions().getIsolationLevel());

    List<CommitRequest> requests = mockSpanner.getRequestsOfType(CommitRequest.class);
    assertThat(requests).hasSize(1);
    CommitRequest request = requests.get(0);
    assertNotNull(request.getRequestOptions());
    assertThat(request.getRequestOptions().getRequestTag()).isEmpty();
    assertThat(request.getRequestOptions().getTransactionTag())
        .isEqualTo("app=spanner,env=test,action=manager");
  }

  @Test
  public void testAsyncRunnerCommitWithTag() {
    DatabaseClient client =
        spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
    MockSpannerTestActions.asyncRunnerCommit(
        client, executor, Options.tag("app=spanner,env=test,action=runner"));

    List<BeginTransactionRequest> beginTransactions =
        mockSpanner.getRequestsOfType(BeginTransactionRequest.class);
    assertThat(beginTransactions).hasSize(1);
    BeginTransactionRequest beginTransaction = beginTransactions.get(0);
    assertNotNull(beginTransaction.getOptions());
    assertTrue(beginTransaction.getOptions().hasReadWrite());
    assertFalse(beginTransaction.getOptions().getExcludeTxnFromChangeStreams());
    assertEquals(
        IsolationLevel.ISOLATION_LEVEL_UNSPECIFIED,
        beginTransaction.getOptions().getIsolationLevel());

    List<CommitRequest> requests = mockSpanner.getRequestsOfType(CommitRequest.class);
    assertThat(requests).hasSize(1);
    CommitRequest request = requests.get(0);
    assertNotNull(request.getRequestOptions());
    assertThat(request.getRequestOptions().getRequestTag()).isEmpty();
    assertThat(request.getRequestOptions().getTransactionTag())
        .isEqualTo("app=spanner,env=test,action=runner");
  }

  @Test
  public void testAsyncTransactionManagerCommitWithTag() {
    DatabaseClient client =
        spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
    MockSpannerTestActions.transactionManagerAsyncCommit(
        client, executor, Options.tag("app=spanner,env=test,action=manager"));

    List<BeginTransactionRequest> beginTransactions =
        mockSpanner.getRequestsOfType(BeginTransactionRequest.class);
    assertThat(beginTransactions).hasSize(1);
    BeginTransactionRequest beginTransaction = beginTransactions.get(0);
    assertNotNull(beginTransaction.getOptions());
    assertTrue(beginTransaction.getOptions().hasReadWrite());
    assertFalse(beginTransaction.getOptions().getExcludeTxnFromChangeStreams());
    assertEquals(
        IsolationLevel.ISOLATION_LEVEL_UNSPECIFIED,
        beginTransaction.getOptions().getIsolationLevel());

    List<CommitRequest> requests = mockSpanner.getRequestsOfType(CommitRequest.class);
    assertThat(requests).hasSize(1);
    CommitRequest request = requests.get(0);
    assertNotNull(request.getRequestOptions());
    assertThat(request.getRequestOptions().getRequestTag()).isEmpty();
    assertThat(request.getRequestOptions().getTransactionTag())
        .isEqualTo("app=spanner,env=test,action=manager");
  }

  @Test
  public void testReadWriteTxnWithExcludeTxnFromChangeStreams_executeUpdate() {
    DatabaseClient client =
        spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
    TransactionRunner runner = client.readWriteTransaction(Options.excludeTxnFromChangeStreams());
    runner.run(transaction -> transaction.executeUpdate(UPDATE_STATEMENT));

    List<ExecuteSqlRequest> requests = mockSpanner.getRequestsOfType(ExecuteSqlRequest.class);
    assertThat(requests).hasSize(1);
    ExecuteSqlRequest request = requests.get(0);
    assertNotNull(request.getTransaction().getBegin());
    assertTrue(request.getTransaction().getBegin().hasReadWrite());
    assertTrue(request.getTransaction().getBegin().getExcludeTxnFromChangeStreams());
  }

  @Test
  public void testReadWriteTxnWithExcludeTxnFromChangeStreams_batchUpdate() {
    DatabaseClient client =
        spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
    MockSpannerTestActions.executeBatchUpdateTransaction(
        client, Options.excludeTxnFromChangeStreams());

    List<ExecuteBatchDmlRequest> requests =
        mockSpanner.getRequestsOfType(ExecuteBatchDmlRequest.class);
    assertThat(requests).hasSize(1);
    ExecuteBatchDmlRequest request = requests.get(0);
    assertNotNull(request.getTransaction().getBegin());
    assertTrue(request.getTransaction().getBegin().hasReadWrite());
    assertTrue(request.getTransaction().getBegin().getExcludeTxnFromChangeStreams());
  }

  @Test
  public void testPartitionedDMLWithExcludeTxnFromChangeStreams() {
    DatabaseClient client =
        spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
    client.executePartitionedUpdate(UPDATE_STATEMENT, Options.excludeTxnFromChangeStreams());

    List<BeginTransactionRequest> beginTransactions =
        mockSpanner.getRequestsOfType(BeginTransactionRequest.class);
    assertThat(beginTransactions).hasSize(1);
    BeginTransactionRequest beginTransaction = beginTransactions.get(0);
    assertNotNull(beginTransaction.getOptions());
    assertTrue(beginTransaction.getOptions().hasPartitionedDml());
    assertTrue(beginTransaction.getOptions().getExcludeTxnFromChangeStreams());
  }

  @Test
  public void testCommitWithExcludeTxnFromChangeStreams() {
    DatabaseClient client =
        spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
    MockSpannerTestActions.commitDeleteTransaction(client, Options.excludeTxnFromChangeStreams());

    List<BeginTransactionRequest> beginTransactions =
        mockSpanner.getRequestsOfType(BeginTransactionRequest.class);
    assertThat(beginTransactions).hasSize(1);
    BeginTransactionRequest beginTransaction = beginTransactions.get(0);
    assertNotNull(beginTransaction.getOptions());
    assertTrue(beginTransaction.getOptions().hasReadWrite());
    assertTrue(beginTransaction.getOptions().getExcludeTxnFromChangeStreams());
  }

  @Test
  public void testTransactionManagerCommitWithExcludeTxnFromChangeStreams() {
    DatabaseClient client =
        spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
    MockSpannerTestActions.transactionManagerCommit(client, Options.excludeTxnFromChangeStreams());

    List<BeginTransactionRequest> beginTransactions =
        mockSpanner.getRequestsOfType(BeginTransactionRequest.class);
    assertThat(beginTransactions).hasSize(1);
    BeginTransactionRequest beginTransaction = beginTransactions.get(0);
    assertNotNull(beginTransaction.getOptions());
    assertTrue(beginTransaction.getOptions().hasReadWrite());
    assertTrue(beginTransaction.getOptions().getExcludeTxnFromChangeStreams());
  }

  @Test
  public void testAsyncRunnerCommitWithExcludeTxnFromChangeStreams() {
    DatabaseClient client =
        spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
    MockSpannerTestActions.asyncRunnerCommit(
        client, executor, Options.excludeTxnFromChangeStreams());

    List<BeginTransactionRequest> beginTransactions =
        mockSpanner.getRequestsOfType(BeginTransactionRequest.class);
    assertThat(beginTransactions).hasSize(1);
    BeginTransactionRequest beginTransaction = beginTransactions.get(0);
    assertNotNull(beginTransaction.getOptions());
    assertTrue(beginTransaction.getOptions().hasReadWrite());
    assertTrue(beginTransaction.getOptions().getExcludeTxnFromChangeStreams());
  }

  @Test
  public void testAsyncTransactionManagerCommitWithExcludeTxnFromChangeStreams() {
    DatabaseClient client =
        spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
    MockSpannerTestActions.transactionManagerAsyncCommit(
        client, executor, Options.excludeTxnFromChangeStreams());

    List<BeginTransactionRequest> beginTransactions =
        mockSpanner.getRequestsOfType(BeginTransactionRequest.class);
    assertThat(beginTransactions).hasSize(1);
    BeginTransactionRequest beginTransaction = beginTransactions.get(0);
    assertNotNull(beginTransaction.getOptions());
    assertTrue(beginTransaction.getOptions().hasReadWrite());
    assertTrue(beginTransaction.getOptions().getExcludeTxnFromChangeStreams());
  }

  @Test
  public void testExecuteUpdateWithExcludeTxnFromChangeStreams() {
    DatabaseClient client =
        spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
    TransactionRunner runner = client.readWriteTransaction();
    SpannerException e =
        assertThrows(
            SpannerException.class,
            () ->
                runner.run(
                    transaction ->
                        transaction.executeUpdate(
                            UPDATE_STATEMENT, Options.excludeTxnFromChangeStreams())));
    assertThat(e.getErrorCode()).isEqualTo(ErrorCode.INVALID_ARGUMENT);
    assertThat(e.getMessage())
        .contains(
            "Options.excludeTxnFromChangeStreams() cannot be specified for individual DML requests."
                + " This option should be set at the transaction level.");
  }

  @Test
  public void testExecuteUpdateAsyncWithExcludeTxnFromChangeStreams() {
    DatabaseClient client =
        spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
    AsyncRunner runner = client.runAsync();
    SpannerException e =
        assertThrows(
            SpannerException.class,
            () ->
                get(
                    runner.runAsync(
                        txn -> {
                          txn.executeUpdateAsync(
                              UPDATE_STATEMENT, Options.excludeTxnFromChangeStreams());
                          return ApiFutures.immediateFuture(null);
                        },
                        executor)));
    assertThat(e.getErrorCode()).isEqualTo(ErrorCode.INVALID_ARGUMENT);
    assertThat(e.getMessage())
        .contains(
            "Options.excludeTxnFromChangeStreams() cannot be specified for individual DML requests."
                + " This option should be set at the transaction level.");
  }

  @Test
  public void testAnalyzeUpdateWithExcludeTxnFromChangeStreams() {
    DatabaseClient client =
        spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
    TransactionRunner runner = client.readWriteTransaction();
    SpannerException e =
        assertThrows(
            SpannerException.class,
            () ->
                runner.run(
                    transaction ->
                        transaction.analyzeUpdate(
                            UPDATE_STATEMENT,
                            QueryAnalyzeMode.PROFILE,
                            Options.excludeTxnFromChangeStreams())));
    assertThat(e.getErrorCode()).isEqualTo(ErrorCode.INVALID_ARGUMENT);
    assertThat(e.getMessage())
        .contains(
            "Options.excludeTxnFromChangeStreams() cannot be specified for individual DML requests."
                + " This option should be set at the transaction level.");
  }

  @Test
  public void testAnalyzeUpdateStatementWithExcludeTxnFromChangeStreams() {
    DatabaseClient client =
        spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
    TransactionRunner runner = client.readWriteTransaction();
    SpannerException e =
        assertThrows(
            SpannerException.class,
            () ->
                runner.run(
                    transaction ->
                        transaction.analyzeUpdateStatement(
                            UPDATE_STATEMENT,
                            QueryAnalyzeMode.PROFILE,
                            Options.excludeTxnFromChangeStreams())));
    assertThat(e.getErrorCode()).isEqualTo(ErrorCode.INVALID_ARGUMENT);
    assertThat(e.getMessage())
        .contains(
            "Options.excludeTxnFromChangeStreams() cannot be specified for individual DML requests."
                + " This option should be set at the transaction level.");
  }

  @Test
  public void testBatchUpdateWithExcludeTxnFromChangeStreams() {
    DatabaseClient client =
        spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
    TransactionRunner runner = client.readWriteTransaction();
    SpannerException e =
        assertThrows(
            SpannerException.class,
            () ->
                runner.run(
                    transaction ->
                        transaction.batchUpdate(
                            Collections.singletonList(UPDATE_STATEMENT),
                            Options.excludeTxnFromChangeStreams())));
    assertThat(e.getErrorCode()).isEqualTo(ErrorCode.INVALID_ARGUMENT);
    assertThat(e.getMessage())
        .contains(
            "Options.excludeTxnFromChangeStreams() cannot be specified for individual DML requests."
                + " This option should be set at the transaction level.");
  }

  @Test
  public void testBatchUpdateAsyncWithExcludeTxnFromChangeStreams() {
    DatabaseClient client =
        spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
    AsyncRunner runner = client.runAsync();
    SpannerException e =
        assertThrows(
            SpannerException.class,
            () ->
                get(
                    runner.runAsync(
                        txn -> {
                          txn.batchUpdateAsync(
                              Collections.singletonList(UPDATE_STATEMENT),
                              Options.excludeTxnFromChangeStreams());
                          return ApiFutures.immediateFuture(null);
                        },
                        executor)));
    assertThat(e.getErrorCode()).isEqualTo(ErrorCode.INVALID_ARGUMENT);
    assertThat(e.getMessage())
        .contains(
            "Options.excludeTxnFromChangeStreams() cannot be specified for individual DML requests."
                + " This option should be set at the transaction level.");
  }

  @Test
  public void singleUse() {
    DatabaseClientImpl client =
        (DatabaseClientImpl)
            spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
    Set<PooledSessionFuture> checkedOut = client.pool.checkedOutSessions;
    assertThat(checkedOut).isEmpty();
    try (ResultSet rs = client.singleUse().executeQuery(SELECT1)) {
      assertThat(rs.next()).isTrue();
      if (!isMultiplexedSessionsEnabled()) {
        assertThat(checkedOut).hasSize(1);
      }
      assertThat(rs.getLong(0)).isEqualTo(1L);
      assertThat(rs.next()).isFalse();
    }
    assertThat(checkedOut).isEmpty();
  }

  @Test
  public void singleUseIsNonBlocking() {
    mockSpanner.freeze();
    // Use a Spanner instance with no initial sessions in the pool to show that getting a session
    // from the pool and then preparing a query is non-blocking (i.e. does not wait on a reply from
    // the server).
    DatabaseClient client =
        spannerWithEmptySessionPool.getDatabaseClient(
            DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
    try (ResultSet rs = client.singleUse().executeQuery(SELECT1)) {
      mockSpanner.unfreeze();
      assertThat(rs.next()).isTrue();
      assertThat(rs.getLong(0)).isEqualTo(1L);
      assertThat(rs.next()).isFalse();
    }
  }

  @Test
  public void singleUseAsync() throws Exception {
    DatabaseClient client =
        spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
    final AtomicInteger rowCount = new AtomicInteger();
    ApiFuture<Void> res;
    try (AsyncResultSet rs = client.singleUse().executeQueryAsync(SELECT1)) {
      res =
          rs.setCallback(
              executor,
              resultSet -> {
                while (true) {
                  switch (resultSet.tryNext()) {
                    case OK:
                      rowCount.incrementAndGet();
                      break;
                    case DONE:
                      return CallbackResponse.DONE;
                    case NOT_READY:
                      return CallbackResponse.CONTINUE;
                  }
                }
              });
    }
    res.get();
    assertThat(rowCount.get()).isEqualTo(1);
  }

  @Test
  public void singleUseAsyncWithoutCallback() {
    DatabaseClient client =
        spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
    int rowCount = 0;
    try (AsyncResultSet rs = client.singleUse().executeQueryAsync(SELECT1)) {
      while (rs.next()) {
        rowCount++;
      }
    }
    assertThat(rowCount).isEqualTo(1);
  }

  @Test
  public void singleUseBound() {
    DatabaseClient client =
        spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
    try (ResultSet rs =
        client
            .singleUse(TimestampBound.ofExactStaleness(15L, TimeUnit.SECONDS))
            .executeQuery(SELECT1)) {
      assertThat(rs.next()).isTrue();
      assertThat(rs.getLong(0)).isEqualTo(1L);
      assertThat(rs.next()).isFalse();
    }
  }

  @Test
  public void singleUseBoundIsNonBlocking() {
    mockSpanner.freeze();
    DatabaseClient client =
        spannerWithEmptySessionPool.getDatabaseClient(
            DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
    try (ResultSet rs =
        client
            .singleUse(TimestampBound.ofExactStaleness(15L, TimeUnit.SECONDS))
            .executeQuery(SELECT1)) {
      mockSpanner.unfreeze();
      assertThat(rs.next()).isTrue();
      assertThat(rs.getLong(0)).isEqualTo(1L);
      assertThat(rs.next()).isFalse();
    }
  }

  @Test
  public void singleUseBoundAsync() throws Exception {
    DatabaseClient client =
        spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
    final AtomicInteger rowCount = new AtomicInteger();
    ApiFuture<Void> res;
    try (AsyncResultSet rs =
        client
            .singleUse(TimestampBound.ofExactStaleness(15L, TimeUnit.SECONDS))
            .executeQueryAsync(SELECT1)) {
      res =
          rs.setCallback(
              executor,
              resultSet -> {
                while (true) {
                  switch (resultSet.tryNext()) {
                    case OK:
                      rowCount.incrementAndGet();
                      break;
                    case DONE:
                      return CallbackResponse.DONE;
                    case NOT_READY:
                      return CallbackResponse.CONTINUE;
                  }
                }
              });
    }
    res.get();
    assertThat(rowCount.get()).isEqualTo(1);
  }

  @Test
  public void singleUseTransaction() {
    DatabaseClient client =
        spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
    try (ResultSet rs = client.singleUseReadOnlyTransaction().executeQuery(SELECT1)) {
      assertThat(rs.next()).isTrue();
      assertThat(rs.getLong(0)).isEqualTo(1L);
      assertThat(rs.next()).isFalse();
    }
  }

  @Test
  public void singleUseTransactionIsNonBlocking() {
    mockSpanner.freeze();
    DatabaseClient client =
        spannerWithEmptySessionPool.getDatabaseClient(
            DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
    try (ResultSet rs = client.singleUseReadOnlyTransaction().executeQuery(SELECT1)) {
      mockSpanner.unfreeze();
      assertThat(rs.next()).isTrue();
      assertThat(rs.getLong(0)).isEqualTo(1L);
      assertThat(rs.next()).isFalse();
    }
  }

  @Test
  public void singleUseTransactionBound() {
    DatabaseClient client =
        spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
    try (ResultSet rs =
        client
            .singleUseReadOnlyTransaction(TimestampBound.ofExactStaleness(15L, TimeUnit.SECONDS))
            .executeQuery(SELECT1)) {
      assertThat(rs.next()).isTrue();
      assertThat(rs.getLong(0)).isEqualTo(1L);
      assertThat(rs.next()).isFalse();
    }
  }

  @Test
  public void singleUseTransactionBoundIsNonBlocking() {
    mockSpanner.freeze();
    DatabaseClient client =
        spannerWithEmptySessionPool.getDatabaseClient(
            DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
    try (ResultSet rs =
        client
            .singleUseReadOnlyTransaction(TimestampBound.ofExactStaleness(15L, TimeUnit.SECONDS))
            .executeQuery(SELECT1)) {
      mockSpanner.unfreeze();
      assertThat(rs.next()).isTrue();
      assertThat(rs.getLong(0)).isEqualTo(1L);
      assertThat(rs.next()).isFalse();
    }
  }

  @Test
  public void readOnlyTransaction() {
    DatabaseClient client =
        spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
    try (ReadOnlyTransaction tx = client.readOnlyTransaction()) {
      try (ResultSet rs = tx.executeQuery(SELECT1)) {
        assertThat(rs.next()).isTrue();
        assertThat(rs.getLong(0)).isEqualTo(1L);
        assertThat(rs.next()).isFalse();
      }
    }
  }

  @Test
  public void readOnlyTransactionIsNonBlocking() {
    mockSpanner.freeze();
    DatabaseClient client =
        spannerWithEmptySessionPool.getDatabaseClient(
            DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
    try (ReadOnlyTransaction tx = client.readOnlyTransaction()) {
      try (ResultSet rs = tx.executeQuery(SELECT1)) {
        mockSpanner.unfreeze();
        assertThat(rs.next()).isTrue();
        assertThat(rs.getLong(0)).isEqualTo(1L);
        assertThat(rs.next()).isFalse();
      }
    }
  }

  @Test
  public void readOnlyTransactionBound() {
    DatabaseClient client =
        spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
    try (ReadOnlyTransaction tx =
        client.readOnlyTransaction(TimestampBound.ofExactStaleness(15L, TimeUnit.SECONDS))) {
      try (ResultSet rs = tx.executeQuery(SELECT1)) {
        assertThat(rs.next()).isTrue();
        assertThat(rs.getLong(0)).isEqualTo(1L);
        assertThat(rs.next()).isFalse();
      }
    }
  }

  @Test
  public void readOnlyTransactionBoundIsNonBlocking() {
    mockSpanner.freeze();
    DatabaseClient client =
        spannerWithEmptySessionPool.getDatabaseClient(
            DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
    try (ReadOnlyTransaction tx =
        client.readOnlyTransaction(TimestampBound.ofExactStaleness(15L, TimeUnit.SECONDS))) {
      try (ResultSet rs = tx.executeQuery(SELECT1)) {
        mockSpanner.unfreeze();
        assertThat(rs.next()).isTrue();
        assertThat(rs.getLong(0)).isEqualTo(1L);
        assertThat(rs.next()).isFalse();
      }
    }
  }

  @Test
  public void testReadWriteTransaction() {
    DatabaseClient client =
        spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
    TransactionRunner runner = client.readWriteTransaction();
    runner.run(
        transaction -> {
          transaction.executeUpdate(UPDATE_STATEMENT);
          return null;
        });
    assertNotNull(runner.getCommitTimestamp());
  }

  @Test
  public void testReadWriteTransaction_returnsCommitStats() {
    DatabaseClient client =
        spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
    TransactionRunner runner = client.readWriteTransaction(Options.commitStats());
    runner.run(
        transaction -> {
          transaction.buffer(Mutation.delete("FOO", Key.of("foo")));
          return null;
        });
    assertNotNull(runner.getCommitResponse());
    assertNotNull(runner.getCommitResponse().getCommitStats());
    assertEquals(1L, runner.getCommitResponse().getCommitStats().getMutationCount());
  }

  @Test
  public void readWriteTransactionIsNonBlocking() {
    mockSpanner.freeze();
    DatabaseClient client =
        spannerWithEmptySessionPool.getDatabaseClient(
            DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
    TransactionRunner runner = client.readWriteTransaction();
    // The runner.run(...) method cannot be made non-blocking, as it returns the result of the
    // transaction.
    mockSpanner.unfreeze();
    runner.run(
        transaction -> {
          transaction.executeUpdate(UPDATE_STATEMENT);
          return null;
        });
  }

  @Test
  public void testRunAsync() throws Exception {
    DatabaseClient client =
        spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
    ExecutorService executor = Executors.newSingleThreadExecutor();
    AsyncRunner runner = client.runAsync();
    ApiFuture<Long> result =
        runner.runAsync(
            txn -> ApiFutures.immediateFuture(txn.executeUpdate(UPDATE_STATEMENT)), executor);
    assertEquals(UPDATE_COUNT, result.get().longValue());
    assertNotNull(runner.getCommitTimestamp().get());
    executor.shutdown();
  }

  @Test
  public void testRunAsync_returnsCommitStats() {
    DatabaseClient client =
        spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
    ExecutorService executor = Executors.newSingleThreadExecutor();
    AsyncRunner runner = client.runAsync(Options.commitStats());
    ApiFuture<Void> result =
        runner.runAsync(
            txn -> {
              txn.buffer(Mutation.delete("FOO", Key.of("foo")));
              return ApiFutures.immediateFuture(null);
            },
            executor);
    assertNull(get(result));
    assertNotNull(get(runner.getCommitResponse()));
    assertNotNull(get(runner.getCommitResponse()).getCommitStats());
    assertEquals(1L, get(runner.getCommitResponse()).getCommitStats().getMutationCount());
    executor.shutdown();
  }

  @Test
  public void runAsyncIsNonBlocking() throws Exception {
    mockSpanner.freeze();
    DatabaseClient client =
        spannerWithEmptySessionPool.getDatabaseClient(
            DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
    ExecutorService executor = Executors.newSingleThreadExecutor();
    AsyncRunner runner = client.runAsync();
    ApiFuture<Long> fut =
        runner.runAsync(
            txn -> ApiFutures.immediateFuture(txn.executeUpdate(UPDATE_STATEMENT)), executor);
    mockSpanner.unfreeze();
    assertThat(fut.get()).isEqualTo(UPDATE_COUNT);
    executor.shutdown();
  }

  @Test
  public void runAsyncWithException() throws Exception {
    DatabaseClient client =
        spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
    ExecutorService executor = Executors.newSingleThreadExecutor();
    AsyncRunner runner = client.runAsync();
    ApiFuture<Long> fut =
        runner.runAsync(
            txn -> ApiFutures.immediateFuture(txn.executeUpdate(INVALID_UPDATE_STATEMENT)),
            executor);

    ExecutionException e = assertThrows(ExecutionException.class, fut::get);
    assertThat(e.getCause()).isInstanceOf(SpannerException.class);
    SpannerException se = (SpannerException) e.getCause();
    assertThat(se.getErrorCode()).isEqualTo(ErrorCode.INVALID_ARGUMENT);

    executor.shutdown();
  }

  @Test
  public void testTransactionManager() {
    DatabaseClient client =
        spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
    try (TransactionManager manager = client.transactionManager()) {
      TransactionContext transaction = manager.begin();
      while (true) {
        try {
          transaction.executeUpdate(UPDATE_STATEMENT);
          manager.commit();
          assertNotNull(manager.getCommitTimestamp());
          break;
        } catch (AbortedException e) {
          transaction = manager.resetForRetry();
        }
      }
    }
  }

  @Test
  public void testTransactionManager_returnsCommitStats() {
    DatabaseClient client =
        spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
    try (TransactionManager manager = client.transactionManager(Options.commitStats())) {
      TransactionContext transaction = manager.begin();
      while (true) {
        try {
          transaction.buffer(Mutation.delete("FOO", Key.of("foo")));
          manager.commit();
          assertNotNull(manager.getCommitResponse());
          assertNotNull(manager.getCommitResponse().getCommitStats());
          assertEquals(1L, manager.getCommitResponse().getCommitStats().getMutationCount());
          break;
        } catch (AbortedException e) {
          transaction = manager.resetForRetry();
        }
      }
    }
  }

  @Test
  public void transactionManagerIsNonBlocking() throws Exception {
    mockSpanner.freeze();
    DatabaseClient client =
        spannerWithEmptySessionPool.getDatabaseClient(
            DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
    try (TransactionManager txManager = client.transactionManager()) {
      mockSpanner.unfreeze();
      TransactionContext transaction = txManager.begin();
      while (true) {
        try {
          transaction.executeUpdate(UPDATE_STATEMENT);
          txManager.commit();
          break;
        } catch (AbortedException e) {
          //noinspection BusyWait
          Thread.sleep(e.getRetryDelayInMillis());
          transaction = txManager.resetForRetry();
        }
      }
    }
  }

  @Test
  public void transactionManagerExecuteQueryAsync() {
    DatabaseClient client =
        spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
    final AtomicInteger rowCount = new AtomicInteger();
    try (TransactionManager txManager = client.transactionManager()) {
      TransactionContext transaction = txManager.begin();
      while (true) {
        try {
          try (AsyncResultSet rs = transaction.executeQueryAsync(SELECT1)) {
            rs.setCallback(
                executor,
                resultSet -> {
                  try {
                    while (true) {
                      switch (resultSet.tryNext()) {
                        case OK:
                          rowCount.incrementAndGet();
                          break;
                        case DONE:
                          return CallbackResponse.DONE;
                        case NOT_READY:
                          return CallbackResponse.CONTINUE;
                      }
                    }
                  } catch (Throwable t) {
                    return CallbackResponse.DONE;
                  }
                });
          }
          txManager.commit();
          break;
        } catch (AbortedException e) {
          transaction = txManager.resetForRetry();
        }
      }
    }
    assertThat(rowCount.get()).isEqualTo(1);
  }

  /**
   * Test that the update statement can be executed as a partitioned transaction that returns a
   * lower bound update count.
   */
  @Test
  public void testExecutePartitionedDml() {
    DatabaseClient client =
        spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
    long updateCount = client.executePartitionedUpdate(UPDATE_STATEMENT);
    assertThat(updateCount).isEqualTo(UPDATE_COUNT);
  }

  /** {@link AbortedException} should automatically be retried. */
  @Test
  public void testExecutePartitionedDmlAborted() {
    DatabaseClient client =
        spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
    mockSpanner.abortNextTransaction();
    long updateCount = client.executePartitionedUpdate(UPDATE_STATEMENT);
    assertThat(updateCount).isEqualTo(UPDATE_COUNT);
  }

  /**
   * A valid query that returns a {@link ResultSet} should not be accepted by a partitioned dml
   * transaction.
   */
  @Test(expected = SpannerException.class)
  public void testExecutePartitionedDmlWithQuery() {
    DatabaseClient client =
        spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
    client.executePartitionedUpdate(SELECT1);
  }

  /** Server side exceptions that are not {@link AbortedException}s should propagate to the user. */
  @Test(expected = SpannerException.class)
  public void testExecutePartitionedDmlWithException() {
    DatabaseClient client =
        spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
    client.executePartitionedUpdate(INVALID_UPDATE_STATEMENT);
  }

  @Test
  public void testPartitionedDmlDoesNotTimeout() {
    mockSpanner.setExecuteSqlExecutionTime(SimulatedExecutionTime.ofMinimumAndRandomTime(20, 0));
    final RetrySettings retrySettings =
        RetrySettings.newBuilder()
            .setInitialRpcTimeoutDuration(Duration.ofMillis(1L))
            .setMaxRpcTimeoutDuration(Duration.ofMillis(1L))
            .setMaxAttempts(1)
            .setTotalTimeoutDuration(Duration.ofMillis(1L))
            .build();
    SpannerOptions.Builder builder =
        SpannerOptions.newBuilder()
            .setProjectId(TEST_PROJECT)
            .setChannelProvider(channelProvider)
            .setCredentials(NoCredentials.getInstance());
    // Set normal DML timeout value.
    builder.getSpannerStubSettingsBuilder().executeSqlSettings().setRetrySettings(retrySettings);
    try (Spanner spanner = builder.build().getService()) {
      DatabaseClient client =
          spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));

      assertThat(spanner.getOptions().getPartitionedDmlTimeoutDuration())
          .isEqualTo(Duration.ofHours(2L));

      // PDML should not timeout with these settings.
      long updateCount = client.executePartitionedUpdate(UPDATE_STATEMENT);
      assertThat(updateCount).isEqualTo(UPDATE_COUNT);

      // Normal DML should timeout.
      SpannerException e =
          assertThrows(
              SpannerException.class,
              () ->
                  client
                      .readWriteTransaction()
                      .run(
                          transaction -> {
                            transaction.executeUpdate(UPDATE_STATEMENT);
                            return null;
                          }));
      assertEquals(ErrorCode.DEADLINE_EXCEEDED, e.getErrorCode());

      DatabaseClientImpl dbImpl = ((DatabaseClientImpl) client);
      int channelId = 0;
      try (Session session = dbImpl.getSession()) {
        channelId = ((PooledSessionFuture) session).getChannel();
      }
      int dbId = dbImpl.dbId;
      long NON_DETERMINISTIC = XGoogSpannerRequestIdTest.NON_DETERMINISTIC;
      XGoogSpannerRequestIdTest.MethodAndRequestId[] wantStreamingValues = {
        XGoogSpannerRequestIdTest.ofMethodAndRequestId(
            "google.spanner.v1.Spanner/ExecuteStreamingSql",
            new XGoogSpannerRequestId(NON_DETERMINISTIC, channelId, 6, 1)),
      };
      xGoogReqIdInterceptor.checkExpectedStreamingXGoogRequestIds(wantStreamingValues);

      XGoogSpannerRequestIdTest.MethodAndRequestId[] wantUnaryValues = {
        XGoogSpannerRequestIdTest.ofMethodAndRequestId(
            "google.spanner.v1.Spanner/BeginTransaction",
            new XGoogSpannerRequestId(NON_DETERMINISTIC, channelId, 7, 1)),
        XGoogSpannerRequestIdTest.ofMethodAndRequestId(
            "google.spanner.v1.Spanner/CreateSession",
            new XGoogSpannerRequestId(NON_DETERMINISTIC, 0, 1, 1)),
        XGoogSpannerRequestIdTest.ofMethodAndRequestId(
            "google.spanner.v1.Spanner/ExecuteSql",
            new XGoogSpannerRequestId(NON_DETERMINISTIC, channelId, 8, 1)),
      };
      xGoogReqIdInterceptor.checkExpectedUnaryXGoogRequestIdsAsSuffixes(wantUnaryValues);
    }
  }

  @Test
  public void testPartitionedDmlWithLowerTimeout() {
    mockSpanner.setExecuteStreamingSqlExecutionTime(
        SimulatedExecutionTime.ofMinimumAndRandomTime(1000, 0));
    SpannerOptions.Builder builder =
        SpannerOptions.newBuilder()
            .setProjectId(TEST_PROJECT)
            .setChannelProvider(channelProvider)
            .setCredentials(NoCredentials.getInstance());
    // Set PDML timeout value.
    builder.setPartitionedDmlTimeoutDuration(Duration.ofMillis(10L));
    try (Spanner spanner = builder.build().getService()) {
      DatabaseClient client =
          spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
      assertThat(spanner.getOptions().getPartitionedDmlTimeoutDuration())
          .isEqualTo(Duration.ofMillis(10L));
      // PDML should time out with these settings.
      mockSpanner.setExecuteSqlExecutionTime(
          SimulatedExecutionTime.ofMinimumAndRandomTime(1000, 0));
      SpannerException e =
          assertThrows(
              SpannerException.class, () -> client.executePartitionedUpdate(UPDATE_STATEMENT));
      assertEquals(ErrorCode.DEADLINE_EXCEEDED, e.getErrorCode());

      // Normal DML should not time out.
      mockSpanner.setExecuteSqlExecutionTime(SimulatedExecutionTime.ofMinimumAndRandomTime(10, 0));
      Long updateCount =
          client
              .readWriteTransaction()
              .run(transaction -> transaction.executeUpdate(UPDATE_STATEMENT));
      assertThat(updateCount).isEqualTo(UPDATE_COUNT);
    }
  }

  @Test
  public void testPartitionedDmlWithHigherTimeout() {
    mockSpanner.setExecuteStreamingSqlExecutionTime(
        SimulatedExecutionTime.ofMinimumAndRandomTime(100, 0));
    SpannerOptions.Builder builder =
        SpannerOptions.newBuilder()
            .setProjectId(TEST_PROJECT)
            .setChannelProvider(channelProvider)
            .setCredentials(NoCredentials.getInstance());
    // Set PDML timeout value to a value that should allow the statement to be executed.
    builder.setPartitionedDmlTimeoutDuration(Duration.ofMillis(5000L));
    // Set the ExecuteSql RPC timeout value to a value lower than the time needed to execute the
    // statement. The higher timeout value that is set above should be respected, and the value for
    // the ExecuteSQL RPC should be ignored specifically for Partitioned DML.
    builder
        .getSpannerStubSettingsBuilder()
        .executeSqlSettings()
        .setRetrySettings(
            builder
                .getSpannerStubSettingsBuilder()
                .executeSqlSettings()
                .getRetrySettings()
                .toBuilder()
                .setInitialRpcTimeoutDuration(Duration.ofMillis(10L))
                .setMaxRpcTimeoutDuration(Duration.ofMillis(10L))
                .setInitialRetryDelayDuration(Duration.ofMillis(1L))
                .setMaxRetryDelayDuration(Duration.ofMillis(1L))
                .build());
    try (Spanner spanner = builder.build().getService()) {
      DatabaseClient client =
          spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
      // PDML should not timeout with these settings.
      long updateCount = client.executePartitionedUpdate(UPDATE_STATEMENT);

      // Normal DML should timeout as it should use the ExecuteSQL RPC settings.
      mockSpanner.setExecuteSqlExecutionTime(SimulatedExecutionTime.ofMinimumAndRandomTime(100, 0));
      SpannerException e =
          assertThrows(
              SpannerException.class,
              () ->
                  client
                      .readWriteTransaction()
                      .run(transaction -> transaction.executeUpdate(UPDATE_STATEMENT)));
      assertThat(e.getErrorCode()).isEqualTo(ErrorCode.DEADLINE_EXCEEDED);
      assertThat(updateCount).isEqualTo(UPDATE_COUNT);

      DatabaseClientImpl dbImpl = ((DatabaseClientImpl) client);
      int channelId = 0;
      try (Session session = dbImpl.getSession()) {
        channelId = ((PooledSessionFuture) session).getChannel();
      }
      int dbId = dbImpl.dbId;
      long NON_DETERMINISTIC = XGoogSpannerRequestIdTest.NON_DETERMINISTIC;
      XGoogSpannerRequestIdTest.MethodAndRequestId[] wantStreamingValues = {
        XGoogSpannerRequestIdTest.ofMethodAndRequestId(
            "google.spanner.v1.Spanner/ExecuteStreamingSql",
            new XGoogSpannerRequestId(NON_DETERMINISTIC, channelId, 6, 1)),
      };

      xGoogReqIdInterceptor.checkExpectedStreamingXGoogRequestIds(wantStreamingValues);

      XGoogSpannerRequestIdTest.MethodAndRequestId[] wantUnaryValues = {
        XGoogSpannerRequestIdTest.ofMethodAndRequestId(
            "google.spanner.v1.Spanner/BeginTransaction",
            new XGoogSpannerRequestId(NON_DETERMINISTIC, channelId, 7, 1)),
        XGoogSpannerRequestIdTest.ofMethodAndRequestId(
            "google.spanner.v1.Spanner/CreateSession",
            new XGoogSpannerRequestId(NON_DETERMINISTIC, 0, 1, 1)),
        XGoogSpannerRequestIdTest.ofMethodAndRequestId(
            "google.spanner.v1.Spanner/ExecuteSql",
            new XGoogSpannerRequestId(NON_DETERMINISTIC, channelId, 8, 1)),
      };
      xGoogReqIdInterceptor.checkExpectedUnaryXGoogRequestIdsAsSuffixes(wantUnaryValues);
    }
  }

  @Test
  public void testPartitionedDmlRetriesOnUnavailable() {
    mockSpanner.setExecuteSqlExecutionTime(
        SimulatedExecutionTime.ofException(Status.UNAVAILABLE.asRuntimeException()));
    SpannerOptions.Builder builder =
        SpannerOptions.newBuilder()
            .setProjectId(TEST_PROJECT)
            .setChannelProvider(channelProvider)
            .setCredentials(NoCredentials.getInstance());
    try (Spanner spanner = builder.build().getService()) {
      DatabaseClient client =
          spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
      long updateCount = client.executePartitionedUpdate(UPDATE_STATEMENT);
      assertThat(updateCount).isEqualTo(UPDATE_COUNT);
    }
  }

  @Test
  public void testDatabaseOrInstanceDoesNotExistOnInitialization() throws Exception {
    StatusRuntimeException[] exceptions =
        new StatusRuntimeException[] {
          SpannerExceptionFactoryTest.newStatusResourceNotFoundException(
              "Database", SpannerExceptionFactory.DATABASE_RESOURCE_TYPE, DATABASE_NAME),
          SpannerExceptionFactoryTest.newStatusResourceNotFoundException(
              "Instance", SpannerExceptionFactory.INSTANCE_RESOURCE_TYPE, INSTANCE_NAME)
        };
    for (StatusRuntimeException exception : exceptions) {
      try (Spanner spanner =
          SpannerOptions.newBuilder()
              .setProjectId(TEST_PROJECT)
              .setChannelProvider(channelProvider)
              .setCredentials(NoCredentials.getInstance())
              .build()
              .getService()) {
        mockSpanner.setBatchCreateSessionsExecutionTime(
            SimulatedExecutionTime.ofStickyException(exception));
        DatabaseClientImpl dbClient =
            (DatabaseClientImpl)
                spanner.getDatabaseClient(
                    DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
        // Wait until session creation has finished.
        Stopwatch watch = Stopwatch.createStarted();
        while (watch.elapsed(TimeUnit.SECONDS) < 5
            && dbClient.pool.getNumberOfSessionsBeingCreated() > 0) {
          //noinspection BusyWait
          Thread.sleep(1L);
        }
        // All session creation should fail and stop trying.
        assertThat(dbClient.pool.getNumberOfSessionsInPool()).isEqualTo(0);
        assertThat(dbClient.pool.getNumberOfSessionsBeingCreated()).isEqualTo(0);
        mockSpanner.reset();
        mockSpanner.removeAllExecutionTimes();
      }
    }
  }

  @Test
  public void testDatabaseOrInstanceDoesNotExistOnCreate() {
    for (Duration waitForMinSessions : ImmutableList.of(Duration.ZERO, Duration.ofSeconds(5L))) {
      StatusRuntimeException[] exceptions =
          new StatusRuntimeException[] {
            SpannerExceptionFactoryTest.newStatusResourceNotFoundException(
                "Database", SpannerExceptionFactory.DATABASE_RESOURCE_TYPE, DATABASE_NAME),
            SpannerExceptionFactoryTest.newStatusResourceNotFoundException(
                "Instance", SpannerExceptionFactory.INSTANCE_RESOURCE_TYPE, INSTANCE_NAME)
          };
      for (StatusRuntimeException exception : exceptions) {
        mockSpanner.setCreateSessionExecutionTime(
            SimulatedExecutionTime.ofStickyException(exception));
        mockSpanner.setBatchCreateSessionsExecutionTime(
            SimulatedExecutionTime.ofStickyException(exception));
        // Ensure there are no sessions in the pool by default.
        try (Spanner spanner =
            SpannerOptions.newBuilder()
                .setProjectId(TEST_PROJECT)
                .setChannelProvider(channelProvider)
                .setCredentials(NoCredentials.getInstance())
                .setSessionPoolOption(
                    SessionPoolOptions.newBuilder()
                        .setMinSessions(0)
                        .setWaitForMinSessionsDuration(waitForMinSessions)
                        .build())
                .build()
                .getService()) {
          boolean useMultiplexedSession =
              spanner.getOptions().getSessionPoolOptions().getUseMultiplexedSession();
          DatabaseId databaseId = DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE);
          if (useMultiplexedSession && !waitForMinSessions.isZero()) {
            assertThrows(
                ResourceNotFoundException.class, () -> spanner.getDatabaseClient(databaseId));
          } else {
            // Freeze the server until we try to execute ResultSet#next() to prevent the creation of
            // a multiplexed session to finish before we try to use it.
            mockSpanner.freeze();
            DatabaseClientImpl dbClient =
                (DatabaseClientImpl) spanner.getDatabaseClient(databaseId);
            // The CreateSession / BatchCreateSessions failure should propagate to the client and
            // not retry.
            try (ResultSet rs = dbClient.singleUse().executeQuery(SELECT1)) {
              mockSpanner.unfreeze();
              assertThrows(ResourceNotFoundException.class, rs::next);
              // The server should only receive one BatchCreateSessions request.
              assertThat(mockSpanner.getRequests()).hasSize(1);
            }
            assertThrows(
                ResourceNotFoundException.class,
                () ->
                    dbClient
                        .readWriteTransaction()
                        .run(transaction -> transaction.executeUpdate(UPDATE_STATEMENT)));
            // No additional requests should have been sent by the client.
            if (spanner.getOptions().getSessionPoolOptions().getUseMultiplexedSession()
                && !spanner.getOptions().getSessionPoolOptions().getUseMultiplexedSessionForRW()) {
              // Note that in case of the use of multiplexed sessions for read-only alone, then we
              // have 2 requests:
              // 1. BatchCreateSessions for the session pool.
              // 2. CreateSession for the multiplexed session.
              assertThat(mockSpanner.getRequests()).hasSize(2);
            } else {
              // Note that in case of the use of regular sessions, then we have 1 request:
              // BatchCreateSessions for the session pool.
              // Note that in case of the use of multiplexed sessions for read-write, then we have 1
              // request: CreateSession for the multiplexed session.
              assertThat(mockSpanner.getRequests()).hasSize(1);
            }
          }
        }
        mockSpanner.reset();
        mockSpanner.removeAllExecutionTimes();
      }
    }
  }

  @Test
  public void testDatabaseOrInstanceDoesNotExistOnReplenish() throws Exception {
    StatusRuntimeException[] exceptions =
        new StatusRuntimeException[] {
          SpannerExceptionFactoryTest.newStatusResourceNotFoundException(
              "Database", SpannerExceptionFactory.DATABASE_RESOURCE_TYPE, DATABASE_NAME),
          SpannerExceptionFactoryTest.newStatusResourceNotFoundException(
              "Instance", SpannerExceptionFactory.INSTANCE_RESOURCE_TYPE, INSTANCE_NAME)
        };
    for (StatusRuntimeException exception : exceptions) {
      try (Spanner spanner =
          SpannerOptions.newBuilder()
              .setProjectId(TEST_PROJECT)
              .setChannelProvider(channelProvider)
              .setCredentials(NoCredentials.getInstance())
              .build()
              .getService()) {
        mockSpanner.setBatchCreateSessionsExecutionTime(
            SimulatedExecutionTime.ofStickyException(exception));
        DatabaseClientImpl dbClient =
            (DatabaseClientImpl)
                spanner.getDatabaseClient(
                    DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
        // Wait until session creation has finished.
        Stopwatch watch = Stopwatch.createStarted();
        while (watch.elapsed(TimeUnit.SECONDS) < 5
            && dbClient.pool.getNumberOfSessionsBeingCreated() > 0) {
          //noinspection BusyWait
          Thread.sleep(1L);
        }
        // All session creation should fail and stop trying.
        assertThat(dbClient.pool.getNumberOfSessionsInPool()).isEqualTo(0);
        assertThat(dbClient.pool.getNumberOfSessionsBeingCreated()).isEqualTo(0);
        // Force a maintainer run. This should schedule new session creation.
        dbClient.pool.poolMaintainer.maintainPool();
        // Wait until the replenish has finished.
        watch.reset().start();
        while (watch.elapsed(TimeUnit.SECONDS) < 5
            && dbClient.pool.getNumberOfSessionsBeingCreated() > 0) {
          //noinspection BusyWait
          Thread.sleep(1L);
        }
        // All session creation from replenishPool should fail and stop trying.
        assertThat(dbClient.pool.getNumberOfSessionsInPool()).isEqualTo(0);
        assertThat(dbClient.pool.getNumberOfSessionsBeingCreated()).isEqualTo(0);
      }
      mockSpanner.reset();
      mockSpanner.removeAllExecutionTimes();
    }
  }

  /**
   * Test showing that when a database is deleted while it is in use by a database client and then
   * re-created with the same name, will continue to return {@link DatabaseNotFoundException}s until
   * a new {@link DatabaseClient} is created.
   */
  @Test
  public void testDatabaseOrInstanceIsDeletedAndThenRecreated() throws Exception {
    StatusRuntimeException[] exceptions =
        new StatusRuntimeException[] {
          SpannerExceptionFactoryTest.newStatusResourceNotFoundException(
              "Database", SpannerExceptionFactory.DATABASE_RESOURCE_TYPE, DATABASE_NAME),
          SpannerExceptionFactoryTest.newStatusResourceNotFoundException(
              "Instance", SpannerExceptionFactory.INSTANCE_RESOURCE_TYPE, INSTANCE_NAME)
        };
    for (StatusRuntimeException exception : exceptions) {
      try (Spanner spanner =
          SpannerOptions.newBuilder()
              .setProjectId(TEST_PROJECT)
              .setChannelProvider(channelProvider)
              .setCredentials(NoCredentials.getInstance())
              .build()
              .getService()) {
        DatabaseClientImpl dbClient =
            (DatabaseClientImpl)
                spanner.getDatabaseClient(
                    DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
        // Wait until all sessions have been created and prepared.
        Stopwatch watch = Stopwatch.createStarted();
        while (watch.elapsed(TimeUnit.SECONDS) < 5
            && (dbClient.pool.getNumberOfSessionsBeingCreated() > 0)) {
          //noinspection BusyWait
          Thread.sleep(1L);
        }
        // Simulate that the database or instance has been deleted.
        mockSpanner.setStickyGlobalExceptions(true);
        mockSpanner.addException(exception);

        // All subsequent calls should fail with a DatabaseNotFoundException.
        try (ResultSet rs = dbClient.singleUse().executeQuery(SELECT1)) {
          assertThrows(ResourceNotFoundException.class, rs::next);
        }
        assertThrows(
            ResourceNotFoundException.class,
            () -> dbClient.readWriteTransaction().run(transaction -> null));

        // Now simulate that the database has been re-created. The database client should still
        // throw DatabaseNotFoundExceptions, as it is not the same database. The server should not
        // receive any new requests.
        mockSpanner.reset();
        // All subsequent calls should fail with a DatabaseNotFoundException.

        if (!spanner.getOptions().getSessionPoolOptions().getUseMultiplexedSession()) {
          // We only verify this for read-only transactions if we are not using multiplexed
          // sessions. For multiplexed sessions, we don't need any special handling, as deleting the
          // database will also invalidate the multiplexed session, and trying to continue to use it
          // will continue to return an error.
          assertThrows(
              ResourceNotFoundException.class, () -> dbClient.singleUse().executeQuery(SELECT1));
        }

        if (!spanner.getOptions().getSessionPoolOptions().getUseMultiplexedSessionForRW()) {
          // We only verify this for read-write transactions if we are not using multiplexed
          // sessions. For multiplexed sessions, we don't need any special handling, as deleting the
          // database will also invalidate the multiplexed session, and trying to continue to use it
          // will continue to return an error.
          assertThrows(
              ResourceNotFoundException.class,
              () -> dbClient.readWriteTransaction().run(transaction -> null));
        }

        assertThat(mockSpanner.getRequests()).isEmpty();
        // Now get a new database client. Normally multiple calls to Spanner#getDatabaseClient will
        // return the same instance, but not when the instance has been invalidated by a
        // DatabaseNotFoundException.
        DatabaseClientImpl newClient =
            (DatabaseClientImpl)
                spanner.getDatabaseClient(
                    DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
        assertThat(newClient).isNotSameInstanceAs(dbClient);
        // Executing a query should now work without problems.
        try (ResultSet rs = newClient.singleUse().executeQuery(SELECT1)) {
          consumeResults(rs);
        }
        assertThat(mockSpanner.getRequests()).isNotEmpty();
      }
      mockSpanner.reset();
      mockSpanner.removeAllExecutionTimes();
    }
  }

  @Test
  public void testGetInvalidatedClientMultipleTimes() {
    StatusRuntimeException[] exceptions =
        new StatusRuntimeException[] {
          SpannerExceptionFactoryTest.newStatusResourceNotFoundException(
              "Database", SpannerExceptionFactory.DATABASE_RESOURCE_TYPE, DATABASE_NAME),
          SpannerExceptionFactoryTest.newStatusResourceNotFoundException(
              "Instance", SpannerExceptionFactory.INSTANCE_RESOURCE_TYPE, INSTANCE_NAME)
        };
    for (StatusRuntimeException exception : exceptions) {
      mockSpanner.setCreateSessionExecutionTime(
          SimulatedExecutionTime.ofStickyException(exception));
      mockSpanner.setBatchCreateSessionsExecutionTime(
          SimulatedExecutionTime.ofStickyException(exception));
      try (Spanner spanner =
          SpannerOptions.newBuilder()
              .setProjectId(TEST_PROJECT)
              .setChannelProvider(channelProvider)
              .setCredentials(NoCredentials.getInstance())
              .setSessionPoolOption(SessionPoolOptions.newBuilder().setMinSessions(0).build())
              .build()
              .getService()) {
        for (int run = 0; run < 2; run++) {
          DatabaseClientImpl dbClient =
              (DatabaseClientImpl)
                  spanner.getDatabaseClient(
                      DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
          for (int useClient = 0; useClient < 2; useClient++) {
            // Using the same client multiple times should continue to return the same
            // ResourceNotFoundException, even though the session pool has been invalidated.
            assertThrows(
                ResourceNotFoundException.class,
                () -> dbClient.singleUse().executeQuery(SELECT1).next());
            if (spanner.getOptions().getSessionPoolOptions().getUseMultiplexedSession()) {
              // We should only receive 1 CreateSession request. The query should never be executed,
              // as the session creation fails before it gets to executing a query.
              assertEquals(1, mockSpanner.countRequestsOfType(CreateSessionRequest.class));
              assertEquals(0, mockSpanner.countRequestsOfType(ExecuteSqlRequest.class));
            } else {
              // The server should only receive one BatchCreateSessions request for each run as we
              // have set MinSessions=0.
              assertThat(mockSpanner.getRequests()).hasSize(run + 1);
              assertThat(dbClient.pool.isValid()).isFalse();
            }
          }
        }
      }
      mockSpanner.reset();
      mockSpanner.removeAllExecutionTimes();
    }
  }

  @Test
  public void testAllowNestedTransactions() throws InterruptedException {
    final DatabaseClientImpl client =
        (DatabaseClientImpl)
            spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
    // Wait until all sessions have been created.
    final int minSessions = spanner.getOptions().getSessionPoolOptions().getMinSessions();
    Stopwatch watch = Stopwatch.createStarted();
    while (watch.elapsed(TimeUnit.SECONDS) < 5
        && client.pool.getNumberOfSessionsInPool() < minSessions) {
      //noinspection BusyWait
      Thread.sleep(1L);
    }
    assertThat(client.pool.getNumberOfSessionsInPool()).isEqualTo(minSessions);
    int expectedMinSessions =
        spanner.getOptions().getSessionPoolOptions().getUseMultiplexedSessionForRW()
            ? minSessions
            : minSessions - 1;
    Long res =
        client
            .readWriteTransaction()
            .allowNestedTransaction()
            .run(
                transaction -> {
                  assertThat(client.pool.getNumberOfSessionsInPool())
                      .isEqualTo(expectedMinSessions);
                  return transaction.executeUpdate(UPDATE_STATEMENT);
                });
    assertThat(res).isEqualTo(UPDATE_COUNT);
    assertThat(client.pool.getNumberOfSessionsInPool()).isEqualTo(minSessions);
  }

  @Test
  public void testNestedTransactionsUsingTwoDatabases() throws InterruptedException {
    final DatabaseClientImpl client1 =
        (DatabaseClientImpl)
            spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, "my-database-1"));
    final DatabaseClientImpl client2 =
        (DatabaseClientImpl)
            spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, "my-database-2"));
    // Wait until all sessions have been created so we can actually check the number of sessions
    // checked out of the pools.
    final int minSessions = spanner.getOptions().getSessionPoolOptions().getMinSessions();
    Stopwatch watch = Stopwatch.createStarted();
    while (watch.elapsed(TimeUnit.SECONDS) < 5
        && (client1.pool.getNumberOfSessionsInPool() < minSessions
            || client2.pool.getNumberOfSessionsInPool() < minSessions)) {
      //noinspection BusyWait
      Thread.sleep(1L);
    }
    assertThat(client1.pool.getNumberOfSessionsInPool()).isEqualTo(minSessions);
    assertThat(client2.pool.getNumberOfSessionsInPool()).isEqualTo(minSessions);
    // When read-write transaction uses multiplexed sessions, then sessions are not checked out from
    // the session pool.
    int expectedMinSessions = isMultiplexedSessionsEnabledForRW() ? minSessions : minSessions - 1;
    Long res =
        client1
            .readWriteTransaction()
            .allowNestedTransaction()
            .run(
                transaction -> {
                  // Client1 should have 1 session checked out.
                  // Client2 should have 0 sessions checked out.
                  assertThat(client1.pool.getNumberOfSessionsInPool())
                      .isEqualTo(expectedMinSessions);
                  assertThat(client2.pool.getNumberOfSessionsInPool()).isEqualTo(minSessions);
                  Long add =
                      client2
                          .readWriteTransaction()
                          .run(
                              transaction1 -> {
                                // Both clients should now have 1 session checked out.
                                assertThat(client1.pool.getNumberOfSessionsInPool())
                                    .isEqualTo(expectedMinSessions);
                                assertThat(client2.pool.getNumberOfSessionsInPool())
                                    .isEqualTo(expectedMinSessions);
                                try (ResultSet rs = transaction1.executeQuery(SELECT1)) {
                                  if (rs.next()) {
                                    return rs.getLong(0);
                                  }
                                  return 0L;
                                }
                              });
                  assertNotNull(add);
                  try (ResultSet rs = transaction.executeQuery(SELECT1)) {
                    if (rs.next()) {
                      return add + rs.getLong(0);
                    }
                    return add;
                  }
                });
    assertThat(res).isEqualTo(2L);
    // All sessions should now be checked back in to the pools.
    assertThat(client1.pool.getNumberOfSessionsInPool()).isEqualTo(minSessions);
    assertThat(client2.pool.getNumberOfSessionsInPool()).isEqualTo(minSessions);
  }

  @Test
  public void testBackendQueryOptions() {
    // Use a Spanner instance with MinSession=0 to prevent background requests
    // from the session pool interfering with the test case.
    try (Spanner spanner =
        SpannerOptions.newBuilder()
            .setProjectId("[PROJECT]")
            .setChannelProvider(channelProvider)
            .setCredentials(NoCredentials.getInstance())
            .setSessionPoolOption(SessionPoolOptions.newBuilder().setMinSessions(0).build())
            .build()
            .getService()) {
      DatabaseClient client =
          spanner.getDatabaseClient(DatabaseId.of("[PROJECT]", "[INSTANCE]", "[DATABASE"));
      try (ResultSet rs =
          client
              .singleUse()
              .executeQuery(
                  Statement.newBuilder(SELECT1.getSql())
                      .withQueryOptions(
                          QueryOptions.newBuilder()
                              .setOptimizerVersion("1")
                              .setOptimizerStatisticsPackage("custom-package")
                              .build())
                      .build())) {
        // Just iterate over the results to execute the query.
        consumeResults(rs);
      }
      // Check that the last query was executed using a custom optimizer version and statistics
      // package.
      List<AbstractMessage> requests = mockSpanner.getRequests();
      assertThat(requests).isNotEmpty();
      assertThat(requests.get(requests.size() - 1)).isInstanceOf(ExecuteSqlRequest.class);
      ExecuteSqlRequest request = (ExecuteSqlRequest) requests.get(requests.size() - 1);
      assertThat(request.getQueryOptions()).isNotNull();
      assertThat(request.getQueryOptions().getOptimizerVersion()).isEqualTo("1");
      assertThat(request.getQueryOptions().getOptimizerStatisticsPackage())
          .isEqualTo("custom-package");
    }
  }

  @Test
  public void testBackendQueryOptionsWithAnalyzeQuery() {
    // Use a Spanner instance with MinSession=0 to prevent background requests
    // from the session pool interfering with the test case.
    try (Spanner spanner =
        SpannerOptions.newBuilder()
            .setProjectId("[PROJECT]")
            .setChannelProvider(channelProvider)
            .setCredentials(NoCredentials.getInstance())
            .setSessionPoolOption(SessionPoolOptions.newBuilder().setMinSessions(0).build())
            .build()
            .getService()) {
      DatabaseClient client =
          spanner.getDatabaseClient(DatabaseId.of("[PROJECT]", "[INSTANCE]", "[DATABASE"));
      try (ReadOnlyTransaction tx = client.readOnlyTransaction()) {
        try (ResultSet rs =
            tx.analyzeQuery(
                Statement.newBuilder(SELECT1.getSql())
                    .withQueryOptions(
                        QueryOptions.newBuilder()
                            .setOptimizerVersion("1")
                            .setOptimizerStatisticsPackage("custom-package")
                            .build())
                    .build(),
                QueryAnalyzeMode.PROFILE)) {
          // Just iterate over the results to execute the query.
          consumeResults(rs);
        }
      }
      // Check that the last query was executed using a custom optimizer version and statistics
      // package.
      List<AbstractMessage> requests = mockSpanner.getRequests();
      assertThat(requests).isNotEmpty();
      assertThat(requests.get(requests.size() - 1)).isInstanceOf(ExecuteSqlRequest.class);
      ExecuteSqlRequest request = (ExecuteSqlRequest) requests.get(requests.size() - 1);
      assertThat(request.getQueryOptions()).isNotNull();
      assertThat(request.getQueryOptions().getOptimizerVersion()).isEqualTo("1");
      assertThat(request.getQueryOptions().getOptimizerStatisticsPackage())
          .isEqualTo("custom-package");
      assertThat(request.getQueryMode()).isEqualTo(QueryMode.PROFILE);
    }
  }

  @Test
  public void testBackendPartitionQueryOptions() {
    // Use a Spanner instance with MinSession=0 to prevent background requests
    // from the session pool interfering with the test case.
    try (Spanner spanner =
        SpannerOptions.newBuilder()
            .setProjectId("[PROJECT]")
            .setChannelProvider(channelProvider)
            .setCredentials(NoCredentials.getInstance())
            .setSessionPoolOption(SessionPoolOptions.newBuilder().setMinSessions(0).build())
            .setDirectedReadOptions(DIRECTED_READ_OPTIONS2)
            .build()
            .getService()) {
      BatchClient client =
          spanner.getBatchClient(DatabaseId.of("[PROJECT]", "[INSTANCE]", "[DATABASE"));
      BatchReadOnlyTransaction transaction =
          client.batchReadOnlyTransaction(TimestampBound.strong());
      List<Partition> partitions =
          transaction.partitionQuery(
              PartitionOptions.newBuilder().setMaxPartitions(10L).build(),
              Statement.newBuilder(SELECT1.getSql())
                  .withQueryOptions(
                      QueryOptions.newBuilder()
                          .setOptimizerVersion("1")
                          .setOptimizerStatisticsPackage("custom-package")
                          .build())
                  .build(),
              Options.directedRead(DIRECTED_READ_OPTIONS1));
      try (ResultSet rs = transaction.execute(partitions.get(0))) {
        // Just iterate over the results to execute the query.
        consumeResults(rs);
      } finally {
        transaction.cleanup();
      }
      // Check if the last query executed is a DeleteSessionRequest and the second last query
      // executed is a ExecuteSqlRequest and was executed using a custom optimizer version,
      // statistics package and directed read options.
      List<AbstractMessage> requests = mockSpanner.getRequests();
      assert requests.size() >= 2 : "required to have at least 2 requests";
      assertThat(requests.get(requests.size() - 1)).isInstanceOf(DeleteSessionRequest.class);
      assertThat(requests.get(requests.size() - 2)).isInstanceOf(ExecuteSqlRequest.class);
      ExecuteSqlRequest executeSqlRequest = (ExecuteSqlRequest) requests.get(requests.size() - 2);
      assertThat(executeSqlRequest.getQueryOptions()).isNotNull();
      assertThat(executeSqlRequest.getQueryOptions().getOptimizerVersion()).isEqualTo("1");
      assertThat(executeSqlRequest.getQueryOptions().getOptimizerStatisticsPackage())
          .isEqualTo("custom-package");
      assertThat(executeSqlRequest.getDirectedReadOptions()).isEqualTo(DIRECTED_READ_OPTIONS1);
    }
  }

  @Test
  public void
      testBackendPartitionQueryOptions_whenDirectedReadOptionsViaSpannerOptions_assertOptions() {
    // Use a Spanner instance with MinSession=0 to prevent background requests
    // from the session pool interfering with the test case.
    try (Spanner spanner =
        SpannerOptions.newBuilder()
            .setProjectId("[PROJECT]")
            .setChannelProvider(channelProvider)
            .setCredentials(NoCredentials.getInstance())
            .setSessionPoolOption(SessionPoolOptions.newBuilder().setMinSessions(0).build())
            .setDirectedReadOptions(DIRECTED_READ_OPTIONS2)
            .build()
            .getService()) {
      BatchClient client =
          spanner.getBatchClient(DatabaseId.of("[PROJECT]", "[INSTANCE]", "[DATABASE"));
      BatchReadOnlyTransaction transaction =
          client.batchReadOnlyTransaction(TimestampBound.strong());
      List<Partition> partitions =
          transaction.partitionQuery(
              PartitionOptions.newBuilder().setMaxPartitions(10L).build(),
              Statement.newBuilder(SELECT1.getSql())
                  .withQueryOptions(
                      QueryOptions.newBuilder()
                          .setOptimizerVersion("1")
                          .setOptimizerStatisticsPackage("custom-package")
                          .build())
                  .build());
      try (ResultSet rs = transaction.execute(partitions.get(0))) {
        // Just iterate over the results to execute the query.
        consumeResults(rs);
      } finally {
        transaction.cleanup();
      }
      // Check if the last query executed is a DeleteSessionRequest and the second last query
      // executed is a ExecuteSqlRequest and was executed using a custom optimizer version,
      // statistics package and directed read options.
      List<AbstractMessage> requests = mockSpanner.getRequests();
      assert requests.size() >= 2 : "required to have at least 2 requests";
      assertThat(requests.get(requests.size() - 1)).isInstanceOf(DeleteSessionRequest.class);
      assertThat(requests.get(requests.size() - 2)).isInstanceOf(ExecuteSqlRequest.class);
      ExecuteSqlRequest executeSqlRequest = (ExecuteSqlRequest) requests.get(requests.size() - 2);
      assertThat(executeSqlRequest.getQueryOptions()).isNotNull();
      assertThat(executeSqlRequest.getQueryOptions().getOptimizerVersion()).isEqualTo("1");
      assertThat(executeSqlRequest.getQueryOptions().getOptimizerStatisticsPackage())
          .isEqualTo("custom-package");
      assertThat(executeSqlRequest.getDirectedReadOptions()).isEqualTo(DIRECTED_READ_OPTIONS2);
    }
  }

  @Test
  public void testBackendPartitionReadOptions() {
    // Use a Spanner instance with MinSession=0 to prevent background requests
    // from the session pool interfering with the test case.
    try (Spanner spanner =
        SpannerOptions.newBuilder()
            .setProjectId("[PROJECT]")
            .setChannelProvider(channelProvider)
            .setCredentials(NoCredentials.getInstance())
            .setSessionPoolOption(SessionPoolOptions.newBuilder().setMinSessions(0).build())
            .setDirectedReadOptions(DIRECTED_READ_OPTIONS2)
            .build()
            .getService()) {
      BatchClient client =
          spanner.getBatchClient(DatabaseId.of("[PROJECT]", "[INSTANCE]", "[DATABASE"));
      BatchReadOnlyTransaction transaction =
          client.batchReadOnlyTransaction(TimestampBound.strong());
      List<Partition> partitions =
          transaction.partitionRead(
              PartitionOptions.newBuilder().setMaxPartitions(10L).build(),
              "FOO",
              KeySet.all(),
              Lists.newArrayList("1"),
              Options.directedRead(DIRECTED_READ_OPTIONS1));
      try (ResultSet rs = transaction.execute(partitions.get(0))) {
        // Just iterate over the results to execute the query.
        consumeResults(rs);
      } finally {
        transaction.cleanup();
      }
      // Check if the last query executed is a DeleteSessionRequest and the second last query
      // executed is a ExecuteSqlRequest and was executed using a custom optimizer version,
      // statistics package and directed read options.
      List<AbstractMessage> requests = mockSpanner.getRequests();
      assert requests.size() >= 2 : "required to have at least 2 requests";
      assertThat(requests.get(requests.size() - 1)).isInstanceOf(DeleteSessionRequest.class);
      assertThat(requests.get(requests.size() - 2)).isInstanceOf(ReadRequest.class);
      ReadRequest readRequest = (ReadRequest) requests.get(requests.size() - 2);
      assertThat(readRequest.getDirectedReadOptions()).isEqualTo(DIRECTED_READ_OPTIONS1);
    }
  }

  @Test
  public void
      testBackendPartitionReadOptions_whenDirectedReadOptionsViaSpannerOptions_assertOptions() {
    // Use a Spanner instance with MinSession=0 to prevent background requests
    // from the session pool interfering with the test case.
    try (Spanner spanner =
        SpannerOptions.newBuilder()
            .setProjectId("[PROJECT]")
            .setChannelProvider(channelProvider)
            .setCredentials(NoCredentials.getInstance())
            .setSessionPoolOption(SessionPoolOptions.newBuilder().setMinSessions(0).build())
            .setDirectedReadOptions(DIRECTED_READ_OPTIONS2)
            .build()
            .getService()) {
      BatchClient client =
          spanner.getBatchClient(DatabaseId.of("[PROJECT]", "[INSTANCE]", "[DATABASE"));
      BatchReadOnlyTransaction transaction =
          client.batchReadOnlyTransaction(TimestampBound.strong());
      List<Partition> partitions =
          transaction.partitionRead(
              PartitionOptions.newBuilder().setMaxPartitions(10L).build(),
              "FOO",
              KeySet.all(),
              Lists.newArrayList("1"));
      try (ResultSet rs = transaction.execute(partitions.get(0))) {
        // Just iterate over the results to execute the query.
        //noinspection StatementWithEmptyBody
        while (rs.next()) {}
      } finally {
        transaction.cleanup();
      }
      // Check if the last query executed is a DeleteSessionRequest and the second last query
      // executed is a ExecuteSqlRequest and was executed using a custom optimizer version,
      // statistics package and directed read options.
      List<AbstractMessage> requests = mockSpanner.getRequests();
      assert requests.size() >= 2 : "required to have at least 2 requests";
      assertThat(requests.get(requests.size() - 1)).isInstanceOf(DeleteSessionRequest.class);
      assertThat(requests.get(requests.size() - 2)).isInstanceOf(ReadRequest.class);
      ReadRequest readRequest = (ReadRequest) requests.get(requests.size() - 2);
      assertThat(readRequest.getDirectedReadOptions()).isEqualTo(DIRECTED_READ_OPTIONS2);
    }
  }

  @Test
  public void testAsyncQuery() throws Exception {
    final int EXPECTED_ROW_COUNT = 10;
    com.google.cloud.spanner.connection.RandomResultSetGenerator generator =
        new RandomResultSetGenerator(EXPECTED_ROW_COUNT);
    com.google.spanner.v1.ResultSet resultSet = generator.generate();
    mockSpanner.putStatementResult(
        StatementResult.query(Statement.of("SELECT * FROM RANDOM"), resultSet));
    DatabaseClient client =
        spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
    ExecutorService executor = Executors.newSingleThreadExecutor();
    ApiFuture<Void> resultSetClosed;
    final SettableFuture<Boolean> finished = SettableFuture.create();
    final List<Struct> receivedResults = new ArrayList<>();
    try (AsyncResultSet rs =
        client.singleUse().executeQueryAsync(Statement.of("SELECT * FROM RANDOM"))) {
      resultSetClosed =
          rs.setCallback(
              executor,
              asyncResultSet -> {
                try {
                  while (true) {
                    switch (rs.tryNext()) {
                      case DONE:
                        finished.set(true);
                        return CallbackResponse.DONE;
                      case NOT_READY:
                        return CallbackResponse.CONTINUE;
                      case OK:
                        receivedResults.add(asyncResultSet.getCurrentRowAsStruct());
                        break;
                      default:
                        throw new IllegalStateException("Unknown cursor state");
                    }
                  }
                } catch (Throwable t) {
                  finished.setException(t);
                  return CallbackResponse.DONE;
                }
              });
    }
    assertThat(finished.get()).isTrue();
    assertThat(receivedResults.size()).isEqualTo(EXPECTED_ROW_COUNT);
    resultSetClosed.get();
  }

  @Test
  public void testClientIdReusedOnDatabaseNotFound() {
    mockSpanner.setBatchCreateSessionsExecutionTime(
        SimulatedExecutionTime.ofStickyException(
            SpannerExceptionFactoryTest.newStatusResourceNotFoundException(
                "my-database",
                SpannerExceptionFactory.DATABASE_RESOURCE_TYPE,
                "project/my-project/instances/my-instance/databases/my-database")));
    try (Spanner spanner =
        SpannerOptions.newBuilder()
            .setProjectId("my-project")
            .setChannelProvider(channelProvider)
            .setCredentials(NoCredentials.getInstance())
            .build()
            .getService()) {
      DatabaseId databaseId = DatabaseId.of("my-project", "my-instance", "my-database");
      String prevClientId = null;
      for (int i = 0; i < 100; i++) {
        try {
          DatabaseClientImpl client = (DatabaseClientImpl) spanner.getDatabaseClient(databaseId);
          if (prevClientId != null) {
            assertThat(client.clientId).isEqualTo(prevClientId);
          }
          prevClientId = client.clientId;
          client.singleUse().readRow("MyTable", Key.of(0), Collections.singletonList("MyColumn"));
        } catch (Exception e) {
          // ignore
        }
      }
    }
  }

  @Test
  public void testBatchCreateSessionsPermissionDenied() {
    for (Duration waitForMinSessions : ImmutableList.of(Duration.ZERO, Duration.ofSeconds(5L))) {
      mockSpanner.setBatchCreateSessionsExecutionTime(
          SimulatedExecutionTime.ofStickyException(
              Status.PERMISSION_DENIED.withDescription("Not permitted").asRuntimeException()));
      mockSpanner.setCreateSessionExecutionTime(
          SimulatedExecutionTime.ofStickyException(
              Status.PERMISSION_DENIED.withDescription("Not permitted").asRuntimeException()));
      if (waitForMinSessions.isZero()) {
        mockSpanner.freeze();
      }
      try (Spanner spanner =
          SpannerOptions.newBuilder()
              .setProjectId("my-project")
              .setChannelProvider(channelProvider)
              .setCredentials(NoCredentials.getInstance())
              .setSessionPoolOption(
                  SessionPoolOptions.newBuilder()
                      .setWaitForMinSessionsDuration(waitForMinSessions)
                      .build())
              .build()
              .getService()) {
        DatabaseId databaseId = DatabaseId.of("my-project", "my-instance", "my-database");
        SpannerException spannerException;
        if (waitForMinSessions.isZero()) {
          // The following call is non-blocking and will not generate an exception.
          DatabaseClient client = spanner.getDatabaseClient(databaseId);
          ResultSet resultSet = client.singleUse().executeQuery(SELECT1);
          mockSpanner.unfreeze();
          // Actually trying to get any results will cause an exception.
          spannerException = assertThrows(SpannerException.class, resultSet::next);
        } else {
          // This is blocking when we should wait for min sessions, and will therefore fail.
          if (spanner.getOptions().getSessionPoolOptions().getUseMultiplexedSession()) {
            spannerException =
                assertThrows(SpannerException.class, () -> spanner.getDatabaseClient(databaseId));
          } else {
            // TODO: Fix the session pool implementation for waiting for min sessions, so this also
            //       propagates the error directly when session creation fails.
            DatabaseClient client = spanner.getDatabaseClient(databaseId);
            spannerException =
                assertThrows(
                    SpannerException.class, () -> client.singleUse().executeQuery(SELECT1).next());
          }
        }
        assertEquals(ErrorCode.PERMISSION_DENIED, spannerException.getErrorCode());
      } finally {
        mockSpanner.setBatchCreateSessionsExecutionTime(SimulatedExecutionTime.none());
        mockSpanner.setCreateSessionExecutionTime(SimulatedExecutionTime.none());
      }
    }
  }

  @Test
  public void testExceptionIncludesStatement() {
    mockSpanner.setExecuteStreamingSqlExecutionTime(
        SimulatedExecutionTime.ofException(
            Status.INVALID_ARGUMENT.withDescription("Invalid query").asRuntimeException()));
    DatabaseClient client =
        spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
    try (ResultSet rs =
        client
            .singleUse()
            .executeQuery(
                Statement.newBuilder("SELECT * FROM FOO WHERE ID=@id").bind("id").to(1L).build())) {
      SpannerException e = assertThrows(SpannerException.class, rs::next);
      assertThat(e.getErrorCode()).isEqualTo(ErrorCode.INVALID_ARGUMENT);
      assertThat(e.getMessage()).contains("Statement: 'SELECT * FROM FOO WHERE ID=@id'");
      // The error message should normally not include the parameter values to prevent sensitive
      // information from accidentally being logged.
      assertThat(e.getMessage()).doesNotContain("id: 1");
    }

    mockSpanner.setExecuteStreamingSqlExecutionTime(
        SimulatedExecutionTime.ofException(
            Status.INVALID_ARGUMENT.withDescription("Invalid query").asRuntimeException()));
    Logger logger = Logger.getLogger(GrpcStreamIterator.class.getName());
    Level currentLevel = logger.getLevel();
    try (ResultSet rs =
        client
            .singleUse()
            .executeQuery(
                Statement.newBuilder("SELECT * FROM FOO WHERE ID=@id").bind("id").to(1L).build())) {
      logger.setLevel(Level.FINEST);
      SpannerException e = assertThrows(SpannerException.class, rs::next);
      // With log level set to FINEST the error should also include the parameter values.
      assertThat(e.getErrorCode()).isEqualTo(ErrorCode.INVALID_ARGUMENT);
      assertThat(e.getMessage()).contains("Statement: 'SELECT * FROM FOO WHERE ID=@id {id: 1}'");
    } finally {
      logger.setLevel(currentLevel);
    }
  }

  @Test
  public void testReadDoesNotIncludeStatement() {
    mockSpanner.setStreamingReadExecutionTime(
        SimulatedExecutionTime.ofException(
            Status.INVALID_ARGUMENT.withDescription("Invalid read").asRuntimeException()));
    DatabaseClient client =
        spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
    try (ResultSet rs =
        client.singleUse().read("FOO", KeySet.singleKey(Key.of(1L)), ImmutableList.of("BAR"))) {
      SpannerException e = assertThrows(SpannerException.class, rs::next);
      assertThat(e.getErrorCode()).isEqualTo(ErrorCode.INVALID_ARGUMENT);
      assertThat(e.getMessage()).doesNotContain("Statement:");
    }
  }

  @Test
  public void testSpecificTimeout() {
    mockSpanner.setExecuteStreamingSqlExecutionTime(
        SimulatedExecutionTime.ofMinimumAndRandomTime(10000, 0));
    final DatabaseClient client =
        spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
    Context.current()
        .withValue(
            SpannerOptions.CALL_CONTEXT_CONFIGURATOR_KEY,
            SpannerCallContextTimeoutConfigurator.create()
                .withExecuteQueryTimeoutDuration(Duration.ofNanos(1L)))
        .run(
            () -> {
              // Query should fail with a timeout.
              try (ResultSet rs = client.singleUse().executeQuery(SELECT1)) {
                SpannerException e = assertThrows(SpannerException.class, rs::next);
                assertThat(e.getErrorCode()).isEqualTo(ErrorCode.DEADLINE_EXCEEDED);
              }
              // Update should succeed.
              client
                  .readWriteTransaction()
                  .run(transaction -> transaction.executeUpdate(UPDATE_STATEMENT));
            });
  }

  @Test
  public void testBatchCreateSessionsFailure_shouldNotPropagateToCloseMethod() {
    assumeFalse(
        "BatchCreateSessions RPC is not invoked for multiplexed sessions",
        isMultiplexedSessionsEnabled());
    try {
      // Simulate session creation failures on the backend.
      mockSpanner.setBatchCreateSessionsExecutionTime(
          SimulatedExecutionTime.ofStickyException(
              Status.FAILED_PRECONDITION.asRuntimeException()));
      DatabaseClient client =
          spannerWithEmptySessionPool.getDatabaseClient(
              DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
      // This will not cause any failure as getting a session from the pool is guaranteed to be
      // non-blocking, and any exceptions will be delayed until actual query execution.
      try (ResultSet rs = client.singleUse().executeQuery(SELECT1)) {
        SpannerException e = assertThrows(SpannerException.class, rs::next);
        assertThat(e.getErrorCode()).isEqualTo(ErrorCode.FAILED_PRECONDITION);
      }
    } finally {
      mockSpanner.setBatchCreateSessionsExecutionTime(SimulatedExecutionTime.none());
    }
  }

  @Test
  public void testCreateSessionsFailure_shouldNotPropagateToCloseMethod() {
    assumeTrue(
        "CreateSessions is not invoked for regular sessions", isMultiplexedSessionsEnabled());
    try {
      // Simulate session creation failures on the backend.
      mockSpanner.setCreateSessionExecutionTime(
          SimulatedExecutionTime.ofStickyException(Status.PERMISSION_DENIED.asRuntimeException()));
      // This will not cause any failure as getting a session from the pool is guaranteed to be
      // non-blocking, and any exceptions will be delayed until actual query execution.
      mockSpanner.freeze();
      DatabaseClient client =
          spannerWithEmptySessionPool.getDatabaseClient(
              DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
      try (ResultSet rs = client.singleUse().executeQuery(SELECT1)) {
        mockSpanner.unfreeze();
        SpannerException exception = assertThrows(SpannerException.class, rs::next);
        assertEquals(ErrorCode.PERMISSION_DENIED, exception.getErrorCode());
      }
    } finally {
      mockSpanner.setCreateSessionExecutionTime(SimulatedExecutionTime.none());
    }
  }

  @Test
  public void testReadWriteTransaction_usesOptions() {
    SessionPool pool = mock(SessionPool.class);
    PooledSessionFuture session = mock(PooledSessionFuture.class);
    when(pool.getSession()).thenReturn(session);
    TransactionOption option = mock(TransactionOption.class);

    TraceWrapper traceWrapper =
        new TraceWrapper(Tracing.getTracer(), OpenTelemetry.noop().getTracer(""), false);

    DatabaseClientImpl client = new DatabaseClientImpl(pool, traceWrapper);
    client.readWriteTransaction(option);

    verify(session).readWriteTransaction(option);
  }

  @Test
  public void testTransactionManager_usesOptions() {
    SessionPool pool = mock(SessionPool.class);
    PooledSessionFuture session = mock(PooledSessionFuture.class);
    when(pool.getSession()).thenReturn(session);
    TransactionOption option = mock(TransactionOption.class);

    DatabaseClientImpl client = new DatabaseClientImpl(pool, mock(TraceWrapper.class));
    try (TransactionManager ignore = client.transactionManager(option)) {
      verify(session).transactionManager(option);
    }
  }

  @Test
  public void testRunAsync_usesOptions() {
    SessionPool pool = mock(SessionPool.class);
    PooledSessionFuture session = mock(PooledSessionFuture.class);
    when(pool.getSession()).thenReturn(session);
    TransactionOption option = mock(TransactionOption.class);

    DatabaseClientImpl client = new DatabaseClientImpl(pool, mock(TraceWrapper.class));
    client.runAsync(option);

    verify(session).runAsync(option);
  }

  @Test
  public void testTransactionManagerAsync_usesOptions() {
    SessionPool pool = mock(SessionPool.class);
    PooledSessionFuture session = mock(PooledSessionFuture.class);
    when(pool.getSession()).thenReturn(session);
    TransactionOption option = mock(TransactionOption.class);

    DatabaseClientImpl client = new DatabaseClientImpl(pool, mock(TraceWrapper.class));
    try (AsyncTransactionManager ignore = client.transactionManagerAsync(option)) {
      verify(session).transactionManagerAsync(option);
    }
  }

  @Test
  public void testExecuteQueryWithPriority() {
    DatabaseClient client =
        spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
    try (ResultSet resultSet =
        client.singleUse().executeQuery(SELECT1, Options.priority(RpcPriority.HIGH))) {
      //noinspection StatementWithEmptyBody
      while (resultSet.next()) {}
    }

    List<ExecuteSqlRequest> requests = mockSpanner.getRequestsOfType(ExecuteSqlRequest.class);
    assertThat(requests).hasSize(1);
    ExecuteSqlRequest request = requests.get(0);
    assertNotNull(request.getRequestOptions());
    assertEquals(Priority.PRIORITY_HIGH, request.getRequestOptions().getPriority());
  }

  @Test
  public void testExecuteReadWithPriority() {
    DatabaseClient client =
        spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
    try (ResultSet resultSet =
        client
            .singleUse()
            .read(
                READ_TABLE_NAME,
                KeySet.singleKey(Key.of(1L)),
                READ_COLUMN_NAMES,
                Options.priority(RpcPriority.HIGH))) {
      //noinspection StatementWithEmptyBody
      while (resultSet.next()) {}
    }

    List<ReadRequest> requests = mockSpanner.getRequestsOfType(ReadRequest.class);
    assertThat(requests).hasSize(1);
    ReadRequest request = requests.get(0);
    assertNotNull(request.getRequestOptions());
    assertEquals(Priority.PRIORITY_HIGH, request.getRequestOptions().getPriority());
  }

  @Test
  public void testReadWriteExecuteQueryWithPriority() {
    DatabaseClient client =
        spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
    TransactionRunner runner = client.readWriteTransaction();
    runner.run(
        transaction -> {
          try (ResultSet resultSet =
              transaction.executeQuery(SELECT1, Options.priority(RpcPriority.HIGH))) {
            //noinspection StatementWithEmptyBody
            while (resultSet.next()) {}
          }
          return null;
        });

    List<ExecuteSqlRequest> requests = mockSpanner.getRequestsOfType(ExecuteSqlRequest.class);
    assertThat(requests).hasSize(1);
    ExecuteSqlRequest request = requests.get(0);
    assertNotNull(request.getRequestOptions());
    assertEquals(Priority.PRIORITY_HIGH, request.getRequestOptions().getPriority());
  }

  @Test
  public void testReadWriteExecuteReadWithPriority() {
    DatabaseClient client =
        spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
    TransactionRunner runner = client.readWriteTransaction();
    runner.run(
        transaction -> {
          try (ResultSet resultSet =
              transaction.read(
                  READ_TABLE_NAME,
                  KeySet.singleKey(Key.of(1L)),
                  READ_COLUMN_NAMES,
                  Options.priority(RpcPriority.HIGH))) {
            //noinspection StatementWithEmptyBody
            while (resultSet.next()) {}
          }
          return null;
        });

    List<ReadRequest> requests = mockSpanner.getRequestsOfType(ReadRequest.class);
    assertThat(requests).hasSize(1);
    ReadRequest request = requests.get(0);
    assertNotNull(request.getRequestOptions());
    assertEquals(Priority.PRIORITY_HIGH, request.getRequestOptions().getPriority());
  }

  @Test
  public void testExecuteUpdateWithPriority() {
    DatabaseClient client =
        spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
    TransactionRunner runner = client.readWriteTransaction();
    runner.run(
        transaction ->
            transaction.executeUpdate(UPDATE_STATEMENT, Options.priority(RpcPriority.HIGH)));

    List<ExecuteSqlRequest> requests = mockSpanner.getRequestsOfType(ExecuteSqlRequest.class);
    assertThat(requests).hasSize(1);
    ExecuteSqlRequest request = requests.get(0);
    assertNotNull(request.getRequestOptions());
    assertEquals(Priority.PRIORITY_HIGH, request.getRequestOptions().getPriority());
  }

  @Test
  public void testBatchUpdateWithPriority() {
    DatabaseClient client =
        spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
    TransactionRunner runner = client.readWriteTransaction();
    runner.run(
        transaction ->
            transaction.batchUpdate(
                Collections.singletonList(UPDATE_STATEMENT), Options.priority(RpcPriority.HIGH)));

    List<ExecuteBatchDmlRequest> requests =
        mockSpanner.getRequestsOfType(ExecuteBatchDmlRequest.class);
    assertThat(requests).hasSize(1);
    ExecuteBatchDmlRequest request = requests.get(0);
    assertNotNull(request.getRequestOptions());
    assertEquals(Priority.PRIORITY_HIGH, request.getRequestOptions().getPriority());
  }

  @Test
  public void testPartitionedDMLWithPriority() {
    DatabaseClient client =
        spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
    client.executePartitionedUpdate(UPDATE_STATEMENT, Options.priority(RpcPriority.HIGH));

    List<ExecuteSqlRequest> requests = mockSpanner.getRequestsOfType(ExecuteSqlRequest.class);
    assertThat(requests).hasSize(1);
    ExecuteSqlRequest request = requests.get(0);
    assertNotNull(request.getRequestOptions());
    assertEquals(Priority.PRIORITY_HIGH, request.getRequestOptions().getPriority());
  }

  @Test
  public void testCommitWithPriority() {
    DatabaseClient client =
        spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
    MockSpannerTestActions.commitDeleteTransaction(client, Options.priority(RpcPriority.HIGH));

    List<CommitRequest> requests = mockSpanner.getRequestsOfType(CommitRequest.class);
    assertThat(requests).hasSize(1);
    CommitRequest request = requests.get(0);
    assertNotNull(request.getRequestOptions());
    assertEquals(Priority.PRIORITY_HIGH, request.getRequestOptions().getPriority());
  }

  @Test
  public void testTransactionManagerCommitWithPriority() {
    DatabaseClient client =
        spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
    MockSpannerTestActions.transactionManagerCommit(client, Options.priority(RpcPriority.HIGH));

    List<CommitRequest> requests = mockSpanner.getRequestsOfType(CommitRequest.class);
    assertThat(requests).hasSize(1);
    CommitRequest request = requests.get(0);
    assertNotNull(request.getRequestOptions());
    assertEquals(Priority.PRIORITY_HIGH, request.getRequestOptions().getPriority());
  }

  @Test
  public void testAsyncRunnerCommitWithPriority() {
    DatabaseClient client =
        spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
    MockSpannerTestActions.asyncRunnerCommit(client, executor, Options.priority(RpcPriority.HIGH));

    List<CommitRequest> requests = mockSpanner.getRequestsOfType(CommitRequest.class);
    assertThat(requests).hasSize(1);
    CommitRequest request = requests.get(0);
    assertNotNull(request.getRequestOptions());
    assertEquals(Priority.PRIORITY_HIGH, request.getRequestOptions().getPriority());
  }

  @Test
  public void testAsyncTransactionManagerCommitWithPriority() {
    DatabaseClient client =
        spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
    MockSpannerTestActions.transactionManagerAsyncCommit(
        client, executor, Options.priority(RpcPriority.HIGH));

    List<CommitRequest> requests = mockSpanner.getRequestsOfType(CommitRequest.class);
    assertThat(requests).hasSize(1);
    CommitRequest request = requests.get(0);
    assertNotNull(request.getRequestOptions());
    assertEquals(Priority.PRIORITY_HIGH, request.getRequestOptions().getPriority());
  }

  @Test
  public void testCommitWithoutMaxCommitDelay() {
    DatabaseClient client =
        spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
    MockSpannerTestActions.commitDeleteTransaction(client);

    List<CommitRequest> requests = mockSpanner.getRequestsOfType(CommitRequest.class);
    assertThat(requests).hasSize(1);
    CommitRequest request = requests.get(0);
    assertFalse(request.hasMaxCommitDelay());
  }

  @Test
  public void testCommitWithMaxCommitDelay() {
    DatabaseClient client =
        spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
    MockSpannerTestActions.commitDeleteTransaction(
        client, Options.maxCommitDelay(java.time.Duration.ofMillis(100)));

    List<CommitRequest> requests = mockSpanner.getRequestsOfType(CommitRequest.class);
    assertThat(requests).hasSize(1);
    CommitRequest request = requests.get(0);
    assertNotNull(request.getMaxCommitDelay());
    assertEquals(
        com.google.protobuf.Duration.newBuilder().setNanos(100000000).build(),
        request.getMaxCommitDelay());
  }

  @Test
  public void testTransactionManagerCommitWithMaxCommitDelay() {
    DatabaseClient client =
        spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
    MockSpannerTestActions.transactionManagerCommit(
        client, Options.maxCommitDelay(java.time.Duration.ofMillis(100)));

    List<CommitRequest> requests = mockSpanner.getRequestsOfType(CommitRequest.class);
    assertThat(requests).hasSize(1);
    CommitRequest request = requests.get(0);
    assertNotNull(request.getMaxCommitDelay());
    assertEquals(
        com.google.protobuf.Duration.newBuilder().setNanos(100000000).build(),
        request.getMaxCommitDelay());
  }

  @Test
  public void testAsyncRunnerCommitWithMaxCommitDelay() {
    DatabaseClient client =
        spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
    MockSpannerTestActions.asyncRunnerCommit(
        client, executor, Options.maxCommitDelay(java.time.Duration.ofMillis(100)));

    List<CommitRequest> requests = mockSpanner.getRequestsOfType(CommitRequest.class);
    assertThat(requests).hasSize(1);
    CommitRequest request = requests.get(0);
    assertNotNull(request.getMaxCommitDelay());
    assertEquals(
        com.google.protobuf.Duration.newBuilder().setNanos(100000000).build(),
        request.getMaxCommitDelay());
  }

  @Test
  public void testAsyncTransactionManagerCommitWithMaxCommitDelay() {
    DatabaseClient client =
        spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
    MockSpannerTestActions.transactionManagerAsyncCommit(
        client, executor, Options.maxCommitDelay(java.time.Duration.ofMillis(100)));

    List<CommitRequest> requests = mockSpanner.getRequestsOfType(CommitRequest.class);
    assertThat(requests).hasSize(1);
    CommitRequest request = requests.get(0);
    assertNotNull(request.getMaxCommitDelay());
    assertEquals(
        com.google.protobuf.Duration.newBuilder().setNanos(100000000).build(),
        request.getMaxCommitDelay());
  }

  @Test
  public void singleUseNoAction_ClearsCheckedOutSession() {
    DatabaseClientImpl client =
        (DatabaseClientImpl)
            spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
    Set<PooledSessionFuture> checkedOut = client.pool.checkedOutSessions;
    assertThat(checkedOut).isEmpty();

    // Getting a single use read-only transaction and not using it should not cause any sessions
    // to be stuck in the map of checked out sessions.
    client.singleUse().close();

    assertThat(checkedOut).isEmpty();
  }

  @Test
  public void singleUseReadOnlyTransactionNoAction_ClearsCheckedOutSession() {
    DatabaseClientImpl client =
        (DatabaseClientImpl)
            spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
    Set<PooledSessionFuture> checkedOut = client.pool.checkedOutSessions;
    assertThat(checkedOut).isEmpty();

    client.singleUseReadOnlyTransaction().close();

    assertThat(checkedOut).isEmpty();
  }

  @Test
  public void readWriteTransactionNoAction_ClearsCheckedOutSession() {
    DatabaseClientImpl client =
        (DatabaseClientImpl)
            spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
    Set<PooledSessionFuture> checkedOut = client.pool.checkedOutSessions;
    assertThat(checkedOut).isEmpty();

    client.readWriteTransaction();

    assertThat(checkedOut).isEmpty();
  }

  @Test
  public void readOnlyTransactionNoAction_ClearsCheckedOutSession() {
    DatabaseClientImpl client =
        (DatabaseClientImpl)
            spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
    Set<PooledSessionFuture> checkedOut = client.pool.checkedOutSessions;
    assertThat(checkedOut).isEmpty();

    client.readOnlyTransaction().close();

    assertThat(checkedOut).isEmpty();
  }

  @Test
  public void transactionManagerNoAction_ClearsCheckedOutSession() {
    DatabaseClientImpl client =
        (DatabaseClientImpl)
            spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
    Set<PooledSessionFuture> checkedOut = client.pool.checkedOutSessions;
    assertThat(checkedOut).isEmpty();

    client.transactionManager().close();

    assertThat(checkedOut).isEmpty();
  }

  @Test
  public void transactionContextFailsIfUsedMultipleTimes() {
    DatabaseClient client =
        spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));

    Function<TransactionContext, Long> function =
        new Function<TransactionContext, Long>() {
          TransactionContext ctx;

          @Override
          public Long apply(TransactionContext transactionContext) {
            if (ctx == null) {
              ctx = transactionContext;
            }
            try (ResultSet rs = ctx.executeQuery(SELECT1)) {
              //noinspection StatementWithEmptyBody
              while (rs.next()) {}
            }
            return 1L;
          }
        };
    assertEquals(Long.valueOf(1L), client.readWriteTransaction().run(function::apply));
    SpannerException exception =
        assertThrows(
            SpannerException.class, () -> client.readWriteTransaction().run(function::apply));
    assertTrue(exception.getMessage().contains("Context has been closed"));
  }

  @Test
  public void testGetDialectDefault() {
    DatabaseClient client =
        spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
    assertEquals(Dialect.GOOGLE_STANDARD_SQL, client.getDialect());
  }

  @Test
  public void testGetDialectDefaultPreloaded() {
    try (Spanner spanner =
        this.spanner.getOptions().toBuilder()
            .setSessionPoolOption(
                SessionPoolOptions.newBuilder().setAutoDetectDialect(true).build())
            .build()
            .getService()) {
      DatabaseClient client =
          spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
      assertEquals(Dialect.GOOGLE_STANDARD_SQL, client.getDialect());
    }
  }

  @Test
  public void testGetDialectPostgreSQL() {
    mockSpanner.putStatementResult(StatementResult.detectDialectResult(Dialect.POSTGRESQL));
    try {
      DatabaseClient client =
          spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
      assertEquals(Dialect.POSTGRESQL, client.getDialect());
    } finally {
      mockSpanner.putStatementResult(
          StatementResult.detectDialectResult(Dialect.GOOGLE_STANDARD_SQL));
    }
  }

  @Test
  public void testGetDialectPostgreSQLPreloaded() {
    mockSpanner.putStatementResult(StatementResult.detectDialectResult(Dialect.POSTGRESQL));
    try (Spanner spanner =
        this.spanner.getOptions().toBuilder()
            .setSessionPoolOption(
                SessionPoolOptions.newBuilder().setAutoDetectDialect(true).build())
            .build()
            .getService()) {
      DatabaseClient client =
          spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
      assertEquals(Dialect.POSTGRESQL, client.getDialect());
    } finally {
      mockSpanner.putStatementResult(
          StatementResult.detectDialectResult(Dialect.GOOGLE_STANDARD_SQL));
    }
  }

  @Test
  public void testGetDialect_FailsDirectlyIfDatabaseNotFound() {
    mockSpanner.setBatchCreateSessionsExecutionTime(
        SimulatedExecutionTime.stickyDatabaseNotFoundException("invalid-database"));
    mockSpanner.setCreateSessionExecutionTime(
        SimulatedExecutionTime.stickyDatabaseNotFoundException("invalid-database"));
    DatabaseClient client =
        spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));

    SpannerException exception = assertThrows(SpannerException.class, client::getDialect);
    assertEquals(ErrorCode.NOT_FOUND, exception.getErrorCode());
    assertTrue(
        exception
            .getMessage()
            .contains(
                "NOT_FOUND: Database not found: Database with id invalid-database not found"));
  }

  @Test
  public void testGetDialectDefaultPreloaded_FailsDirectlyIfDatabaseNotFound() {
    mockSpanner.setBatchCreateSessionsExecutionTime(
        SimulatedExecutionTime.stickyDatabaseNotFoundException("invalid-database"));
    mockSpanner.setCreateSessionExecutionTime(
        SimulatedExecutionTime.stickyDatabaseNotFoundException("invalid-database"));
    try (Spanner spanner =
        this.spanner.getOptions().toBuilder()
            .setSessionPoolOption(
                SessionPoolOptions.newBuilder().setAutoDetectDialect(true).build())
            .build()
            .getService()) {
      DatabaseClient client =
          spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
      SpannerException exception = assertThrows(SpannerException.class, client::getDialect);
      assertEquals(ErrorCode.NOT_FOUND, exception.getErrorCode());
      assertTrue(
          exception
              .getMessage()
              .contains(
                  "NOT_FOUND: Database not found: Database with id invalid-database not found"));
    }
  }

  @Test
  public void testUntypedNullParameters() {
    Statement statement =
        Statement.newBuilder("INSERT INTO FOO (BAR) VALUES (@p)")
            .bind("p")
            .to((Value) null)
            .build();
    mockSpanner.putStatementResult(StatementResult.update(statement, 1L));

    DatabaseClient client =
        spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
    Long updateCount =
        client.readWriteTransaction().run(transaction -> transaction.executeUpdate(statement));

    assertNotNull(updateCount);
    assertEquals(1L, updateCount.longValue());
  }

  @Test
  public void testGetDatabaseRole() {
    DatabaseClient client =
        spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
    assertEquals(TEST_DATABASE_ROLE, client.getDatabaseRole());
  }

  @Test
  public void testAnalyzeUpdateStatement() {
    String sql = "update foo set bar=1 where baz=@param";
    mockSpanner.putStatementResult(
        StatementResult.query(
            Statement.of(sql),
            com.google.spanner.v1.ResultSet.newBuilder()
                .setMetadata(
                    ResultSetMetadata.newBuilder()
                        .setUndeclaredParameters(
                            StructType.newBuilder()
                                .addFields(
                                    Field.newBuilder()
                                        .setName("param")
                                        .setType(Type.newBuilder().setCode(TypeCode.STRING).build())
                                        .build())
                                .build())
                        .build())
                .setStats(ResultSetStats.newBuilder().setRowCountExact(0L).build())
                .build()));
    DatabaseClient client =
        spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
    client
        .readWriteTransaction()
        .run(
            transaction -> {
              try (ResultSet resultSet =
                  transaction.analyzeUpdateStatement(Statement.of(sql), QueryAnalyzeMode.PLAN)) {
                assertFalse(resultSet.next());
                assertNotNull(resultSet.getStats());
                assertEquals(0L, resultSet.getStats().getRowCountExact());
                assertNotNull(resultSet.getMetadata());
                assertEquals(1, resultSet.getMetadata().getUndeclaredParameters().getFieldsCount());
                assertEquals(
                    "param",
                    resultSet.getMetadata().getUndeclaredParameters().getFields(0).getName());
                assertEquals(
                    Type.newBuilder().setCode(TypeCode.STRING).build(),
                    resultSet.getMetadata().getUndeclaredParameters().getFields(0).getType());
              }
              return null;
            });
    assertEquals(1, mockSpanner.countRequestsOfType(ExecuteSqlRequest.class));
    ExecuteSqlRequest request = mockSpanner.getRequestsOfType(ExecuteSqlRequest.class).get(0);
    assertEquals(QueryMode.PLAN, request.getQueryMode());
  }

  @Test
  public void testByteArray() {
    Random random = new Random();
    byte[] bytes = new byte[random.nextInt(200)];
    int numRows = 5;
    List<ListValue> rows = new ArrayList<>(numRows);
    for (int i = 0; i < numRows; i++) {
      random.nextBytes(bytes);
      rows.add(
          ListValue.newBuilder()
              .addValues(
                  com.google.protobuf.Value.newBuilder()
                      .setStringValue(
                          // Use both the Guava and the JDK encoder to encode the values to ensure
                          // that encoding/decoding using both of them works.
                          i % 2 == 0
                              ? Base64.getEncoder().encodeToString(bytes)
                              : BaseEncoding.base64().encode(bytes))
                      .build())
              .build());
    }
    Statement statement = Statement.of("select * from foo");
    mockSpanner.putStatementResult(
        StatementResult.query(
            statement,
            com.google.spanner.v1.ResultSet.newBuilder()
                .setMetadata(
                    ResultSetMetadata.newBuilder()
                        .setRowType(
                            StructType.newBuilder()
                                .addFields(
                                    Field.newBuilder()
                                        .setType(Type.newBuilder().setCode(TypeCode.BYTES).build())
                                        .setName("f1")
                                        .build())
                                .build())
                        .build())
                .addAllRows(rows)
                .build()));
    DatabaseClient client =
        spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
    try (ResultSet resultSet = client.singleUse().executeQuery(statement)) {
      while (resultSet.next()) {
        String base64String = resultSet.getValue(0).getAsString();
        ByteArray byteArray = resultSet.getBytes(0);
        // Use the 'old' ByteArray.fromBase64(..) method that uses the Guava encoder to ensure that
        // the two encoders (JDK and Guava) return the same values.
        assertEquals(ByteArray.fromBase64(base64String), byteArray);
      }
    }
  }

  @Test
  public void testGetAllTypesAsString() {
    SingerInfo info = SingerInfo.newBuilder().setSingerId(1).build();
    for (Dialect dialect : Dialect.values()) {
      Statement statement = Statement.of("select * from all_types");
      mockSpanner.putStatementResult(
          StatementResult.query(
              statement,
              com.google.spanner.v1.ResultSet.newBuilder()
                  .setMetadata(
                      RandomResultSetGenerator.generateAllTypesMetadata(
                          RandomResultSetGenerator.generateAllTypes(dialect)))
                  .addRows(getRows(dialect))
                  .build()));

      DatabaseClient client =
          spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
      try (ResultSet resultSet = client.singleUse().executeQuery(statement)) {
        assertTrue(resultSet.next());
        int col = 0;
        assertAsString("true", resultSet, col++);
        assertAsString("100", resultSet, col++);
        assertAsString("-3.14", resultSet, col++);
        assertAsString("3.14", resultSet, col++);
        assertAsString("6.626", resultSet, col++);
        assertAsString("test-string", resultSet, col++);
        assertAsString("{\"key1\": \"value1\"}", resultSet, col++);
        assertAsString(
            Base64.getEncoder().encodeToString("test-bytes".getBytes(StandardCharsets.UTF_8)),
            resultSet,
            col++);
        assertAsString("2023-01-11", resultSet, col++);
        assertAsString("b1153a48-cd31-498e-b770-f554bce48e05", resultSet, col++);
        assertAsString("2023-01-11T11:55:18.123456789Z", resultSet, col++);
        if (dialect == Dialect.POSTGRESQL) {
          // Check PG_OID value
          assertAsString("100", resultSet, col++);
        }
        assertAsString(ImmutableList.of("true", "NULL", "false"), resultSet, col++);
        assertAsString(
            ImmutableList.of(
                String.format("%d", Long.MAX_VALUE), String.format("%d", Long.MIN_VALUE), "NULL"),
            resultSet,
            col++);
        assertAsString(
            ImmutableList.of(
                "NULL",
                Float.valueOf(Float.MAX_VALUE).toString(),
                Float.valueOf(Float.MIN_VALUE).toString(),
                "NaN",
                "3.14"),
            resultSet,
            col++);
        assertAsString(ImmutableList.of("NULL", "-12345.6789", "3.14"), resultSet, col++);
        assertAsString(ImmutableList.of("6.626", "NULL", "-8.9123"), resultSet, col++);
        assertAsString(ImmutableList.of("test-string1", "NULL", "test-string2"), resultSet, col++);
        assertAsString(
            ImmutableList.of("{\"key\": \"value1\"}", "{\"key\": \"value2\"}", "NULL"),
            resultSet,
            col++);
        assertAsString(
            ImmutableList.of(
                String.format(
                    "%s",
                    Base64.getEncoder()
                        .encodeToString("test-bytes1".getBytes(StandardCharsets.UTF_8))),
                String.format(
                    "%s",
                    Base64.getEncoder()
                        .encodeToString("test-bytes2".getBytes(StandardCharsets.UTF_8))),
                "NULL"),
            resultSet,
            col++);
        assertAsString(ImmutableList.of("2000-02-29", "NULL", "2000-01-01"), resultSet, col++);
        assertAsString(
            ImmutableList.of(
                "b1153a48-cd31-498e-b770-f554bce48e05",
                "NULL",
                "11546309-8b37-4366-9a20-369381c7803a"),
            resultSet,
            col++);
        assertAsString(
            ImmutableList.of("2023-01-11T11:55:18.123456789Z", "NULL", "2023-01-12T11:55:18Z"),
            resultSet,
            col++);
        if (dialect == Dialect.GOOGLE_STANDARD_SQL) {
          assertAsString(Base64.getEncoder().encodeToString(info.toByteArray()), resultSet, col++);
          assertAsString(String.valueOf(Genre.JAZZ_VALUE), resultSet, col++);
          assertAsString(
              ImmutableList.of(
                  String.format("%s", Base64.getEncoder().encodeToString(info.toByteArray())),
                  "NULL"),
              resultSet,
              col++);
          assertAsString(
              ImmutableList.of(String.format("%d", Genre.JAZZ_VALUE), "NULL"), resultSet, col++);
        }
        if (dialect == Dialect.POSTGRESQL) {
          // Check ARRAY<PG_OID> value
          assertAsString(
              ImmutableList.of(
                  String.format("%d", Long.MAX_VALUE), String.format("%d", Long.MIN_VALUE), "NULL"),
              resultSet,
              col++);
        }
        assertFalse(resultSet.next());
      }
    }
  }

  @Test
  public void testSelectUnknownType() {
    mockSpanner.putStatementResult(
        StatementResult.query(
            Statement.of("SELECT * FROM foo"),
            com.google.spanner.v1.ResultSet.newBuilder()
                .setMetadata(
                    ResultSetMetadata.newBuilder()
                        .setRowType(
                            StructType.newBuilder()
                                .addFields(
                                    Field.newBuilder()
                                        .setName("c")
                                        .setType(
                                            Type.newBuilder()
                                                .setCodeValue(Integer.MAX_VALUE)
                                                .build())
                                        .build())
                                .build())
                        .build())
                .addRows(
                    ListValue.newBuilder()
                        .addValues(
                            com.google.protobuf.Value.newBuilder().setStringValue("bar").build())
                        .build())
                .addRows(
                    ListValue.newBuilder()
                        .addValues(
                            com.google.protobuf.Value.newBuilder().setBoolValue(true).build())
                        .build())
                .addRows(
                    ListValue.newBuilder()
                        .addValues(
                            com.google.protobuf.Value.newBuilder().setNumberValue(3.14d).build())
                        .build())
                .addRows(
                    ListValue.newBuilder()
                        .addValues(
                            com.google.protobuf.Value.newBuilder()
                                .setNullValue(NullValue.NULL_VALUE)
                                .build())
                        .build())
                .addRows(
                    ListValue.newBuilder()
                        .addValues(
                            com.google.protobuf.Value.newBuilder()
                                .setListValue(
                                    ListValue.newBuilder()
                                        .addValues(
                                            com.google.protobuf.Value.newBuilder()
                                                .setStringValue("baz")
                                                .build())
                                        .addValues(
                                            com.google.protobuf.Value.newBuilder()
                                                .setBoolValue(false)
                                                .build())
                                        .addValues(
                                            com.google.protobuf.Value.newBuilder()
                                                .setNumberValue(6.626)
                                                .build())
                                        .addValues(
                                            com.google.protobuf.Value.newBuilder()
                                                .setNullValue(NullValue.NULL_VALUE)
                                                .build())
                                        .build())
                                .build())
                        .build())
                .build()));
    DatabaseClient client =
        spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
    try (ResultSet resultSet = client.singleUse().executeQuery(Statement.of("SELECT * FROM foo"))) {
      assertTrue(resultSet.next());
      assertAsString("bar", resultSet, 0);

      assertTrue(resultSet.next());
      assertAsString("true", resultSet, 0);

      assertTrue(resultSet.next());
      assertAsString("3.14", resultSet, 0);

      assertTrue(resultSet.next());
      assertAsString("NULL", resultSet, 0);

      assertTrue(resultSet.next());
      assertAsString(ImmutableList.of("baz", "false", "6.626", "NULL"), resultSet, 0);

      assertFalse(resultSet.next());
    }
  }

  @Test
  public void testMetadataUnknownTypes() {
    mockSpanner.putStatementResult(
        StatementResult.query(
            Statement.of("SELECT * FROM foo"),
            com.google.spanner.v1.ResultSet.newBuilder()
                .setMetadata(
                    ResultSetMetadata.newBuilder()
                        .setRowType(
                            StructType.newBuilder()
                                .addFields(
                                    Field.newBuilder()
                                        .setName("c1")
                                        .setType(
                                            Type.newBuilder()
                                                .setCodeValue(Integer.MAX_VALUE)
                                                .build())
                                        .build())
                                .addFields(
                                    Field.newBuilder()
                                        .setName("c2")
                                        .setType(
                                            Type.newBuilder()
                                                .setCode(TypeCode.STRING)
                                                .setTypeAnnotationValue(Integer.MAX_VALUE)
                                                .build())
                                        .build())
                                .addFields(
                                    Field.newBuilder()
                                        .setName("c3")
                                        .setType(
                                            Type.newBuilder()
                                                .setCodeValue(Integer.MAX_VALUE)
                                                .setTypeAnnotation(TypeAnnotationCode.PG_NUMERIC)
                                                .build())
                                        .build())
                                .addFields(
                                    Field.newBuilder()
                                        .setName("c4")
                                        .setType(
                                            Type.newBuilder()
                                                .setCode(TypeCode.ARRAY)
                                                .setArrayElementType(
                                                    Type.newBuilder()
                                                        .setCodeValue(Integer.MAX_VALUE)
                                                        .build())
                                                .build())
                                        .build())
                                .addFields(
                                    Field.newBuilder()
                                        .setName("c5")
                                        .setType(
                                            Type.newBuilder()
                                                .setCode(TypeCode.ARRAY)
                                                .setArrayElementType(
                                                    Type.newBuilder()
                                                        .setCode(TypeCode.STRING)
                                                        .setTypeAnnotationValue(Integer.MAX_VALUE)
                                                        .build())
                                                .build())
                                        .build())
                                .addFields(
                                    Field.newBuilder()
                                        .setName("c6")
                                        .setType(
                                            Type.newBuilder()
                                                // Set an unrecognized type with an array element
                                                // type. The client should recognize this as an
                                                // array.
                                                .setCodeValue(Integer.MAX_VALUE)
                                                .setArrayElementType(
                                                    Type.newBuilder()
                                                        .setCodeValue(Integer.MAX_VALUE)
                                                        .build())
                                                .build())
                                        .build())
                                .addFields(
                                    Field.newBuilder()
                                        .setName("c7")
                                        .setType(
                                            Type.newBuilder()
                                                .setCode(TypeCode.ARRAY)
                                                .setArrayElementType(
                                                    Type.newBuilder()
                                                        .setCodeValue(Integer.MAX_VALUE)
                                                        .setTypeAnnotation(
                                                            TypeAnnotationCode.PG_NUMERIC)
                                                        .build())
                                                .build())
                                        .build())
                                .build())
                        .build())
                .build()));
    DatabaseClient client =
        spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
    try (ResultSet resultSet = client.singleUse().executeQuery(Statement.of("SELECT * FROM foo"))) {
      // There are no rows, but we need to call resultSet.next() before we can get the metadata.
      assertFalse(resultSet.next());
      assertEquals(
          "STRUCT<c1 UNRECOGNIZED, c2 STRING<UNRECOGNIZED>, c3 UNRECOGNIZED<PG_NUMERIC>, c4"
              + " ARRAY<UNRECOGNIZED>, c5 ARRAY<STRING<UNRECOGNIZED>>, c6"
              + " UNRECOGNIZED<UNRECOGNIZED>, c7 ARRAY<UNRECOGNIZED<PG_NUMERIC>>>",
          resultSet.getType().toString());
      assertEquals(
          "UNRECOGNIZED", resultSet.getType().getStructFields().get(0).getType().toString());
      assertEquals(
          "STRING<UNRECOGNIZED>",
          resultSet.getType().getStructFields().get(1).getType().toString());
      assertEquals(
          "UNRECOGNIZED<PG_NUMERIC>",
          resultSet.getType().getStructFields().get(2).getType().toString());
      assertEquals(
          "ARRAY<UNRECOGNIZED>", resultSet.getType().getStructFields().get(3).getType().toString());
      assertEquals(Code.ARRAY, resultSet.getType().getStructFields().get(3).getType().getCode());
      assertEquals(
          Code.UNRECOGNIZED,
          resultSet.getType().getStructFields().get(3).getType().getArrayElementType().getCode());
      assertEquals(
          "ARRAY<STRING<UNRECOGNIZED>>",
          resultSet.getType().getStructFields().get(4).getType().toString());
      assertEquals(Code.ARRAY, resultSet.getType().getStructFields().get(4).getType().getCode());
      assertEquals(
          Code.UNRECOGNIZED,
          resultSet.getType().getStructFields().get(4).getType().getArrayElementType().getCode());
      assertEquals(
          "UNRECOGNIZED<UNRECOGNIZED>",
          resultSet.getType().getStructFields().get(5).getType().toString());
      assertEquals(
          Code.UNRECOGNIZED, resultSet.getType().getStructFields().get(5).getType().getCode());
      assertEquals(
          Code.UNRECOGNIZED,
          resultSet.getType().getStructFields().get(5).getType().getArrayElementType().getCode());
      assertEquals(
          "ARRAY<UNRECOGNIZED<PG_NUMERIC>>",
          resultSet.getType().getStructFields().get(6).getType().toString());
      assertEquals(Code.ARRAY, resultSet.getType().getStructFields().get(6).getType().getCode());
      assertEquals(
          Code.UNRECOGNIZED,
          resultSet.getType().getStructFields().get(6).getType().getArrayElementType().getCode());
    }
  }

  @Test
  public void testStatementWithUnnamedParameters() {
    DatabaseClient client =
        spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));

    Statement statement =
        client.getStatementFactory().withUnnamedParameters("select id from test where b=?", true);
    Statement generatedStatement =
        Statement.newBuilder("select id from test where b=@p1").bind("p1").to(true).build();
    mockSpanner.putStatementResult(StatementResult.query(generatedStatement, SELECT1_RESULTSET));

    try (ResultSet resultSet = client.singleUse().executeQuery(statement)) {
      assertTrue(resultSet.next());
      assertEquals(1L, resultSet.getLong(0));
      assertFalse(resultSet.next());
    }
  }

  @Test
  public void testStatementWithUnnamedParametersAndSingleLineComment() {
    DatabaseClient client =
        spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));

    Statement statement =
        client
            .getStatementFactory()
            .withUnnamedParameters(
                "-- comment about ? in the statement\nselect id from test where b=?", true);
    Statement generatedStatement =
        Statement.newBuilder("-- comment about ? in the statement\nselect id from test where b=@p1")
            .bind("p1")
            .to(true)
            .build();
    mockSpanner.putStatementResult(StatementResult.query(generatedStatement, SELECT1_RESULTSET));

    try (ResultSet resultSet = client.singleUse().executeQuery(statement)) {
      assertTrue(resultSet.next());
      assertEquals(1L, resultSet.getLong(0));
      assertFalse(resultSet.next());
    }
  }

  @Test
  public void testStatementWithUnnamedParametersAndSingleLineCommentWithHash() {
    DatabaseClient client =
        spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));

    Statement statement =
        client
            .getStatementFactory()
            .withUnnamedParameters(
                "# comment about ? in the statement\nselect id from test where b=?", true);
    Statement generatedStatement =
        Statement.newBuilder("# comment about ? in the statement\nselect id from test where b=@p1")
            .bind("p1")
            .to(true)
            .build();
    mockSpanner.putStatementResult(StatementResult.query(generatedStatement, SELECT1_RESULTSET));

    try (ResultSet resultSet = client.singleUse().executeQuery(statement)) {
      assertTrue(resultSet.next());
      assertEquals(1L, resultSet.getLong(0));
      assertFalse(resultSet.next());
    }
  }

  @Test
  public void testStatementWithUnnamedParametersAndMultiLineComment() {
    DatabaseClient client =
        spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));

    Statement statement =
        client
            .getStatementFactory()
            .withUnnamedParameters(
                "# comment about ? in the statement\n"
                    + "select id from test\n"
                    + " /* This is a ? comment \n"
                    + " about ? */ \n"
                    + " where b=? # this is a inline command about ?",
                true);
    Statement generatedStatement =
        Statement.newBuilder(
                "# comment about ? in the statement\n"
                    + "select id from test\n"
                    + " /* This is a ? comment \n"
                    + " about ? */ \n"
                    + " where b=@p1 # this is a inline command about ?")
            .bind("p1")
            .to(true)
            .build();
    mockSpanner.putStatementResult(StatementResult.query(generatedStatement, SELECT1_RESULTSET));

    try (ResultSet resultSet = client.singleUse().executeQuery(statement)) {
      assertTrue(resultSet.next());
      assertEquals(1L, resultSet.getLong(0));
      assertFalse(resultSet.next());
    }
  }

  @Test
  public void testStatementWithUnnamedParametersAndStringLiteralWithQuestionMark() {
    DatabaseClient client =
        spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));

    Statement statement =
        client
            .getStatementFactory()
            .withUnnamedParameters("select id from test where name = \"abc?\" AND b=?", true);
    Statement generatedStatement =
        Statement.newBuilder("select id from test where name = \"abc?\" AND b=@p1")
            .bind("p1")
            .to(true)
            .build();
    mockSpanner.putStatementResult(StatementResult.query(generatedStatement, SELECT1_RESULTSET));

    try (ResultSet resultSet = client.singleUse().executeQuery(statement)) {
      assertTrue(resultSet.next());
      assertEquals(1L, resultSet.getLong(0));
      assertFalse(resultSet.next());
    }
  }

  @Test
  public void testStatementWithUnnamedParametersAndHint() {
    DatabaseClient client =
        spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));

    Statement statement =
        client
            .getStatementFactory()
            .withUnnamedParameters("@{FORCE_INDEX=ABCDEF} select id from test where b=?", true);
    Statement generatedStatement =
        Statement.newBuilder("@{FORCE_INDEX=ABCDEF} select id from test where b=@p1")
            .bind("p1")
            .to(true)
            .build();
    mockSpanner.putStatementResult(StatementResult.query(generatedStatement, SELECT1_RESULTSET));

    try (ResultSet resultSet = client.singleUse().executeQuery(statement)) {
      assertTrue(resultSet.next());
      assertEquals(1L, resultSet.getLong(0));
      assertFalse(resultSet.next());
    }
  }

  @Test
  public void testStatementWithBytesArrayParameter() {
    Statement statement =
        Statement.newBuilder("select id from test where b=@p1")
            .bind("p1")
            .toBytesArray(
                Arrays.asList(ByteArray.copyFrom("test1"), null, ByteArray.copyFrom("test2")))
            .build();
    mockSpanner.putStatementResult(StatementResult.query(statement, SELECT1_RESULTSET));
    DatabaseClient client =
        spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
    try (ResultSet resultSet = client.singleUse().executeQuery(statement)) {
      assertTrue(resultSet.next());
      assertEquals(1L, resultSet.getLong(0));
      assertFalse(resultSet.next());
    }
  }

  @Test
  public void testStreamWaitTimeout() {
    DatabaseClient client =
        spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
    // Add a wait time to the mock server. Note that the test won't actually wait 100ms, as it uses
    // a 1ns time out.
    mockSpanner.setExecuteStreamingSqlExecutionTime(
        SimulatedExecutionTime.ofMinimumAndRandomTime(100, 0));
    // Create a custom call configuration that uses a 1 nanosecond stream timeout value. This will
    // always time out, as a call to the mock server will always take more than 1 nanosecond.
    CallContextConfigurator configurator =
        new CallContextConfigurator() {
          @Override
          public <ReqT, RespT> ApiCallContext configure(
              ApiCallContext context, ReqT request, MethodDescriptor<ReqT, RespT> method) {
            return context.withStreamWaitTimeoutDuration(Duration.ofNanos(1L));
          }
        };
    Context context =
        Context.current().withValue(SpannerOptions.CALL_CONTEXT_CONFIGURATOR_KEY, configurator);
    context.run(
        () -> {
          try (ResultSet resultSet = client.singleUse().executeQuery(SELECT1)) {
            SpannerException exception = assertThrows(SpannerException.class, resultSet::next);
            assertEquals(ErrorCode.DEADLINE_EXCEEDED, exception.getErrorCode());
            assertTrue(
                exception.getMessage(), exception.getMessage().contains("stream wait timeout"));
          }
        });
  }

  @Test
  public void testZeroStreamWaitTimeout() {
    DatabaseClient client =
        spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
    // Create a custom call configuration that sets the stream timeout to zero.
    // This should disable the timeout.
    CallContextConfigurator configurator =
        new CallContextConfigurator() {
          @Override
          public <ReqT, RespT> ApiCallContext configure(
              ApiCallContext context, ReqT request, MethodDescriptor<ReqT, RespT> method) {
            return context.withStreamWaitTimeoutDuration(Duration.ZERO);
          }
        };
    Context context =
        Context.current().withValue(SpannerOptions.CALL_CONTEXT_CONFIGURATOR_KEY, configurator);
    context.run(
        () -> {
          try (ResultSet resultSet = client.singleUse().executeQuery(SELECT1)) {
            // A zero timeout should not cause a timeout, and instead be ignored.
            assertTrue(resultSet.next());
            assertFalse(resultSet.next());
          }
        });
  }

  @Test
  public void testRetryOnResourceExhausted() {
    final RetrySettings retrySettings =
        RetrySettings.newBuilder()
            .setInitialRpcTimeoutDuration(Duration.ofSeconds(60L))
            .setMaxRpcTimeoutDuration(Duration.ofSeconds(60L))
            .setTotalTimeoutDuration(Duration.ofSeconds(60L))
            .setRpcTimeoutMultiplier(1.0d)
            .setInitialRetryDelayDuration(Duration.ZERO)
            .setMaxRetryDelayDuration(Duration.ZERO)
            .setMaxAttempts(100)
            .build();
    SpannerOptions.Builder builder =
        SpannerOptions.newBuilder()
            .setProjectId(TEST_PROJECT)
            .setChannelProvider(channelProvider)
            .setCredentials(NoCredentials.getInstance());
    RetryInfo retryInfo =
        RetryInfo.newBuilder()
            .setRetryDelay(
                com.google.protobuf.Duration.newBuilder()
                    .setNanos((int) Duration.ofMillis(1).toNanos())
                    .build())
            .build();
    Metadata.Key<RetryInfo> key =
        Metadata.Key.of(
            retryInfo.getDescriptorForType().getFullName() + Metadata.BINARY_HEADER_SUFFIX,
            ProtoLiteUtils.metadataMarshaller(retryInfo));
    Metadata trailers = new Metadata();
    trailers.put(key, retryInfo);
    builder
        .getSpannerStubSettingsBuilder()
        .executeStreamingSqlSettings()
        .setRetryableCodes(StatusCode.Code.UNAVAILABLE, StatusCode.Code.RESOURCE_EXHAUSTED)
        .setRetrySettings(retrySettings);

    try (Spanner spanner = builder.build().getService()) {
      DatabaseClient client =
          spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
      final int expectedRowCount = 5;
      RandomResultSetGenerator generator = new RandomResultSetGenerator(expectedRowCount);
      Statement statement = Statement.of("select * from random_table");
      mockSpanner.putStatementResult(StatementResult.query(statement, generator.generate()));

      for (int errorIndex = 0; errorIndex < expectedRowCount - 1; errorIndex++) {
        for (boolean withRetryInfo : new boolean[] {false, true}) {
          // RESOURCE_EXHAUSTED errors with and without retry-info should be retried.
          StatusRuntimeException exception =
              Status.RESOURCE_EXHAUSTED.asRuntimeException(withRetryInfo ? trailers : null);
          mockSpanner.setExecuteStreamingSqlExecutionTime(
              SimulatedExecutionTime.ofStreamException(exception, errorIndex));
          try (ResultSet resultSet = client.singleUse().executeQuery(statement)) {
            //noinspection StatementWithEmptyBody
            while (resultSet.next()) {}
          }
          assertEquals(2, mockSpanner.countRequestsOfType(ExecuteSqlRequest.class));
          if (errorIndex == 0) {
            // We should only have two requests without a resume token, as the error occurred before
            // any resume token could be returned.
            assertEquals(
                2,
                mockSpanner.getRequestsOfType(ExecuteSqlRequest.class).stream()
                    .filter(request -> request.getResumeToken().isEmpty())
                    .count());
          } else {
            final int expectedResumeToken = errorIndex;
            // Check that we have one request with a resume token that corresponds with the place in
            // the stream where the error happened.
            assertEquals(
                1,
                mockSpanner.getRequestsOfType(ExecuteSqlRequest.class).stream()
                    .filter(
                        request ->
                            request
                                .getResumeToken()
                                .equals(
                                    ByteString.copyFromUtf8(
                                        String.format("%09d", expectedResumeToken))))
                    .count());
          }
          mockSpanner.clearRequests();
        }
      }
    }
  }

  @Test
  public void testSelectHasXGoogRequestIdHeader() {
    Statement statement =
        Statement.newBuilder("select id from test where b=@p1")
            .bind("p1")
            .toBytesArray(
                Arrays.asList(ByteArray.copyFrom("test1"), null, ByteArray.copyFrom("test2")))
            .build();
    mockSpanner.putStatementResult(StatementResult.query(statement, SELECT1_RESULTSET));
    DatabaseClient client =
        spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
    try (ResultSet resultSet = client.singleUse().executeQuery(statement)) {
      assertTrue(resultSet.next());
      assertEquals(1L, resultSet.getLong(0));
      assertFalse(resultSet.next());
    } finally {
      xGoogReqIdInterceptor.assertIntegrity();
    }
  }

  @Test
  public void testSessionPoolExhaustedError_containsStackTraces() {
    assumeFalse(
        "Session pool tests are skipped for multiplexed sessions",
        isMultiplexedSessionsEnabledForRW());
    try (Spanner spanner =
        SpannerOptions.newBuilder()
            .setProjectId(TEST_PROJECT)
            .setChannelProvider(channelProvider)
            .setCredentials(NoCredentials.getInstance())
            .setSessionPoolOption(
                SessionPoolOptions.newBuilder()
                    .setFailIfPoolExhausted()
                    .setMinSessions(2)
                    .setMaxSessions(4)
                    .setWaitForMinSessionsDuration(Duration.ofSeconds(10L))
                    .build())
            .build()
            .getService()) {
      DatabaseClient client =
          spanner.getDatabaseClient(DatabaseId.of(TEST_PROJECT, TEST_INSTANCE, TEST_DATABASE));
      List<TransactionManager> transactions = new ArrayList<>();
      // Deliberately leak 4 sessions.
      for (int i = 0; i < 4; i++) {
        // Get a transaction manager without doing anything with it. This will reserve a session
        // from the pool, but not increase the number of sessions marked as in use.
        transactions.add(client.transactionManager());
      }
      // Trying to get yet another transaction will fail.
      // NOTE: This fails directly, because we have set the setFailIfPoolExhausted() option.
      SpannerException spannerException =
          assertThrows(SpannerException.class, client::transactionManager);
      assertEquals(ErrorCode.RESOURCE_EXHAUSTED, spannerException.getErrorCode());
      assertTrue(
          spannerException.getMessage(),
          spannerException.getMessage().contains("There are currently 4 sessions checked out:"));
      assertTrue(
          spannerException.getMessage(),
          spannerException.getMessage().contains("Session was checked out from the pool at"));

      SessionPool pool = ((DatabaseClientImpl) client).pool;
      // Verify that there are no sessions in the pool.
      assertEquals(0, pool.getNumberOfSessionsInPool());
      // Verify that the sessions have not (yet) been marked as in use.
      assertEquals(0, pool.getNumberOfSessionsInUse());
      assertEquals(0, pool.getMaxSessionsInUse());
      // Verify that we have 4 sessions in the pool.
      assertEquals(4, pool.getTotalSessionsPlusNumSessionsBeingCreated());

      // Release the sessions back into the pool.
      for (TransactionManager transaction : transactions) {
        transaction.close();
      }
      // Wait up to 100 milliseconds for the sessions to actually all be in the pool, as there are
      // two possible ways that the session pool handles the above:
      // 1. The pool starts to create 4 sessions.
      // 2. It then hands out whatever session has been created to one of the waiters.
      // 3. The waiting process then executes its transaction, and when finished, the session is
      //    given to any other process waiting at that moment.
      // The above means that although there will always be 4 sessions created, it could in theory
      // be that not all of them are used, as it could be that a transaction finishes before the
      // creation of session 2, 3, or 4 finished, and then the existing session is re-used.
      Stopwatch watch = Stopwatch.createStarted();
      while (pool.getNumberOfSessionsInPool() < 4 && watch.elapsed(TimeUnit.MILLISECONDS) < 100) {
        Thread.yield();
      }
      // Closing the transactions should return the sessions to the pool.
      assertEquals(4, pool.getNumberOfSessionsInPool());

      DatabaseClientImpl dbClient = (DatabaseClientImpl) client;
      int channelId = 0;
      try (Session session = dbClient.getSession()) {
        channelId = ((PooledSessionFuture) session).getChannel();
      }
      int dbId = dbClient.dbId;
      XGoogSpannerRequestIdTest.MethodAndRequestId[] wantStreamingValues = {};

      xGoogReqIdInterceptor.checkExpectedStreamingXGoogRequestIds(wantStreamingValues);
      long NON_DETERMINISTIC = XGoogSpannerRequestIdTest.NON_DETERMINISTIC;

      XGoogSpannerRequestIdTest.MethodAndRequestId[] wantUnaryValues = {
        XGoogSpannerRequestIdTest.ofMethodAndRequestId(
            "google.spanner.v1.Spanner/CreateSession",
            new XGoogSpannerRequestId(NON_DETERMINISTIC, 0, 1, 1)),
      };
      xGoogReqIdInterceptor.checkExpectedUnaryXGoogRequestIdsAsSuffixes(wantUnaryValues);
    }
  }

  static void assertAsString(String expected, ResultSet resultSet, int col) {
    assertEquals(expected, resultSet.getValue(col).getAsString());
    assertEquals(ImmutableList.of(expected), resultSet.getValue(col).getAsStringList());
  }

  static void assertAsString(ImmutableList<String> expected, ResultSet resultSet, int col) {
    assertEquals(expected, resultSet.getValue(col).getAsStringList());
    assertEquals(
        expected.stream().collect(Collectors.joining(",", "[", "]")),
        resultSet.getValue(col).getAsString());
  }

  private void consumeResults(ResultSet resultSet) {
    //noinspection StatementWithEmptyBody
    while (resultSet.next()) {}
  }

  private void consumeBatchWriteStream(ServerStream<BatchWriteResponse> stream) {
    //noinspection StatementWithEmptyBody
    for (BatchWriteResponse ignore : stream) {}
  }

  private ListValue getRows(Dialect dialect) {
    SingerInfo info = SingerInfo.newBuilder().setSingerId(1).build();
    ListValue.Builder valuesBuilder =
        ListValue.newBuilder()
            .addValues(com.google.protobuf.Value.newBuilder().setBoolValue(true).build())
            .addValues(com.google.protobuf.Value.newBuilder().setStringValue("100").build())
            .addValues(com.google.protobuf.Value.newBuilder().setNumberValue(-3.14f).build())
            .addValues(com.google.protobuf.Value.newBuilder().setNumberValue(3.14d).build())
            .addValues(com.google.protobuf.Value.newBuilder().setStringValue("6.626").build())
            .addValues(com.google.protobuf.Value.newBuilder().setStringValue("test-string").build())
            .addValues(
                com.google.protobuf.Value.newBuilder()
                    .setStringValue("{\"key1\": \"value1\"}")
                    .build())
            .addValues(
                com.google.protobuf.Value.newBuilder()
                    .setStringValue(
                        Base64.getEncoder()
                            .encodeToString("test-bytes".getBytes(StandardCharsets.UTF_8)))
                    .build())
            .addValues(com.google.protobuf.Value.newBuilder().setStringValue("2023-01-11").build())
            .addValues(
                com.google.protobuf.Value.newBuilder()
                    .setStringValue("b1153a48-cd31-498e-b770-f554bce48e05")
                    .build())
            .addValues(
                com.google.protobuf.Value.newBuilder()
                    .setStringValue("2023-01-11T11:55:18.123456789Z")
                    .build());
    if (dialect == Dialect.POSTGRESQL) {
      // Add PG_OID value
      valuesBuilder.addValues(com.google.protobuf.Value.newBuilder().setStringValue("100").build());
    }
    valuesBuilder
        .addValues(
            com.google.protobuf.Value.newBuilder()
                .setListValue(
                    ListValue.newBuilder()
                        .addValues(
                            com.google.protobuf.Value.newBuilder().setBoolValue(true).build())
                        .addValues(
                            com.google.protobuf.Value.newBuilder()
                                .setNullValue(NullValue.NULL_VALUE)
                                .build())
                        .addValues(
                            com.google.protobuf.Value.newBuilder().setBoolValue(false).build())
                        .build()))
        .addValues(
            com.google.protobuf.Value.newBuilder()
                .setListValue(
                    ListValue.newBuilder()
                        .addValues(
                            com.google.protobuf.Value.newBuilder()
                                .setStringValue(String.valueOf(Long.MAX_VALUE))
                                .build())
                        .addValues(
                            com.google.protobuf.Value.newBuilder()
                                .setStringValue(String.valueOf(Long.MIN_VALUE))
                                .build())
                        .addValues(
                            com.google.protobuf.Value.newBuilder()
                                .setNullValue(NullValue.NULL_VALUE)
                                .build())
                        .build()))
        .addValues(
            com.google.protobuf.Value.newBuilder()
                .setListValue(
                    ListValue.newBuilder()
                        .addValues(
                            com.google.protobuf.Value.newBuilder()
                                .setNullValue(NullValue.NULL_VALUE)
                                .build())
                        .addValues(
                            com.google.protobuf.Value.newBuilder()
                                .setNumberValue(Float.MAX_VALUE)
                                .build())
                        .addValues(
                            com.google.protobuf.Value.newBuilder()
                                .setNumberValue(Float.MIN_VALUE)
                                .build())
                        .addValues(
                            com.google.protobuf.Value.newBuilder().setStringValue("NaN").build())
                        .addValues(
                            com.google.protobuf.Value.newBuilder().setNumberValue(3.14f).build())
                        .build()))
        .addValues(
            com.google.protobuf.Value.newBuilder()
                .setListValue(
                    ListValue.newBuilder()
                        .addValues(
                            com.google.protobuf.Value.newBuilder()
                                .setNullValue(NullValue.NULL_VALUE)
                                .build())
                        .addValues(
                            com.google.protobuf.Value.newBuilder()
                                .setNumberValue(-12345.6789d)
                                .build())
                        .addValues(
                            com.google.protobuf.Value.newBuilder().setNumberValue(3.14d).build())
                        .build()))
        .addValues(
            com.google.protobuf.Value.newBuilder()
                .setListValue(
                    ListValue.newBuilder()
                        .addValues(
                            com.google.protobuf.Value.newBuilder().setStringValue("6.626").build())
                        .addValues(
                            com.google.protobuf.Value.newBuilder()
                                .setNullValue(NullValue.NULL_VALUE)
                                .build())
                        .addValues(
                            com.google.protobuf.Value.newBuilder()
                                .setStringValue("-8.9123")
                                .build())
                        .build()))
        .addValues(
            com.google.protobuf.Value.newBuilder()
                .setListValue(
                    ListValue.newBuilder()
                        .addValues(
                            com.google.protobuf.Value.newBuilder()
                                .setStringValue("test-string1")
                                .build())
                        .addValues(
                            com.google.protobuf.Value.newBuilder()
                                .setNullValue(NullValue.NULL_VALUE)
                                .build())
                        .addValues(
                            com.google.protobuf.Value.newBuilder()
                                .setStringValue("test-string2")
                                .build())
                        .build()))
        .addValues(
            com.google.protobuf.Value.newBuilder()
                .setListValue(
                    ListValue.newBuilder()
                        .addValues(
                            com.google.protobuf.Value.newBuilder()
                                .setStringValue("{\"key\": \"value1\"}")
                                .build())
                        .addValues(
                            com.google.protobuf.Value.newBuilder()
                                .setStringValue("{\"key\": \"value2\"}")
                                .build())
                        .addValues(
                            com.google.protobuf.Value.newBuilder()
                                .setNullValue(NullValue.NULL_VALUE)
                                .build())
                        .build()))
        .addValues(
            com.google.protobuf.Value.newBuilder()
                .setListValue(
                    ListValue.newBuilder()
                        .addValues(
                            com.google.protobuf.Value.newBuilder()
                                .setStringValue(
                                    Base64.getEncoder()
                                        .encodeToString(
                                            "test-bytes1".getBytes(StandardCharsets.UTF_8)))
                                .build())
                        .addValues(
                            com.google.protobuf.Value.newBuilder()
                                .setStringValue(
                                    Base64.getEncoder()
                                        .encodeToString(
                                            "test-bytes2".getBytes(StandardCharsets.UTF_8)))
                                .build())
                        .addValues(
                            com.google.protobuf.Value.newBuilder()
                                .setNullValue(NullValue.NULL_VALUE)
                                .build())
                        .build()))
        .addValues(
            com.google.protobuf.Value.newBuilder()
                .setListValue(
                    ListValue.newBuilder()
                        .addValues(
                            com.google.protobuf.Value.newBuilder()
                                .setStringValue("2000-02-29")
                                .build())
                        .addValues(
                            com.google.protobuf.Value.newBuilder()
                                .setNullValue(NullValue.NULL_VALUE)
                                .build())
                        .addValues(
                            com.google.protobuf.Value.newBuilder()
                                .setStringValue("2000-01-01")
                                .build())
                        .build()))
        .addValues(
            com.google.protobuf.Value.newBuilder()
                .setListValue(
                    ListValue.newBuilder()
                        .addValues(
                            com.google.protobuf.Value.newBuilder()
                                .setStringValue("b1153a48-cd31-498e-b770-f554bce48e05")
                                .build())
                        .addValues(
                            com.google.protobuf.Value.newBuilder()
                                .setNullValue(NullValue.NULL_VALUE)
                                .build())
                        .addValues(
                            com.google.protobuf.Value.newBuilder()
                                .setStringValue("11546309-8b37-4366-9a20-369381c7803a")
                                .build())
                        .build()))
        .addValues(
            com.google.protobuf.Value.newBuilder()
                .setListValue(
                    ListValue.newBuilder()
                        .addValues(
                            com.google.protobuf.Value.newBuilder()
                                .setStringValue("2023-01-11T11:55:18.123456789Z")
                                .build())
                        .addValues(
                            com.google.protobuf.Value.newBuilder()
                                .setNullValue(NullValue.NULL_VALUE)
                                .build())
                        .addValues(
                            com.google.protobuf.Value.newBuilder()
                                .setStringValue("2023-01-12T11:55:18Z")
                                .build())
                        .build()));

    if (dialect == Dialect.GOOGLE_STANDARD_SQL) {
      // Proto columns is supported only for GOOGLE_STANDARD_SQL
      valuesBuilder
          .addValues(
              com.google.protobuf.Value.newBuilder()
                  .setStringValue(Base64.getEncoder().encodeToString(info.toByteArray()))
                  .build())
          .addValues(
              com.google.protobuf.Value.newBuilder()
                  .setStringValue(String.valueOf(Genre.JAZZ_VALUE))
                  .build())
          .addValues(
              com.google.protobuf.Value.newBuilder()
                  .setListValue(
                      ListValue.newBuilder()
                          .addValues(
                              com.google.protobuf.Value.newBuilder()
                                  .setStringValue(
                                      Base64.getEncoder().encodeToString(info.toByteArray()))
                                  .build())
                          .addValues(
                              com.google.protobuf.Value.newBuilder()
                                  .setNullValue(NullValue.NULL_VALUE)
                                  .build())
                          .build()))
          .addValues(
              com.google.protobuf.Value.newBuilder()
                  .setListValue(
                      ListValue.newBuilder()
                          .addValues(
                              com.google.protobuf.Value.newBuilder()
                                  .setStringValue(String.valueOf(Genre.JAZZ_VALUE))
                                  .build())
                          .addValues(
                              com.google.protobuf.Value.newBuilder()
                                  .setNullValue(NullValue.NULL_VALUE)
                                  .build())
                          .build()));
    }
    if (dialect == Dialect.POSTGRESQL) {
      // Add ARRAY<PG_OID> value
      valuesBuilder.addValues(
          com.google.protobuf.Value.newBuilder()
              .setListValue(
                  ListValue.newBuilder()
                      .addValues(
                          com.google.protobuf.Value.newBuilder()
                              .setStringValue(String.valueOf(Long.MAX_VALUE))
                              .build())
                      .addValues(
                          com.google.protobuf.Value.newBuilder()
                              .setStringValue(String.valueOf(Long.MIN_VALUE))
                              .build())
                      .addValues(
                          com.google.protobuf.Value.newBuilder()
                              .setNullValue(NullValue.NULL_VALUE)
                              .build())
                      .build()));
    }

    return valuesBuilder.build();
  }

  private boolean isMultiplexedSessionsEnabled() {
    if (spanner.getOptions() == null || spanner.getOptions().getSessionPoolOptions() == null) {
      return false;
    }
    return spanner.getOptions().getSessionPoolOptions().getUseMultiplexedSession();
  }

  private boolean isMultiplexedSessionsEnabledForRW() {
    if (spanner.getOptions() == null || spanner.getOptions().getSessionPoolOptions() == null) {
      return false;
    }
    return spanner.getOptions().getSessionPoolOptions().getUseMultiplexedSessionForRW();
  }

  @Test
  public void testdbIdFromClientId() {
    SessionPool pool = mock(SessionPool.class);
    PooledSessionFuture session = mock(PooledSessionFuture.class);
    when(pool.getSession()).thenReturn(session);
    TransactionOption option = mock(TransactionOption.class);
    DatabaseClientImpl client = new DatabaseClientImpl(pool, mock(TraceWrapper.class));

    for (int i = 0; i < 10; i++) {
      String dbId = String.format("%d", i);
      int id = client.dbIdFromClientId(dbId);
      assertEquals(id, i + 2); // There was already 1 dbId after new DatabaseClientImpl.
    }
  }

  @Test
  public void testrunWithSessionRetry_withRequestId() {
    // Tests that DatabaseClientImpl.runWithSessionRetry correctly returns a XGoogSpannerRequestId
    // and correctly increases its nthRequest ordinal number and that attempts stay at 1, given
    // a fresh session returned on SessionNotFoundException.
    SessionPool pool = mock(SessionPool.class);
    PooledSessionFuture sessionFut = mock(PooledSessionFuture.class);
    when(pool.getSession()).thenReturn(sessionFut);
    SessionPool.PooledSession pooledSession = mock(SessionPool.PooledSession.class);
    when(sessionFut.get()).thenReturn(pooledSession);
    SessionPool.PooledSessionReplacementHandler sessionReplacementHandler =
        mock(SessionPool.PooledSessionReplacementHandler.class);
    when(pool.getPooledSessionReplacementHandler()).thenReturn(sessionReplacementHandler);
    when(sessionReplacementHandler.replaceSession(any(), any())).thenReturn(sessionFut);
    DatabaseClientImpl client = new DatabaseClientImpl(pool, mock(TraceWrapper.class));

    // 1. Run with no fail runs a single attempt.
    final AtomicInteger nCalls = new AtomicInteger(0);
    client.runWithSessionRetry(
        (session, reqId) -> {
          assertEquals(reqId.getAttempt(), 1);
          nCalls.incrementAndGet();
          return 1;
        });
    assertEquals(nCalls.get(), 1);

    // Reset the call counter.
    nCalls.set(0);

    // 2. Run with SessionNotFoundException and ensure that a fresh requestId is returned each time.
    SessionNotFoundException excSessionNotFound =
        SpannerExceptionFactoryTest.newSessionNotFoundException(
            "projects/p/instances/i/databases/d/sessions/s");

    final AtomicLong priorNthRequest = new AtomicLong(client.getNthRequest());
    client.runWithSessionRetry(
        (session, reqId) -> {
          // Monotonically increasing priorNthRequest.
          assertEquals(reqId.getNthRequest() - priorNthRequest.get(), 1);
          priorNthRequest.set(reqId.getNthRequest());

          // Attempts stay at 1 since with a SessionNotFound exception,
          // a fresh requestId is generated.
          assertEquals(reqId.getAttempt(), 1);

          if (nCalls.addAndGet(1) < 4) {
            throw excSessionNotFound;
          }

          return 1;
        });

    assertEquals(nCalls.get(), 4);
  }
}