yanniskatsaros

yanniskatsaros

Hello!

I am working on a project and was hoping to use Backblaze B2 (as an alternative to S3) due to its low cost and generous free egress. I am hoping to get recommendations from anyone that has similar experience using B2 in Elixir. Which client library did you use? Did you use one of the dedicated Elixir clients, or did you use the S3-compatible API with one of the Elixir AWS clients? If so, how did you make your decision and what has your experience been?

Most of the dedicated B2 Elixir clients that I could find appear to be relatively old and it concerns me adopting them in case I run into any issues. These are the ones I found:

Conversely, if you recommend the S3-compatible API, which Elixir S3 client would you recommend? Here are two that I found, but are they are any specific libraries you have experience using and recommend?

Thanks in advance!

Marked As Solved

D4no0

D4no0

For file upload, I would definitely use ex_aws_s3, I have used it in the past with backblaze successfully on a project, you really don’t want to deal with things like large file uploads on your own and the s3 library works very well.

As for other backblaze specific endpoints, what I personally did was to just use a customized HTTPoison client and implement authentication and the few APIs I needed from their official documentation, it is very fast and easy to do as their API documentation is pretty good.

Also Liked

ragamuf

ragamuf

Also recommend rolling your own for the parts that are simple if you are concern about outdated libraries. Check out this article on Small Development Kits (SDK) from Dashbit if you need inspiration. SDKs with Req: Stripe - Dashbit Blog

wojtekmach

wojtekmach

Hex Core Team

Thanks for the mention. I tried Req/ReqS3 with a few S3-compatible services but not yet B2. If anyone runs into any problems please open up an issue!

wojtekmach

wojtekmach

Hex Core Team

Oh, there is one consideration for Backblaze in particular. If you’d upload huge files, instead of doing it in a single put_object (an HTTP PUT) you may consider doing multipart uploads, ExAws.S3.initiate_multipart_upload/2 and friends. These are not available in Req/ReqS3 and there are no plans at the moment.

Last Post!

yanniskatsaros

yanniskatsaros OP

@ragamuf and @wojtekmach I ended up implementing a small and lightweight B2 client using the advice in the article. This is only for my own use, so there is room for improvement (feel free to add any suggestions/feedback!) but here is what the end result looks like:

# in Livebook (or your `mix.exs`)
Mix.install([
  {:req, "~> 0.5.6"},
  {:typed_struct, "~> 0.3.0"}
])

defmodule B2.Client do
  use TypedStruct

  typedstruct do
    field :app_key_id, String.t(), enforce: true
    field :app_key, String.t(), enforce: true
    field :endpoint_url, String.t(), enforce: true
    field :bucket, String.t(), enforce: true
  end
end

defmodule B2 do
  defp new(%B2.Client{} = client, options) when is_list(options) do
    Req.new(
      # https://hexdocs.pm/req/Req.Steps.html#put_aws_sigv4/1
      aws_sigv4: [
        service: :s3,
        access_key_id: client.app_key_id,
        secret_access_key: client.app_key
      ],
      base_url: "#{client.endpoint_url}/#{client.bucket}"
      # retry: :transient
    )
    |> Req.merge(options)
  end

  def client(app_key_id, app_key, endpoint_url, bucket) do
    %B2.Client{
      app_key_id: app_key_id,
      app_key: app_key,
      endpoint_url: endpoint_url,
      bucket: bucket
    }
  end

  def get_object(%B2.Client{} = client, key, options \\ []) when is_binary(key) do
    req = new(client, options)
      
    case Req.get(req, url: key) do
      {:ok, %{status: 200, body: body}} -> body
      {:ok, %{status: 404}} -> nil
      error -> error
    end
  end

  def put_object(%B2.Client{} = client, key, object, options \\ [])
    when is_binary(key) and is_binary(object) do
    req =
      new(client, options)
      # TODO: properly set the content MIME type
      # https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Common_types
      # |> Req.Request.put_header("Content-Type", "text/csv")
    
    case Req.put(req, url: key, body: object) do
      {:ok, %{status: 200}} -> :ok
      {:ok, %{status: n} = resp} when n > 300 -> {:error, resp}
      error -> error
    end
  end
end

And here is some example usage:

# configure the client using the Application environment or environment variables etc

# in this example I am using LiveBook secrets
b2_app_key_id = System.get_env("LB_B2_APP_KEY_ID")
b2_app_key = System.get_env("LB_B2_APP_KEY")

# make sure to replace your <region>
endpoint_url = "https://s3.<region>.backblazeb2.com"
# make sure to replace your <bucket>
bucket = "<bucket>"

client = B2.client(b2_app_key_id, b2_app_key, endpoint_url, bucket)

# write a file
contents = """
col_1,col_2,col_3
A1,B1,C1
A2,B2,C2
A3,B3,C3
A4,B4,C3
"""
:ok = client |> B2.put_object("example.csv", contents)

# read a file
object = client |> B2.get_object("example.csv")

Thanks again to everyone that provided recommendations, I really appreciate the feedback :pray:

Where Next? Top

Trending in Questions Top

RSP87
I’m working on a project that simulates the bumbl example in the programming phoenix book. It acts almost like an email client. We have a...
New
nseaSeb
Hello, I know there is an approach for handling lists that allows for optimized traversal, but I can’t recall the specific method (somet...
New
brecabral
Documentation While reading the Scoped Routes section, I noticed that the documentation currently refers to a problem without explainin...
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
velrest
So my question is quite simple and i have found no conclusive answer on forum, google or AI. Should we use :erlang.float for Integer to ...
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
FlyingNoodle
If a change or preparation module uses Ash.Changeset.get_argument/2 or Ash.Query.get_argument/2 (or any of the other get_argument functio...
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
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
marciok
Hi there! We created Gust: A task orchestrator inspired by Airflow. For those who have never heard about Aiflow, it’s a Python-based wor...
New
mhanberg
Hi everyone! The first release candidate for the Expert language server project is now available! We’ve published a press release detai...
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
Dmk
Xamal is a deployment tool for Elixir apps that deploys native releases to bare metal servers over SSH. It’s a port of GitHub - basecamp/...
New

We're in Beta

About us Mission Statement

Options

Thread Display Mode




Thread Preview

Skip Thread Previews