# Copyright 2017 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
#
#     https://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.

require "helper"

describe Google::Cloud::Spanner::Client, :transaction, :retry, :mock_spanner do
  let(:instance_id) { "my-instance-id" }
  let(:database_id) { "my-database-id" }
  let(:session_id) { "session123" }
  let(:session_grpc) { Google::Spanner::V1::Session.new name: session_path(instance_id, database_id, session_id) }
  let(:session) { Google::Cloud::Spanner::Session.from_grpc session_grpc, spanner.service }
  let(:transaction_id) { "tx789" }
  let(:transaction_grpc) { Google::Spanner::V1::Transaction.new id: transaction_id }
  let(:transaction) { Google::Cloud::Spanner::Transaction.from_grpc transaction_grpc, session }
  let(:tx_selector) { Google::Spanner::V1::TransactionSelector.new id: transaction_id }
  let(:default_options) { Google::Gax::CallOptions.new kwargs: { "google-cloud-resource-prefix" => database_path(instance_id, database_id) } }
  let :results_hash do
    {
      metadata: {
        rowType: {
          fields: [
            { name: "id",          type: { code: "INT64" } },
            { name: "name",        type: { code: "STRING" } },
            { name: "active",      type: { code: "BOOL" } },
            { name: "age",         type: { code: "INT64" } },
            { name: "score",       type: { code: "FLOAT64" } },
            { name: "updated_at",  type: { code: "TIMESTAMP" } },
            { name: "birthday",    type: { code: "DATE"} },
            { name: "avatar",      type: { code: "BYTES" } },
            { name: "project_ids", type: { code: "ARRAY",
                                           arrayElementType: { code: "INT64" } } }
          ]
        }
      },
      values: [
        { stringValue: "1" },
        { stringValue: "Charlie" },
        { boolValue: true},
        { stringValue: "29" },
        { numberValue: 0.9 },
        { stringValue: "2017-01-02T03:04:05.060000000Z" },
        { stringValue: "1950-01-01" },
        { stringValue: "aW1hZ2U=" },
        { listValue: { values: [ { stringValue: "1"},
                                 { stringValue: "2"},
                                 { stringValue: "3"} ]}}
      ]
    }
  end
  let(:results_json) { results_hash.to_json }
  let(:results_grpc) { Google::Spanner::V1::PartialResultSet.decode_json results_json }
  let(:results_enum) { Array(results_grpc).to_enum }
  let(:client) { spanner.client instance_id, database_id, pool: { min: 0 } }
  let(:tx_opts) { Google::Spanner::V1::TransactionOptions.new(read_write: Google::Spanner::V1::TransactionOptions::ReadWrite.new) }

  it "retries aborted transactions without retry metadata" do
    mutations = [
      Google::Spanner::V1::Mutation.new(
        update: Google::Spanner::V1::Mutation::Write.new(
          table: "users", columns: %w(id name active),
          values: [Google::Cloud::Spanner::Convert.raw_to_value([1, "Charlie", false]).list_value]
        )
      )
    ]

    mock = Minitest::Mock.new
    mock.expect :create_session, session_grpc, [database_path(instance_id, database_id), options: default_options]
    mock.expect :begin_transaction, transaction_grpc, [session_grpc.name, tx_opts, options: default_options]
    mock.expect :execute_streaming_sql, results_enum, [session_grpc.name, "SELECT * FROM users", transaction: tx_selector, params: nil, param_types: nil, resume_token: nil, partition_token: nil, options: default_options]

    mock.expect :begin_transaction, transaction_grpc, [session_grpc.name, tx_opts, options: default_options]
    mock.expect :execute_streaming_sql, results_enum, [session_grpc.name, "SELECT * FROM users", transaction: tx_selector, params: nil, param_types: nil, resume_token: nil, partition_token: nil, options: default_options]

    # transaction checkin
    mock.expect :begin_transaction, transaction_grpc, [session_grpc.name, tx_opts, options: default_options]

    def mock.commit *args
      # first time called this will raise
      if @called == nil
        @called = true
        gax_error = Google::Gax::GaxError.new "aborted"
        gax_error.instance_variable_set :@cause, GRPC::BadStatus.new(10, "aborted")
        raise gax_error
      end
      # second call will return correct response
      Google::Spanner::V1::CommitResponse.new commit_timestamp: Google::Protobuf::Timestamp.new()
    end
    mock.expect :sleep, nil, [1.3]
    spanner.service.mocked_service = mock

    client.define_singleton_method :sleep do |count|
      # call the mock to satisfy the expectation
      mock.sleep count
    end

    results = nil
    client.transaction do |tx|
      tx.must_be_kind_of Google::Cloud::Spanner::Transaction
      results = tx.execute "SELECT * FROM users"
      tx.update "users", [{ id: 1, name: "Charlie", active: false }]
    end

    assert_results results

    shutdown_client! client

    mock.verify
  end

  it "retries aborted transactions with retry metadata seconds" do
    mutations = [
      Google::Spanner::V1::Mutation.new(
        update: Google::Spanner::V1::Mutation::Write.new(
          table: "users", columns: %w(id name active),
          values: [Google::Cloud::Spanner::Convert.raw_to_value([1, "Charlie", false]).list_value]
        )
      )
    ]

    mock = Minitest::Mock.new
    mock.expect :create_session, session_grpc, [database_path(instance_id, database_id), options: default_options]
    mock.expect :begin_transaction, transaction_grpc, [session_grpc.name, tx_opts, options: default_options]
    mock.expect :execute_streaming_sql, results_enum, [session_grpc.name, "SELECT * FROM users", transaction: tx_selector, params: nil, param_types: nil, resume_token: nil, partition_token: nil, options: default_options]

    mock.expect :begin_transaction, transaction_grpc, [session_grpc.name, tx_opts, options: default_options]
    mock.expect :execute_streaming_sql, results_enum, [session_grpc.name, "SELECT * FROM users", transaction: tx_selector, params: nil, param_types: nil, resume_token: nil, partition_token: nil, options: default_options]

    # transaction checkin
    mock.expect :begin_transaction, transaction_grpc, [session_grpc.name, tx_opts, options: default_options]

    def mock.commit *args
      # first time called this will raise
      if @called == nil
        @called = true
        gax_error = Google::Gax::GaxError.new "aborted"
        gax_error.instance_variable_set :@cause, GRPC::BadStatus.new(10, "aborted", {"retryDelay"=>{"seconds"=>60}})
        raise gax_error
      end
      # second call will return correct response
      Google::Spanner::V1::CommitResponse.new commit_timestamp: Google::Protobuf::Timestamp.new()
    end
    mock.expect :sleep, nil, [60]
    spanner.service.mocked_service = mock

    client.define_singleton_method :sleep do |count|
      # call the mock to satisfy the expectation
      mock.sleep count
    end

    results = nil
    client.transaction do |tx|
      tx.must_be_kind_of Google::Cloud::Spanner::Transaction
      results = tx.execute "SELECT * FROM users"
      tx.update "users", [{ id: 1, name: "Charlie", active: false }]
    end

    assert_results results

    shutdown_client! client

    mock.verify
  end

  it "retries aborted transactions with retry metadata seconds and nanos" do
    mutations = [
      Google::Spanner::V1::Mutation.new(
        update: Google::Spanner::V1::Mutation::Write.new(
          table: "users", columns: %w(id name active),
          values: [Google::Cloud::Spanner::Convert.raw_to_value([1, "Charlie", false]).list_value]
        )
      )
    ]

    mock = Minitest::Mock.new
    mock.expect :create_session, session_grpc, [database_path(instance_id, database_id), options: default_options]
    mock.expect :begin_transaction, transaction_grpc, [session_grpc.name, tx_opts, options: default_options]
    mock.expect :execute_streaming_sql, results_enum, [session_grpc.name, "SELECT * FROM users", transaction: tx_selector, params: nil, param_types: nil, resume_token: nil, partition_token: nil, options: default_options]

    mock.expect :begin_transaction, transaction_grpc, [session_grpc.name, tx_opts, options: default_options]
    mock.expect :execute_streaming_sql, results_enum, [session_grpc.name, "SELECT * FROM users", transaction: tx_selector, params: nil, param_types: nil, resume_token: nil, partition_token: nil, options: default_options]

    # transaction checkin
    mock.expect :begin_transaction, transaction_grpc, [session_grpc.name, tx_opts, options: default_options]

    def mock.commit *args
      # first time called this will raise
      if @called == nil
        @called = true
        gax_error = Google::Gax::GaxError.new "aborted"
        gax_error.instance_variable_set :@cause, GRPC::BadStatus.new(10, "aborted", {"retryDelay"=>{"seconds"=>123, "nanos"=>456000000}})
        raise gax_error
      end
      # second call will return correct response
      Google::Spanner::V1::CommitResponse.new commit_timestamp: Google::Protobuf::Timestamp.new()
    end
    mock.expect :sleep, nil, [123.456]
    spanner.service.mocked_service = mock

    client.define_singleton_method :sleep do |count|
      # call the mock to satisfy the expectation
      mock.sleep count
    end

    results = nil
    client.transaction do |tx|
      tx.must_be_kind_of Google::Cloud::Spanner::Transaction
      results = tx.execute "SELECT * FROM users"
      tx.update "users", [{ id: 1, name: "Charlie", active: false }]
    end

    assert_results results

    shutdown_client! client

    mock.verify
  end

  it "retries multiple aborted transactions" do
    mutations = [
      Google::Spanner::V1::Mutation.new(
        update: Google::Spanner::V1::Mutation::Write.new(
          table: "users", columns: %w(id name active),
          values: [Google::Cloud::Spanner::Convert.raw_to_value([1, "Charlie", false]).list_value]
        )
      )
    ]

    mock = Minitest::Mock.new
    mock.expect :create_session, session_grpc, [database_path(instance_id, database_id), options: default_options]
    mock.expect :begin_transaction, transaction_grpc, [session_grpc.name, tx_opts, options: default_options]
    mock.expect :execute_streaming_sql, results_enum, [session_grpc.name, "SELECT * FROM users", transaction: tx_selector, params: nil, param_types: nil, resume_token: nil, partition_token: nil, options: default_options]

    mock.expect :begin_transaction, transaction_grpc, [session_grpc.name, tx_opts, options: default_options]
    mock.expect :execute_streaming_sql, results_enum, [session_grpc.name, "SELECT * FROM users", transaction: tx_selector, params: nil, param_types: nil, resume_token: nil, partition_token: nil, options: default_options]

    mock.expect :begin_transaction, transaction_grpc, [session_grpc.name, tx_opts, options: default_options]
    mock.expect :execute_streaming_sql, results_enum, [session_grpc.name, "SELECT * FROM users", transaction: tx_selector, params: nil, param_types: nil, resume_token: nil, partition_token: nil, options: default_options]

    # transaction checkin
    mock.expect :begin_transaction, transaction_grpc, [session_grpc.name, tx_opts, options: default_options]

    def mock.commit *args
      # first time called this will raise
      if @called == nil
        @called = false
        gax_error = Google::Gax::GaxError.new "aborted"
        gax_error.instance_variable_set :@cause, GRPC::BadStatus.new(10, "aborted")
        raise gax_error
      end
      if @called == false
        @called = true
        gax_error = Google::Gax::GaxError.new "aborted"
        gax_error.instance_variable_set :@cause, GRPC::BadStatus.new(10, "aborted", {"retryDelay"=>{"seconds"=>30}})
        raise gax_error
      end
      # third call will return correct response
      Google::Spanner::V1::CommitResponse.new commit_timestamp: Google::Protobuf::Timestamp.new()
    end
    mock.expect :sleep, nil, [1.3]
    mock.expect :sleep, nil, [30]
    spanner.service.mocked_service = mock

    client.define_singleton_method :sleep do |count|
      # call the mock to satisfy the expectation
      mock.sleep count
    end

    results = nil
    client.transaction do |tx|
      tx.must_be_kind_of Google::Cloud::Spanner::Transaction
      results = tx.execute "SELECT * FROM users"
      tx.update "users", [{ id: 1, name: "Charlie", active: false }]
    end

    assert_results results

    shutdown_client! client

    mock.verify
  end

  it "retries with incremental backoff until deadline has passed" do
    mutations = [
      Google::Spanner::V1::Mutation.new(
        update: Google::Spanner::V1::Mutation::Write.new(
          table: "users", columns: %w(id name active),
          values: [Google::Cloud::Spanner::Convert.raw_to_value([1, "Charlie", false]).list_value]
        )
      )
    ]

    mock = Minitest::Mock.new
    mock.expect :create_session, session_grpc, [database_path(instance_id, database_id), options: default_options]
    mock.expect :begin_transaction, transaction_grpc, [session_grpc.name, tx_opts, options: default_options]
    mock.expect :execute_streaming_sql, results_enum, [session_grpc.name, "SELECT * FROM users", transaction: tx_selector, params: nil, param_types: nil, resume_token: nil, partition_token: nil, options: default_options]

    mock.expect :begin_transaction, transaction_grpc, [session_grpc.name, tx_opts, options: default_options]
    mock.expect :execute_streaming_sql, results_enum, [session_grpc.name, "SELECT * FROM users", transaction: tx_selector, params: nil, param_types: nil, resume_token: nil, partition_token: nil, options: default_options]

    mock.expect :begin_transaction, transaction_grpc, [session_grpc.name, tx_opts, options: default_options]
    mock.expect :execute_streaming_sql, results_enum, [session_grpc.name, "SELECT * FROM users", transaction: tx_selector, params: nil, param_types: nil, resume_token: nil, partition_token: nil, options: default_options]

    mock.expect :begin_transaction, transaction_grpc, [session_grpc.name, tx_opts, options: default_options]
    mock.expect :execute_streaming_sql, results_enum, [session_grpc.name, "SELECT * FROM users", transaction: tx_selector, params: nil, param_types: nil, resume_token: nil, partition_token: nil, options: default_options]

    mock.expect :begin_transaction, transaction_grpc, [session_grpc.name, tx_opts, options: default_options]
    mock.expect :execute_streaming_sql, results_enum, [session_grpc.name, "SELECT * FROM users", transaction: tx_selector, params: nil, param_types: nil, resume_token: nil, partition_token: nil, options: default_options]

    # transaction checkin
    mock.expect :begin_transaction, transaction_grpc, [session_grpc.name, tx_opts, options: default_options]

    def mock.commit *args
      gax_error = Google::Gax::GaxError.new "aborted"
      gax_error.instance_variable_set :@cause, GRPC::BadStatus.new(10, "aborted")
      raise gax_error
    end
    mock.expect :sleep, nil, [1.3]
    mock.expect :sleep, nil, [1.6900000000000002]
    mock.expect :sleep, nil, [2.1970000000000005]
    mock.expect :sleep, nil, [2.856100000000001]

    mock.expect :current_time, Time.now, []
    mock.expect :current_time, Time.now, []
    mock.expect :current_time, Time.now + 30, []
    mock.expect :current_time, Time.now + 60, []
    mock.expect :current_time, Time.now + 90, []
    mock.expect :current_time, Time.now + 125, []
    spanner.service.mocked_service = mock

    client.define_singleton_method :sleep do |count|
      # call the mock to satisfy the expectation
      mock.sleep count
    end
    client.define_singleton_method :current_time do
      # call the mock to satisfy the expectation
      mock.current_time
    end

    assert_raises Google::Cloud::AbortedError do
      client.transaction do |tx|
        tx.must_be_kind_of Google::Cloud::Spanner::Transaction
        results = tx.execute "SELECT * FROM users"
        tx.update "users", [{ id: 1, name: "Charlie", active: false }]
      end
    end

    shutdown_client! client

    mock.verify
  end

  def assert_results results
    results.must_be_kind_of Google::Cloud::Spanner::Results

    results.fields.wont_be :nil?
    results.fields.must_be_kind_of Google::Cloud::Spanner::Fields
    results.fields.keys.count.must_equal 9
    results.fields[:id].must_equal          :INT64
    results.fields[:name].must_equal        :STRING
    results.fields[:active].must_equal      :BOOL
    results.fields[:age].must_equal         :INT64
    results.fields[:score].must_equal       :FLOAT64
    results.fields[:updated_at].must_equal  :TIMESTAMP
    results.fields[:birthday].must_equal    :DATE
    results.fields[:avatar].must_equal      :BYTES
    results.fields[:project_ids].must_equal [:INT64]

    rows = results.rows.to_a # grab them all from the enumerator
    rows.count.must_equal 1
    row = rows.first
    row.must_be_kind_of Google::Cloud::Spanner::Data
    row.keys.must_equal [:id, :name, :active, :age, :score, :updated_at, :birthday, :avatar, :project_ids]
    row[:id].must_equal 1
    row[:name].must_equal "Charlie"
    row[:active].must_equal true
    row[:age].must_equal 29
    row[:score].must_equal 0.9
    row[:updated_at].must_equal Time.parse("2017-01-02T03:04:05.060000000Z")
    row[:birthday].must_equal Date.parse("1950-01-01")
    row[:avatar].must_be_kind_of StringIO
    row[:avatar].read.must_equal "image"
    row[:project_ids].must_equal [1, 2, 3]
  end
end
