phoenix_kit

1.7.19

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 37 Dependencies Dependants Files Activity

phoenix_kit lib phoenix_kit install oauth_config.ex

Raw

lib/phoenix_kit/install/oauth_config.ex

defmodule PhoenixKit.Install.OAuthConfig do
  @moduledoc """
  Handles OAuth configuration for PhoenixKit installation.

  PhoenixKit uses **fully dynamic OAuth** - providers are configured at runtime from database.
  However, a minimal compile-time configuration is still required for Ueberauth to initialize.

  ## How It Works

  Instead of using `plug Ueberauth` (which requires compile-time providers configuration),
  PhoenixKit calls Ueberauth functions directly in the OAuth controller:

  ```elixir
  # In PhoenixKitWeb.Users.OAuth controller:
  # - request/2 calls Ueberauth.run_request/4
  # - callback/2 calls Ueberauth.run_callback/4
  ```

  This approach allows:
  - **Minimal compile-time configuration** - Only `config :ueberauth, Ueberauth, providers: []`
  - **Database-driven credentials** - Credentials loaded from Settings table at runtime
  - **Dynamic provider management** - Add/remove/modify providers without app restart

  ## Runtime OAuth Flow

  1. User clicks "Sign in with Google"
  2. `PhoenixKitWeb.Plugs.EnsureOAuthConfig` loads credentials from database
  3. `PhoenixKitWeb.Users.OAuth.request/2` calls `Ueberauth.run_request/4` dynamically
  4. User authenticates with provider
  5. `PhoenixKitWeb.Users.OAuth.callback/2` calls `Ueberauth.run_callback/4` dynamically
  6. User is logged in

  ## Related Modules

  - `PhoenixKit.Users.OAuthConfig` - Configures credentials in Application env at runtime
  - `PhoenixKit.Workers.OAuthConfigLoader` - Loads OAuth config on app startup
  - `PhoenixKitWeb.Plugs.EnsureOAuthConfig` - Ensures credentials loaded before OAuth
  - `PhoenixKitWeb.Users.OAuth` - OAuth controller with dynamic Ueberauth calls
  """
  use PhoenixKit.Install.IgniterCompat

  @doc """
  Adds OAuth configuration for PhoenixKit installation.

  This adds the minimal Ueberauth configuration required for compilation.
  OAuth providers are configured dynamically at runtime from the database.

  ## Parameters
  - `igniter` - The igniter context

  ## Returns
  Updated igniter with Ueberauth configuration and informational notice.

  ## Example
  ```elixir
  igniter
  |> OAuthConfig.add_oauth_configuration()
  ```
  """
  def add_oauth_configuration(igniter) do
    igniter
    |> add_ueberauth_config()
    |> add_oauth_configuration_notice()
  end

  # Add minimal Ueberauth config required for compilation
  # Providers are configured dynamically at runtime from database
  defp add_ueberauth_config(igniter) do
    ueberauth_config = """

    # Configure Ueberauth (minimal configuration for compilation)
    # OAuth providers are configured dynamically at runtime from database
    config :ueberauth, Ueberauth, providers: []
    """

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

        # Check if Ueberauth config already exists
        if String.contains?(content, "config :ueberauth") do
          source
        else
          # Find insertion point before import_config statements
          insertion_point = find_import_config_location(content)

          updated_content =
            case insertion_point do
              {:before_import, before_content, after_content} ->
                # Insert before import_config
                before_content <> ueberauth_config <> "\n" <> after_content

              :append_to_end ->
                # No import_config found, append to end
                content <> ueberauth_config
            end

          Rewrite.Source.update(source, :content, updated_content)
        end
      end)
    rescue
      e ->
        IO.warn("Failed to add Ueberauth configuration: #{inspect(e)}")
        add_manual_config_notice(igniter)
    end
  end

  # Find the location to insert config before import_config statements
  defp find_import_config_location(content) do
    lines = String.split(content, "\n")

    # Look for import_config pattern
    import_index =
      Enum.find_index(lines, fn line ->
        trimmed = String.trim(line)
        String.starts_with?(trimmed, "import_config") or String.contains?(line, "import_config")
      end)

    case import_index do
      nil ->
        # No import_config found, append to end
        :append_to_end

      index ->
        # Find the start of the import_config block
        start_index = find_import_block_start(lines, index)

        # Split content at the start of import block
        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
  end

  # Find the start of the import_config block (including preceding comments)
  defp find_import_block_start(lines, import_index) do
    lines
    |> Enum.take(import_index)
    |> Enum.reverse()
    |> Enum.reduce_while(import_index, fn line, current_index ->
      trimmed = String.trim(line)

      cond do
        # Comment line related to import
        String.starts_with?(trimmed, "#") and
            (String.contains?(line, "import") or String.contains?(line, "Import") or
               String.contains?(line, "bottom") or String.contains?(line, "BOTTOM") or
               String.contains?(line, "environment")) ->
          {:cont, current_index - 1}

        # Blank line
        trimmed == "" ->
          {:cont, current_index - 1}

        # config_env or similar
        String.contains?(line, "config_env()") or String.contains?(line, "env_config") ->
          {:cont, current_index - 1}

        # Stop at any other code
        true ->
          {:halt, current_index}
      end
    end)
  end

  # Add informational notice about OAuth configuration
  defp add_oauth_configuration_notice(igniter) do
    Igniter.add_notice(
      igniter,
      "🔐 OAuth ready (providers configured dynamically from database at runtime)"
    )
  end

  # Add notice when manual configuration is required
  defp add_manual_config_notice(igniter) do
    notice = """
    ⚠️  Manual Configuration Required: Ueberauth

    PhoenixKit couldn't automatically configure Ueberauth.

    Please add the following to config/config.exs:

      config :ueberauth, Ueberauth, providers: []

    This minimal configuration is required for compilation.
    OAuth providers are configured dynamically at runtime from the database.
    """

    Igniter.add_notice(igniter, notice)
  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