discourse/lib/tasks/site_settings.rake
Gabriel Grubba e52b385ae1
FIX: type: objects uploads should be stored as IDs (#40178)
Inside `type objects` we accepted upload URLs and converted them into
IDs, but we did not update the original object to have an ID.

Only on consuming should we turn the ID into a URL.

For normal front-end consumers, object upload fields should still be
URLs. Backend consumers should expect upload IDs.

<img width="2295" height="1263" alt="Screenshot 2026-05-20 at 12 19 23"
src="https://github.com/user-attachments/assets/20d411c4-1570-45fc-96c8-02f2b1b3639d"
/>
2026-05-21 13:45:27 -03:00

114 lines
3 KiB
Ruby
Vendored

# frozen_string_literal: true
require "yaml"
require_relative "../site_settings/object_uploads_normalizer"
desc "Exports site settings"
task "site_settings:export" => :environment do
h = SiteSettingsTask.export_to_hash
puts h.to_yaml
end
desc "Imports site settings"
task "site_settings:import" => :environment do
yml = STDIN.tty? ? "" : STDIN.read
if yml == ""
puts
puts "Please specify a settings yml file"
puts "Example: rake site_settings:import < settings.yml"
exit 1
end
puts
puts "starting import..."
puts
log, counts = SiteSettingsTask.import(yml)
puts log
puts
puts "Results:"
puts " Updated: #{counts[:updated]}"
puts " Not Found: #{counts[:not_found]}"
puts " Errors: #{counts[:errors]}"
exit 1 if counts[:not_found] + counts[:errors] > 0
end
# Outputs a list of Site Settings that may no longer be in use
desc "Find dead site settings"
task "site_settings:find_dead" => :environment do
setting_names = SiteSettingsTask.names
setting_names.each do |n|
if !SiteSetting.respond_to?(n)
# Likely won't hit here, but just in case
puts "Setting #{n} does not exist."
end
end
directories = SiteSettingsTask.directories
dead_settings = []
if !SiteSettingsTask.rg_installed?
puts "Please install ripgrep to use this command"
exit 1
end
if !ENV["ALL_THE_PARENT_DIR"]
puts "To specify a custom parent directory for all-the-themes & all-the-plugins"
puts "use the ALL_THE_PARENT_DIR ENV var."
end
puts "Checking #{setting_names.count} settings in these directories:"
puts directories
puts
setting_names.each do |setting_name|
count = SiteSettingsTask.rg_search_count("SiteSetting.#{setting_name}", directories.first)
count =
SiteSettingsTask.rg_search_count(
"siteSettings.#{setting_name}",
directories.first,
) if count.zero?
directories.each do |directory|
count = SiteSettingsTask.rg_search_count(setting_name, directory) if count.zero?
end
if count.zero?
print setting_name
dead_settings << setting_name
else
print "."
end
end
puts
if dead_settings.count > 0
puts "These settings may be unused:"
puts dead_settings
else
puts "No dead settings found."
end
end
# TODO(gabriel): This was added as a fix for a bug in `type: object` settings.
# Some settings were storing the upload URLs instead of upload IDs.
# This rake task can be removed by May 2027
# Remove `spec/tasks/site_settings_spec.rb` too.
desc "Normalize upload URLs in objects site/theme settings to upload IDs"
task "site_settings:normalize_object_uploads" => :environment do
dry_run = ENV["DRY_RUN"] == "1"
counts = SiteSettings::ObjectUploadsNormalizer.new(dry_run:).normalize
puts
puts "Results:"
puts " Processed: #{counts[:processed]}"
puts " Changed: #{counts[:changed]}"
puts " Unchanged: #{counts[:unchanged]}"
puts " Skipped: #{counts[:skipped]}"
puts " Invalid JSON: #{counts[:invalid_json]}"
puts " Errors: #{counts[:errors]}"
exit 1 if counts[:errors] > 0
end