ycherniavskyi

ycherniavskyi

Let’s say I have next controller where {:error, _, _} action result processed by FallbackController:

defmodule SomeProjectWeb.Api.V1.SessionController do
  use SomeProjectWeb, :controller

  alias SomeProject.Session
  alias SomeProject.Session.Otp
  alias SomeProjectWeb.Api.V1.CastAndValidateRenderError
  alias SomeProjectWeb.Api.V1.FallbackController
  alias SomeProjectWeb.Api.V1.{CommonSchema, SessionSchema}

  plug(OpenApiSpex.Plug.CastAndValidate, render_error: CastAndValidateRenderError)

  action_fallback(FallbackController)

  tags(["session"])

  def action(conn, _) do
    apply(__MODULE__, action_name(conn), [conn, conn.params, conn.body_params])
  end

  operation(:otp_create,
    summary: "otp_create summary",
    description: "otp_create description",
    requestBody: {
      "request body description",
      "application/json",
      SessionSchema.OtpCreateRequest,
      required: true
    },
    responses: [
      ok: {
        "ok description",
        "application/json",
        SessionSchema.OtpCreateResponse
      },
      unauthorized: "...",
      unprocessable_entity: {
        "Unprocessable Content, ...",
        "application/json",
        %Schema{
          allOf: [
            CommonSchema.ErrorResponse,
            %Schema{
              type: :object,
              properties: %{
                code: %Schema{
                  enum: [
                    :no_otp_delivery_channel,
                    :runout_signup_account
                  ]
                }
              }
            }
          ]
        }
      },
      internal_server_error: {
        "Internal Server Error, ...",
        "application/json",
        %Schema{
          allOf: [
            CommonSchema.ErrorResponse,
            %Schema{
              type: :object,
              properties: %{
                code: %Schema{
                  enum: [
                    :external_api,
                    :demo_account_manager
                  ]
                }
              }
            }
          ]
        }
      }
    ]
  )

  def otp_create(conn, _params, %{user_email: email} = _body_params) do
    case SomeProject.DemoAccountManager.retrieve(email) do
      {:ok, i_account} ->
        case SomeProject.ExternalApi.create_otp(i_account) do
          {200, %{"success" => 1, "type" => "email", "from" => email}} ->
            otp = Session.create_otp(%{i_account: i_account, demo: true})

            render(conn, otp_id: otp.id, type: "email", from: email)

          {500, %{"faultcode" => "channel-error"}} ->
            {:error, :unprocessable_entity, :no_otp_delivery_channel}

          _ ->
            {:error, :internal_server_error, :external_api}
        end

      {:error, :runout} ->
        {:error, :unprocessable_entity, :runout_signup_account}

      {:error, _} ->
        {:error, :internal_server_error, :demo_account_manager}
    end
  end
end

For now, I manually sync possible error codes for each result with relative result schema. That is diffidently not convenient and will lead to unsync in the future.

I want to implement some type of module macro that will collect and group all its functions :error results and introduce the helper function to access them.
So I could replace:

      internal_server_error: {
        "Internal Server Error, ...",
        "application/json",
        %Schema{
          allOf: [
            CommonSchema.ErrorResponse,
            %Schema{
              type: :object,
              properties: %{
                code: %Schema{
                  enum: [
                    :external_api,
                    :demo_account_manager
                  ]
                }
              }
            }
          ]
        }
      }

with:

      internal_server_error: {
        "Internal Server Error, ...",
        "application/json",
        %Schema{
          allOf: [
            CommonSchema.ErrorResponse,
            %Schema{
              type: :object,
              properties: %{
                code: %Schema{
                  enum: error_codes(:otp_create, :internal_server_error)
                }
              }
            }
          ]
        }
      }

(for sure such the final helper function could produce a more significant piece of repetitive code, but here I want to highlight its core functionality)

What is the best way to implement such functionality?

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

jeffyzooom
Hi all, I’ve been working on RustyCSV, a CSV parser and encoder for Elixir backed by Rust NIFs. Version 0.4.0 is now available. The goa...
New
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
mcass19
ExRatatui lets you cook up rich terminal UIs in Elixir, powered by Rust’s ratatui via Rustler NIFs. Build interactive terminal applicatio...
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

We're in Beta

About us Mission Statement

Options

Thread Display Mode




Thread Preview

Skip Thread Previews