document_provider.ex

defmodule Absinthe.Plug.DocumentProvider do
  @moduledoc """
  A document provider is a module that, given a GraphQL query, determines
  what document should be executed and how the configured pipeline should be
  applied to that document.

  ## Configuring

  Configuration of your document providers occurs on initialization of
  `Absinthe.Plug`; see that module's documentation of the `:document_providers`
  option for more details.

  ## Making Your Own

  `Absinthe.Plug.DocumentProvider` is a behaviour, and any module that
  implements its callbacks can function as a document provider for
  `Absinthe.Plug`.

  See the documentation for the behaviour callbacks and the implementation of
  the document providers that are defined in this package for more information.

  - `Absinthe.Plug.DocumentProvider.Default`
  - `Absinthe.Plug.DocumentProvider.Compiled`
  """

  @typedoc """
  A configuration for a document provider, which can take two forms:

  - `module` when options do not need to be passed to the document provider.
  - `{module, Keyword.t}` when options are needed by the document provider.
  """
  @type t :: module | {module, Keyword.t()}

  @typedoc """
  When the request is not handled by this document provider (so processing should
  continue to the next one):

      {:cont, Absinthe.Plug.Request.Query.t}

  When the request has been processed by this document provider:

      {:halt, Absinthe.Plug.Request.Query.t}

  Note that if no document providers set the request `document`, no document execution
  will occur and an error will be returned to the client.
  """
  @type result ::
          {:halt, Absinthe.Plug.Request.Query.t()} | {:cont, Absinthe.Plug.Request.Query.t()}

  @doc """
  Given a request, determine what part of its configured pipeline
  should be applied during execution.
  """
  @callback pipeline(Absinthe.Plug.Request.Query.t()) :: Absinthe.Pipeline.t()

  @doc """
  Given a request, attempt to process it with this document provider.

  ## Return Types

  See the documentation for the `Absinthe.Plug.DocumentProvider.result` type.
  """
  @callback process(Absinthe.Plug.Request.Query.t(), Keyword.t()) :: result

  @doc false
  @spec process([t], Absinthe.Plug.Request.Query.t()) :: Absinthe.Plug.Request.Query.t()
  # Attempt to process an request through the given list of valid document providers
  def process(document_providers, query) do
    document_providers
    |> normalize
    |> Enum.reduce_while(query, fn {mod, opts} = provider, acc ->
      case mod.process(acc, opts) do
        {:halt, result} ->
          {:halt, %{result | document_provider: provider}}

        cont ->
          cont
      end
    end)
  end

  @doc false
  @spec pipeline(Absinthe.Plug.Request.Query.t()) :: Absinthe.Pipeline.t()
  # Determine the remaining pipeline for request, based on the associated
  # document provider.
  def pipeline(%{document_provider: {mod, _}} = request) do
    mod.pipeline(request)
  end

  # Normalize plain module references to document providers to the fully declared
  # configuration that includes a keyword list.
  @spec normalize([t]) :: [t]
  defp normalize(document_providers) do
    Enum.map(document_providers, &do_normalize/1)
  end

  @spec do_normalize(t) :: t
  defp do_normalize(config) when is_tuple(config), do: config
  defp do_normalize(config), do: {config, []}
end