Class: Jets::Application

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

Defined Under Namespace

Modules: Middleware

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

#assemble_app, #call

Class Method Details

.default_iam_policyObject



148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
# File 'lib/jets/application.rb', line 148

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

#awsObject



217
218
219
# File 'lib/jets/application.rb', line 217

def aws
  Jets::AwsInfo.new
end

#configObject

Default config



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
# File 'lib/jets/application.rb', line 27

def config
  config = ActiveSupport::OrderedOptions.new

  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 = [
    'https://gems.lambdagems.com'
  ]

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

  config.assets = ActiveSupport::OrderedOptions.new
  config.assets.folders = %w[public]
  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.ruby.lazy_load = true # also set in config/environments files

  config
end

#configure(&block) ⇒ Object



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

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

#eval_app_configObject



98
99
100
101
# File 'lib/jets/application.rb', line 98

def eval_app_config
  app_config = "#{Jets.root}config/application.rb"
  load app_config if File.exist?(app_config)
end

#internal_autoload_pathsObject



66
67
68
69
70
71
72
73
74
# File 'lib/jets/application.rb', line 66

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_configObject

First time loading this might not have all the values. Some values like project_namespace depend on project_name. Loading the config twice resolves the chicken and egg problem here.



88
89
90
91
92
93
94
95
96
# File 'lib/jets/application.rb', line 88

def load_app_config
  eval_app_config
  # Normalize config and setup some shortcuts
  set_dependent_configs! # things like project_namespace that need project_name
  eval_app_config # twice to fix values that rely on the dependent configs

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

#load_configsObject



76
77
78
79
80
81
82
83
# File 'lib/jets/application.rb', line 76

def load_configs
  # The Jets default/application.rb is loaded.
  load File.expand_path("../default/application.rb", __FILE__)
  # Then project config/application.rb is loaded.
  load_app_config
  load_db_config
  load_environments_config
end

#load_db_configObject



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

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_configObject



103
104
105
106
107
108
109
# File 'lib/jets/application.rb', line 103

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_inflectionsObject



22
23
24
# File 'lib/jets/application.rb', line 22

def load_inflections
  Jets::Inflections.load!
end

#load_routesObject



212
213
214
215
# File 'lib/jets/application.rb', line 212

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.



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

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

#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.



144
145
146
# File 'lib/jets/application.rb', line 144

def reload_configs!
  load_configs
end

#routesObject

Naming it routes because config/routes.rb requires

Jets.application.routes.draw do

for scaffolding to work.



208
209
210
# File 'lib/jets/application.rb', line 208

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

#set_dependent_configs!Object



123
124
125
126
127
128
129
130
131
132
133
134
# File 'lib/jets/application.rb', line 123

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_policyObject



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

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

#setup!Object



15
16
17
18
19
20
# File 'lib/jets/application.rb', line 15

def setup!
  load_configs # load config object so following methods can use it
  load_inflections
  setup_auto_load_paths
  load_routes
end

#setup_auto_load_pathsObject



58
59
60
61
62
63
64
# File 'lib/jets/application.rb', line 58

def setup_auto_load_paths
  autoload_paths = config.autoload_paths + config.extra_autoload_paths
  autoload_paths = autoload_paths.uniq.map { |p| "#{Jets.root}#{p}" }
  # internal_autoload_paths are last
  autoload_paths += internal_autoload_paths
  ActiveSupport::Dependencies.autoload_paths += autoload_paths
end