Exadra37

Exadra37

This is a copy/paste of my question in StackOverflow, but once we have an amazing community, I thought to also put it here :slight_smile:

DISCLAIMER: Still a beginner in Elixir and Phoenix. I just play with time to time, with months of interval. Please fill free to provide honest feedback and say where I am missing something or where i am totally wrong.

Parameter Validation

I want to be able to do in the Phoenix Router the validation of the :date parameter for the route /todos/:date, but I am not able to find any documentation or library to achieve this in the Phoenix Routing docs, but I found the Plug Validator library, that looks like what I need, but doesn’t work with the Phoenix Framework, just with Elixir projects.

The Code

The Router:

defmodule TasksWeb.Router do
  use TasksWeb, :router

  pipeline :browser do
    plug :accepts, ["html"]
    plug :fetch_session
    plug :fetch_live_flash
    plug :protect_from_forgery
    plug :put_secure_browser_headers
    plug :put_root_layout, {TasksWeb.LayoutView, :root}
  end

  pipeline :api do
    plug :accepts, ["json"]
  end

  scope "/", TasksWeb do
    pipe_through :browser

    get "/", PageController, :index
    live "/todos", TodoLive
    
    # THIS IS THE ROUTE I WANT TO VALIDATE THE PARAMETER :date
    live "/todos/:date", TodoLive
  end
end

The validator I am using currently elsewhere in the code:

defmodule Utils.Validators.Date do

  def valid_iso8601?(%Ecto.Changeset{} = changeset, field) when is_atom(field) do
    date = changeset |> Ecto.Changeset.get_field(field)

    case Date.from_iso8601(date) do
      {:ok, _valid_date} ->
        changeset

      {:error, :invalid_format} ->
        Ecto.Changeset.add_error(changeset, field, "Date '#{date}' has an invalid format - Valid format: YYYY-MM-DD")

      {:error, :invalid_date} ->
        Ecto.Changeset.add_error(changeset, field, "Date '#{date}' is invalid - e.g. 2020-04-31 (April only have 30 days)")
    end
  end

  def valid_iso8601?(date) when is_binary(date) do
    case Date.from_iso8601(date) do
      {:ok, _valid_date} ->
        :ok

      {:error, :invalid_format} ->
        {:invalid_format, "Date '#{date}' has an invalid format - Valid format: YYYY-MM-DD"}

      {:error, :invalid_date} ->
        {:invalid_date, "Date '#{date}' is invalid - e.g. 2020-04-31 (April only have 30 days)"}
    end
  end
end

The Goal is to Validate at the Edge

My goal is to be able to call Utils.Validators.Date.valid_iso8601?(date) from the Phoenix Router, but only when the Route is matched.

I know that a lot of libraries exist to validate this in the Controller or from anywhere else, but what I want is to validate the :date at the edge, aka when the route is matched, not inside my application logic.

So my question is if anyone knows a library that allows to achieve this in the Phoenix Router or how I can write a plug that only is invoked when the route matches, because I know I can write one that inspect all requests, but that is not optimal, and a waste of computer resources.

I would love to be able to do like this:

live "/todos/:date", TodoLive, plug: MyValidatorPlug

Or in alternative as I describe below in the Pipeline section.

Pipelines

I forgot to mention them in my original question, but @fhdhsni kindly remembered me of them and pointed me to a possible solution, but while that may achieve the goal for one route, during my thinking about it I found it to not scale when my router grows, because I will need to wrap each route in a scope for that pipeline.

What I want to mean by scoping the routes to use the pipeline is:

  scope "/", TasksWeb do
    pipe_through :browser
    get "/", PageController, :index

    scope "/todos" do
      live "/", TodoLive

      pipe_through :validator
      live "/:date", TodoLive
      # NOW ANY ROUTE ADDED HERE WILL ALSO BE EXECUTED THROUGH THE VALIDATOR PIPELINE
      # And this is why I don't want to go down this path...
    end
  end

But if was possible to do like this:

live "/todos/:date", TodoLive, pipe_through: :my-validator-pipeline 

Then my problem would be solved :wink:

First 5 of 5 Posts Switch mode

Exadra37

Exadra37 OP

Turns out that I was wrong when said this… I just followed their docs to the letter, and the code was not compiling, but after a night of sleep I realized how to do it:

defmodule TasksWeb.Router do
  use TasksWeb, :router

  pipeline :browser do
    plug :accepts, ["html"]
    plug :fetch_session
    #plug :fetch_flash
    plug :fetch_live_flash
    plug :protect_from_forgery
    plug :put_secure_browser_headers
    plug :put_root_layout, {TasksWeb.LayoutView, :root}

    # *** NEW CODE TO ENABLE THE PLUG VALIDATOR CHECK ***
    plug Plug.Validator, on_error: &TasksWeb.Router.validation_error_callback/2
  end

  pipeline :api do
    plug :accepts, ["json"]
  end

  scope "/", TasksWeb do
    pipe_through :browser
    get "/", PageController, :index

    live "/todos", TodoLive

    # *** NEW CODE TO ENABLE THE PLUG VALIDATOR CHECK ***
    live "/todos/:date", TodoLive, private: %{validate: %{date: &Utils.Validators.Date.valid_iso8601?/1}}
  end

  # *** CALLBACK TO HANDLE THE ERRORS RETURNED BY THE PLUG VALIDATOR CHECK ***
  def validation_error_callback(conn, _errors) do
    conn
    |> put_status(:not_found)
    |> put_view(TasksWeb.ErrorView)
    |> render("404.html")
    |> halt()
  end

  # Other scopes may use custom stacks.
  # scope "/api", TasksWeb do
  #   pipe_through :api
  # end
end

erez-rabih

erez-rabih

Library author here
I am glad that you found the right way to make it work with Phoenix framework
Would you be kind and make a PR correcting the docs where they are wrong or misleading? This way other developers would be able to use it for their needs

Exadra37

Exadra37 OP

Here it is the pull request :slight_smile:

7rans

7rans

Seems to me that Phoenix could really use something like this built-in with a more elegant syntax.

Exadra37

Exadra37 OP

I agree :slight_smile:

@erez-rabih Are you still maintaining the repo? My PR is still open. I can take over the maintenance of the library if you want.

— All posts loaded —

Where Next? Top

Trending in Questions Top

stjefim
Hello! Suppose you are building workflow (order / task / payment) processing system with the following requirements: Each workflow con...
New
jonnycharles
I’m in search of an Elixir library that offers PDF generation capabilities similar to Ruby’s Prawn. While there have been discussions abo...
New
spammy
I’m looking to build a personal workflow to quickly deploy web applications written in elixir/phoenix, for local consumption (ie not on t...
New
dli
Before I dive in myself, did anyone successfully sprinkle Hologram into their existing LiveView app? Looking for hints regarding: Addi...
New
roeland
Kia ora, We have been using elixir-google-api to connect to Google Drive. However, with the updates to Tesla due to CVEs this is now bro...
New
bottlenecked
Hi all, I wanted to ask how the community is dealing with post-release steps. Today we have Ecto migrations, which make sure that the db...
New
rahultumpala
Hello, I have an Elixir backend that implements a custom protocol over TCP. I want to load test the backend and assess the performance o...
New

Other Trending Topics Top

JesseHerrick
Hey, I’m Jesse and I’m the main contributor behind Dexter, a full-featured, lightning-fast Elixir LSP optimized for large codebases. It s...
New
jimsynz
Beam Bots (or just BB for short) is a framework for building fault-tolerant robotics applications in Elixir using familiar OTP patterns. ...
New
Damirados
Hello everyone. After busy few months I am happy to announce v0.1.0 of Emerge & Solve. They are GUI (Emerge) and State management (S...
New
netoum
Corex is an accessible, unstyled UI component library for Phoenix that integrates Zag.js state machines using Vanilla JavaScript and Live...
New
ausimian
Emily is an Elixir library that runs Nx computations on Apple’s MLX. Install it as the default Nx backend and Nx, defn, Axon, Nx.Serving,...
New
wintermeyer
There are three potential reasons for members of this forum to have a look at https://vutuv.de You are tired or annoyed of LinkedIn. Yo...
New

We're in Beta

About us Mission Statement