From b696ca6b1a0fee1e56fcf70f4c561ff2661ad81d Mon Sep 17 00:00:00 2001
From: Matt Jankowski <matt@jankowski.online>
Date: Thu, 30 Nov 2023 05:48:46 -0500
Subject: [PATCH] Move self destruct CLI command definition code to module
(#28131)
---
lib/mastodon/cli/federation.rb | 74 ++++++++++++++++++++++++++++++++++
lib/mastodon/cli/main.rb | 62 +---------------------------
2 files changed, 76 insertions(+), 60 deletions(-)
create mode 100644 lib/mastodon/cli/federation.rb
diff --git a/lib/mastodon/cli/federation.rb b/lib/mastodon/cli/federation.rb
new file mode 100644
index 00000000000..1b4cb467a57
--- /dev/null
+++ b/lib/mastodon/cli/federation.rb
@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+require 'tty-prompt'
+
+module Mastodon::CLI
+ module Federation
+ extend ActiveSupport::Concern
+
+ included do
+ desc 'self-destruct', 'Erase the server from the federation'
+ long_desc <<~LONG_DESC
+ Erase the server from the federation by broadcasting account delete
+ activities to all known other servers. This allows a "clean exit" from
+ running a Mastodon server, as it leaves next to no cache behind on
+ other servers.
+
+ This command is always interactive and requires confirmation twice.
+
+ No local data is actually deleted, because emptying the
+ database or removing files is much faster through other, external
+ means, such as e.g. deleting the entire VPS. However, because other
+ servers will delete data about local users, but no local data will be
+ updated (such as e.g. followers), there will be a state mismatch
+ that will lead to glitches and issues if you then continue to run and use
+ the server.
+
+ So either you know exactly what you are doing, or you are starting
+ from a blank slate afterwards by manually clearing out all the local
+ data!
+ LONG_DESC
+ def self_destruct
+ if SelfDestructHelper.self_destruct?
+ prompt.ok('Self-destruct mode is already enabled for this Mastodon server')
+
+ pending_accounts = Account.local.without_suspended.count + Account.local.suspended.joins(:deletion_request).count
+ sidekiq_stats = Sidekiq::Stats.new
+
+ if pending_accounts.positive?
+ prompt.warn("#{pending_accounts} accounts are still pending deletion.")
+ elsif sidekiq_stats.enqueued.positive?
+ prompt.warn('Deletion notices are still being processed')
+ elsif sidekiq_stats.retry_size.positive?
+ prompt.warn('At least one delivery attempt for each deletion notice has been made, but some have failed and are scheduled for retry')
+ else
+ prompt.ok('Every deletion notice has been sent! You can safely delete all data and decomission your servers!')
+ end
+
+ exit(0)
+ end
+
+ exit(1) unless prompt.ask('Type in the domain of the server to confirm:', required: true) == Rails.configuration.x.local_domain
+
+ prompt.warn('This operation WILL NOT be reversible.')
+ prompt.warn('While the data won\'t be erased locally, the server will be in a BROKEN STATE afterwards.')
+ prompt.warn('The deletion process itself may take a long time, and will be handled by Sidekiq, so do not shut it down until it has finished (you will be able to re-run this command to see the state of the self-destruct process).')
+
+ exit(1) if prompt.no?('Are you sure you want to proceed?')
+
+ self_destruct_value = Rails.application.message_verifier('self-destruct').generate(Rails.configuration.x.local_domain)
+ prompt.ok('To switch Mastodon to self-destruct mode, add the following variable to your evironment (e.g. by adding a line to your `.env.production`) and restart all Mastodon processes:')
+ prompt.ok(" SELF_DESTRUCT=#{self_destruct_value}")
+ prompt.ok("\nYou can re-run this command to see the state of the self-destruct process.")
+ rescue TTY::Reader::InputInterrupt
+ exit(1)
+ end
+
+ private
+
+ def prompt
+ @prompt ||= TTY::Prompt.new
+ end
+ end
+ end
+end
diff --git a/lib/mastodon/cli/main.rb b/lib/mastodon/cli/main.rb
index 64f1646f491..ef40b81f339 100644
--- a/lib/mastodon/cli/main.rb
+++ b/lib/mastodon/cli/main.rb
@@ -8,6 +8,7 @@ require_relative 'canonical_email_blocks'
require_relative 'domains'
require_relative 'email_domain_blocks'
require_relative 'emoji'
+require_relative 'federation'
require_relative 'feeds'
require_relative 'ip_blocks'
require_relative 'maintenance'
@@ -65,66 +66,7 @@ module Mastodon::CLI
desc 'maintenance SUBCOMMAND ...ARGS', 'Various maintenance utilities'
subcommand 'maintenance', Maintenance
- desc 'self-destruct', 'Erase the server from the federation'
- long_desc <<~LONG_DESC
- Erase the server from the federation by broadcasting account delete
- activities to all known other servers. This allows a "clean exit" from
- running a Mastodon server, as it leaves next to no cache behind on
- other servers.
-
- This command is always interactive and requires confirmation twice.
-
- No local data is actually deleted, because emptying the
- database or removing files is much faster through other, external
- means, such as e.g. deleting the entire VPS. However, because other
- servers will delete data about local users, but no local data will be
- updated (such as e.g. followers), there will be a state mismatch
- that will lead to glitches and issues if you then continue to run and use
- the server.
-
- So either you know exactly what you are doing, or you are starting
- from a blank slate afterwards by manually clearing out all the local
- data!
- LONG_DESC
- def self_destruct
- require 'tty-prompt'
-
- prompt = TTY::Prompt.new
-
- if SelfDestructHelper.self_destruct?
- prompt.ok('Self-destruct mode is already enabled for this Mastodon server')
-
- pending_accounts = Account.local.without_suspended.count + Account.local.suspended.joins(:deletion_request).count
- sidekiq_stats = Sidekiq::Stats.new
-
- if pending_accounts.positive?
- prompt.warn("#{pending_accounts} accounts are still pending deletion.")
- elsif sidekiq_stats.enqueued.positive?
- prompt.warn('Deletion notices are still being processed')
- elsif sidekiq_stats.retry_size.positive?
- prompt.warn('At least one delivery attempt for each deletion notice has been made, but some have failed and are scheduled for retry')
- else
- prompt.ok('Every deletion notice has been sent! You can safely delete all data and decomission your servers!')
- end
-
- exit(0)
- end
-
- exit(1) unless prompt.ask('Type in the domain of the server to confirm:', required: true) == Rails.configuration.x.local_domain
-
- prompt.warn('This operation WILL NOT be reversible.')
- prompt.warn('While the data won\'t be erased locally, the server will be in a BROKEN STATE afterwards.')
- prompt.warn('The deletion process itself may take a long time, and will be handled by Sidekiq, so do not shut it down until it has finished (you will be able to re-run this command to see the state of the self-destruct process).')
-
- exit(1) if prompt.no?('Are you sure you want to proceed?')
-
- self_destruct_value = Rails.application.message_verifier('self-destruct').generate(Rails.configuration.x.local_domain)
- prompt.ok('To switch Mastodon to self-destruct mode, add the following variable to your evironment (e.g. by adding a line to your `.env.production`) and restart all Mastodon processes:')
- prompt.ok(" SELF_DESTRUCT=#{self_destruct_value}")
- prompt.ok("\nYou can re-run this command to see the state of the self-destruct process.")
- rescue TTY::Reader::InputInterrupt
- exit(1)
- end
+ include Federation
map %w(--version -v) => :version