neuone

neuone

SCENARIO

I have this 3rd party API JSON that has it’s keys in TitleCase format. These API calls are all “GET” requests.

“MetaData” => %{
“UserName” => …
“LastName” => …
}%

I want to convert the keys from Titlecase to lowercase atom keys before I start to internally break down the json into internal structs.

HTTP Client

Tesla for my HTTP Client

Option 1 - Tesla Middleware JSON Engine Options

I was reading the Tesla.Middleware.JSON docs and I saw this option engine_opts: [keys: :atoms].

defmodule Api.Client.Base do

  use Tesla
  plug Tesla.Middleware.BaseUrl, "http://somewebsite.com"
  plug Tesla.Middleware.JSON, engine_opts: [keys: :atoms]

But this converts my JSON from MetaData to metaData for the keys. Not ideal as I want them to be lowercase and underscore. So ideally meta_data

Option 2 - Build my own Middleware

I have never done this before but the instructions and documentation make it easy

defmodule Api.Client.InspectHeadersMiddleware do
  
  @behaviour Tesla.Middleware
  
  def call(env, next, _) do
    env
    |> Tesla.run(next)
    |> decode_json()
  end

  def decode_json(env) do
    with  {:ok, tesla_struct} <- env,
          {:ok, json} <- convert_to_json(tesla_struct),
          results <-  keys_to_underscore(json) do
      {:ok, put_in(tesla_struct.body, results)}
    end
  end


  def convert_to_json(strct) do
    strct.body
    |> Jason.decode()
  end

  def keys_to_underscore(json) when is_map(json) do
    Map.new(json, &reduce_keys_to_underscore/1)
  end

  def reduce_keys_to_underscore({key, val}) when is_map(val), do: {string_to_atom(key), keys_to_underscore(val)}
  def reduce_keys_to_underscore({key, val}) when is_list(val), do: {string_to_atom(key), Enum.map(val, &keys_to_underscore(&1))}
  def reduce_keys_to_underscore({key, val}), do: {string_to_atom(key), val}

  def string_to_atom(key) do
    Macro.underscore(key)
    |> String.to_atom
  end

end

And then I make sure to place my middleware plug Api.Client.InspectHeadersMiddleware after the Tesla.Middleware.JSON

defmodule Api.Client.Base do

  use Tesla
  plug Tesla.Middleware.BaseUrl, "http://somewebsite.com"
  plug Tesla.Middleware.JSON
  plug Api.Client.InspectHeadersMiddleware

Conclusion

And this works but I have concerns and need some feedback.

QUESTIONS

1. Other possible solutions?
Has anyone had to deal with a similar situation? Any open source libraries I should check out?

2. The process of converting 3rd party JSON API keys and String.to_atom
I’m reading posts that suggest converting keys to atoms from 3rd party sources can be dangerous due to garbage collection limit String.to_atom, When to use Elixir String.to_atom and even this post

3. Is my solution putting me in danger
Is using a Middleware approach ideal OR is there something better?
The API requests are just GET requests and I do trust the service.
And I do know what the keys will be for each endpoint.

Thanks

Showing Posts 1 to 4

stefanchrobot

stefanchrobot

Custom middleware that converts keys is the way to go. The idea behind middlewares was to provide an extension point. So something like:

defmodule Api.Client.Base do
  use Tesla
  plug Tesla.Middleware.JSON
  # Once this middleware is called, the body is already deserialized from JSON.
  plug KeyConversionMiddleware
end

would do the job.

I would suggest keeping the keys as strings, exactly for the reasons you’ve mentioned. Consider using Ecto schemas and changesets to validate the incoming requests and convert them to structs - it will convert the string keys for you.

neuone

neuone OP

I have done what you suggested and just kept the 3rd party api keys as strings but converted to “lowercase” and then through some module and then using Ecto.Schema to cast the string keys.

Helpful tip and good to know my approach is ideal.

Thanks for the feedback.

Wigny

Wigny

I came across the same problem converting cases, so create a package to be able to reuse the approach in other projects: TeslaKeys.Middleware.Case — tesla_keys v0.3.0

neuone

neuone OP

Thanks. Will try this out in another project.

— All posts loaded —

Where Next? Top

Trending in Questions Top

Blokh
Hey guys, I’ve got a huge CSV ( around 10 GB ) that needs to be processed hourly Do you guys have any suggestions what is the best prac...
New
kszambelanczyk
Hello! Could someone please give me a help/sample code, how to delete a file from s3 using waffle/waffle_ecto from Phoenix app. I creat...
New
Onor.io
I have what I’ve heard referred to as a “lookup table” in my database. This is a way of assigning codes to common values. One common lo...
New
Trolleger
What approach to take when sending live updates to “random” users Hi! I have a question, I have a little chat app, and when I create a DM...
New
RemyXRenard
I’m seeing that a list inside a Kino.DataTable will be interpreted as a charlist, even if the Kino.configure() is set to charlists: :as_l...
New
matt-savvy
Anyone here using Honeybadger? My Honeybadger account is being overwhelmed with noise from some bots. Seeing a lot of Bandit.HTTPError...
New
samoloth
Hi, I’ve just set up an application with ash_authentication. There is only magic link strategy for now, so there is no confirmation add o...
New

Other Trending Topics Top

mudasobwa
I am happy to introduce the very α version of the new programming language compiled to BEAM. Welcome Cure. It has literally three kille...
New
garrison
Hobbes is a low-level distributed database for the Elixir programming language. Hobbes provides a simple, safe, and scalable storage lay...
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 &amp; 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
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

Options

Thread Display Mode




Thread Preview

Skip Thread Previews