Avoid compile-time dependency to Gettext backend #391

whatyouhide · 2024-08-17T14:00:45Z

First pass, let's see if this is a direction we like.

coveralls · 2024-08-17T14:02:18Z

Pull Request Test Coverage Report for Build 2810c37e8e880dc91dcf26f143374c41f8c1c98c-PR-391

Details

23 of 39 (58.97%) changed or added relevant lines in 4 files are covered.
No unchanged relevant lines lost coverage.
Overall coverage decreased (-2.2%) to 90.939%

Changes Missing Coverage	Covered Lines	Changed/Added Lines	%
lib/gettext.ex	5	6	83.33%
lib/gettext/extractor.ex	2	3	66.67%
lib/gettext/macros.ex	9	23	39.13%

Totals
Change from base Build c602ea9d1a2ee5869216a653337b3e66f2b70b10:	-2.2%
Covered Lines:	552
Relevant Lines:	607

💛 - Coveralls

whatyouhide · 2024-08-17T14:02:31Z

lib/gettext/macros.ex

+  defp expand_domain({backend, :__default_domain__}, env) do
+    if Gettext.Extractor.extracting?() do
+      Macro.expand(backend, env).__gettext__(:default_domain)
+    else
+      quote do
+        unquote(backend).__gettext__(:default_domain)
+      end
+    end
+  end
+
+  defp expand_domain(domain, _env) do
+    domain
+  end


This is pretty nasty uh? Basically if you're extracting then expand the domain at compile-time by calling the backend, and that creates a compile-time dependency but not one we care about (we're recompiling everything). If not extracting, then it's dynamic and shouldn't create a compile-time dependency.

whatyouhide · 2024-08-17T14:03:27Z

test/gettext/new_backend_setup_test.exs

+  end
+
+  describe "compile-time dependencies" do
+    @tag :skip


If I don't skip this, I get these errors and I have no clue why, trying to figure it out:

Output

1) test allowed_locales ignores other locales as strings (GettextTest) test/gettext_test.exs:184 Assertion with == failed code: assert TranslatorWithAllowedLocalesString.lgettext("es", "default", nil, "Hello world", %{}) == {:ok, "Hola mundo"} left: {:default, "Hello world"} right: {:ok, "Hola mundo"} stacktrace: test/gettext_test.exs:190: (test) ........ 2) test allowed_locales ignores other locales as atom (GettextTest) test/gettext_test.exs:194 Assertion with == failed code: assert TranslatorWithAllowedLocalesAtom.lgettext("es", "default", nil, "Hello world", %{}) == {:ok, "Hola mundo"} left: {:default, "Hello world"} right: {:ok, "Hola mundo"} stacktrace: test/gettext_test.exs:200: (test) ....... 3) test using a custom Gettext.Plural module with the context parameter (GettextTest) test/gettext_test.exs:214 Assertion failed, no matching message after 0ms The process mailbox is empty. code: assert_received {:plural_context, %{plural_forms_header: "nplurals=2; plural=(n != 1);"}} stacktrace: test/gettext_test.exs:219: (test) ..... 4) test known_locales/1: returns all the locales for which a backend has PO files (GettextTest) test/gettext_test.exs:846 Assertion with == failed code: assert Gettext.known_locales(TranslatorWithAllowedLocalesAtom) == ["es"] left: [] right: ["es"] stacktrace: test/gettext_test.exs:848: (test) ...... 5) test using a custom Gettext.Plural module (GettextTest) test/gettext_test.exs:204 Assertion with == failed code: assert T.lngettext("it", "default", nil, "One new email", "%{count} new emails", 1, %{}) == {:ok, "1 nuove email"} left: {:default, "One new email"} right: {:ok, "1 nuove email"} stacktrace: test/gettext_test.exs:207: (test) ............. 6) test a custom default_domain can be set for a backend (GettextTest) test/gettext_test.exs:177 Assertion with == failed code: assert T.gettext("Invalid email address") == "Indirizzo email non valido" left: "Invalid email address" right: "Indirizzo email non valido" stacktrace: test/gettext_test.exs:180: (test)

whatyouhide · 2024-08-17T14:03:46Z

test/support/mix_project_helpers.ex

@@ -0,0 +1,31 @@
+defmodule GettextTest.MixProjectHelpers do


Unnecessary refactor if it wasn't for that stupid test that is causing me issues

lib/gettext/macros.ex

lib/gettext.ex

josevalim · 2024-08-17T16:31:06Z

lib/gettext/macros.ex

+    domain =
+      case domain do
+        {backend, :__default_domain__} when not is_nil(backend) ->
+          Macro.expand(backend, __CALLER__).__gettext__(:default_domain)


We cannot do this. This is doing the expansion at compile-time, which means we have a compile-time dependency.

Is the domain a string? If the domain is a string, we can support a special domain called :default and we resolve it at runtime, inside the Gettext module.

Oh wait this is a place where I forgot to do

domain = expand_domain(domain, __CALLER__)

which does pretty much what you said 😄

josevalim · 2024-08-17T16:32:00Z

lib/gettext/macros.ex

+
+  defmacro dgettext(domain, msgid, bindings \\ Macro.escape(%{})) do
+    quote do
+      unquote(__MODULE__).dpgettext(unquote(domain), nil, unquote(msgid), unquote(bindings))


I would avoid calling macros recursively, is there any chance we can move the shared logic to private functions called by macros?

@josevalim you ok if I do that in a subsequent PR? Already going crazy with this one and this works fine so maybe we make it work make it beautiful and stuff? 😄

Yup, glad to postpone.

josevalim · 2024-08-17T16:37:51Z

lib/gettext/macros.ex

@@ -0,0 +1,239 @@
+defmodule Gettext.Macros do
+  @moduledoc false


We should make this public and move the @macrocallback from Gettext.Backend to this module. Only the actual callbacks (handle_*) should remain in Gettext.Backend. We should also update Gettext module docs to say that, when it is used, it imports the macros in this module.

Maybe we should also have use Gettext.Macros, backend: ... instead of use Gettext, backend: .... Thoughts?

I think use Gettext, backend: ... is quite ergonomic and easy to remember.

I for sure don't like it with the name Macros, even though I can't think of a better name right now.

Macros make sense if you consider that you have Gettext.dngettext and we call them "gettext functions". It should also answer your question below: if you can't use the macros, you can always use the functions directly and pass the gettext backend as an explicit argument.

Macros makes sense from an implementation standpoint. The user doesn’t care however that they are macros, he just wants to get the translation. If we use functions or macros is not something he cares about.

True on calling the functions directly. The import we had before was nicer, but that’s an edge case anyways and shouldn’t dictate our approach if there’s a workaround.

I am convinced. We can keep the primary API use Gettext, backend: …. We need to find a name for the module and document it, but this way the name does not play such a big role anyway.

maennchen

We might actually have a larger issue with our current plan.

How does this work if we're not in a module context? If I for example want to use translations in an elixir script?

The only solution I can think of right now would be to have the user create two modules in separate files. A Backend and a Frontend. The frontend can then just be imported directly to invoke the gettext functions.

whatyouhide

@josevalim @maennchen this is ready for another review.

Changes:

Gettext.Macros is public now, and hosts all the macros (documented).
No more @macrocallbacks in Gettext.Backend. We won't generate macros anywhere now so no point in making a behaviour out of them right?
We use :default as the default domain and then expand that in Gettext.Extractor (at compile time) and in Gettext.Macros (at runtime, so no compile-time dependency).
Gettext.Backend introduced also the l(n)gettext callbacks now, why not. Good to document and stuff?

whatyouhide · 2024-08-18T08:39:45Z

lib/gettext/macros.ex

+
+  defmacro dgettext(domain, msgid, bindings \\ Macro.escape(%{})) do
+    quote do
+      unquote(__MODULE__).dpgettext(unquote(domain), nil, unquote(msgid), unquote(bindings))


@josevalim you ok if I do that in a subsequent PR? Already going crazy with this one and this works fine so maybe we make it work make it beautiful and stuff? 😄

josevalim

Beautiful. I think the only things missing overall are:

A bit more docs on the Gettext module
Deprecating the old backend style
Test if this will actually remove compile time dependencies in a Phoenix project. You can use mix xref trace in a view or controller for that
Update Phoenix generators

whatyouhide · 2024-08-18T11:56:03Z

Yes docs coming up, and deprecation as well. I tested on a small sample app (not Phoenix) and it did but I will test once I update the generatorssss

whatyouhide · 2024-08-18T12:09:36Z

In a Phoenix project with some tweaks (the one we'll do to the generator):

→ mix xref trace lib/gtest_web/components/core_components.ex 
lib/gtest_web/components/core_components.ex:1: call GtestWeb.CoreComponents.__phoenix_component_verify__/1 (compile)
lib/gtest_web/components/core_components.ex:18: alias GtestWeb.Gettext (runtime)
lib/gtest_web/components/core_components.ex:568: alias GtestWeb.Gettext (runtime)
lib/gtest_web/components/core_components.ex:570: alias GtestWeb.Gettext (runtime)

→ mix xref trace lib/gtest_web/controllers/page_controller.ex
lib/gtest_web/controllers/page_controller.ex:1: call GtestWeb.PageController.__phoenix_verify_routes__/1 (compile)
lib/gtest_web/controllers/page_controller.ex:2: require GtestWeb (export)
lib/gtest_web/controllers/page_controller.ex:2: alias GtestWeb.Endpoint (runtime)
lib/gtest_web/controllers/page_controller.ex:2: alias GtestWeb.Gettext (runtime)
lib/gtest_web/controllers/page_controller.ex:2: alias GtestWeb.Layouts (runtime)
lib/gtest_web/controllers/page_controller.ex:2: alias GtestWeb.Router (runtime)
lib/gtest_web/controllers/page_controller.ex:2: call GtestWeb.__using__/1 (compile)
lib/gtest_web/controllers/page_controller.ex:2: call GtestWeb.static_paths/0 (compile)

Looks fantastique!

Avoid compile-time dependency to Gettext backend

1eff8d6

whatyouhide requested review from josevalim and maennchen and removed request for josevalim August 17, 2024 14:00

whatyouhide commented Aug 17, 2024

View reviewed changes

whatyouhide requested a review from josevalim August 17, 2024 14:04

whatyouhide commented Aug 17, 2024

View reviewed changes

lib/gettext/macros.ex Show resolved Hide resolved

josevalim reviewed Aug 17, 2024

View reviewed changes

lib/gettext.ex Outdated Show resolved Hide resolved

josevalim reviewed Aug 17, 2024

View reviewed changes

maennchen reviewed Aug 17, 2024

View reviewed changes

whatyouhide added 2 commits August 18, 2024 10:21

Docs and move stuff

faf0c97

More more more

2810c37

whatyouhide commented Aug 18, 2024

View reviewed changes

josevalim approved these changes Aug 18, 2024

View reviewed changes

whatyouhide marked this pull request as ready for review August 18, 2024 11:56

whatyouhide merged commit 57c6249 into main Aug 18, 2024
3 checks passed

whatyouhide deleted the al/no-recompilation branch August 18, 2024 11:56

whatyouhide mentioned this pull request Aug 18, 2024

Update generators with new Gettext API phoenixframework/phoenix#5902

Merged

Gladear mentioned this pull request Aug 18, 2024

Custom storage models #389

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Avoid compile-time dependency to Gettext backend #391

Avoid compile-time dependency to Gettext backend #391

whatyouhide commented Aug 17, 2024

coveralls commented Aug 17, 2024 •

edited

Loading

whatyouhide Aug 17, 2024

whatyouhide Aug 17, 2024

whatyouhide Aug 17, 2024

josevalim Aug 17, 2024

josevalim Aug 17, 2024

whatyouhide Aug 18, 2024

josevalim Aug 17, 2024

whatyouhide Aug 18, 2024

josevalim Aug 18, 2024

josevalim Aug 17, 2024

maennchen Aug 17, 2024

josevalim Aug 17, 2024

maennchen Aug 17, 2024

josevalim Aug 17, 2024

maennchen left a comment

whatyouhide left a comment

whatyouhide Aug 18, 2024

josevalim left a comment

whatyouhide commented Aug 18, 2024

whatyouhide commented Aug 18, 2024

		@@ -0,0 +1,239 @@
		defmodule Gettext.Macros do
		@moduledoc false

Avoid compile-time dependency to Gettext backend #391

Avoid compile-time dependency to Gettext backend #391

Conversation

whatyouhide commented Aug 17, 2024

coveralls commented Aug 17, 2024 • edited Loading

Pull Request Test Coverage Report for Build 2810c37e8e880dc91dcf26f143374c41f8c1c98c-PR-391

Details

💛 - Coveralls

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

maennchen left a comment

Choose a reason for hiding this comment

whatyouhide left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

josevalim left a comment

Choose a reason for hiding this comment

whatyouhide commented Aug 18, 2024

whatyouhide commented Aug 18, 2024

coveralls commented Aug 17, 2024 •

edited

Loading