phoenix_kit

1.7.143

1.7.208 1.7.207 1.7.206 1.7.205 1.7.204 1.7.203 1.7.202 1.7.201 1.7.200 1.7.199 1.7.198 1.7.197 1.7.196 1.7.194 1.7.193 1.7.192 1.7.191 1.7.190 1.7.189 1.7.187 1.7.186 1.7.185 1.7.184 1.7.183 1.7.182 1.7.181 1.7.180 1.7.179 1.7.178 1.7.177 1.7.176 1.7.175 1.7.174 1.7.173 1.7.172 1.7.171 1.7.170 1.7.169 1.7.168 1.7.167 1.7.166 1.7.165 1.7.164 1.7.162 1.7.161 1.7.160 1.7.159 1.7.157 1.7.156 1.7.155 1.7.154 1.7.153 1.7.152 1.7.151 1.7.150 1.7.149 1.7.146 1.7.145 1.7.144 1.7.143 1.7.138 1.7.133 1.7.132 1.7.131 1.7.130 1.7.128 1.7.126 1.7.125 1.7.121 1.7.120 1.7.119 1.7.118 1.7.117 1.7.116 1.7.115 1.7.114 1.7.113 1.7.112 1.7.111 1.7.110 1.7.109 1.7.108 1.7.107 1.7.106 1.7.105 1.7.104 1.7.103 1.7.102 1.7.101 1.7.100 1.7.99 1.7.98 1.7.97 1.7.96 1.7.95 1.7.94 1.7.93 1.7.92 1.7.91 1.7.90 1.7.89 1.7.88 1.7.87 1.7.86 1.7.85 1.7.84 1.7.83 1.7.82 1.7.81 1.7.80 1.7.79 1.7.78 1.7.77 1.7.76 1.7.75 1.7.74 1.7.71 1.7.70 1.7.69 1.7.66 1.7.65 1.7.64 1.7.63 1.7.62 1.7.61 1.7.59 1.7.58 1.7.57 1.7.56 1.7.55 1.7.54 1.7.53 1.7.52 1.7.51 1.7.49 1.7.44 1.7.43 1.7.42 1.7.41 1.7.39 1.7.38 1.7.37 1.7.36 1.7.34 1.7.33 1.7.31 1.7.30 1.7.29 1.7.28 1.7.27 1.7.26 1.7.25 1.7.24 1.7.23 1.7.22 1.7.21 1.7.20 1.7.19 1.7.18 1.7.17 1.7.16 1.7.15 1.7.14 1.7.13 1.7.12 1.7.11 1.7.10 1.7.9 1.7.8 1.7.7 1.7.6 1.7.5 1.7.4 1.7.3 1.7.2 1.7.1 1.7.0 1.6.20 1.6.19 1.6.18 1.6.17 1.6.16 1.6.15 1.6.14 1.6.13 1.6.12 1.6.11 1.6.10 1.6.9 1.6.8 1.6.7 1.6.6 1.6.5 1.6.4 1.6.3 1.5.2 1.5.1 1.5.0 1.4.9 1.4.8 1.4.7 1.4.6 1.4.5 1.4.4 1.4.3 1.4.2 1.4.1 1.4.0 1.3.2 1.3.1 1.3.0 1.2.10 1.2.9 1.2.8 1.2.7 1.2.5 1.2.4 1.2.2 1.2.1 1.2.0 1.1.0 1.0.0

A foundation for building Elixir Phoenix apps — SaaS, social networks, ERP systems, marketplaces, and more

HexDocs

Current section

Files

Jump to

Readme 222 Versions 45 Dependencies Dependants Files Activity

phoenix_kit lib phoenix_kit install finch_setup.ex

Raw

lib/phoenix_kit/install/finch_setup.ex

defmodule PhoenixKit.Install.FinchSetup do
  use PhoenixKit.Install.IgniterCompat

  @moduledoc """
  Handles automatic Finch and HTTP client setup for PhoenixKit installation.

  This module provides functionality to:
  - Detect if HTTP client adapters (like AmazonSES, SendGrid, etc.) are being used
  - Automatically add Finch to the application supervisor when needed
  - Add required dependencies like gen_smtp for AWS SES
  - Configure Swoosh API client appropriately
  """

  alias Igniter.Project.{Application, Config, Deps}

  @doc """
  Automatically configures Finch and dependencies based on mailer adapter configuration.

  This function checks if any HTTP-based email adapters are configured and:
  - Adds Finch to the application supervisor
  - Adds gen_smtp dependency for AWS SES
  - Configures Swoosh API client

  ## Parameters
  - `igniter` - The igniter context

  ## Returns
  Updated igniter with Finch configuration if needed.
  """
  def add_finch_configuration(igniter) do
    igniter
    |> maybe_add_finch_dependency()
    |> maybe_add_finch_supervisor()
    |> maybe_add_gen_smtp_dependency()
    |> add_swoosh_api_client_config()
  end

  # Always add Finch to supervisor - it's lightweight and allows future HTTP adapter use
  defp maybe_add_finch_supervisor(igniter) do
    Application.add_new_child(
      igniter,
      {Finch, name: Swoosh.Finch},
      opts: [after: [:telemetry_supervisor, :pubsub]]
    )
  end

  # Always add Finch dependency for HTTP email adapters
  defp maybe_add_finch_dependency(igniter) do
    Deps.add_dep(igniter, {:finch, "~> 0.18"})
  end

  # Check if AWS SES is being used and add gen_smtp dependency
  defp maybe_add_gen_smtp_dependency(igniter) do
    if needs_gen_smtp?(igniter) do
      Deps.add_dep(igniter, {:gen_smtp, "~> 1.2"})
    else
      igniter
    end
  end

  # Configure Swoosh API client to use Finch
  defp add_swoosh_api_client_config(igniter) do
    # Always configure Finch as the API client in config.exs
    # This allows users to switch to HTTP-based adapters later without conflicts
    Config.configure_new(
      igniter,
      "config.exs",
      :swoosh,
      [:api_client],
      Swoosh.ApiClient.Finch
    )
  rescue
    _ ->
      add_swoosh_config_simple(igniter)
  end

  # Simple file append for Swoosh config when Igniter fails
  defp add_swoosh_config_simple(igniter) do
    swoosh_config = """

    # Swoosh API client configuration
    config :swoosh, api_client: Swoosh.ApiClient.Finch
    """

    try do
      igniter =
        Igniter.update_file(igniter, "config/config.exs", fn source ->
          content = Rewrite.Source.get(source, :content)

          # Check if already configured
          if String.contains?(content, "config :swoosh, api_client:") do
            source
          else
            # Find insertion point before import_config
            updated_content =
              case find_import_config_location_simple(content) do
                {:before_import, before_content, after_content} ->
                  before_content <> swoosh_config <> "\n" <> after_content

                :append_to_end ->
                  content <> swoosh_config
              end

            Rewrite.Source.update(source, :content, updated_content)
          end
        end)

      igniter
    rescue
      e ->
        IO.warn("Failed to configure Swoosh API client automatically: #{inspect(e)}")
        add_swoosh_config_manual_notice(igniter)
    end
  end

  # Helper to find import_config location (simplified version)
  defp find_import_config_location_simple(content) do
    if String.contains?(content, "import_config") do
      lines = String.split(content, "\n")

      import_index =
        Enum.find_index(lines, fn line ->
          String.contains?(line, "import_config")
        end)

      case import_index do
        nil ->
          :append_to_end

        index ->
          # Find start of import block
          start_index = max(0, index - 3)
          before_lines = Enum.take(lines, start_index)
          after_lines = Enum.drop(lines, start_index)

          before_content = Enum.join(before_lines, "\n")
          after_content = Enum.join(after_lines, "\n")

          {:before_import, before_content, after_content}
      end
    else
      :append_to_end
    end
  end

  # Manual configuration notice for Swoosh
  defp add_swoosh_config_manual_notice(igniter) do
    notice = """
    ⚠️  Manual Swoosh Configuration Required

    PhoenixKit couldn't automatically configure Swoosh API client.

    Please add this to config/config.exs:

      config :swoosh, api_client: Swoosh.ApiClient.Finch
    """

    Igniter.add_notice(igniter, notice)
  end

  # Check if AWS SES is being used (needs gen_smtp)
  defp needs_gen_smtp?(igniter) do
    check_config_for_adapters(igniter, ["Swoosh.Adapters.AmazonSES"])
  end

  # Helper to check if any of the specified adapters are configured
  defp check_config_for_adapters(igniter, adapters) do
    config_files = ["config.exs", "dev.exs", "prod.exs"]

    Enum.any?(config_files, fn file ->
      case igniter.rewrite.sources[file] do
        nil ->
          false

        source ->
          content = Rewrite.Source.get(source, :content)
          Enum.any?(adapters, &String.contains?(content, &1))
      end
    end)
  end
end

Operator	Description	Example
name:	Match package name. Supports * wildcards and repo/package form	name:phx* or name:hexpm/phoenix
description:	Full-text search of package descriptions	description:auth
depends:	Packages depending on a given package. Supports repo:package form	depends:ecto or depends:hexpm:ecto
build_tool:	Filter by build tool	build_tool:mix
updated_after:	Packages updated after an ISO8601 datetime	updated_after:2025-01-01T00:00:00Z
extra:	Match custom metadata (key,value). Nested keys are separated by commas	extra:license,MIT