-
Notifications
You must be signed in to change notification settings - Fork 3.3k
/
compile.app.ex
422 lines (337 loc) · 13.6 KB
/
compile.app.ex
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
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
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
147
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
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
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
232
233
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
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
defmodule Mix.Tasks.Compile.App do
use Mix.Task.Compiler
@recursive true
@moduledoc """
Writes an .app file.
An `.app` file is a file containing Erlang terms that defines
your application. Mix automatically generates this file based on
your `mix.exs` configuration.
In order to generate the `.app` file, Mix expects your project
to have both `:app` and `:version` keys. Furthermore, you can
configure the generated application by defining an `application/0`
function in your `mix.exs` that returns a keyword list.
The most commonly used keys are:
* `:extra_applications` - a list of OTP applications
your application depends on which are not included in `:deps`
(usually defined in `deps/0` in your `mix.exs`). For example,
here you can declare a dependency on applications that ship
with Erlang/OTP or Elixir, like `:crypto` or `:logger`.
Optional extra applications can be declared as a tuple, such
as `{:ex_unit, :optional}`. Mix guarantees all non-optional
applications are started before your application starts.
* `:registered` - the name of all registered processes in the
application. If your application defines a local GenServer
with name `MyServer`, it is recommended to add `MyServer`
to this list. It is most useful in detecting conflicts
between applications that register the same names.
* `:env` - the default values for the application environment.
The application environment is one of the most common ways
to configure applications. See the `Application` module for
mechanisms to read and write to the application environment.
For example:
def application do
[
extra_applications: [:logger, :crypto, ex_unit: :optional],
env: [key: :value],
registered: [MyServer]
]
end
Other options include:
* `:applications` - all applications your application depends
on at runtime. By default, this list is automatically inferred
from your dependencies. Mix and other tools use the application
list in order to start your dependencies before starting the
application itself.
* `:mod` - specifies a module to invoke when the application
is started. It must be in the format `{Mod, args}` where
args is often an empty list. The module specified must
implement the callbacks defined by the `Application`
module.
* `:start_phases` - specifies a list of phases and their arguments
to be called after the application is started. See the "Phases"
section below.
* `:included_applications` - specifies a list of applications
that will be included in the application. It is the responsibility of
the primary application to start the supervision tree of all included
applications, as only the primary application will be started. A process
in an included application considers itself belonging to the
primary application.
* `:maxT` - specifies the maximum time the application is allowed to run, in
milliseconds. Applications are stopped if `:maxT` is reached, and their
top-level supervisor terminated with reason `:normal`. This threshold is
technically valid in any resource file, but it is only effective for
applications with a callback module. Defaults to `:infinity`.
Besides the options above, `.app` files also expect other options like
`:modules` and `:vsn`, but these are automatically added by Mix.
## Command line options
* `--force` - forces compilation regardless of modification times
* `--compile-path` - where to find `.beam` files and write the
resulting `.app` file, defaults to `Mix.Project.compile_path/0`
## Phases
Applications provide a start phases mechanism which will be called,
in order, for the application and all included applications. If a phase
is not defined for an included application, that application is skipped.
Let's see an example `MyApp.application/0` function:
def application do
[
start_phases: [init: [], go: [], finish: []],
included_applications: [:my_included_app]
]
end
And an example `:my_included_app` defines on its `mix.exs` the function:
def application do
[
mod: {MyIncludedApp, []},
start_phases: [go: []]
]
end
In this example, the order that the application callbacks are called in is:
Application.start(MyApp)
MyApp.start(:normal, [])
MyApp.start_phase(:init, :normal, [])
MyApp.start_phase(:go, :normal, [])
MyIncludedApp.start_phase(:go, :normal, [])
MyApp.start_phase(:finish, :normal, [])
"""
@impl true
def run(args) do
{opts, _, _} = OptionParser.parse(args, switches: [force: :boolean, compile_path: :string])
project = Mix.Project.get!()
config = Mix.Project.config()
app = Keyword.get(config, :app)
version = Keyword.get(config, :version)
validate_app(app)
validate_version(version)
path = Keyword.get_lazy(opts, :compile_path, &Mix.Project.compile_path/0)
modules = modules_from(Path.wildcard("#{path}/*.beam")) |> Enum.sort()
target = Path.join(path, "#{app}.app")
sources = [Mix.Project.config_mtime(), Mix.Project.project_file()]
current_properties = current_app_properties(target)
compile_env = load_compile_env(current_properties)
if opts[:force] || Mix.Utils.stale?(sources, [target]) ||
app_changed?(current_properties, modules, compile_env) do
properties =
[
description: to_charlist(config[:description] || app),
modules: modules,
registered: [],
vsn: to_charlist(version)
]
|> merge_project_application(project)
|> validate_properties!()
|> handle_extra_applications(config)
|> add_compile_env(compile_env)
contents = :io_lib.format("~p.~n", [{:application, app, properties}])
Mix.Project.ensure_structure()
File.write!(target, IO.chardata_to_string(contents))
Mix.shell().info("Generated #{app} app")
{:ok, []}
else
{:noop, []}
end
end
defp current_app_properties(target) do
case :file.consult(target) do
{:ok, [{:application, _app, properties}]} -> properties
_ -> []
end
end
defp load_compile_env(current_properties) do
case Mix.ProjectStack.compile_env(nil) do
nil -> Keyword.get(current_properties, :compile_env, [])
list -> list
end
end
defp app_changed?(properties, mods, compile_env) do
Keyword.get(properties, :modules, []) != mods or
Keyword.get(properties, :compile_env, []) != compile_env
end
defp validate_app(app) when is_atom(app), do: :ok
defp validate_app(app) do
ensure_present(:app, app)
Mix.raise("Expected :app to be an atom, got: #{inspect(app)}")
end
defp validate_version(version) do
ensure_present(:version, version)
unless is_binary(version) and match?({:ok, _}, Version.parse(version)) do
Mix.raise(
"Expected :version to be a valid Version, got: #{inspect(version)} (see the Version module for more information)"
)
end
end
defp ensure_present(name, nil) do
Mix.raise("Please ensure mix.exs file has the #{inspect(name)} in the project definition")
end
defp ensure_present(_name, _val), do: :ok
defp modules_from(beams) do
Enum.map(beams, &(&1 |> Path.basename() |> Path.rootname(".beam") |> String.to_atom()))
end
defp merge_project_application(best_guess, project) do
if function_exported?(project, :application, 0) do
project_application = project.application()
unless Keyword.keyword?(project_application) do
Mix.raise(
"Application configuration returned from application/0 should be a keyword list"
)
end
Keyword.merge(best_guess, project_application)
else
best_guess
end
end
defp validate_properties!(properties) do
Enum.each(properties, fn
{:description, value} ->
unless is_list(value) do
Mix.raise(
"Application description (:description) is not a character list, got: " <>
inspect(value)
)
end
{:id, value} ->
unless is_list(value) do
Mix.raise("Application ID (:id) is not a character list, got: " <> inspect(value))
end
{:vsn, value} ->
unless is_list(value) do
Mix.raise("Application vsn (:vsn) is not a character list, got: " <> inspect(value))
end
{:maxT, value} ->
unless value == :infinity or is_integer(value) do
Mix.raise(
"Application maximum time (:maxT) is not an integer or :infinity, got: " <>
inspect(value)
)
end
{:modules, value} ->
unless is_list(value) and Enum.all?(value, &is_atom(&1)) do
Mix.raise(
"Application modules (:modules) should be a list of atoms, got: " <> inspect(value)
)
end
{:registered, value} ->
unless is_list(value) and Enum.all?(value, &is_atom(&1)) do
Mix.raise(
"Application registered processes (:registered) should be a list of atoms, got: " <>
inspect(value)
)
end
{:included_applications, value} ->
unless is_list(value) and Enum.all?(value, &is_atom(&1)) do
Mix.raise(
"Application included applications (:included_applications) should be a list of atoms, got: " <>
inspect(value)
)
end
{:extra_applications, value} ->
unless is_list(value) and Enum.all?(value, &typed_app?(&1)) do
Mix.raise(
"Application extra applications (:extra_applications) should be a list of atoms or " <>
"{app, :required | :optional} pairs, got: " <> inspect(value)
)
end
{:applications, value} ->
unless is_list(value) and Enum.all?(value, &typed_app?(&1)) do
Mix.raise(
"Application applications (:applications) should be a list of atoms or " <>
"{app, :required | :optional} pairs, got: " <> inspect(value)
)
end
{:env, value} ->
unless Keyword.keyword?(value) do
Mix.raise(
"Application environment (:env) should be a keyword list, got: " <> inspect(value)
)
end
{:start_phases, value} ->
unless Keyword.keyword?(value) do
Mix.raise(
"Application start phases (:start_phases) should be a keyword list, got: " <>
inspect(value)
)
end
{:mod, []} ->
:ok
{:mod, {module, _args}} when is_atom(module) ->
:ok
{:mod, value} ->
Mix.raise(
"Application callback module (:mod) should be either [] or {module, start_args}, got: " <>
inspect(value)
)
_ ->
:ok
end)
properties
end
defp typed_app?(app) when is_atom(app), do: true
defp typed_app?({app, type}) when is_atom(app) and type in [:required, :optional], do: true
defp typed_app?(_), do: false
defp add_compile_env(properties, []), do: properties
defp add_compile_env(properties, compile_env), do: [compile_env: compile_env] ++ properties
defp handle_extra_applications(properties, config) do
{extra, properties} = Keyword.pop(properties, :extra_applications, [])
{all, optional} =
project_apps(properties, config, extra, fn ->
apps_from_runtime_prod_deps(properties, config)
end)
properties
|> Keyword.put(:applications, all)
|> Keyword.put(:optional_applications, optional)
end
defp apps_from_runtime_prod_deps(properties, config) do
included_applications = Keyword.get(properties, :included_applications, [])
for {app, opts} <- deps_opts(config),
runtime_app?(opts),
app not in included_applications,
do: {app, if(Keyword.get(opts, :optional, false), do: :optional, else: :required)}
end
defp runtime_app?(opts) do
Keyword.get(opts, :runtime, true) and Keyword.get(opts, :app, true) and matching_only?(opts) and
matching_target?(opts)
end
defp matching_only?(opts) do
case Keyword.fetch(opts, :only) do
{:ok, value} -> Mix.env() in List.wrap(value)
:error -> true
end
end
defp matching_target?(opts) do
case Keyword.fetch(opts, :targets) do
{:ok, value} -> Mix.target() in List.wrap(value)
:error -> true
end
end
defp deps_opts(config) do
for config_dep <- Keyword.get(config, :deps, []),
do: {elem(config_dep, 0), dep_opts(config_dep)}
end
defp dep_opts({_app, opts}) when is_list(opts), do: opts
defp dep_opts({_app, _req, opts}) when is_list(opts), do: opts
defp dep_opts(_), do: []
## Helpers for loading and manipulating apps
@doc false
def project_apps(properties, config, extra, deps_loader) do
apps = Keyword.get(properties, :applications) || deps_loader.()
{all, required, optional} = split_by_type(extra ++ apps)
all = Enum.uniq(language_apps(config) ++ Enum.reverse(all))
optional = Enum.uniq(Enum.reverse(optional -- required))
{all, optional}
end
defp split_by_type(apps) do
Enum.reduce(apps, {[], [], []}, fn
app, {all, required, optional} when is_atom(app) ->
{[app | all], [app | required], optional}
{app, :required}, {all, required, optional} ->
{[app | all], [app | required], optional}
{app, :optional}, {all, required, optional} ->
{[app | all], required, [app | optional]}
end)
end
defp language_apps(config) do
case Keyword.get(config, :language, :elixir) do
:elixir -> [:kernel, :stdlib, :elixir]
:erlang -> [:kernel, :stdlib]
end
end
end