add prefix option to RequestId

Author: Schultzer

lib/plug/request_id.ex

@@ -54,6 +54,9 @@ defmodule Plug.RequestId do
 
           plug Plug.RequestId, logger_metadata_key: :my_request_id
 
+    * `:prefix` - The prefix that will be appended on the request_id, if generated.
+
+          plug Plug.RequestId, prefix: :myapp
   """
 
   alias Plug.Conn
@@ -64,36 +67,35 @@ defmodule Plug.RequestId do
     {
       Keyword.get(opts, :http_header, "x-request-id"),
       Keyword.get(opts, :assign_as),
-      Keyword.get(opts, :logger_metadata_key, :request_id)
+      Keyword.get(opts, :logger_metadata_key, :request_id),
+      Keyword.get(opts, :prefix, false)
     }
   end
 
   @impl true
-  def call(conn, {header, assign_as, logger_metadata_key}) do
-    request_id = get_request_id(conn, header)
+  def call(conn, {header, assign_as, logger_metadata_key, prefix}) do
+    request_id = get_request_id(conn, header, prefix)
 
     Logger.metadata([{logger_metadata_key, request_id}])
     conn = if assign_as, do: Conn.assign(conn, assign_as, request_id), else: conn
 
     Conn.put_resp_header(conn, header, request_id)
   end
 
-  defp get_request_id(conn, header) do
+  defp get_request_id(conn, header, prefix) do
     case Conn.get_req_header(conn, header) do
-      [] -> generate_request_id()
-      [val | _] -> if valid_request_id?(val), do: val, else: generate_request_id()
+      [val | _] when byte_size(val) in 20..200 -> val
+      _ -> generate_request_id(prefix)
     end
   end
 
-  defp generate_request_id do
-    binary = <<
-      System.system_time(:nanosecond)::64,
-      :erlang.phash2({node(), self()}, 16_777_216)::24,
-      :erlang.unique_integer()::32
-    >>
+  defp generate_request_id(prefix) do
+    id =
+      Base.url_encode64(
+        <<System.system_time(:nanosecond)::64, :erlang.phash2({node(), self()}, 16_777_216)::24,
+          :erlang.unique_integer()::32>>
+      )
 
-    Base.url_encode64(binary)
+    if prefix, do: "#{prefix}-#{id}", else: id
   end
-
-  defp valid_request_id?(s), do: byte_size(s) in 20..200
 end

test/plug/request_id_test.exs

@@ -7,6 +7,15 @@ defmodule Plug.RequestIdTest do
     Plug.RequestId.call(conn, Plug.RequestId.init(opts))
   end
 
+  test "generates new request id with prefix" do
+    conn = call(conn(:get, "/"), prefix: :myapp)
+    [res_request_id] = get_resp_header(conn, "x-request-id")
+    meta_request_id = Logger.metadata()[:request_id]
+    assert generated_request_id?(res_request_id)
+    assert res_request_id == meta_request_id
+    assert String.starts_with?(res_request_id, "myapp-")
+  end
+
   test "generates new request id if none exists" do
     conn = call(conn(:get, "/"), [])
     [res_request_id] = get_resp_header(conn, "x-request-id")