Admin -> Customize -> Text behaving badly

merefield · November 16, 2023, 9:00am

Getting a load of similar issues to this when attempting to filter on my chatbot prompts.

The really strange part is that behaviour can be fine on one install but not another.

Take the very simple filter of chatbot.prompt on Admin → Customize → Text:

Working install:

Failing install:

NoMethodError (undefined method `scan' for {:basic=>"You are a helpful assistant.", :agent=>"You are a helpful assistant.  You have great tools in the form of functions that give you the power to get newer information. Only use the functions you have been provided with.  The current date and time is %{current_date_time}.  Only respond to the last question, using the prior information as context, if appropriate."}:Hash)
lib/i18n/i18n_interpolation_keys_finder.rb:6:in `find'
app/controllers/admin/site_texts_controller.rb:183:in `record_for'
app/controllers/admin/site_texts_controller.rb:249:in `block in find_translations'
app/controllers/admin/site_texts_controller.rb:234:in `each'
app/controllers/admin/site_texts_controller.rb:234:in `find_translations'
app/controllers/admin/site_texts_controller.rb:34:in `index'
app/controllers/application_controller.rb:422:in `block in with_resolved_locale'
app/controllers/application_controller.rb:422:in `with_resolved_locale'
lib/middleware/omniauth_bypass_middleware.rb:64:in `call'
lib/content_security_policy/middleware.rb:12:in `call'
lib/middleware/anonymous_cache.rb:389:in `call'
lib/middleware/gtm_script_nonce_injector.rb:10:in `call'
config/initializers/100-quiet_logger.rb:20:in `call'
config/initializers/100-silence_logger.rb:29:in `call'
lib/middleware/enforce_hostname.rb:24:in `call'
lib/middleware/request_tracker.rb:233:in `call'

The locale file in question is this one:

github.com/merefield/discourse-chatbot

config/locales/server.en.yml

main

en:
  site_settings:
    chatbot_enabled: "Enable the chatbot plugin"
    chatbot_open_ai_token: "Your Open AI token. Will also be used as token if you set a custom URL to service other than Open AI. You can get one at <a target='_blank' rel='noopener' href='https://platform.openai.com/account/api-keys/'>openai.com</a>"
    chatbot_bot_type_low_trust: "(LOW TRUST USERS) New Reasoning models (o1 series) currently require 'basic'.  'RAG' will give bot local deterministic functions (but be aware this uses more calls to the LLM increasing cost significantly!). Maintain associated prompts at <a target='_blank' rel='noopener' href='/admin/customize/site_texts?q=chatbot.prompt.system.'>Customize Text</a>"
    chatbot_bot_type_medium_trust: "(MEDIUM TRUST USERS) New Reasoning models (o1 series) currently require 'basic'.  'RAG' will give bot local deterministic functions (but be aware this uses more calls to the LLM increasing cost significantly!). Maintain associated prompts at <a target='_blank' rel='noopener' href='/admin/customize/site_texts?q=chatbot.prompt.system.'>Customize Text</a>"
    chatbot_bot_type_high_trust: "(HIGH TRUST USERS) New Reasoning models (o1 series) currently require 'basic'.  'RAG' will give bot local deterministic functions (but be aware this uses more calls to the LLM increasing cost significantly!). Maintain associated prompts at <a target='_blank' rel='noopener' href='/admin/customize/site_texts?q=chatbot.prompt.system.'>Customize Text</a>"
    chatbot_open_ai_model_low_trust: "(LOW TRUST USERS, UNLESS CUSTOM) The model to be accessed. More on supported models at <a target='_blank' rel='noopener' href='https://platform.openai.com/docs/models/overview'>OpenAI: Model overview</a>"
    chatbot_open_ai_model_custom_low_trust: "(LOW TRUST USERS) Use Custom model name (ADVANCED USERS ONLY)"
    chatbot_open_ai_model_custom_name_low_trust: "(LOW TRUST USERS, CUSTOM ONLY) Name of model"
    chatbot_open_ai_model_custom_url_low_trust: "Populate it if you want to use proxy to Open AI or Azure OpenAI, e.g. https://custom-domain.openai.azure.com/openai/deployments/custom-name."
    chatbot_open_ai_model_medium_trust: "(MEDIUM TRUST USERS, UNLESS CUSTOM) The model to be accessed. More on supported models at <a target='_blank' rel='noopener' href='https://platform.openai.com/docs/models/overview'>OpenAI: Model overview</a>"
    chatbot_open_ai_model_custom_medium_trust: "(MEDIUM TRUST USERS) Use Custom model name (ADVANCED USERS ONLY)"
    chatbot_open_ai_model_custom_name_medium_trust: "(MEDIUM TRUST USERS, CUSTOM ONLY) Name of model"
    chatbot_open_ai_model_custom_url_medium_trust: "Populate it if you want to use proxy to Open AI or Azure OpenAI, e.g. https://custom-domain.openai.azure.com/openai/deployments/custom-name."
    chatbot_open_ai_model_high_trust: "(HIGH TRUST USERS, UNLESS CUSTOM) The model to be accessed. More on supported models at <a target='_blank' rel='noopener' href='https://platform.openai.com/docs/models/overview'>OpenAI: Model overview</a>"
    chatbot_open_ai_model_custom_high_trust: "(HIGH TRUST USERS) Use Custom model name (ADVANCED USERS ONLY)"
    chatbot_open_ai_model_custom_name_high_trust: "(HIGH TRUST USERS, CUSTOM ONLY) Name of model"
    chatbot_open_ai_model_custom_url_high_trust: "Populate it if you want to use proxy to Open AI or Azure OpenAI, e.g. https://custom-domain.openai.azure.com/openai/deployments/custom-name."
    chatbot_open_ai_model_custom_api_version: "Azure OpenAI REST API version. Required only when 'custom_api_type' is set to 'azure'. Refer to: <a target='_blank' rel='noopener' href='https://learn.microsoft.com/en-us/azure/ai-services/openai/reference'>Azure REST API reference</a>"

This file has been truncated. show original

Am I doing anything illegal?

merefield · November 16, 2023, 9:52am

ok

looks like the method in question is expecting text:

github.com/discourse/discourse

lib/i18n/i18n_interpolation_keys_finder.rb

68a912952


      
          # frozen_string_literal: true
          
          class I18nInterpolationKeysFinder
            def self.find(text)
              pattern = Regexp.union([*I18n.config.interpolation_patterns, /\{\{(\w+)\}\}/])
              keys = text.scan(pattern)
              keys.flatten!
              keys.compact!
              keys.uniq!
              keys
            end
          end

but somehow receiving a Hash:

irb(main):001:0> item = {:basic=>"You are a helpful assistant.", :agent=>"You are a helpful assistant.  You have great tools in the form of functions that give you the power to get newer information. Only use the functions you have been provided with.  The current date and time is %{current_date_time}.  Only respond to the last question, using the prior information as context, if appropriate."}
=>
{:basic=>"You are a helpful assistant.",
...
irb(main):002:0> item
=>
{:basic=>"You are a helpful assistant.",
 :agent=>
  "You are a helpful assistant.  You have great tools in the form of functions that give you the power to get newer information. Only use the functions you have been provided with.  The current date and time is %{current_date_time}.  Only respond to the last question, using the prior information as context, if appropriate."}
irb(main):003:0> item.scan
(irb):3:in `<main>': undefined method `scan' for {:basic=>"You are a helpful assistant.", :agent=>"You are a helpful assistant.  You have great tools in the form of functions that give you the power to get newer information. Only use the functions you have been provided with.  The current date and time is %{current_date_time}.  Only respond to the last question, using the prior information as context, if appropriate."}:Hash (NoMethodError)
        from /home/robert/.rbenv/versions/3.2.1/lib/ruby/gems/3.2.0/gems/irb-1.6.2/exe/irb:11:in `<top (required)>'
        from /home/robert/.rbenv/versions/3.2.1/bin/irb:25:in `load'
        from /home/robert/.rbenv/versions/3.2.1/bin/irb:25:in `<main>'
irb(main):004:0>

Causing it to fall over … I will continue investigation

It’s being called from here, I believe:

github.com/discourse/discourse

app/controllers/admin/site_texts_controller.rb

68a912952


      
          
          def is_badge_title?(id = "")
            badge_parts = id.split(".")
            badge_parts[0] == "badges" && badge_parts[2] == "name"
          end
          
          def record_for(key:, value: nil, locale:)
            en_key = TranslationOverride.transform_pluralized_key(key)
            value ||= I18n.with_locale(locale) { I18n.t(key) }
            interpolation_keys =
              I18nInterpolationKeysFinder.find(I18n.overrides_disabled { I18n.t(en_key, locale: :en) })
            custom_keys = TranslationOverride.custom_interpolation_keys(en_key)
            { id: key, value: value, locale: locale, interpolation_keys: interpolation_keys + custom_keys }
          end
          
          PLURALIZED_REGEX = /(.*)\.(zero|one|two|few|many|other)\z/
          
          def find_site_text(locale)
            if self.class.restricted_keys.include?(params[:id])
              raise Discourse::InvalidAccess.new(
                      nil,

I can repro the issue with:

I18nInterpolationKeysFinder.find(I18n.overrides_disabled { I18n.t("chatbot.prompt.system.", locale: :en) })
from the rails console.

I think this line is supposed to prevent the method receiving a Hash, but it’s not working, why?:

github.com/discourse/discourse

app/controllers/admin/site_texts_controller.rb

68a912952


      
            else
              translations[key] = value
            end
          end
          
          results = []
          
          translations.each do |key, value|
            next unless I18n.exists?(key, :en)
          
            if value&.is_a?(Hash)
              fix_plural_keys(key, value, locale).each do |plural|
                plural_key = plural[0]
                plural_value = plural[1]
          
                results << record_for(
                  key: "#{key}.#{plural_key}",
                  value: plural_value,
                  locale: plural.last,
                )
              end

merefield · November 16, 2023, 10:17am

Moving this to Contribute > Bug, because I think this behaviour is incorrect and for some reason unreliable.

According to the code, if the value is a Hash, it should not be sent to the record_for method (where it would cause an exception as that is expecting text), but in some instances, it is.

Happy to stand corrected.

gerhard · November 20, 2023, 3:23pm

This happens when there’s a translation override for a key that previously was a translatable string, but was converted into a Hash at a later time. That’s exactly what happened with chatbot.prompt.system.

This seems like a regression. I’m pretty sure this used to work in the past.

I can easily reproduce this with a locale file like this:

en:
  foo: "this is foo"

Go to Customize → Text and override “foo” with a different value.

Then, change the locale file to look like this:

en:
  foo:
    basic: "Basic Foo"
    advanced: "Advanced Foo"

Visit Customize → Text again and search for “foo”. Discourse will log the following error.

NoMethodError (undefined method `scan' for {:basic=>"Basic Foo", :advanced=>"Advanced Foo"}:Hash)
lib/i18n/i18n_interpolation_keys_finder.rb:6:in `find'
app/controllers/admin/site_texts_controller.rb:183:in `record_for'
app/controllers/admin/site_texts_controller.rb:249:in `block in find_translations'
app/controllers/admin/site_texts_controller.rb:234:in `each'
app/controllers/admin/site_texts_controller.rb:234:in `find_translations'
app/controllers/admin/site_texts_controller.rb:34:in `index'

Discourse shouldn’t load translation overrides if there’s no corresponding English string.

merefield · November 20, 2023, 3:46pm

Thanks @gerhard

That’s exactly what happened: I added another final key in the same bucket.

… And it doesn’t affect new installs.

Is there any kind of rails console workaround?

gerhard · November 20, 2023, 4:10pm

TranslationOverride.where(translation_key: "chatbot.prompt.system").delete_all
TranslationOverride.send(:reload_locale!)

merefield · November 20, 2023, 4:11pm

Peeerrrfect. Yes I was going to try that but not at

Guess I could add that to a migration?!

JammyDodger · August 2, 2024, 6:59am

I believe this bug has also been resolved along with this one:

Topic		Replies	Views
Undefined method `scan' Translations	2	934	March 6, 2019
Errors after migrating to a new version (1.9.0.beta3) Bug	14	2241	July 11, 2017
Error In changing site texts Bug	9	1098	August 29, 2019
Changes in text content not reflected on (non-english) site Bug	7	1416	November 10, 2019
Translation data errors (pending users template, other) Bug	2	1366	December 31, 2015

Admin -> Customize -> Text behaving badly

AI-generated summary

Related topics