Class: Anthropic::Internal::Transport::BaseClient Abstract Private

Inherits:
Object
  • Object
show all
Extended by:
Util::SorbetRuntimeSupport
Defined in:
lib/anthropic/internal/transport/base_client.rb

Overview

This class is part of a private API. You should avoid using this class if possible, as it may be removed or be changed in the future.

This class is abstract.

Direct Known Subclasses

Client

Constant Summary collapse

MAX_REDIRECTS =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

from whatwg fetch spec

20
PLATFORM_HEADERS =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

rubocop:disable Style/MutableConstant

{
  "x-stainless-arch" => Anthropic::Internal::Util.arch,
  "x-stainless-lang" => "ruby",
  "x-stainless-os" => Anthropic::Internal::Util.os,
  "x-stainless-package-version" => Anthropic::VERSION,
  "x-stainless-runtime" => ::RUBY_ENGINE,
  "x-stainless-runtime-version" => ::RUBY_ENGINE_VERSION
}

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Util::SorbetRuntimeSupport

const_missing, define_sorbet_constant!, sorbet_constant_defined?, to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(base_url:, timeout: 0.0, max_retries: 0, initial_retry_delay: 0.0, max_retry_delay: 0.0, headers: {}, idempotency_header: nil, middleware: nil, requester: nil) ⇒ BaseClient

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of BaseClient.

Parameters:

  • base_url (String)
  • timeout (Float) (defaults to: 0.0)
  • max_retries (Integer) (defaults to: 0)
  • initial_retry_delay (Float) (defaults to: 0.0)
  • max_retry_delay (Float) (defaults to: 0.0)
  • headers (Hash{String=>String, Integer, Array<String, Integer, nil>, nil}) (defaults to: {})
  • idempotency_header (String, nil) (defaults to: nil)
  • middleware (Array<#call>, #call, nil) (defaults to: nil)
  • requester (Anthropic::Internal::Transport::PooledNetRequester, nil) (defaults to: nil) 


202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/anthropic/internal/transport/base_client.rb', line 202

def initialize(
  base_url:,
  timeout: 0.0,
  max_retries: 0,
  initial_retry_delay: 0.0,
  max_retry_delay: 0.0,
  headers: {},
  idempotency_header: nil,
  middleware: nil,
  requester: nil
)
  @middleware = Array(middleware).freeze
  @requester = requester || Anthropic::Internal::Transport::PooledNetRequester.new
  @headers = Anthropic::Internal::Util.normalized_headers(
    self.class::PLATFORM_HEADERS,
    {
      "accept" => "application/json",
      "content-type" => "application/json",
      "user-agent" => user_agent
    },
    headers
  )
  @base_url_components = Anthropic::Internal::Util.parse_uri(base_url)
  @base_url = Anthropic::Internal::Util.unparse_uri(@base_url_components)
  @idempotency_header = idempotency_header&.to_s&.downcase
  @timeout = timeout
  @max_retries = max_retries
  @initial_retry_delay = initial_retry_delay
  @max_retry_delay = max_retry_delay
end

Instance Attribute Details

#base_url ⇒ URI::Generic (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns:

  • (URI::Generic) 


164
165
166
 
# File 'lib/anthropic/internal/transport/base_client.rb', line 164

def base_url
  @base_url
end

#headers ⇒ Hash{String=>String} (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns:

  • (Hash{String=>String}) 


179
180
181
 
# File 'lib/anthropic/internal/transport/base_client.rb', line 179

def headers
  @headers
end

#idempotency_header ⇒ String? (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns:

  • (String, nil) 


182
183
184
 
# File 'lib/anthropic/internal/transport/base_client.rb', line 182

def idempotency_header
  @idempotency_header
end

#initial_retry_delay ⇒ Float (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns:

  • (Float) 


173
174
175
 
# File 'lib/anthropic/internal/transport/base_client.rb', line 173

def initial_retry_delay
  @initial_retry_delay
end

#max_retries ⇒ Integer (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns:

  • (Integer) 


170
171
172
 
# File 'lib/anthropic/internal/transport/base_client.rb', line 170

def max_retries
  @max_retries
end

#max_retry_delay ⇒ Float (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns:

  • (Float) 


176
177
178
 
# File 'lib/anthropic/internal/transport/base_client.rb', line 176

def max_retry_delay
  @max_retry_delay
end

#middleware ⇒ Array<#call> (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns the middleware chain (first = outermost).

Returns:

  • (Array<#call>) —

    the middleware chain (first = outermost).



189
190
191
 
# File 'lib/anthropic/internal/transport/base_client.rb', line 189

def middleware
  @middleware
end

#requester ⇒ Anthropic::Internal::Transport::PooledNetRequester (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns:



186
187
188
 
# File 'lib/anthropic/internal/transport/base_client.rb', line 186

def requester
  @requester
end

#timeout ⇒ Float (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns:

  • (Float) 


167
168
169
 
# File 'lib/anthropic/internal/transport/base_client.rb', line 167

def timeout
  @timeout
end

Class Method Details

.follow_redirect(request, status:, response_headers:) ⇒ Hash{Symbol=>Object}

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:

  • request (Hash{Symbol=>Object}) —

    .

    @option request [Symbol] :method

    @option request [URI::Generic] :url

    @option request [HashString=>String] :headers

    @option request [Object] :body

    @option request [Integer] :max_retries

    @option request [Float] :timeout

  • status (Integer)
  • response_headers (Hash{String=>String})

Returns:

  • (Hash{Symbol=>Object}) 


91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
 
# File 'lib/anthropic/internal/transport/base_client.rb', line 91

def follow_redirect(request, status:, response_headers:)
  method, url, headers = request.fetch_values(:method, :url, :headers)
  location =
    Kernel.then do
      URI.join(url, response_headers["location"])
    rescue ArgumentError
      message = "Server responded with status #{status} but no valid location header."
      raise Anthropic::Errors::APIConnectionError.new(
        url: url,
        response: response_headers,
        message: message
      )
    end

  request = {**request, url: location}

  case [url.scheme, location.scheme]
  in ["https", "http"]
    message = "Tried to redirect to a insecure URL"
    raise Anthropic::Errors::APIConnectionError.new(
      url: url,
      response: response_headers,
      message: message
    )
  else
    nil
  end

  # from whatwg fetch spec
  case [status, method]
  in [301 | 302, :post] | [303, _]
    drop = %w[content-encoding content-language content-length content-location content-type]
    request = {
      **request,
      method: method == :head ? :head : :get,
      headers: headers.except(*drop),
      body: nil
    }
  else
  end

  # from undici
  if Anthropic::Internal::Util.uri_origin(url) != Anthropic::Internal::Util.uri_origin(location)
    drop = %w[authorization cookie host proxy-authorization]
    # The sentinel keeps the strip durable: provider middleware
    # (Vertex OAuth, Bedrock SigV4) runs per attempt and would
    # otherwise re-add `authorization` on the redirected leg.
    request = {
      **request,
      headers: request.fetch(:headers).except(*drop),
      metadata: {**request.fetch(:metadata, {}), cross_origin_redirect: true}
    }
  end

  request
end

.reap_connection!(status, stream:) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:



152
153
154
155
156
157
158
159
160
 
# File 'lib/anthropic/internal/transport/base_client.rb', line 152

def reap_connection!(status, stream:)
  case status
  in (..199) | (300..499)
    stream&.each { next }
  in Anthropic::Errors::APIConnectionError | (500..)
    Anthropic::Internal::Util.close_fused!(stream)
  else
  end
end

.should_retry?(status, headers:) ⇒ Boolean

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:

  • status (Integer)
  • headers (Hash{String=>String})

Returns:



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/anthropic/internal/transport/base_client.rb', line 53

def should_retry?(status, headers:)
  coerced = Anthropic::Internal::Util.coerce_boolean(headers["x-should-retry"])
  case [coerced, status]
  in [true | false, _]
    coerced
  in [_, 408 | 409 | 429 | (500..)]
    # retry on:
    # 408: timeouts
    # 409: locks
    # 429: rate limits
    # 500+: unknown errors
    true
  else
    false
  end
end

.validate!(req) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:

  • req (Hash{Symbol=>Object})

Raises:

  • (ArgumentError) 


33
34
35
36
37
38
39
40
41
42
43
44
45
 
# File 'lib/anthropic/internal/transport/base_client.rb', line 33

def validate!(req)
  keys = [:method, :path, :query, :headers, :body, :unwrap, :page, :stream, :model, :options]
  case req
  in Hash
    req.each_key do |k|
      unless keys.include?(k)
        raise ArgumentError.new("Request `req` keys must be one of #{keys}, got #{k.inspect}")
      end
    end
  else
    raise ArgumentError.new("Request `req` must be a Hash or RequestOptions, got #{req.inspect}")
  end
end

Instance Method Details

#inspect ⇒ String

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns:

  • (String) 


717
718
719
720
721
 
# File 'lib/anthropic/internal/transport/base_client.rb', line 717

def inspect
  # rubocop:disable Layout/LineLength
  "#<#{self.class.name}:0x#{object_id.to_s(16)} base_url=#{@base_url} max_retries=#{@max_retries} timeout=#{@timeout}>"
  # rubocop:enable Layout/LineLength
end

#request(method, path, query: {}, headers: {}, body: nil, unwrap: nil, page: nil, stream: nil, model: Anthropic::Internal::Type::Unknown, options: {}) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Execute the request specified by ‘req`. This is the method that all resource methods call into.

Parameters:

  • method (Symbol)
  • path (String, Array<String>)
  • query (Hash{String=>Array<String>, String, nil}, nil)
  • headers (Hash{String=>String, Integer, Array<String, Integer, nil>, nil}, nil)
  • body (Object, nil)
  • unwrap (Symbol, Integer, Array<Symbol, Integer>, Proc, nil)
  • page (Class<Anthropic::Internal::Type::BasePage>, nil)
  • stream (Class<Anthropic::Internal::Type::BaseStream>, nil)
  • model (Anthropic::Internal::Type::Converter, Class, nil)
  • options (Anthropic::RequestOptions, Hash{Symbol=>Object}, nil) —

    .

    @option options [String, nil] :idempotency_key

    @option options [HashString, nil, nil] :extra_query

    @option options [Hashnil, nil] :extra_headers

    @option options [Object, nil] :extra_body

    @option options [Integer, nil] :max_retries

    @option options [Float, nil] :timeout

Returns:

  • (Object)

Raises:



676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
 
# File 'lib/anthropic/internal/transport/base_client.rb', line 676

def request(req)
  self.class.validate!(req)
  model = req.fetch(:model) { Anthropic::Internal::Type::Unknown }
  opts = req[:options].to_h
  unwrap = req[:unwrap]
  Anthropic::RequestOptions.validate!(opts)
  request = build_request(req.except(:options), opts)
  url = request.fetch(:url)

  # Don't send the current retry count in the headers if the caller modified the header defaults.
  send_retry_header = request.fetch(:headers)["x-stainless-retry-count"] == "0"
  status, response, headers, stream = send_request(
    request,
    redirect_count: 0,
    retry_count: 0,
    send_retry_header: send_retry_header
  )

  decoded = Anthropic::Internal::Util.decode_content(headers, stream: stream)
  case req
  in {stream: Class => st}
    st.new(
      model: model,
      url: url,
      status: status,
      headers: headers,
      response: response,
      unwrap: unwrap,
      stream: decoded
    )
  in {page: Class => page}
    page.new(client: self, req: req, headers: headers, page_data: decoded)
  else
    unwrapped = Anthropic::Internal::Util.dig(decoded, unwrap)
    Anthropic::Internal::Type::Converter.coerce(model, unwrapped)
  end
end

#retry_request?(status, headers:) ⇒ Boolean

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:

  • status (Integer)
  • headers (Hash{String=>String})

Returns:



414
415
416
 
# File 'lib/anthropic/internal/transport/base_client.rb', line 414

def retry_request?(status, headers:)
  self.class.should_retry?(status, headers: headers)
end

#send_request(request, redirect_count:, retry_count:, send_retry_header:) ⇒ Array(Integer, Net::HTTPResponse|nil, Hash{String=>String}, Enumerable<String>)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:

  • request (Hash{Symbol=>Object}) —

    .

    @option request [Symbol] :method

    @option request [URI::Generic] :url

    @option request [HashString=>String] :headers

    @option request [Object] :body

    @option request [Integer] :max_retries

    @option request [Float] :timeout

  • redirect_count (Integer)
  • retry_count (Integer)
  • send_retry_header (Boolean)

Returns:

  • (Array(Integer, Net::HTTPResponse|nil, Hash{String=>String}, Enumerable<String>))

Raises:



464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
 
# File 'lib/anthropic/internal/transport/base_client.rb', line 464

def send_request(request, redirect_count:, retry_count:, send_retry_header:)
  if send_retry_header
    request.fetch(:headers)["x-stainless-retry-count"] = retry_count.to_s
  end

  url, max_retries, timeout = request.fetch_values(:url, :max_retries, :timeout)

  # Request-level middleware (from `request_options`) runs innermost
  # among user middleware — below client-level entries, above the
  # provider middleware.
  request_middleware = request.fetch(:middleware, [])

  # Per-attempt defensive copies: the `request` hash and its members are
  # reused across retry recursions (the SDK mutates `request[:headers]`
  # for retry-count/auth stamping), so the immutable view middleware sees
  # must not alias them. With no user middleware at all only the terminal
  # and the provider middleware read these (both are pure), so the deep
  # freeze is skipped. Only `headers` change across retries, so the frozen
  # `url`/`body`/`options` copies are cached on `request` and reused; the
  # redirect path drops the stale `url`/`body` copies. `metadata` is the
  # deliberate exception — it is the cross-attempt scratchpad a middleware
  # may write to.
  user_middleware_empty = @middleware.empty? && request_middleware.empty?
  freeze = user_middleware_empty ? ->(o) { o } : Anthropic::Internal::Util.method(:deep_frozen_copy)
  api_req = Anthropic::APIRequest.new(
    method: request.fetch(:method),
    url: (request[:frozen_url] ||= freeze.call(url)),
    headers: freeze.call(request.fetch(:headers)),
    body: (request[:frozen_body] ||= freeze.call(request[:body])),
    stream: request[:stream],
    cast_to: request[:cast_to],
    unwrap: request[:unwrap],
    options: (
      request[:frozen_options] ||= freeze.call(request.fetch(:options, {}).merge(timeout: timeout))
    ),
    retry_count: retry_count,
    metadata: request.fetch(:metadata, {})
  )

  # The provider request the response actually came from — captured
  # inside the terminal so error reporting, relative-redirect
  # resolution, and redirect re-sends see the post-`provider_middleware`
  # (Bedrock/Vertex) URL and body, not the canonical `/v1/messages`
  # shape. Falls back to the canonical values when middleware
  # short-circuits before `nxt.call`.
  adapted_url = url
  adapted_body = request[:body]
  attempt_body = nil
  attempt_headers = nil
  terminal = lambda do |r|
    adapted_url = r.url
    adapted_body = r.body
    enc_headers, encoded = Anthropic::Internal::Util.encode_content(r.headers, r.body)
    input = {
      method: r.method,
      url: r.url,
      headers: enc_headers,
      body: encoded,
      deadline: Anthropic::Internal::Util.monotonic_secs + timeout
    }
    http_status, raw, body = @requester.execute(input)
    attempt_body = body
    res = Anthropic::APIResponse.wrap(http_status, raw, body, request: r)
    attempt_headers = res.headers
    res
  end

  begin
    chain = Anthropic::Middleware.build_chain(
      [*@middleware, *request_middleware, *provider_middleware],
      terminal
    )
    mres = chain.call(api_req)
    unless mres.is_a?(Anthropic::APIResponse)
      raise TypeError,
            "middleware returned #{mres.class}, expected Anthropic::APIResponse"
    end
    status, response, headers, stream = mres.to_tuple
  rescue StandardError => e
    # A middleware may raise after `nxt.call` returned a live response
    # (e.g. `raise RetryableError if res.status >= 500`); release the
    # pooled connection its un-consumed body still holds.
    Anthropic::Internal::Util.close_fused!(attempt_body)
    raise unless retryable_error?(e)
    status = e
    # A middleware may raise after observing a live response (e.g. a 429
    # carrying `Retry-After`); keep that response's headers so retry
    # backoff still honors server-driven delay. `nil` when the terminal
    # itself raised — a connection failure carries no response.
    headers = attempt_headers || {}
  end

  case status
  in ..299
    [status, response, headers, stream]
  in 300..399 if redirect_count >= self.class::MAX_REDIRECTS
    self.class.reap_connection!(status, stream: stream)

    message = "Failed to complete the request within #{self.class::MAX_REDIRECTS} redirects."
    raise Anthropic::Errors::APIConnectionError.new(
      url: adapted_url,
      response: response,
      message: message
    )
  in 300..399
    self.class.reap_connection!(status, stream: stream)

    # Re-send the provider-adapted body: the redirect target is a
    # provider URL that fails the provider middleware's adapt gate, so
    # the canonical body would otherwise go out un-adapted on
    # Bedrock/Vertex. A SigV4-signed `StringIO` body was consumed by
    # the prior attempt and must be rewound before re-signing.
    adapted_body.rewind if adapted_body.is_a?(StringIO) || adapted_body.is_a?(IO)
    request = self.class.follow_redirect(
      request.merge(url: adapted_url, body: adapted_body),
      status: status,
      response_headers: headers
    )
    # The redirect retargets the URL, and `follow_redirect` may drop the
    # body (303 → GET); the cached frozen copies would then be stale, so
    # they are recomputed on the redirected attempt.
    request.delete(:frozen_body)
    request.delete(:frozen_url)
    send_request(
      request,
      redirect_count: redirect_count + 1,
      retry_count: retry_count,
      send_retry_header: send_retry_header
    )
  in Exception if retry_count >= max_retries
    raise status
  in (400..) if retry_count >= max_retries || !retry_request?(status, headers: headers)
    decoded = Kernel.then do
      Anthropic::Internal::Util.decode_content(headers, stream: stream, suppress_error: true)
    ensure
      self.class.reap_connection!(status, stream: stream)
    end

    raise Anthropic::Errors::APIStatusError.for(
      url: adapted_url,
      status: status,
      headers: headers,
      body: decoded,
      request: nil,
      response: response
    )
  in (400..) | Exception
    self.class.reap_connection!(status, stream: stream)

    delay = retry_delay(headers, retry_count: retry_count)
    sleep(delay)

    # Refresh auth headers across retries: credential providers (e.g. OAuth
    # token caches invalidated by a 401) may return a different token now
    # than at initial build_request time. Skip keys the caller supplied so
    # per-request overrides aren't clobbered.
    user_keys = request.fetch(:user_header_keys, [])

    auth_headers.each do |k, v|
      k_norm = k.to_s.downcase
      next if user_keys.include?(k_norm)
      request.fetch(:headers)[k_norm] = v.to_s.strip
    end

    send_request(
      request,
      redirect_count: redirect_count,
      retry_count: retry_count + 1,
      send_retry_header: send_retry_header
    )
  end
end