Class: Jets::Application

Inherits:
Object
  • Object
show all
Extended by:
Memoist
Includes:
Middleware, Singleton
Defined in:
lib/jets/application.rb

Constant Summary collapse

ENV_MAP =

Use the shorter name in stack names, but use the full name when it comes to checking for the env.

Example:

Jets.env: 'development'
Jets.config.project_namespace: 'demo-dev'

{
  development: 'dev',
  production: 'prod',
  staging: 'stag',
}

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Middleware

#build_stack, #call, #config_middleware, #default_stack, #endpoint, #middlewares

Class Method Details

.default_iam_policy ⇒ Object 



234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'lib/jets/application.rb', line 234

def self.default_iam_policy
  project_namespace = Jets.project_namespace
  logs = {
    action: ["logs:*"],
    effect: "Allow",
    resource: "arn:aws:logs:#{Jets.aws.region}:#{Jets.aws.}:log-group:/aws/lambda/#{project_namespace}-*",
  }
  s3_bucket = Jets.aws.s3_bucket
  s3_readonly = {
    action: ["s3:Get*", "s3:List*"],
    effect: "Allow",
    resource: "arn:aws:s3:::#{s3_bucket}*",
  }
  s3_bucket = {
    action: ["s3:ListAllMyBuckets", "s3:HeadBucket"],
    effect: "Allow",
    resource: "arn:aws:s3:::*", # scoped to all buckets
  }
  policies = [logs, s3_readonly, s3_bucket]

  if Jets::Stack.has_resources?
    cloudformation = {
      action: ["cloudformation:DescribeStacks"],
      effect: "Allow",
      resource: "arn:aws:cloudformation:#{Jets.aws.region}:#{Jets.aws.}:stack/#{project_namespace}*",
    }
    policies << cloudformation
  end
  policies
end

Instance Method Details

#aws ⇒ Object 



303
304
305
 
# File 'lib/jets/application.rb', line 303

def aws
  Jets::AwsInfo.new
end

#config ⇒ Object 



28
29
30
 
# File 'lib/jets/application.rb', line 28

def config
  @config ||= ActiveSupport::OrderedOptions.new # dont use memoize since we reset @config later
end

#configure(&block) ⇒ Object 



10
11
12
 
# File 'lib/jets/application.rb', line 10

def configure(&block)
  instance_eval(&block) if block
end

#default_autoload_paths ⇒ Object

Essentially folders under app folder will be the default_autoload_paths. Example:

app/controllers
app/helpers
app/jobs
app/models
app/rules
app/shared/resources



181
182
183
184
185
186
187
188
 
# File 'lib/jets/application.rb', line 181

def default_autoload_paths
  paths = []
  Dir.glob("#{Jets.root}/app/*").each do |p|
    p.sub!('./','')
    paths << p unless exclude_autoload_path?(p)
  end
  paths
end

#default_config ⇒ Object 



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
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/jets/application.rb', line 32

def default_config
  config = ActiveSupport::OrderedOptions.new
  config.project_name = parse_project_name # must set early because other configs requires this
  config.cors = false
  config.autoload_paths = default_autoload_paths
  config.extra_autoload_paths = []
  config.logger = Jets::Logger.new($stderr)

  # function properties defaults
  config.function = ActiveSupport::OrderedOptions.new
  config.function.timeout = 30
  # default memory setting based on:
  # https://medium.com/epsagon/how-to-make-lambda-faster-memory-performance-benchmark-be6ebc41f0fc
  config.function.memory_size = 1536

  config.prewarm = ActiveSupport::OrderedOptions.new
  config.prewarm.enable = true
  config.prewarm.rate = '30 minutes'
  config.prewarm.concurrency = 2
  config.prewarm.public_ratio = 3
  config.prewarm.rack_ratio = 5

  config.gems = ActiveSupport::OrderedOptions.new
  config.gems.sources = [
    Jets.default_gems_source
  ]

  config.inflections = ActiveSupport::OrderedOptions.new
  config.inflections.irregular = {}

  config.assets = ActiveSupport::OrderedOptions.new
  config.assets.folders = %w[assets images packs]
  config.assets.base_url = nil # IE: https://cloudfront.com/my/base/path
  config.assets.max_age = 3600
  config.assets.cache_control = nil # IE: public, max-age=3600 , max_age is a shorter way to set cache_control.

  config.ruby = ActiveSupport::OrderedOptions.new

  config.middleware = Jets::Middleware::Configurator.new

  config.session = ActiveSupport::OrderedOptions.new
  config.session.store = Rack::Session::Cookie # note when accessing it use session[:store] since .store is an OrderedOptions method
  config.session.options = {}

  config.api = ActiveSupport::OrderedOptions.new
  config.api.authorization_type = "NONE"
  config.api.cors_authorization_type = nil # nil so ApiGateway::Cors#cors_authorization_type handles
  config.api.binary_media_types = ['multipart/form-data']
  config.api.endpoint_type = 'EDGE' # PRIVATE, EDGE, REGIONAL

  config.domain = ActiveSupport::OrderedOptions.new
  # config.domain.name = "#{Jets.project_namespace}.coolapp.com" # Default is nil
  # config.domain.cert_arn = "..."
  config.domain.endpoint_type = "REGIONAL" # EDGE or REGIONAL. Default to EDGE because CloudFormation update is faster
  config.domain.route53 = true # controls whether or not to create the managed route53 record.
    # Useful to disable this when user wants to manage the route themself like pointing
    # it to CloudFront for blue-green deployments instead.

  # Custom user lambda layers
  config.lambda = ActiveSupport::OrderedOptions.new
  config.lambda.layers = []

  # Only used for Jets Afterburner, Mega Mode currently. This is a fallback default
  # encoding.  Usually, the Rails response will return a content-type header and
  # the encoding in there is used when possible. Example Content-Type header:
  #   Content-Type    text/html; charset=utf-8
  config.encoding = ActiveSupport::OrderedOptions.new
  config.encoding.default = "utf-8"

  config
end

#deprecated_configs_message ⇒ Object 



156
157
158
159
160
161
162
163
164
165
 
# File 'lib/jets/application.rb', line 156

def deprecated_configs_message
  unless config.ruby.lazy_load.nil?
    puts "Detected config.ruby.lazy_load = #{config.ruby.lazy_load.inspect}".color(:yellow)
    puts "Deprecated: config.ruby.lazy_load".color(:yellow)
    puts "Gems are now bundled with with Lambda Layer and there's no need to lazy load them."
    puts "Please remove the config in your config/application.rb or config/environments files."
    puts "You can have Jets automatically do this by running:"
    puts "  jets upgrade"
  end
end

#eval_app_config ⇒ Object 



129
130
131
132
 
# File 'lib/jets/application.rb', line 129

def eval_app_config
  app_config = "#{Jets.root}/config/application.rb"
  load app_config # use load instead of require so reload_configs! works
end

#exclude_autoload_path?(path) ⇒ Boolean

Returns:

  • (Boolean) 


190
191
192
 
# File 'lib/jets/application.rb', line 190

def exclude_autoload_path?(path)
  path =~ %r{app/javascript} || path =~ %r{app/views}
end

#finish! ⇒ Object 



18
19
20
21
22
 
# File 'lib/jets/application.rb', line 18

def finish!
  load_inflections
  setup_auto_load_paths
  load_routes
end

#internal_autoload_paths ⇒ Object 



194
195
196
197
198
199
200
201
202
 
# File 'lib/jets/application.rb', line 194

def internal_autoload_paths
  internal = File.expand_path("../internal", __FILE__)
  paths = %w[
    app/controllers
    app/models
    app/jobs
  ]
  paths.map { |path| "#{internal}/#{path}" }
end

#load_app_config ⇒ Object 



119
120
121
122
123
124
125
126
127
 
# File 'lib/jets/application.rb', line 119

def load_app_config
  @config = default_config
  set_dependent_configs! # things like project_namespace that need project_name
  eval_app_config # this overwrites Jets.config.project_name
  Jets.config.project_name = parse_project_name # Must set again because JETS_PROJECT_NAME is possible

  set_iam_policy # relies on dependent values, must be called afterwards
  normalize_env_vars!
end

#load_configs ⇒ Object 



149
150
151
152
153
154
 
# File 'lib/jets/application.rb', line 149

def load_configs
  load_app_config
  load_db_config
  load_environments_config
  deprecated_configs_message
end

#load_db_config ⇒ Object 



277
278
279
280
281
282
283
284
285
286
287
 
# File 'lib/jets/application.rb', line 277

def load_db_config
  config.database = {}

  Jets::Dotenv.load!
  database_yml = "#{Jets.root}/config/database.yml"
  if File.exist?(database_yml)
    text = Jets::Erb.result(database_yml)
    db_config = YAML.load(text)
    config.database = db_config
  end
end

#load_environments_config ⇒ Object 



141
142
143
144
145
146
147
 
# File 'lib/jets/application.rb', line 141

def load_environments_config
  env_file = "#{Jets.root}/config/environments/#{Jets.env}.rb"
  if File.exist?(env_file)
    code = IO.read(env_file)
    instance_eval(code)
  end
end

#load_inflections ⇒ Object 



24
25
26
 
# File 'lib/jets/application.rb', line 24

def load_inflections
  Jets::Inflections.load!
end

#load_routes ⇒ Object 



298
299
300
301
 
# File 'lib/jets/application.rb', line 298

def load_routes
  routes_file = "#{Jets.root}/config/routes.rb"
  require routes_file if File.exist?(routes_file)
end

#normalize_env_vars! ⇒ Object

It is pretty easy to attempt to set environment variables without the correct AWS Environment.Variables path struture. Auto-fix it for convenience.



268
269
270
271
272
273
274
275
 
# File 'lib/jets/application.rb', line 268

def normalize_env_vars!
  environment = config.function.environment
  if environment and !environment.to_h.key?(:variables)
    config.function.environment = {
      variables: environment.to_h
    }
  end
end

#parse_project_name ⇒ Object

Double evaling config/application.rb causes subtle issues:

* double loading of shared resources: Jets::Stack.subclasses will have the same
class twice when config is called when declaring a function
* forces us to rescue all exceptions, which is a big hammer

Lets parse for the project name instead for now.



111
112
113
114
115
116
117
 
# File 'lib/jets/application.rb', line 111

def parse_project_name
  return ENV['JETS_PROJECT_NAME'] if ENV['JETS_PROJECT_NAME'] # override

  lines = IO.readlines("#{Jets.root}/config/application.rb")
  project_name_line = lines.find { |l| l =~ /config\.project_name.*=/ }
  project_name_line.gsub(/.*=/,'').strip.gsub(/["']/,'') # project_name
end

#reload_configs! ⇒ Object

After the mimimal template gets build, we need to reload it for the full stack creation. This allows us to reference IAM policies configs that depend on the creation of the s3 bucket.



137
138
139
 
# File 'lib/jets/application.rb', line 137

def reload_configs!
  load_configs
end

#routes ⇒ Object

Naming it routes because config/routes.rb requires

Jets.application.routes.draw do

for scaffolding to work.



294
295
296
 
# File 'lib/jets/application.rb', line 294

def routes
  @router ||= Jets::Router.new
end

#set_dependent_configs! ⇒ Object 



216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/jets/application.rb', line 216

def set_dependent_configs!
  # env_extra can be also be set with JETS_ENV_EXTRA.
  # JETS_ENV_EXTRA higher precedence than config.env_extra
  config.env_extra = ENV['JETS_ENV_EXTRA'] if ENV['JETS_ENV_EXTRA']
  # IE: With env_extra: project-dev-1
  #     Without env_extra: project-dev
  config.short_env = ENV_MAP[Jets.env.to_sym] || Jets.env
  # table_namespace does not have the env_extra, more common case desired.
  config.table_namespace = [config.project_name, config.short_env].compact.join('-')

  config.project_namespace = Jets.project_namespace
end

#set_iam_policy ⇒ Object 



229
230
231
232
 
# File 'lib/jets/application.rb', line 229

def set_iam_policy
  config.iam_policy ||= self.class.default_iam_policy
  config.managed_policy_definitions ||= [] # default empty
end

#setup! ⇒ Object 



14
15
16
 
# File 'lib/jets/application.rb', line 14

def setup!
  load_configs
end

#setup_auto_load_paths ⇒ Object 



167
168
169
170
171
172
 
# File 'lib/jets/application.rb', line 167

def setup_auto_load_paths
  autoload_paths = config.autoload_paths + config.extra_autoload_paths
  # internal_autoload_paths are last
  autoload_paths += internal_autoload_paths
  ActiveSupport::Dependencies.autoload_paths += autoload_paths
end