DEV: Translate post raw instead of post cooked

Author: nattsw

app/jobs/scheduled/automatic_translation_backfill.rb

@@ -102,7 +102,7 @@ def process_batch
       translations_per_model = [translations_per_run / models_translated, 1].max
       topic_ids = fetch_untranslated_model_ids(Topic, "title", translations_per_model)
       translations_per_model = translations_per_run - topic_ids.size
-      post_ids = fetch_untranslated_model_ids(Post, "cooked", translations_per_model)
+      post_ids = fetch_untranslated_model_ids(Post, "raw", translations_per_model)
 
       DiscourseTranslator::VerboseLogger.log(
         "Translating #{topic_ids.size} topics and #{post_ids.size} posts to #{backfill_locales.join(", ")}",

app/models/concerns/discourse_translator/translatable.rb

@@ -24,7 +24,6 @@ def set_detected_locale(locale)
     # @param text [String] the translated text
     def set_translation(locale, text)
       locale = locale.to_s.gsub("_", "-")
-      text = DiscourseTranslator::TranslatedContentSanitizer.sanitize(text)
       translations.find_or_initialize_by(locale: locale).update!(translation: text)
     end
 

app/services/discourse_ai/language_detector.rb

@@ -3,11 +3,11 @@
 module DiscourseAi
   class LanguageDetector
     PROMPT_TEXT = <<~TEXT
-      I want you to act as a language expert, determining the locale for a set of text.
-      The locale is a language identifier, such as "en" for English, "de" for German, etc,
-      and can also include a region identifier, such as "en-GB" for British English, or "zh-Hans" for Simplified Chinese.
-      I will provide you with text, and you will determine the locale of the text.
-      Include your locale between <language></language> XML tags.
+      You are a language expert. Determine the locale for a set of text.
+      - the locale is a language identifier, such as "en" for English, "de" for German, etc
+      - it may include a region identifier, such as "en-GB" for British English, or "zh-CN" for Simplified Chinese
+      - only return the locale
+      - do not write explanations
     TEXT
 
     def initialize(text)
@@ -21,14 +21,13 @@ def detect
           messages: [{ type: :user, content: @text, id: "user" }],
         )
 
-      response =
+      locale =
         DiscourseAi::Completions::Llm.proxy(SiteSetting.ai_helper_model).generate(
           prompt,
           user: Discourse.system_user,
           feature_name: "translator-language-detect",
         )
-
-      (Nokogiri::HTML5.fragment(response).at("language")&.text || response)
+      locale.strip
     end
   end
 end

app/services/discourse_ai/translator.rb

@@ -3,13 +3,14 @@
 module DiscourseAi
   class Translator
     PROMPT_TEMPLATE = <<~TEXT.freeze
-      You are a highly skilled linguist of many languages and have expert knowledge in HTML.
-      Your task is to identify the language of the text I provide and accurately translate it into this language locale "%{target_language}" while preserving the meaning, tone, and nuance of the original text.
-      The text may or may not contain html tags. If they do, preserve them.
-      Maintain proper grammar, spelling, and punctuation in the translated version.
-      You will find the text between <input></input> XML tags.
-      Include your translation between <output></output> XML tags.
-      Do not write explanations.
+      You are an expert translator specializing in converting Markdown content from any source language to target locale "%{target_language}". Your task is to:
+      1. Translate the content accurately while preserving all Markdown formatting elements
+      2. Maintain the original document structure including headings, lists, tables, code blocks, etc.
+      3. Preserve all links, images, and other media references without translation
+      4. Handle code snippets appropriately - don't translate variable names, functions, or syntax within code blocks (```), but translate comments
+      5. When encountering technical terminology, provide the accepted target language term if it exists, or transliterate if no equivalent exists, with the original term in parentheses
+      6. For ambiguous terms or phrases, choose the most contextually appropriate translation
+      7. You are being consumed via an API, only EVER return the translated text, do not return any other information
     TEXT
 
     def initialize(text, target_language)
@@ -21,17 +22,14 @@ def translate
       prompt =
         DiscourseAi::Completions::Prompt.new(
           build_prompt(@target_language),
-          messages: [{ type: :user, content: "<input>#{@text}</input>", id: "user" }],
+          messages: [{ type: :user, content: "#{@text}", id: "user" }],
         )
 
-      llm_translation =
-        DiscourseAi::Completions::Llm.proxy(SiteSetting.ai_helper_model).generate(
-          prompt,
-          user: Discourse.system_user,
-          feature_name: "translator-translate",
-        )
-
-      (Nokogiri::HTML5.fragment(llm_translation).at("output")&.inner_html || "").strip
+      DiscourseAi::Completions::Llm.proxy(SiteSetting.ai_helper_model).generate(
+        prompt,
+        user: Discourse.system_user,
+        feature_name: "translator-translate",
+      )
     end
 
     private

app/services/discourse_translator/base.rb

@@ -33,7 +33,7 @@ def self.translate(translatable, target_locale_sym = I18n.locale)
       detected_lang = detect(translatable)
 
       if translatable.locale_matches?(target_locale_sym)
-        return detected_lang, get_untranslated(translatable)
+        return detected_lang, get_untranslated_cooked(translatable)
       end
 
       translation = translatable.translation_for(target_locale_sym)
@@ -50,7 +50,9 @@ def self.translate(translatable, target_locale_sym = I18n.locale)
       end
 
       translated = translate!(translatable, target_locale_sym)
-      save_translation(translatable, target_locale_sym) { translated }
+      save_translation(translatable, target_locale_sym) do
+        TranslatedContentNormalizer.normalize(translatable, translated)
+      end
       [detected_lang, translated]
     end
 
@@ -122,25 +124,25 @@ def self.translate_supported?(detected_lang, target_lang)
 
     private
 
-    def self.strip_tags_for_detection(detection_text)
-      html_doc = Nokogiri::HTML::DocumentFragment.parse(detection_text)
-      html_doc.css("img", "aside.quote", "div.lightbox-wrapper", "a.mention,a.lightbox").remove
-      html_doc.to_html
-    end
-
     def self.text_for_detection(translatable)
-      strip_tags_for_detection(get_untranslated(translatable)).truncate(
-        DETECTION_CHAR_LIMIT,
-        omission: nil,
-      )
+      get_untranslated_raw(translatable).truncate(DETECTION_CHAR_LIMIT, omission: nil)
     end
 
     def self.text_for_translation(translatable)
       max_char = SiteSetting.max_characters_per_translation
-      get_untranslated(translatable).truncate(max_char, omission: nil)
+      get_untranslated_raw(translatable).truncate(max_char, omission: nil)
+    end
+
+    def self.get_untranslated_raw(translatable)
+      case translatable.class.name
+      when "Post"
+        translatable.raw
+      when "Topic"
+        translatable.title
+      end
     end
 
-    def self.get_untranslated(translatable)
+    def self.get_untranslated_cooked(translatable)
       case translatable.class.name
       when "Post"
         translatable.cooked

lib/discourse_translator/translated_content_normalizer.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module DiscourseTranslator
+  class TranslatedContentNormalizer
+    def self.normalize(translatable, content)
+      case translatable.class.name
+      when "Post"
+        PrettyText.cook(content)
+      when "Topic"
+        PrettyText.cleanup(content, {})
+      end
+    end
+  end
+end

lib/discourse_translator/translated_content_sanitizer.rb

@@ -20,7 +20,9 @@ def valid_value?(val)
     def error_message
       return I18n.t("translator.discourse_ai.not_installed") if !defined?(::DiscourseAi)
 
-      I18n.t("translator.discourse_ai.ai_helper_required") if !SiteSetting.ai_helper_enabled
+      if !SiteSetting.ai_helper_enabled
+        I18n.t("translator.discourse_ai.ai_helper_required", { base_url: Discourse.base_url })
+      end
     end
   end
 end

lib/discourse_translator/translator_selection_validator.rb

@@ -102,7 +102,7 @@ def expect_google_translate(text)
         described_class.new.execute
 
         expect(topic.translations.pluck(:locale, :translation)).to eq([%w[es hola]])
-        expect(post.translations.pluck(:locale, :translation)).to eq([%w[de hallo]])
+        expect(post.translations.pluck(:locale, :translation)).to eq([%w[de <p>hallo</p>]])
       end
     end
 
@@ -126,7 +126,7 @@ def expect_google_translate(text)
 
         expect(topic.translations.pluck(:locale, :translation)).to eq([%w[de hallo]])
         expect(posts.map { |p| p.translations.pluck(:locale, :translation).flatten }).to eq(
-          [%w[de hallo]] * 4,
+          [%w[de <p>hallo</p>]] * 4,
         )
       end
     end
@@ -186,27 +186,27 @@ def expect_google_translate(text)
       post_1.update!(updated_at: 4.days.ago)
       post_7.update!(updated_at: 5.days.ago)
 
-      result = described_class.new.fetch_untranslated_model_ids(Post, "cooked", 50, %w[de es])
+      result = described_class.new.fetch_untranslated_model_ids(Post, "raw", 50, %w[de es])
       expect(result).to include(post_6.id, post_3.id, post_2.id, post_1.id, post_7.id)
     end
 
     it "does not return posts that are deleted" do
       post_1.trash!
-      result = described_class.new.fetch_untranslated_model_ids(Post, "cooked", 50, %w[de es])
+      result = described_class.new.fetch_untranslated_model_ids(Post, "raw", 50, %w[de es])
       expect(result).not_to include(post_1.id)
     end
 
     it "does not return posts that are empty" do
-      post_1.cooked = ""
+      post_1.raw = ""
       post_1.save!(validate: false)
-      result = described_class.new.fetch_untranslated_model_ids(Post, "cooked", 50, %w[de es])
+      result = described_class.new.fetch_untranslated_model_ids(Post, "raw", 50, %w[de es])
       expect(result).not_to include(post_1.id)
     end
 
     it "does not return posts by bots" do
       post_1.update(user: Discourse.system_user)
 
-      result = described_class.new.fetch_untranslated_model_ids(Post, "cooked", 50, %w[de es])
+      result = described_class.new.fetch_untranslated_model_ids(Post, "raw", 50, %w[de es])
 
       expect(result).not_to include(post_1.id)
     end

spec/jobs/automatic_translation_backfill_spec.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+describe DiscourseTranslator::TranslatedContentNormalizer do
+  fab!(:post)
+  fab!(:topic)
+
+  it "normalizes the content" do
+    expect(
+      DiscourseTranslator::TranslatedContentNormalizer.normalize(
+        post,
+        "<script>alert('test')</script><p> <h1>Testing</h1> This is a test post</p>",
+      ),
+    ).to eq("<p> </p><h1>Testing</h1> This is a test post<p></p>")
+
+    expect(
+      DiscourseTranslator::TranslatedContentNormalizer.normalize(
+        topic,
+        "<script>alert('test')</script><p> <h1>Testing</h1> This is a test post</p>",
+      ),
+    ).to eq("<p> </p><h1>Testing</h1> This is a test post<p></p>")
+  end
+end