Class: Fly::Configuration

Inherits:
Object
  • Object
show all
Defined in:
lib/fly-ruby/configuration.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Configuration

Returns a new instance of Configuration.



36
37
38
39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/fly-ruby/configuration.rb', line 36

def initialize
  self.primary_region = ENV["PRIMARY_REGION"]
  self.current_region = ENV["FLY_REGION"]
  self.replay_http_methods = ["POST", "PUT", "PATCH", "DELETE"]
  self.database_url_env_var = "DATABASE_URL"
  self.redis_url_env_var = "REDIS_URL"
  self.database_host_env_var = "DATABASE_HOST"
  self.database_port_env_var = "DATABASE_PORT"
  self.replay_threshold_cookie = "fly-replay-threshold"
  self.replay_threshold_in_seconds = 5
  self.database_url = ENV[database_url_env_var]
  self.redis_url = ENV[redis_url_env_var]
  self.replayable_exceptions = ["SQLite3::CantOpenException", "PG::ReadOnlySqlTransaction"]
end

Instance Attribute Details

#current_region ⇒ Object

Set the region where this instance of the application is deployed



6
7
8
 
# File 'lib/fly-ruby/configuration.rb', line 6

def current_region
  @current_region
end

#database_host_env_var ⇒ Object

Returns the value of attribute database_host_env_var.



18
19
20
 
# File 'lib/fly-ruby/configuration.rb', line 18

def database_host_env_var
  @database_host_env_var
end

#database_port_env_var ⇒ Object

Returns the value of attribute database_port_env_var.



19
20
21
 
# File 'lib/fly-ruby/configuration.rb', line 19

def database_port_env_var
  @database_port_env_var
end

#database_url ⇒ Object

Returns the value of attribute database_url.



30
31
32
 
# File 'lib/fly-ruby/configuration.rb', line 30

def database_url
  @database_url
end

#database_url_env_var ⇒ Object

Environment variables related to the database connection. These get by this middleware in secondary regions, so they must be interpolated rather than defined directly in the configuration.



17
18
19
 
# File 'lib/fly-ruby/configuration.rb', line 17

def database_url_env_var
  @database_url_env_var
end

#primary_region ⇒ Object

Set the region where the primary database lives, i.e “ams”



9
10
11
 
# File 'lib/fly-ruby/configuration.rb', line 9

def primary_region
  @primary_region
end

#redis_url ⇒ Object

Returns the value of attribute redis_url.



31
32
33
 
# File 'lib/fly-ruby/configuration.rb', line 31

def redis_url
  @redis_url
end

#redis_url_env_var ⇒ Object

Returns the value of attribute redis_url_env_var.



20
21
22
 
# File 'lib/fly-ruby/configuration.rb', line 20

def redis_url_env_var
  @redis_url_env_var
end

#replay_http_methods ⇒ Object

Automatically replay these HTTP methods in the primary region



12
13
14
 
# File 'lib/fly-ruby/configuration.rb', line 12

def replay_http_methods
  @replay_http_methods
end

#replay_threshold_cookie ⇒ Object

Cookie written and read by this middleware storing a UNIX timestamp. Requests arriving before this timestamp will be replayed in the primary region.



24
25
26
 
# File 'lib/fly-ruby/configuration.rb', line 24

def replay_threshold_cookie
  @replay_threshold_cookie
end

#replay_threshold_in_seconds ⇒ Object

How long, in seconds, should all requests from the same client be replayed in the primary region after a successful write replay



28
29
30
 
# File 'lib/fly-ruby/configuration.rb', line 28

def replay_threshold_in_seconds
  @replay_threshold_in_seconds
end

#replayable_exceptions ⇒ Object

An array of string representations of exceptions that should trigger a replay



34
35
36
 
# File 'lib/fly-ruby/configuration.rb', line 34

def replayable_exceptions
  @replayable_exceptions
end

Instance Method Details

#console? ⇒ Boolean

Is the current process a Rails console?

Returns:

  • (Boolean) 


111
112
113
 
# File 'lib/fly-ruby/configuration.rb', line 111

def console?
  defined?(::Rails::Console) && $stdout.isatty && $stdin.isatty
end

#database_uri ⇒ Object 



63
64
65
66
 
# File 'lib/fly-ruby/configuration.rb', line 63

def database_uri
  @database_uri ||= URI.parse(database_url)
  @database_uri
end

#eligible_for_activation? ⇒ Boolean

Returns:

  • (Boolean) 


102
103
104
 
# File 'lib/fly-ruby/configuration.rb', line 102

def eligible_for_activation?
  database_url && primary_region && current_region && web?
end

#in_secondary_region? ⇒ Boolean

Returns:

  • (Boolean) 


106
107
108
 
# File 'lib/fly-ruby/configuration.rb', line 106

def in_secondary_region?
  primary_region && primary_region != current_region
end

#module_exists?(module_name) ⇒ Boolean

Returns:

  • (Boolean) 


56
57
58
59
60
61
 
# File 'lib/fly-ruby/configuration.rb', line 56

def module_exists?(module_name)
  mod = Module.const_get(module_name)
  return mod
rescue NameError
  nil
end

#rake_task? ⇒ Boolean

Is the current process a rake task?

Returns:

  • (Boolean) 


116
117
118
 
# File 'lib/fly-ruby/configuration.rb', line 116

def rake_task?
  defined?(::Rake) && !Rake.application.top_level_tasks.empty?
end

#redis_uri ⇒ Object 



87
88
89
90
 
# File 'lib/fly-ruby/configuration.rb', line 87

def redis_uri
  @redis_uri ||= URI.parse(redis_url)
  @redis_uri
end

#regional_database_config ⇒ Object

Rails-compatible database configuration



79
80
81
82
83
84
85
 
# File 'lib/fly-ruby/configuration.rb', line 79

def regional_database_config
  {
    :host => regional_database_host,
    :port => 5433,
    :adapter => "postgresql"
  }
end

#regional_database_host ⇒ Object 



74
75
76
 
# File 'lib/fly-ruby/configuration.rb', line 74

def regional_database_host
  "#{current_region}.#{database_uri.hostname}"
end

#regional_database_url ⇒ Object 



68
69
70
71
72
 
# File 'lib/fly-ruby/configuration.rb', line 68

def regional_database_url
  uri = database_uri.dup
  uri.host = regional_database_host
  uri.to_s
end

#regional_redis_host ⇒ Object 



92
93
94
 
# File 'lib/fly-ruby/configuration.rb', line 92

def regional_redis_host
  "#{current_region}.#{redis_uri.hostname}"
end

#regional_redis_url ⇒ Object 



96
97
98
99
100
 
# File 'lib/fly-ruby/configuration.rb', line 96

def regional_redis_url
  uri = redis_uri.dup
  uri.host = regional_redis_host
  uri.to_s
end

#replayable_exception_classes ⇒ Object 



51
52
53
54
 
# File 'lib/fly-ruby/configuration.rb', line 51

def replayable_exception_classes
  @replayable_exception_classes ||= replayable_exceptions.collect {|ex| module_exists?(ex) }.compact
  @replayable_exception_classes
end

#web? ⇒ Boolean

Returns:

  • (Boolean) 


120
121
122
 
# File 'lib/fly-ruby/configuration.rb', line 120

def web?
  !console? && !rake_task?
end