125 lines
3.5 KiB
Ruby
125 lines
3.5 KiB
Ruby
#
|
|
# Copyright (C) 2013 - present Instructure, Inc.
|
|
#
|
|
# This file is part of Canvas.
|
|
#
|
|
# Canvas is free software: you can redistribute it and/or modify it under
|
|
# the terms of the GNU Affero General Public License as published by the Free
|
|
# Software Foundation, version 3 of the License.
|
|
#
|
|
# Canvas is distributed in the hope that it will be useful, but WITHOUT ANY
|
|
# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
|
|
# A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
|
|
# details.
|
|
#
|
|
# You should have received a copy of the GNU Affero General Public License along
|
|
# with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
#
|
|
|
|
# Public: Delete old (> 360 days) records from messages table.
|
|
class MessageScrubber
|
|
|
|
# Public: The minimum wait time in seconds between processing batches.
|
|
MIN_DELAY = 1
|
|
|
|
# Public: The default batch size.
|
|
BATCH_SIZE = 1000
|
|
|
|
attr_reader :batch_size, :delay, :limit, :logger
|
|
|
|
# Public: Create a new MessageScrubber.
|
|
#
|
|
# options - A settings hash. Accepted options are:
|
|
# - batch_size: The number of records to fetch at once (default: 1000).
|
|
# - delay: The delay, in seconds, between batches (default: 1).
|
|
# - logger: A logger object to log messages to (default: Rails.logger).
|
|
def initialize(options = {})
|
|
@batch_size = options.fetch(:batch_size, BATCH_SIZE)
|
|
@limit = Integer(Setting.get(limit_setting, limit_size)).days.ago
|
|
@delay = options.fetch(:delay, MIN_DELAY)
|
|
@logger = options.fetch(:logger, Rails.logger)
|
|
end
|
|
|
|
def self.scrub
|
|
new.scrub
|
|
end
|
|
|
|
# Public: Delete old delayed messages on the current shard.
|
|
#
|
|
# options - A settings hash that accepts:
|
|
# - dry_run: If true, log the # of records affected but do not delete them (default: false).
|
|
#
|
|
# Returns nothing.
|
|
def scrub(options = {})
|
|
dry_run = options.fetch(:dry_run, false)
|
|
scope = klass.where("#{filter_attribute} < ?", limit)
|
|
dry_run ? log(scope) : delete_messages(scope)
|
|
end
|
|
|
|
# Public: Delete old delayed messages on all shards.
|
|
#
|
|
# options - A settings hash that accepts:
|
|
# - dry_run: If true, log the # of records affected but do not delete them (default: false).
|
|
#
|
|
# Returns nothing
|
|
def scrub_all(options = {})
|
|
Shard.with_each_shard { scrub(options) }
|
|
end
|
|
|
|
protected
|
|
|
|
# Internal: Delete the current batch of messages.
|
|
#
|
|
# scope - The ActiveRecord scope to work on.
|
|
#
|
|
# Returns the number of records deleted.
|
|
def delete_messages(scope)
|
|
count = scope.limit(batch_size).delete_all
|
|
total = count
|
|
while count > 0
|
|
sleep(delay)
|
|
count = scope.limit(batch_size).delete_all
|
|
total += count
|
|
end
|
|
|
|
total
|
|
end
|
|
|
|
# Internal: The column name to filter messages on (e.g. 'sent_at').
|
|
#
|
|
# Returns a column name string.
|
|
def filter_attribute
|
|
'updated_at'
|
|
end
|
|
|
|
# Internal: The class object to delete records from (e.g. 'Message').
|
|
#
|
|
# Returns class object.
|
|
def klass
|
|
raise "regular MessageScrubber is deprecated in favor of dropping partitions"
|
|
end
|
|
|
|
# Internal: The name of the Canvas setting this class' limit is stored in.
|
|
#
|
|
# Returns a setting name string.
|
|
def limit_setting
|
|
'message_scrubber_limit'
|
|
end
|
|
|
|
# Internal: The default limit (in days) to delete messages after.
|
|
#
|
|
# Returns a setting name string.
|
|
def limit_size
|
|
360
|
|
end
|
|
|
|
# Internal: Log expected action.
|
|
#
|
|
# scope - The ActiveRecord scope to log.
|
|
#
|
|
# Returns nothing.
|
|
def log(scope)
|
|
logger.info("#{self.class}: #{scope.count} records would be deleted (older than #{limit})")
|
|
end
|
|
end
|