File: refreshing_token.rb

package info (click to toggle)
ruby-aws-sdk-core 3.212.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,232 kB
  • sloc: ruby: 17,533; makefile: 4
file content (71 lines) | stat: -rw-r--r-- 1,605 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
# frozen_string_literal: true

require 'thread'

module Aws

  # Module/mixin used by token provider classes that can be refreshed. This
  # provides basic refresh logic in a thread-safe manner. Classes mixing in
  # this module are expected to implement a #refresh method that populates
  # the following instance variable:
  #
  # * `@token` [Token] - {Aws::Token} object with the `expiration` and `token`
  #       fields set.
  #
  # @api private
  module RefreshingToken

    def initialize(options = {})
      @mutex = Mutex.new
      @before_refresh = options.delete(:before_refresh) if Hash === options

      @before_refresh.call(self) if @before_refresh
      refresh
    end

    # @return [Token]
    def token
      refresh_if_near_expiration
      @token
    end

    # @return [Time,nil]
    def expiration
      refresh_if_near_expiration
      @expiration
    end

    # Refresh token.
    # @return [void]
    def refresh!
      @mutex.synchronize do
        @before_refresh.call(self) if @before_refresh
        refresh
      end
    end

    private

    # Refreshes token if it is within
    # 5 minutes of expiration.
    def refresh_if_near_expiration
      if near_expiration?
        @mutex.synchronize do
          if near_expiration?
            @before_refresh.call(self) if @before_refresh
            refresh
          end
        end
      end
    end

    def near_expiration?
      if @token && @token.expiration
        # are we within 5 minutes of expiration?
        (Time.now.to_i + 5 * 60) > @token.expiration.to_i
      else
        true
      end
    end
  end
end