-
-
Notifications
You must be signed in to change notification settings - Fork 317
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Igniter task for installing Oban (#1208)
Add single task igniter based installer to simplify getting started with Oban. The installer composes with other igniter tasks as well, so it's possible to install phoenix/ecto/ash/oban all at once.
- Loading branch information
Showing
6 changed files
with
294 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,182 @@ | ||
| defmodule Mix.Tasks.Oban.Install.Docs do | ||
| @moduledoc false | ||
|
|
||
| def short_doc do | ||
| "Install and configure Oban for use in an application." | ||
| end | ||
|
|
||
| def example do | ||
| "mix oban.install" | ||
| end | ||
|
|
||
| def long_doc do | ||
| """ | ||
| Install and configure Oban for use in an application. | ||
| ## Example | ||
| Install using the default Ecto repo and matching engine: | ||
| ```bash | ||
| mix oban.install | ||
| ``` | ||
| Specify a `SQLite3` repo and `Lite` engine explicitly: | ||
| ```bash | ||
| mix oban.install --repo MyApp.LiteRepo --engine Oban.Engines.Lite | ||
| ``` | ||
| ## Options | ||
| * `--engine` or `-e` — Select the engine for your repo, defaults to `Oban.Engines.Postgres` | ||
| * `--notifier` or `-n` — Select the pubsub notifier, defaults to `Oban.Notifiers.Postgres` | ||
| * `--repo` or `-r` — Specify an Ecto repo for Oban to use | ||
| """ | ||
| end | ||
| end | ||
|
|
||
| if Code.ensure_loaded?(Igniter) do | ||
| defmodule Mix.Tasks.Oban.Install do | ||
| @shortdoc __MODULE__.Docs.short_doc() | ||
|
|
||
| @moduledoc __MODULE__.Docs.long_doc() | ||
|
|
||
| use Igniter.Mix.Task | ||
|
|
||
| @impl Igniter.Mix.Task | ||
| def info(_argv, _composing_task) do | ||
| %Igniter.Mix.Task.Info{ | ||
| group: :oban, | ||
| adds_deps: [oban: "oban"], | ||
| installs: [], | ||
| example: __MODULE__.Docs.example(), | ||
| only: nil, | ||
| positional: [], | ||
| composes: [], | ||
| schema: [engine: :string, notifier: :string, repo: :string], | ||
| defaults: [], | ||
| aliases: [e: :engine, n: :notifier, r: :repo], | ||
| required: [] | ||
| } | ||
| end | ||
|
|
||
| @impl Igniter.Mix.Task | ||
| def igniter(igniter) do | ||
| app_name = Igniter.Project.Application.app_name(igniter) | ||
| opts = igniter.args.options | ||
|
|
||
| case extract_repo(igniter, app_name, opts[:repo]) do | ||
| {:ok, repo, adapter} -> | ||
| engine = parse_engine(adapter, opts[:engine]) | ||
| notifier = parse_notifier(adapter, opts[:notifier]) | ||
|
|
||
| conf_code = [engine: engine, notifier: notifier, queues: [default: 10], repo: repo] | ||
| test_code = [testing: :manual] | ||
|
|
||
| tree_code = | ||
| quote do | ||
| Application.fetch_env!(unquote(app_name), Oban) | ||
| end | ||
|
|
||
| migration = """ | ||
| use Ecto.Migration | ||
| def up, do: Oban.Migration.up() | ||
| def down, do: Oban.Migration.down(version: 1) | ||
| """ | ||
|
|
||
| igniter | ||
| |> Igniter.Project.Deps.add_dep({:oban, "~> 2.18"}) | ||
| |> Igniter.Project.Config.configure("config.exs", app_name, [Oban], {:code, conf_code}) | ||
| |> Igniter.Project.Config.configure("test.exs", app_name, [Oban], {:code, test_code}) | ||
| |> Igniter.Project.Application.add_new_child({Oban, {:code, tree_code}}, after: [repo]) | ||
| |> Igniter.Project.Formatter.import_dep(:oban) | ||
| |> Igniter.Libs.Ecto.gen_migration(repo, "add_oban", body: migration) | ||
|
|
||
| {:error, igniter} -> | ||
| igniter | ||
| end | ||
| end | ||
|
|
||
| defp extract_repo(igniter, app_name, nil) do | ||
| case Igniter.Libs.Ecto.list_repos(igniter) do | ||
| {igniter, [repo | _]} -> | ||
| {:ok, repo, extract_adapter(igniter, repo)} | ||
|
|
||
| _ -> | ||
| issue = """ | ||
| No ecto repos found for #{inspect(app_name)}. | ||
| Ensure `:ecto` is installed and configured for the current application. | ||
| """ | ||
|
|
||
| {:error, Igniter.add_issue(igniter, issue)} | ||
| end | ||
| end | ||
|
|
||
| defp extract_repo(igniter, _app_name, module) do | ||
| repo = Igniter.Project.Module.parse(module) | ||
|
|
||
| case Igniter.Project.Module.module_exists(igniter, repo) do | ||
| {true, igniter} -> | ||
| {:ok, repo, extract_adapter(igniter, repo)} | ||
|
|
||
| {false, _} -> | ||
| {:error, Igniter.add_issue(igniter, "Provided repo (#{inspect(repo)}) doesn't exist")} | ||
| end | ||
| end | ||
|
|
||
| defp extract_adapter(igniter, repo) do | ||
| match_use = &match?({:use, _, [{:__aliases__, _, [:Ecto, :Repo]} | _]}, &1.node) | ||
| match_adp = &match?({{:__block__, _, [:adapter]}, {:__aliases__, _, _}}, &1.node) | ||
|
|
||
| with {:ok, {_, _, zipper}} <- Igniter.Project.Module.find_module(igniter, repo), | ||
| {:ok, zipper} <- Igniter.Code.Common.move_to(zipper, match_use), | ||
| {:ok, zipper} <- Igniter.Code.Common.move_to(zipper, match_adp), | ||
| {:ok, {:adapter, adapter}} <- Igniter.Code.Common.expand_literal(zipper) do | ||
| adapter | ||
| else | ||
| _ -> Ecto.Adapters.Postgres | ||
| end | ||
| end | ||
|
|
||
| defp parse_engine(adapter, nil) do | ||
| case adapter do | ||
| Ecto.Adapters.Postgres -> Oban.Engines.Basic | ||
| Ecto.Adapters.MyXQL -> Oban.Engines.Dolphin | ||
| Ecto.Adapters.SQLite3 -> Oban.Engines.Lite | ||
| end | ||
| end | ||
|
|
||
| defp parse_engine(_, module), do: Igniter.Project.Module.parse(module) | ||
|
|
||
| defp parse_notifier(adapter, nil) do | ||
| case adapter do | ||
| Ecto.Adapters.Postgres -> Oban.Notifiers.Postgres | ||
| _ -> Oban.Notifiers.PG | ||
| end | ||
| end | ||
|
|
||
| defp parse_notifier(_, module), do: Igniter.Project.Module.parse(module) | ||
| end | ||
| else | ||
| defmodule Mix.Tasks.Oban.Install do | ||
| @shortdoc "Install `igniter` in order to install Oban." | ||
|
|
||
| @moduledoc __MODULE__.Docs.long_doc() | ||
|
|
||
| use Mix.Task | ||
|
|
||
| def run(_argv) do | ||
| Mix.shell().error(""" | ||
| The task 'oban.install' requires igniter. Please install igniter and try again. | ||
| For more information, see: https://hexdocs.pm/igniter/readme.html#installation | ||
| """) | ||
|
|
||
| exit({:shutdown, 1}) | ||
| end | ||
| end | ||
| end |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,83 @@ | ||
| defmodule Mix.Tasks.Oban.InstallTest do | ||
| use ExUnit.Case, async: true | ||
|
|
||
| import Igniter.Test | ||
|
|
||
| describe "install" do | ||
| test "installing without an available ecto repo" do | ||
| assert {:error, [warning]} = | ||
| test_project() | ||
| |> Igniter.compose_task("oban.install", []) | ||
| |> apply_igniter() | ||
|
|
||
| assert warning =~ "No ecto repos found for :test" | ||
| end | ||
|
|
||
| test "installing with an ecto repo available" do | ||
| application = """ | ||
| defmodule Oban.Application do | ||
| use Application | ||
| def start(_type, _args) do | ||
| children = [ | ||
| Oban.Test.Repo, | ||
| {Ecto.Migrator, migrator_opts()}, | ||
| MyWeb.Endpoint | ||
| ] | ||
| end | ||
| end | ||
| """ | ||
|
|
||
| repo = """ | ||
| defmodule Oban.Test.Repo do | ||
| @moduledoc false | ||
| use MyApp.CustomMacro, otp_app: :oban | ||
| use Ecto.Repo, otp_app: :oban, adapter: Ecto.Adapters.Postgres | ||
| end | ||
| """ | ||
|
|
||
| files = %{"lib/oban/application.ex" => application, "lib/oban/repo.ex" => repo} | ||
|
|
||
| [app_name: :oban, files: files] | ||
| |> test_project() | ||
| |> Igniter.compose_task("oban.install", []) | ||
| |> assert_has_patch("config/config.exs", """ | ||
| | config :oban, Oban, | ||
| | engine: Oban.Engines.Basic, | ||
| | notifier: Oban.Notifiers.Postgres, | ||
| | queues: [default: 10], | ||
| | repo: Oban.Test.Repo | ||
| """) | ||
| |> assert_has_patch("config/test.exs", """ | ||
| | config :oban, Oban, testing: :manual | ||
| """) | ||
| |> assert_has_patch("lib/oban/application.ex", """ | ||
| | {Oban, Application.fetch_env!(:oban, Oban)}, | ||
| | MyWeb.Endpoint | ||
| """) | ||
| end | ||
|
|
||
| test "installing selects correct config with alternate repo" do | ||
| repo = """ | ||
| defmodule Oban.Test.LiteRepo do | ||
| @moduledoc false | ||
| use Ecto.Repo, otp_app: :oban, adapter: Ecto.Adapters.SQLite3 | ||
| end | ||
| """ | ||
|
|
||
| [app_name: :oban, files: %{"lib/oban/repo.ex" => repo}] | ||
| |> test_project() | ||
| |> Igniter.compose_task("oban.install", ["--repo", "Oban.Test.LiteRepo"]) | ||
| |> assert_has_patch("config/config.exs", """ | ||
| | config :oban, Oban, | ||
| | engine: Oban.Engines.Lite, | ||
| | notifier: Oban.Notifiers.PG, | ||
| | queues: [default: 10], | ||
| | repo: Oban.Test.LiteRepo | ||
| """) | ||
| end | ||
| end | ||
| end |