Use effective locale for inline translation

Author: nattsw

assets/javascripts/discourse/components/show-original-content.gjs

@@ -7,7 +7,10 @@ import concatClass from "discourse/helpers/concat-class";
 
 export default class ShowOriginalContent extends Component {
   static shouldRender(args) {
-    return args.topic.is_translated;
+    return (
+      args.topic.is_translated ||
+      args.topic.postStream.posts.some(({ is_translated }) => is_translated)
+    );
   }
 
   @service router;

lib/discourse_translator/guardian_extension.rb

@@ -24,15 +24,17 @@ def can_detect_language?(post)
   def can_translate?(post)
     return false if post.user&.bot?
     return false if !user_group_allow_translate?
-    return false if post.locale_matches?(I18n.locale)
 
     # we want to return false if the post is created within a short buffer ago,
     # this prevents the 🌐from appearing and then disappearing if the lang is same as user's lang
     return false if post.created_at > POST_DETECTION_BUFFER.ago && post.detected_locale.blank?
 
     if SiteSetting.experimental_inline_translation
-      post.translation_for(I18n.locale).nil?
+      locale = DiscourseTranslator::InlineTranslation.effective_locale
+      return false if post.locale_matches?(locale)
+      post.translation_for(locale).nil?
     else
+      return false if post.locale_matches?(I18n.locale)
       poster_group_allow_translate?(post)
     end
   end

lib/discourse_translator/inline_translation.rb

@@ -2,62 +2,68 @@
 
 module DiscourseTranslator
   class InlineTranslation
+    def self.effective_locale
+      if LocaleMatcher.user_locale_is_default? || LocaleMatcher.user_locale_in_target_languages?
+        I18n.locale
+      else
+        SiteSetting.default_locale
+      end
+    end
+
     def inject(plugin)
+      # since locales are eager loaded but translations may not,
+      # always return early if topic and posts are in the user's effective_locale.
+      # this prevents the need to load translations.
+
       plugin.register_modifier(:basic_post_serializer_cooked) do |cooked, serializer|
         if !SiteSetting.experimental_inline_translation ||
-             serializer.scope&.request&.params&.[]("show") == "original" ||
-             serializer.object.detected_locale == I18n.locale.to_s.gsub("_", "-")
+             serializer.object.locale_matches?(InlineTranslation.effective_locale) ||
+             serializer.scope&.request&.params&.[]("show") == "original"
           cooked
         else
-          serializer.object.translation_for(I18n.locale).presence
+          serializer.object.translation_for(InlineTranslation.effective_locale).presence
         end
       end
 
       plugin.register_modifier(:topic_serializer_fancy_title) do |fancy_title, serializer|
         if !SiteSetting.experimental_inline_translation ||
-             serializer.scope&.request&.params&.[]("show") == "original" ||
-             serializer.object.locale_matches?(I18n.locale)
+             serializer.object.locale_matches?(InlineTranslation.effective_locale) ||
+             serializer.scope&.request&.params&.[]("show") == "original"
           fancy_title
         else
-          serializer.object.translation_for(I18n.locale).presence&.then { |t| Topic.fancy_title(t) }
+          serializer
+            .object
+            .translation_for(InlineTranslation.effective_locale)
+            .presence
+            &.then { |t| Topic.fancy_title(t) }
         end
       end
 
       plugin.register_modifier(:topic_view_serializer_fancy_title) do |fancy_title, serializer|
         if !SiteSetting.experimental_inline_translation ||
-             serializer.scope&.request&.params&.[]("show") == "original" ||
-             serializer.object.topic.locale_matches?(I18n.locale)
+             serializer.object.topic.locale_matches?(InlineTranslation.effective_locale) ||
+             serializer.scope&.request&.params&.[]("show") == "original"
           fancy_title
         else
           serializer
             .object
             .topic
-            .translation_for(I18n.locale)
+            .translation_for(InlineTranslation.effective_locale)
             .presence
             &.then { |t| Topic.fancy_title(t) }
         end
       end
 
-      plugin.add_to_serializer(
-        :basic_post,
-        :is_translated,
-        include_condition: -> { SiteSetting.experimental_inline_translation },
-      ) { !object.locale_matches?(I18n.locale) && object.translation_for(I18n.locale).present? }
-
-      plugin.add_to_serializer(
-        :topic_view,
-        :is_translated,
-        include_condition: -> { SiteSetting.experimental_inline_translation },
-      ) do
-        # since locales are eager loaded, but translations may not
-        # return early if topic and posts are all in the user's locale
-        if object.topic.locale_matches?(I18n.locale) &&
-             object.posts.all? { |p| p.locale_matches?(I18n.locale) }
-          return false
-        end
+      plugin.add_to_serializer(:basic_post, :is_translated) do
+        SiteSetting.experimental_inline_translation &&
+          !object.locale_matches?(InlineTranslation.effective_locale) &&
+          object.translation_for(InlineTranslation.effective_locale).present?
+      end
 
-        object.topic.translation_for(I18n.locale).present? ||
-          object.posts.any? { |p| p.translation_for(I18n.locale).present? }
+      plugin.add_to_serializer(:topic_view, :is_translated) do
+        SiteSetting.experimental_inline_translation &&
+          !object.topic.locale_matches?(InlineTranslation.effective_locale) &&
+          object.topic.translation_for(InlineTranslation.effective_locale).present?
       end
     end
   end

lib/discourse_translator/locale_matcher.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module DiscourseTranslator
+  class LocaleMatcher
+    def self.user_locale_in_target_languages?
+      # e.g. "en|es|pt_BR" vs :en_UK
+      SiteSetting.automatic_translation_target_languages.split("|").include?(I18n.locale.to_s)
+    end
+
+    def self.user_locale_is_default?
+      # e.g. :en_UK vs "en_UK"
+      I18n.locale.to_s == SiteSetting.default_locale
+    end
+  end
+end

lib/discourse_translator/topic_view_serializer_extension.rb

@@ -8,15 +8,15 @@ def posts
         # this is kind of a micro-optimization.
         # we do not want to eager load translations if the user is using the site's language.
         # we will only load them if the user is using a different language that is supported by the site.
-        posts_query =
-          posts_query.includes(:translations) if SiteSetting.experimental_inline_translation &&
-          (
-            I18n.locale.to_s != SiteSetting.default_locale &&
-              SiteSetting
-                .automatic_translation_target_languages
-                .split("|")
-                .include?(I18n.locale.to_s)
-          )
+        if SiteSetting.experimental_inline_translation && !LocaleMatcher.user_locale_is_default? &&
+             LocaleMatcher.user_locale_in_target_languages?
+          posts_query =
+            posts_query.includes(:translations).where(
+              translations: {
+                locale: InlineTranslation.effective_locale.to_s.gsub("_", "-"),
+              },
+            )
+        end
         object.instance_variable_set(:@posts, posts_query)
       end
       super

spec/serializers/post_serializer_spec.rb

@@ -74,9 +74,11 @@
       expect(serializer.is_translated).to eq(false)
     end
 
-    it "returns true when there is a translation for the current locale" do
+    it "returns true when there is a translation for the user's locale in target languages" do
       SiteSetting.translator_enabled = true
       SiteSetting.experimental_inline_translation = true
+      SiteSetting.automatic_translation_backfill_maximum_translations_per_hour = 1
+      SiteSetting.automatic_translation_target_languages = "ja"
       I18n.locale = "ja"
       post.set_detected_locale("en")
       post.set_translation("ja", "こんにちは")
@@ -85,9 +87,24 @@
       expect(serializer.is_translated).to eq(true)
     end
 
-    it "returns false when there is no translation for the current locale" do
+    it "returns false when there is a translation for the user's locale not in target languages" do
       SiteSetting.translator_enabled = true
       SiteSetting.experimental_inline_translation = true
+      SiteSetting.automatic_translation_backfill_maximum_translations_per_hour = 1
+      SiteSetting.automatic_translation_target_languages = "es"
+      I18n.locale = "ja"
+      post.set_detected_locale("en")
+      post.set_translation("ja", "こんにちは")
+      serializer = PostSerializer.new(post, scope: Guardian.new)
+
+      expect(serializer.is_translated).to eq(false)
+    end
+
+    it "returns false when there is no translation for the current locale in target languages" do
+      SiteSetting.translator_enabled = true
+      SiteSetting.experimental_inline_translation = true
+      SiteSetting.automatic_translation_backfill_maximum_translations_per_hour = 1
+      SiteSetting.automatic_translation_target_languages = "ja"
       I18n.locale = "ja"
       post.set_translation("es", "Hola")
       serializer = PostSerializer.new(post, scope: Guardian.new)
@@ -116,6 +133,8 @@ def serialize_post(guardian_user: user, params: {})
 
     it "does not return translated_cooked when show=original param is present" do
       I18n.locale = "ja"
+      SiteSetting.automatic_translation_backfill_maximum_translations_per_hour = 1
+      SiteSetting.automatic_translation_target_languages = "ja"
       post.set_translation("ja", "こんにちは")
 
       expect(serialize_post(params: { "show" => "original" }).cooked).to eq(post.cooked)
@@ -130,11 +149,17 @@ def serialize_post(guardian_user: user, params: {})
       expect(serialize_post.cooked).to eq(post.cooked)
     end
 
-    it "returns translated content based on locale" do
-      I18n.locale = "ja"
+    it "returns translated content based on locale presence in target languages" do
+      SiteSetting.automatic_translation_backfill_maximum_translations_per_hour = 1
       post.set_translation("ja", "こんにちは")
       post.set_translation("es", "Hola")
+      I18n.locale = "ja"
+
+      SiteSetting.automatic_translation_target_languages = "ja"
       expect(serialize_post.cooked).to eq("こんにちは")
+
+      SiteSetting.automatic_translation_target_languages = "es"
+      expect(serialize_post.cooked).to eq(post.cooked)
     end
 
     it "does not return translated_cooked when plugin is disabled" do