discourse
/
discourse-ai
mirror of https://github.com/discourse/discourse-ai.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

DEV: doc style comments + i18n.t()

This commit is contained in:
Keegan George 2025-06-12 09:29:47 -07:00
parent 9a69cb8796
commit 46e13f200f
No known key found for this signature in database
GPG Key ID: 91B40E38537AC000
2 changed files with 55 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
config/locales/server.en.yml
View File

@ -586,6 +586,11 @@ en:
missing_provider_param: "%{param} can't be blank"
bedrock_invalid_url: "Please complete all the fields to use this model."
ai_staff_action_logger:
updated: "updated"
set: "set"
removed: "removed"
errors:
quota_exceeded: "You have exceeded the quota for this model. Please try again in %{relative_time}."
quota_required: "You must specify maximum tokens or usages for this model"

58
lib/utils/ai_staff_action_logger.rb
View File

@ -3,7 +3,7 @@
module DiscourseAi
module Utils
class AiStaffActionLogger
# Maximum length for text fields before truncation/simplification
## Maximum length for text fields before truncation/simplification
MAX_TEXT_LENGTH = 100
def initialize(current_user)
@ -11,14 +11,20 @@ module DiscourseAi
@staff_logger = ::StaffActionLogger.new(current_user)
end
# Log creation of an AI entity (LLM model or persona)
## Logs the creation of an AI entity (LLM model or persona)
## @param entity_type [Symbol] The type of AI entity being created
## @param entity [Object] The entity object being created
## @param field_config [Hash] Configuration for how to handle different entity fields
## @param entity_details [Hash] Additional details about the entity to be logged
def log_creation(entity_type, entity, field_config = {}, entity_details = {})
# Start with provided entity details (id, name, etc.)
# Convert all keys to strings for consistent handling in StaffActionLogger
log_details = {}
# Extract subject for StaffActionLogger.base_attrs
subject = entity_details[:subject] || (entity.respond_to?(:display_name) ? entity.display_name : nil)
subject =
entity_details[:subject] ||
(entity.respond_to?(:display_name) ? entity.display_name : nil)
# Add the entity details but preserve subject as a top-level attribute
entity_details.each { |k, v| log_details[k.to_s] = v unless k == :subject }
@ -31,7 +37,12 @@ module DiscourseAi
@staff_logger.log_custom("create_ai_#{entity_type}", log_details.merge(subject: subject))
end
# Log update of an AI entity with before/after comparison
## Logs an update to an AI entity with before/after comparison
## @param entity_type [Symbol] The type of AI entity being updated
## @param entity [Object] The entity object after update
## @param initial_attributes [Hash] The attributes of the entity before update
## @param field_config [Hash] Configuration for how to handle different entity fields
## @param entity_details [Hash] Additional details about the entity to be logged
def log_update(
entity_type,
entity,
@ -69,7 +80,7 @@ module DiscourseAi
field_config[:json_fields].each do |field|
field_str = field.to_s
if initial_attributes[field_str].to_s != current_attributes[field_str].to_s
changes[field_str] = "updated"
changes[field_str] = I18n.t("discourse_ai.ai_staff_action_logger.updated")
end
end
end
@ -77,7 +88,9 @@ module DiscourseAi
# Only log if there are actual changes
if changes.any?
# Extract subject for StaffActionLogger.base_attrs
subject = entity_details[:subject] || (entity.respond_to?(:display_name) ? entity.display_name : nil)
subject =
entity_details[:subject] ||
(entity.respond_to?(:display_name) ? entity.display_name : nil)
log_details = {}
# Convert entity_details keys to strings, but preserve subject as a top-level attribute
@ -89,7 +102,9 @@ module DiscourseAi
end
end
# Log deletion of an AI entity
## Logs the deletion of an AI entity
## @param entity_type [Symbol] The type of AI entity being deleted
## @param entity_details [Hash] Details about the entity being deleted
def log_deletion(entity_type, entity_details)
# Extract subject for StaffActionLogger.base_attrs
subject = entity_details[:subject]
@ -101,7 +116,9 @@ module DiscourseAi
@staff_logger.log_custom("delete_ai_#{entity_type}", string_details.merge(subject: subject))
end
# Direct custom logging for complex cases
## Direct custom logging for complex cases
## @param action_type [String] The type of action being logged
## @param log_details [Hash] Details to be logged
def log_custom(action_type, log_details)
# Extract subject for StaffActionLogger.base_attrs if present
subject = log_details[:subject]
@ -115,34 +132,45 @@ module DiscourseAi
private
## Formats the change in a field's value for logging
## @param field [Symbol] The field that changed
## @param initial_value [Object] The original value
## @param current_value [Object] The new value
## @param options [Hash] Options for formatting
## @return [String] Formatted representation of the change
def format_field_change(field, initial_value, current_value, options = {})
# Handle different field types based on controller-provided options
if options[:type] == :sensitive
return format_sensitive_field_change(initial_value, current_value)
elsif options[:type] == :large_text ||
(initial_value.is_a?(String) && initial_value.length > MAX_TEXT_LENGTH) ||
(current_value.is_a?(String) && current_value.length > MAX_TEXT_LENGTH)
return "updated"
return I18n.t("discourse_ai.ai_staff_action_logger.updated")
end
# Default formatting: "old_value → new_value"
"#{initial_value} → #{current_value}"
end
## Formats changes to sensitive fields without exposing actual values
## @param initial_value [Object] The original value
## @param current_value [Object] The new value
## @return [String] Description of the change (updated/set/removed)
def format_sensitive_field_change(initial_value, current_value)
if initial_value.present? && current_value.present?
"updated"
I18n.t("discourse_ai.ai_staff_action_logger.updated")
elsif current_value.present?
"set"
I18n.t("discourse_ai.ai_staff_action_logger.set")
else
"removed"
I18n.t("discourse_ai.ai_staff_action_logger.removed")
end
end
## Extracts relevant attributes from an entity based on field configuration
## @param entity [Object] The entity to extract attributes from
## @param field_config [Hash] Configuration for how to handle different entity fields
## @return [Hash] The extracted attributes
def extract_entity_attributes(entity, field_config)
result = {}
# Process each field according to its configuration
field_config.each do |field, options|
# Skip special keys like :json_fields which are arrays, not field configurations
next if field == :json_fields