replace user agent with custom version header

go-vela · Aug 2, 2024 · d724e0f · d724e0f
1 parent d2b16aa
commit d724e0f
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 19 deletions.
diff --git a/src/elm/Api/Api.elm b/src/elm/Api/Api.elm
@@ -17,7 +17,7 @@ module Api.Api exposing
     )
 
 import Api.Endpoint as Endpoint exposing (Endpoint)
-import Api.Header exposing (userAgent, userAgentString)
+import Api.Header exposing (velaVersionHeader)
 import Api.Pagination as Pagination
 import Auth.Session exposing (Session(..))
 import Http
@@ -216,7 +216,7 @@ get : String -> Endpoint -> Decoder b -> Request b
 get api endpoint decoder =
     request
         { method = "GET"
-        , headers = [ userAgent userAgentString ]
+        , headers = [ velaVersionHeader ]
         , url = Endpoint.toUrl api endpoint
         , body = Http.emptyBody
         , decoder = decoder
@@ -229,7 +229,7 @@ post : String -> Endpoint -> Http.Body -> Decoder b -> Request b
 post api endpoint body decoder =
     request
         { method = "POST"
-        , headers = [ userAgent userAgentString ]
+        , headers = [ velaVersionHeader ]
         , url = Endpoint.toUrl api endpoint
         , body = body
         , decoder = decoder
@@ -242,7 +242,7 @@ put : String -> Endpoint -> Http.Body -> Decoder b -> Request b
 put api endpoint body decoder =
     request
         { method = "PUT"
-        , headers = [ userAgent userAgentString ]
+        , headers = [ velaVersionHeader ]
         , url = Endpoint.toUrl api endpoint
         , body = body
         , decoder = decoder
@@ -255,7 +255,7 @@ delete : String -> Endpoint -> Decoder b -> Request b
 delete api endpoint decoder =
     request
         { method = "DELETE"
-        , headers = [ userAgent userAgentString ]
+        , headers = [ velaVersionHeader ]
         , url = Endpoint.toUrl api endpoint
         , body = Http.emptyBody
         , decoder = decoder
@@ -268,7 +268,7 @@ patch : String -> Endpoint -> Decoder b -> Request b
 patch api endpoint decoder =
     request
         { method = "PATCH"
-        , headers = [ userAgent userAgentString ]
+        , headers = [ velaVersionHeader ]
         , url = Endpoint.toUrl api endpoint
         , body = Http.emptyBody
         , decoder = decoder

diff --git a/src/elm/Api/Header.elm b/src/elm/Api/Header.elm
@@ -3,7 +3,7 @@ SPDX-License-Identifier: Apache-2.0
 --}
 
 
-module Api.Header exposing (get, userAgent, userAgentString)
+module Api.Header exposing (get, velaVersionHeader)
 
 import Dict exposing (Dict)
 import Http
@@ -28,18 +28,11 @@ get key headers =
     Dict.get key_ headers_
 
 
-{-| userAgentString is the default User-Agent header value for the UI.
+{-| velaVersionHeader creates a User-Agent header with the specified value.
 
-TODO: pass this in via flags/config.
+TODO: allow this to be controlled via flags/config
 
 -}
-userAgentString : String
-userAgentString =
-    "vela/ui"
-
-
-{-| userAgent creates a User-Agent header with the specified value.
--}
-userAgent : String -> Http.Header
-userAgent value =
-    Http.header "user-agent" value
+velaVersionHeader : Http.Header
+velaVersionHeader =
+    Http.header "x-vela-ui-version" "vela/ui"