From c7b9f044a4c449ff5532f27766fe0a3f5f8a8e44 Mon Sep 17 00:00:00 2001 From: Roman Rizzi Date: Mon, 14 Dec 2020 14:06:50 -0300 Subject: [PATCH] FEATURE: Automatically disable slow mode. (#11461) Staff and TL4 users can decide the slow mode duration. We'll internally set a topic timer to disable it. --- .../app/components/future-date-input.js | 1 + .../app/controllers/edit-slow-mode.js | 3 +- .../javascripts/discourse/app/models/topic.js | 4 +- .../components/future-date-input.hbs | 2 +- .../app/templates/modal/edit-slow-mode.hbs | 12 +++++ app/controllers/topics_controller.rb | 11 +++++ app/jobs/regular/clear_slow_mode.rb | 24 ++++++++++ app/models/topic_timer.rb | 15 ++++-- config/locales/client.en.yml | 1 + spec/requests/topics_controller_spec.rb | 48 +++++++++++++++++++ 10 files changed, 115 insertions(+), 6 deletions(-) create mode 100644 app/jobs/regular/clear_slow_mode.rb diff --git a/app/assets/javascripts/discourse/app/components/future-date-input.js b/app/assets/javascripts/discourse/app/components/future-date-input.js index ab0f447601..f1d7752fb1 100644 --- a/app/assets/javascripts/discourse/app/components/future-date-input.js +++ b/app/assets/javascripts/discourse/app/components/future-date-input.js @@ -17,6 +17,7 @@ export default Component.extend({ isBasedOnLastPost: equal("selection", "set_based_on_last_post"), displayDateAndTimePicker: and("includeDateTime", "isCustom"), displayLabel: null, + labelClasses: null, displayNumberInput: or("isBasedOnLastPost", "isBasedOnDuration"), init() { diff --git a/app/assets/javascripts/discourse/app/controllers/edit-slow-mode.js b/app/assets/javascripts/discourse/app/controllers/edit-slow-mode.js index e76573617f..84f990eeb4 100644 --- a/app/assets/javascripts/discourse/app/controllers/edit-slow-mode.js +++ b/app/assets/javascripts/discourse/app/controllers/edit-slow-mode.js @@ -14,6 +14,7 @@ export default Controller.extend(ModalFunctionality, { minutes: null, seconds: null, saveDisabled: false, + enabledUntil: null, showCustomSelect: equal("selectedSlowMode", "custom"), init() { @@ -99,7 +100,7 @@ export default Controller.extend(ModalFunctionality, { this._parseValue(this.seconds) ); - Topic.setSlowMode(this.model.id, seconds) + Topic.setSlowMode(this.model.id, seconds, this.enabledUntil) .catch(popupAjaxError) .then(() => { this.set("model.slow_mode_seconds", seconds); diff --git a/app/assets/javascripts/discourse/app/models/topic.js b/app/assets/javascripts/discourse/app/models/topic.js index 819f8c8ff0..c350c5e747 100644 --- a/app/assets/javascripts/discourse/app/models/topic.js +++ b/app/assets/javascripts/discourse/app/models/topic.js @@ -837,8 +837,10 @@ Topic.reopenClass({ return ajax(`/t/id_for/${slug}`); }, - setSlowMode(topicId, seconds) { + setSlowMode(topicId, seconds, enabledUntil) { const data = { seconds }; + data.enabled_until = enabledUntil; + return ajax(`/t/${topicId}/slow_mode`, { type: "PUT", data }); }, }); diff --git a/app/assets/javascripts/discourse/app/templates/components/future-date-input.hbs b/app/assets/javascripts/discourse/app/templates/components/future-date-input.hbs index 43c7e421e0..aa92210bc7 100644 --- a/app/assets/javascripts/discourse/app/templates/components/future-date-input.hbs +++ b/app/assets/javascripts/discourse/app/templates/components/future-date-input.hbs @@ -1,7 +1,7 @@
{{#unless isBasedOnDuration}}
- + {{future-date-input-selector minimumResultsForSearch=-1 statusType=statusType diff --git a/app/assets/javascripts/discourse/app/templates/modal/edit-slow-mode.hbs b/app/assets/javascripts/discourse/app/templates/modal/edit-slow-mode.hbs index 956db77d76..fdf231d130 100644 --- a/app/assets/javascripts/discourse/app/templates/modal/edit-slow-mode.hbs +++ b/app/assets/javascripts/discourse/app/templates/modal/edit-slow-mode.hbs @@ -25,6 +25,18 @@ {{input value=seconds type="number" class="input-small"}}
{{/if}} + +
+ {{future-date-input + class="enabled-until" + label="topic.slow_mode_update.enabled_until" + labelClasses="slow-mode-label" + includeFarFuture=false + clearable=true + input=enabledUntil + onChangeInput=(action (mut enabledUntil)) + }} +
{{/d-modal-body}}
diff --git a/app/controllers/topics_controller.rb b/app/controllers/topics_controller.rb index d1b5ca2b7c..e5a2f9387a 100644 --- a/app/controllers/topics_controller.rb +++ b/app/controllers/topics_controller.rb @@ -938,9 +938,20 @@ class TopicsController < ApplicationController def set_slow_mode topic = Topic.find(params[:topic_id]) + slow_mode_type = TopicTimer.types[:clear_slow_mode] + timer = TopicTimer.find_by(topic: topic, status_type: slow_mode_type) guardian.ensure_can_moderate!(topic) topic.update!(slow_mode_seconds: params[:seconds]) + enabled = params[:seconds].to_i > 0 + + time = enabled && params[:enabled_until].present? ? params[:enabled_until] : nil + + topic.set_or_create_timer( + slow_mode_type, + time, + by_user: timer&.user + ) head :ok end diff --git a/app/jobs/regular/clear_slow_mode.rb b/app/jobs/regular/clear_slow_mode.rb new file mode 100644 index 0000000000..0c45421d18 --- /dev/null +++ b/app/jobs/regular/clear_slow_mode.rb @@ -0,0 +1,24 @@ +# frozen_string_literal: true + +module Jobs + class ClearSlowMode < ::Jobs::Base + + def execute(args) + topic_timer = TopicTimer.find_by(id: args[:topic_timer_id] || args[:topic_status_update_id]) + + if topic_timer.nil? || topic_timer.execute_at > Time.zone.now + return + end + + topic = topic_timer&.topic + + if topic.nil? + topic_timer.destroy! + return + end + + topic.update!(slow_mode_seconds: 0) + topic_timer.trash!(Discourse.system_user) + end + end +end diff --git a/app/models/topic_timer.rb b/app/models/topic_timer.rb index 441e631aa1..0d7be787f2 100644 --- a/app/models/topic_timer.rb +++ b/app/models/topic_timer.rb @@ -51,16 +51,17 @@ class TopicTimer < ActiveRecord::Base reminder: 5, bump: 6, delete_replies: 7, - silent_close: 8 + silent_close: 8, + clear_slow_mode: 9 ) end def self.public_types - @_public_types ||= types.except(:reminder) + @_public_types ||= types.except(:reminder, :clear_slow_mode) end def self.private_types - @_private_types ||= types.only(:reminder) + @_private_types ||= types.only(:reminder, :clear_slow_mode) end def self.ensure_consistency! @@ -122,6 +123,10 @@ class TopicTimer < ActiveRecord::Base Jobs.cancel_scheduled_job(:delete_replies, topic_timer_id: id) end + def cancel_auto_clear_slow_mode_job + Jobs.cancel_scheduled_job(:clear_slow_mode, topic_timer_id: id) + end + def schedule_auto_delete_replies_job(time) Jobs.enqueue_at(time, :delete_replies, topic_timer_id: id) end @@ -173,6 +178,10 @@ class TopicTimer < ActiveRecord::Base def schedule_auto_reminder_job(time) # noop, TODO(martin 2021-03-11): Remove this after timers migrated and outstanding jobs cancelled end + + def schedule_auto_clear_slow_mode_job(time) + Jobs.enqueue_at(time, :clear_slow_mode, topic_timer_id: id) + end end # == Schema Information diff --git a/config/locales/client.en.yml b/config/locales/client.en.yml index 39d1b29869..98d7ebdb29 100644 --- a/config/locales/client.en.yml +++ b/config/locales/client.en.yml @@ -2333,6 +2333,7 @@ en: select: "Users may only post in this topic once every:" description: "To promote thoughtful discussion in fast moving or contentious discussions, users must wait before posting again in this topic." save: "Enable" + enabled_until: "(Optional) Enabled until:" remove: "Disable" hours: "Hours:" minutes: "Minutes:" diff --git a/spec/requests/topics_controller_spec.rb b/spec/requests/topics_controller_spec.rb index 32e6ee1a51..36ab0ee002 100644 --- a/spec/requests/topics_controller_spec.rb +++ b/spec/requests/topics_controller_spec.rb @@ -3227,6 +3227,54 @@ RSpec.describe TopicsController do expect(topic.slow_mode_seconds).to eq(3600) end end + + context 'auto-disable slow mode' do + before { sign_in(admin) } + + let(:timestamp) { 1.week.from_now.to_formatted_s(:iso8601) } + + it 'sets a topic timer to clear the slow mode automatically' do + put "/t/#{topic.id}/slow_mode.json", params: { + seconds: '3600', enabled_until: timestamp + } + + created_timer = TopicTimer.find_by(topic: topic) + execute_at = created_timer.execute_at.to_formatted_s(:iso8601) + + expect(execute_at).to eq(timestamp) + end + + it 'deletes the topic timer' do + put "/t/#{topic.id}/slow_mode.json", params: { + seconds: '3600', enabled_until: timestamp + } + + put "/t/#{topic.id}/slow_mode.json", params: { + seconds: '0', enabled_until: timestamp + } + + created_timer = TopicTimer.find_by(topic: topic) + + expect(created_timer).to be_nil + end + + it 'updates the existing timer' do + put "/t/#{topic.id}/slow_mode.json", params: { + seconds: '3600', enabled_until: timestamp + } + + updated_timestamp = 1.hour.from_now.to_formatted_s(:iso8601) + + put "/t/#{topic.id}/slow_mode.json", params: { + seconds: '3600', enabled_until: updated_timestamp + } + + created_timer = TopicTimer.find_by(topic: topic) + execute_at = created_timer.execute_at.to_formatted_s(:iso8601) + + expect(execute_at).to eq(updated_timestamp) + end + end end describe '#invite' do