Fallbacks to exclude default locale #415

tjoyal · 2018-04-17T20:41:35Z

Fixes #338 ?

I believe using the default locale as a default fallback is not a sane default behaviour.

"Silently" displaying an default locale version of a string when a page is being rendered in another can have a negative impact (especially if this is not fixable like in the cases where emails are being sent).

For us to disable that behaviour, we had to pass in an explicit nil, but I believe it should be the default behaviour:

I18n::Locale::Fallbacks.new([nil])
or
Rails.application.config.i18n.fallbacks = [nil]

This only work because of a undocumented compact down in the internals of the class.

I am not saying that I would always prefer to have a "translation missing" error instead of displaying the default locale, but not having the default allows the rest of the i18n stack to handle exceptions as normal, send it to the exception handler where I can transform that missing translation to the specificities of my application.

Eg.: in my current case we have an exception handler that logs on missing translation, send a developer actionable item then manually fall back to I18n.t(key, options.merge(locale: :en), all within the I18n.exception_handler#call

radar · 2018-04-18T05:03:29Z

I have a sneaking suspicion this might also fix #413. That would be nice :)

Fernan2 · 2018-08-08T17:37:58Z

v1.1.0 has broken broken our application, due to this change. We built all relying on its default behavior, and changing it is a major compatibility issue that I see no reason to add, but if it should be added, at the very least it should be done properly: name the version 2.0 instead of 1.1, and release a previous version triggering warnings when the default behavior is being used...

But well... we always can stick to 1.0.1 (which we will do).

radar · 2018-08-08T20:35:58Z

Please provide steps to reproduce this issue so that I can investigate.

…

On 9 Aug 2018, 03:38 +1000, Fernando Calatayud ***@***.***>, wrote: v1.1.0 has broken broken our application, due to this change. We built all relying on its default behavior, and changing it is a major compatibility issue that I see no reason to add, but if it should be added, at the very least it should be done properly: name the version 2.0 instead of 1.1, and release a previous version triggering warnings when the default behavior is being used... But well... we always can stick to 1.0.1 (which we will do). — You are receiving this because you modified the open/close state. Reply to this email directly, view it on GitHub, or mute the thread.

jarthod · 2018-08-08T21:47:01Z

@Fernan2 if you relied on this behavior all you have to do now is declare it explicitly if I'm right, something like:

# config/application.rb
module XXXXX
  class Application < Rails::Application
    ...
    config.i18n.fallbacks = [:en]
  end
end

Fernan2 · 2018-08-09T07:35:36Z

Ok, it seems that I had a weird configuration that has been the cause of all... after @jarthod 's comment, I've gone to my application.rb and I've found that I had

    config.i18n.default_locale = :es
    config.i18n.fallbacks = [:es]

But (fortunately!) I also noticed that I had a different configuration in development.rb and production.rb:

config.i18n.fallbacks = true

That worked fine on 1.0.1, but not on 1.1.0... with the problem that I had overriden development and production but no test, so tests were all passing.

Now I've removed my environment overrides and it works fine... thanks a lot!

jarthod · 2018-08-09T07:43:51Z

I've had exactly the same problem, and after I found the code change in i18n I checked my application.rb and saw that this syntax can't work, I removed the fallback = true line all is back to normal. I'm not sure where this line came from but I guess it was in some tutorial or documentation.

Fernan2 · 2018-08-09T07:50:21Z

As my application comes from Rails 1.2, I guess that this was the proper configuration many years ago...

jarthod · 2018-08-09T07:54:59Z

Haha, mine is from Rails 3 so maybe not that old ;)

Before i18n v1.1.0, i18n.fallbacks would eventually hit your default_locale. That was changed without warning and broke everything ruby-i18n/i18n#415. This restores the previous behavior by explicity falling back to English.

I'm not 100% sure that this is right, but when I make this change it seems to fix the problem that I was having which many other people seem to be having in the globalize#682 discussion ruby-i18n/i18n#415

sshaw · 2020-06-25T02:44:28Z

I had:

I18n::Backend::Simple.send(:include, I18n::Backend::Fallbacks)
I18n.enforce_available_locales = false

And things like:

I18n.l product.updated_at, :format => :long, :locale => "un-supported"

Worked great! Used default locale's :long.

Then I upgraded to said version, and I cannot get this behavior back.

I18n::Backend::Simple.send :include, I18n::Backend::Fallbacks
I18n.enforce_available_locales = false
I18n.fallbacks = [I18n.default_locale]

Gives:

Traceback (most recent call last):
       14: from ./bin/rails:4:in `<main>'
       13: from ./bin/rails:4:in `require'
       12: from /Users/sshaw/.rvm/gems/ruby-2.5.2/gems/railties-5.0.7.2/lib/rails/commands.rb:18:in `<top (required)>'
       11: from /Users/sshaw/.rvm/gems/ruby-2.5.2/gems/railties-5.0.7.2/lib/rails/commands/commands_tasks.rb:49:in `run_command!'
       10: from /Users/sshaw/.rvm/gems/ruby-2.5.2/gems/railties-5.0.7.2/lib/rails/commands/commands_tasks.rb:78:in `console'
        9: from /Users/sshaw/.rvm/gems/ruby-2.5.2/gems/railties-5.0.7.2/lib/rails/commands/console_helper.rb:9:in `start'
        8: from /Users/sshaw/.rvm/gems/ruby-2.5.2/gems/railties-5.0.7.2/lib/rails/commands/console.rb:65:in `start'
        7: from (irb):1
        6: from /Users/sshaw/.rvm/gems/ruby-2.5.2/gems/i18n-1.1.0/lib/i18n.rb:274:in `localize'
        5: from /Users/sshaw/.rvm/gems/ruby-2.5.2/gems/i18n-1.1.0/lib/i18n/backend/base.rb:83:in `localize'
        4: from /Users/sshaw/.rvm/gems/ruby-2.5.2/gems/i18n-1.1.0/lib/i18n.rb:181:in `translate'
        3: from /Users/sshaw/.rvm/gems/ruby-2.5.2/gems/i18n-1.1.0/lib/i18n.rb:181:in `catch'
        2: from /Users/sshaw/.rvm/gems/ruby-2.5.2/gems/i18n-1.1.0/lib/i18n.rb:185:in `block in translate'
        1: from /Users/sshaw/.rvm/gems/ruby-2.5.2/gems/i18n-1.1.0/lib/i18n/backend/fallbacks.rb:45:in `translate'
TypeError (no implicit conversion of String into Integer)

I18n.enforce_available_locales = false
I18n.fallbacks = [I18n.default_locale]

Along with other seemingly correct config permutations give:

I18n::MissingTranslationData (translation missing: XX.time.formats.long)

Back to 1.0.1! 🔒

radar · 2020-07-14T22:55:57Z

@sshaw Could you please open a new issue so that we can track this separately from this merged PR?

radar · 2020-07-14T22:58:25Z

Actually I just found the option to DIY! One moment...

ruby-i18n/i18n#415

movermeyer · 2021-09-01T20:37:13Z

lib/i18n/locale/fallbacks.rb

@@ -56,7 +56,7 @@ class Fallbacks < Hash
      def initialize(*mappings)
        @map = {}
        map(mappings.pop) if mappings.last.is_a?(Hash)
-        self.defaults = mappings.empty? ? [I18n.default_locale.to_sym] : mappings
+        self.defaults = mappings.empty? ? [] : mappings


@tjoyal This PR did not update the documentation comment above, which still references default_locale.

Took me far too long to realize that default_locale was no longer getting used. 😅

I've opened a PR to update the comment: #576

ruby-i18n#415 changed the behaviour, but this comment was not updated to reflect the change.

Fallbacks to exclude default locale

8ddfb17

radar merged commit 697b42d into ruby-i18n:master Apr 18, 2018

tjoyal deleted the fallbacks-to-exclude-default-locale branch April 18, 2018 12:08

radar mentioned this pull request Aug 7, 2018

[WIP] defaults take precedence over fallbacks causing a misleading situation #413

Closed

lsylvester mentioned this pull request Aug 9, 2018

restrict the version of i18n rails/rails#33560

Closed

This was referenced Aug 9, 2018

Rails CI failure since i18n 1.1.0 #427

Closed

Avoid i18n 1.1.0 for now rails/rails#33566

Merged

smgt mentioned this pull request Sep 12, 2018

Add default locale back to fallback locales mongodb/mongoid#4548

Closed

shioyama mentioned this pull request Sep 21, 2018

Bump i18n dependency shioyama/mobility#280

Merged

igor-alexandrov mentioned this pull request Oct 3, 2018

Fixed I18n fallback issue dry-rb/dry-schema#7

Merged

VitaliyAdamkov mentioned this pull request Oct 23, 2018

Fallback is not working for default locale globalize/globalize#682

Closed

ota42y mentioned this pull request Oct 25, 2018

Fix all failed tests globalize/globalize#709

Merged

shioyama mentioned this pull request Oct 27, 2018

Query with fallbacks shioyama/mobility#51

Closed

viroulep mentioned this pull request Oct 29, 2018

Bump money-rails from 1.12.0 to 1.13.0 in /WcaOnRails thewca/worldcubeassociation.org#3543

Merged

kyamaguchi mentioned this pull request Dec 5, 2018

Add post_install_message about change of fallbacks #442

Merged

cbothner mentioned this pull request Dec 12, 2018

Fix interface when locale is something other than English galahq/gala#561

Merged

radar mentioned this pull request Jul 14, 2020

TypeError (no implicit conversion of String into Integer) -- While using I18n.l #534

Closed

j15e added a commit to didacte/hstore_translate that referenced this pull request May 28, 2021

Add fallback configuration now required

136dc32

ruby-i18n/i18n#415

j15e mentioned this pull request May 28, 2021

Testing against latest Rails versions didacte/hstore_translate#1

Open

movermeyer reviewed Sep 1, 2021

View reviewed changes

movermeyer mentioned this pull request Sep 2, 2021

Remove references to default_locale in fallbacks comment #576

Merged

1 task

This was referenced Oct 27, 2021

Broken i18n fallbacks alxckn/middleman#1

Closed

Fix broken i18n fallbacks middleman/middleman#2507

Merged

movermeyer added a commit to movermeyer/i18n that referenced this pull request Mar 16, 2022

Remove references to default_locale in fallbacks comment

1ae0e3f

ruby-i18n#415 changed the behaviour, but this comment was not updated to reflect the change.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fallbacks to exclude default locale #415

Fallbacks to exclude default locale #415

tjoyal commented Apr 17, 2018

radar commented Apr 18, 2018

Fernan2 commented Aug 8, 2018

radar commented Aug 8, 2018 via email

jarthod commented Aug 8, 2018

Fernan2 commented Aug 9, 2018

jarthod commented Aug 9, 2018

Fernan2 commented Aug 9, 2018

jarthod commented Aug 9, 2018

sshaw commented Jun 25, 2020

radar commented Jul 14, 2020

radar commented Jul 14, 2020

movermeyer Sep 1, 2021

movermeyer Sep 2, 2021

Fallbacks to exclude default locale #415

Fallbacks to exclude default locale #415

Conversation

tjoyal commented Apr 17, 2018

radar commented Apr 18, 2018

Fernan2 commented Aug 8, 2018

radar commented Aug 8, 2018 via email

jarthod commented Aug 8, 2018

Fernan2 commented Aug 9, 2018

jarthod commented Aug 9, 2018

Fernan2 commented Aug 9, 2018

jarthod commented Aug 9, 2018

sshaw commented Jun 25, 2020

radar commented Jul 14, 2020

radar commented Jul 14, 2020

movermeyer Sep 1, 2021

Choose a reason for hiding this comment

movermeyer Sep 2, 2021

Choose a reason for hiding this comment