pleroma

commit: 0fd3695b9c884cbc05f07c45249eb0e291cf6d1d
parent d91e9cee04f2e4cb809037e4fcfebc295994b563
Author: Tusooa Zhu <tusooa@kazv.moe>
Date:   Mon, 21 Feb 2022 17:54:18 -0500

Prefer userLanguage cookie over Accept-Language header in detecting locale

https://git.pleroma.social/pleroma/pleroma-meta/-/issues/60

Diffstat:
M
lib/pleroma/web/plugs/set_locale_plug.ex
29
++++++++++++++++++++++++++++-
M
test/pleroma/web/plugs/set_locale_plug_test.exs
59
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

2 files changed, 87 insertions(+), 1 deletion(-)
diff --git a/lib/pleroma/web/plugs/set_locale_plug.ex b/lib/pleroma/web/plugs/set_locale_plug.ex
@@ -6,6 +6,8 @@
 defmodule Pleroma.Web.Plugs.SetLocalePlug do
   import Plug.Conn, only: [get_req_header: 2, assign: 3]
 
+  def frontend_language_cookie_name(), do: "userLanguage"
+
   def init(_), do: nil
 
   def call(conn, _) do
@@ -16,10 +18,35 @@ defmodule Pleroma.Web.Plugs.SetLocalePlug do
 
   defp get_locale_from_header(conn) do
     conn
-    |> extract_accept_language()
+    |> extract_preferred_language()
+    |> normalize_language_codes()
     |> Enum.find(&supported_locale?/1)
   end
 
+  defp normalize_language_codes(codes) do
+    codes
+    |> Enum.map(fn code -> String.replace(code, "-", "_") end)
+  end
+
+  defp extract_preferred_language(conn) do
+    extract_frontend_language(conn) ++ extract_accept_language(conn)
+  end
+
+  defp extract_frontend_language(conn) do
+    %{req_cookies: cookies} =
+      conn
+      |> Plug.Conn.fetch_cookies()
+
+    case cookies[frontend_language_cookie_name()] do
+      nil ->
+        []
+
+      fe_lang ->
+        [fe_lang]
+        |> ensure_language_fallbacks()
+    end
+  end
+
   defp extract_accept_language(conn) do
     case get_req_header(conn, "accept-language") do
       [value | _] ->
diff --git a/test/pleroma/web/plugs/set_locale_plug_test.exs b/test/pleroma/web/plugs/set_locale_plug_test.exs
@@ -33,6 +33,65 @@ defmodule Pleroma.Web.Plugs.SetLocalePlugTest do
     assert %{locale: "ru"} == conn.assigns
   end
 
+  test "use supported locale with specifiers from `accept-language`" do
+    conn =
+      :get
+      |> conn("/cofe")
+      |> Conn.put_req_header(
+        "accept-language",
+        "zh-Hans;q=0.9, en;q=0.8, *;q=0.5"
+      )
+      |> SetLocalePlug.call([])
+
+    assert "zh_Hans" == Gettext.get_locale()
+    assert %{locale: "zh_Hans"} == conn.assigns
+  end
+
+  test "use supported locale from cookie" do
+    conn =
+      :get
+      |> conn("/cofe")
+      |> put_req_cookie(SetLocalePlug.frontend_language_cookie_name(), "zh-Hans")
+      |> Conn.put_req_header(
+        "accept-language",
+        "ru, fr-CH, fr;q=0.9, en;q=0.8, *;q=0.5"
+      )
+      |> SetLocalePlug.call([])
+
+    assert "zh_Hans" == Gettext.get_locale()
+    assert %{locale: "zh_Hans"} == conn.assigns
+  end
+
+  test "fallback to supported locale from `accept-language` if locale in cookie not supported" do
+    conn =
+      :get
+      |> conn("/cofe")
+      |> put_req_cookie(SetLocalePlug.frontend_language_cookie_name(), "x-nonexist")
+      |> Conn.put_req_header(
+        "accept-language",
+        "ru, fr-CH, fr;q=0.9, en;q=0.8, *;q=0.5"
+      )
+      |> SetLocalePlug.call([])
+
+    assert "ru" == Gettext.get_locale()
+    assert %{locale: "ru"} == conn.assigns
+  end
+
+  test "fallback to default if nothing is supported" do
+    conn =
+      :get
+      |> conn("/cofe")
+      |> put_req_cookie(SetLocalePlug.frontend_language_cookie_name(), "x-nonexist")
+      |> Conn.put_req_header(
+        "accept-language",
+        "x-nonexist"
+      )
+      |> SetLocalePlug.call([])
+
+    assert "en" == Gettext.get_locale()
+    assert %{locale: "en"} == conn.assigns
+  end
+
   test "use default locale if locale from `accept-language` is not supported" do
     conn =
       :get