Skip to content

A platform for community discussion. Free, open, simple.

DEV: Introduce `enable_local_logins_via_code` as an alpha upcoming change (#41624)

Keegan George5e8d72c85e61
diff --git a/app/controllers/session_controller.rb b/app/controllers/session_controller.rb
index a20d0832411..969bccf7e28 100644
--- a/app/controllers/session_controller.rb
+++ b/app/controllers/session_controller.rb
@@ -852,7 +852,9 @@ class SessionController < ApplicationController
end
def ensure_login_code_allowed
- raise Discourse::NotFound if !SiteSetting.enable_local_logins_via_code
+ if !UpcomingChanges.enabled_for_user?(:enable_local_logins_via_code, current_user)
+ raise Discourse::NotFound
+ end
# Code login is a delivery variant of email login, so it also requires
# `enable_local_logins_via_email` (checked via `check_login_via_email`).
check_local_login_allowed(check_login_via_email: true)
diff --git a/app/jobs/regular/send_email_login_code.rb b/app/jobs/regular/send_email_login_code.rb
index 5e7c119676d..bcf96d21d99 100644
--- a/app/jobs/regular/send_email_login_code.rb
+++ b/app/jobs/regular/send_email_login_code.rb
@@ -7,7 +7,7 @@ module Jobs
def execute(args)
raise Discourse::InvalidParameters.new(:to_address) if args[:to_address].blank?
raise Discourse::InvalidParameters.new(:code) if args[:code].blank?
- return if !SiteSetting.enable_local_logins_via_code
+ return if !UpcomingChanges.enabled?(:enable_local_logins_via_code)
message = EmailLoginCodeMailer.send_code(args[:to_address], args[:code])
Email::Sender.new(message, :email_login_code).send
diff --git a/config/locales/server.en.yml b/config/locales/server.en.yml
index b68ed6ed94f..bae4fe348ca 100644
--- a/config/locales/server.en.yml
+++ b/config/locales/server.en.yml
@@ -2163,7 +2163,7 @@ en:
enable_local_logins: "Enable local username and password login based accounts. WARNING: if disabled, you may be unable to log in if you have not previously configured at least one alternate login method."
enable_local_logins_via_email: "Allow users to request a one-click login link to be sent to them via email."
- enable_local_logins_via_code: "Send a one-time code instead of a login link when a user logs in via email, and let new users sign up with just an email address and that code. Requires 'enable local logins via email'."
+ enable_local_logins_via_code: "Allow members to sign up and log in faster using one-time email codes (OTPs). Requires 'enable local logins via email'."
allow_passkeys_for_2fa: "Allow users to use a passkey to satisfy two-factor authentication when confirming a sensitive action."
allow_new_registrations: "Allow new user registrations. Uncheck this to prevent anyone from creating a new account."
enable_signup_cta: "Show a notice to returning anonymous users prompting them to sign up for an account."
diff --git a/config/site_settings.yml b/config/site_settings.yml
index 92ae55ba6c8..26fde0d5403 100644
--- a/config/site_settings.yml
+++ b/config/site_settings.yml
@@ -699,6 +699,12 @@ login:
hidden: true
validator: "EnableLocalLoginsViaCodeValidator"
area: "login"
+ upcoming_change:
+ status: "alpha"
+ impact: "feature,all_members"
+ learn_more_url: "https://meta.discourse.org/t/-/407068"
+ allow_enabled_for:
+ - everyone
enable_passkeys:
client: true
default: true
diff --git a/lib/upcoming_changes.rb b/lib/upcoming_changes.rb
index e07757bfa99..5a34048b8ed 100644
--- a/lib/upcoming_changes.rb
+++ b/lib/upcoming_changes.rb
@@ -38,6 +38,17 @@ module UpcomingChanges
def self.should_display_remove_and_replace_uncategorized?
SiteSetting::Action::RemoveAndReplaceUncategorizedToggled.should_display_upcoming_change?
end
+
+ # Code login is a delivery variant of email login (see
+ # EnableLocalLoginsViaCodeValidator), so the change is only actionable when
+ # local logins via email are possible. Must stay visible once enabled so
+ # admins can still find and disable it.
+ def self.should_display_enable_local_logins_via_code?
+ return true if UpcomingChanges.enabled?(:enable_local_logins_via_code)
+
+ SiteSetting.enable_local_logins && SiteSetting.enable_local_logins_via_email &&
+ !SiteSetting.enable_discourse_connect
+ end
end
def self.user_enabled_reasons
diff --git a/public/images/upcoming_changes/enable_local_logins_via_code.png b/public/images/upcoming_changes/enable_local_logins_via_code.png
new file mode 100644
index 00000000000..3c14a5c029b
Binary files /dev/null and b/public/images/upcoming_changes/enable_local_logins_via_code.png differ
diff --git a/spec/lib/upcoming_changes_spec.rb b/spec/lib/upcoming_changes_spec.rb
index 2028eecd969..c126cde1a80 100644
--- a/spec/lib/upcoming_changes_spec.rb
+++ b/spec/lib/upcoming_changes_spec.rb
@@ -945,5 +945,40 @@ RSpec.describe UpcomingChanges do
end
end
end
+
+ describe ".should_display_enable_local_logins_via_code?" do
+ it "returns true when local logins via email are possible" do
+ expect(
+ UpcomingChanges::ConditionalDisplay.should_display?(:enable_local_logins_via_code),
+ ).to eq(true)
+ end
+
+ it "returns false when DiscourseConnect is enabled" do
+ SiteSetting.discourse_connect_url = "https://www.example.com/sso"
+ SiteSetting.discourse_connect_secret = "x" * 10
+ SiteSetting.enable_discourse_connect = true
+
+ expect(
+ UpcomingChanges::ConditionalDisplay.should_display?(:enable_local_logins_via_code),
+ ).to eq(false)
+ end
+
+ it "returns false when local logins via email are disabled" do
+ SiteSetting.enable_local_logins_via_email = false
+
+ expect(
+ UpcomingChanges::ConditionalDisplay.should_display?(:enable_local_logins_via_code),
+ ).to eq(false)
+ end
+
+ it "stays displayed when the change is already enabled even if email login is later disabled" do
+ SiteSetting.enable_local_logins_via_code = true
+ SiteSetting.enable_local_logins_via_email = false
+
+ expect(
+ UpcomingChanges::ConditionalDisplay.should_display?(:enable_local_logins_via_code),
+ ).to eq(true)
+ end
+ end
end
end
diff --git a/spec/requests/session_controller_spec.rb b/spec/requests/session_controller_spec.rb
index 65308db9f4d..7a784a36380 100644
--- a/spec/requests/session_controller_spec.rb
+++ b/spec/requests/session_controller_spec.rb
@@ -553,6 +553,16 @@ RSpec.describe SessionController do
expect(response.status).to eq(404)
end
+ it "allows requesting a code when the upcoming change is auto-promoted without the setting being toggled" do
+ SiteSetting.remove_override!(:enable_local_logins_via_code)
+ SiteSetting.promote_upcoming_changes_on_status = "alpha"
+
+ post "/session/login-code.json", params: honeypot_magic(email: user.email)
+
+ expect(response.status).to eq(200)
+ expect(EmailLoginCode.for_email(user.email).count).to eq(1)
+ end
+
context "when local logins are disabled" do
before { SiteSetting.enable_local_logins = false }