discourse/db/migrate/20210204135429_rename_sso_site_settings.rb

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

42 lines
1.8 KiB
Ruby
Raw Normal View History

FEATURE: Rename 'Discourse SSO' to DiscourseConnect (#11978) The 'Discourse SSO' protocol is being rebranded to DiscourseConnect. This should help to reduce confusion when 'SSO' is used in the generic sense. This commit aims to: - Rename `sso_` site settings. DiscourseConnect specific ones are prefixed `discourse_connect_`. Generic settings are prefixed `auth_` - Add (server-side-only) backwards compatibility for the old setting names, with deprecation notices - Copy `site_settings` database records to the new names - Rename relevant translation keys - Update relevant translations This commit does **not** aim to: - Rename any Ruby classes or methods. This might be done in a future commit - Change any URLs. This would break existing integrations - Make any changes to the protocol. This would break existing integrations - Change any functionality. Further normalization across DiscourseConnect and other auth methods will be done separately The risks are: - There is no backwards compatibility for site settings on the client-side. Accessing auth-related site settings in Javascript is fairly rare, and an error on the client side would not be security-critical. - If a plugin is monkey-patching parts of the auth process, changes to locale keys could cause broken error messages. This should also be unlikely. The old site setting names remain functional, so security-related overrides will remain working. A follow-up commit will be made with a post-deploy migration to delete the old `site_settings` rows.
2021-02-08 18:04:33 +08:00
# frozen_string_literal: true
class RenameSsoSiteSettings < ActiveRecord::Migration[6.0]
RENAME_SETTINGS = [
%w[enable_sso enable_discourse_connect],
%w[sso_allows_all_return_paths discourse_connect_allows_all_return_paths],
%w[enable_sso_provider enable_discourse_connect_provider],
%w[verbose_sso_logging verbose_discourse_connect_logging],
%w[sso_url discourse_connect_url],
%w[sso_secret discourse_connect_secret],
%w[sso_provider_secrets discourse_connect_provider_secrets],
%w[sso_overrides_groups discourse_connect_overrides_groups],
%w[sso_overrides_bio discourse_connect_overrides_bio],
%w[sso_overrides_email auth_overrides_email],
%w[sso_overrides_username auth_overrides_username],
%w[sso_overrides_name auth_overrides_name],
%w[sso_overrides_avatar discourse_connect_overrides_avatar],
%w[sso_overrides_profile_background discourse_connect_overrides_profile_background],
%w[sso_overrides_location discourse_connect_overrides_location],
%w[sso_overrides_website discourse_connect_overrides_website],
%w[sso_overrides_card_background discourse_connect_overrides_card_background],
%w[external_auth_skip_create_confirm auth_skip_create_confirm],
%w[external_auth_immediately auth_immediately],
]
def up
# Copying the rows so that things keep working during deploy
# They will be dropped in post_migrate/20210219171329_drop_old_sso_site_settings
FEATURE: Rename 'Discourse SSO' to DiscourseConnect (#11978) The 'Discourse SSO' protocol is being rebranded to DiscourseConnect. This should help to reduce confusion when 'SSO' is used in the generic sense. This commit aims to: - Rename `sso_` site settings. DiscourseConnect specific ones are prefixed `discourse_connect_`. Generic settings are prefixed `auth_` - Add (server-side-only) backwards compatibility for the old setting names, with deprecation notices - Copy `site_settings` database records to the new names - Rename relevant translation keys - Update relevant translations This commit does **not** aim to: - Rename any Ruby classes or methods. This might be done in a future commit - Change any URLs. This would break existing integrations - Make any changes to the protocol. This would break existing integrations - Change any functionality. Further normalization across DiscourseConnect and other auth methods will be done separately The risks are: - There is no backwards compatibility for site settings on the client-side. Accessing auth-related site settings in Javascript is fairly rare, and an error on the client side would not be security-critical. - If a plugin is monkey-patching parts of the auth process, changes to locale keys could cause broken error messages. This should also be unlikely. The old site setting names remain functional, so security-related overrides will remain working. A follow-up commit will be made with a post-deploy migration to delete the old `site_settings` rows.
2021-02-08 18:04:33 +08:00
RENAME_SETTINGS.each { |old_name, new_name| execute <<~SQL }
INSERT INTO site_settings (name, data_type, value, created_at, updated_at)
SELECT '#{new_name}', data_type, value, created_at, updated_at
FROM site_settings
WHERE name = '#{old_name}'
SQL
end
def down
raise ActiveRecord::IrreversibleMigration
end
end