Merge branch 'feature/extend-logging-in-thunderbird-export'

Author: joeyates

.rubocop.yml

@@ -261,6 +261,10 @@ RSpec/NoExpectationExample:
   Enabled: true
 RSpec/NotToNot:
   Enabled: false
+RSpec/Output:
+  Enabled: true
+  Exclude:
+  - spec/performance/**/*
 RSpec/PendingWithoutReason:
   Enabled: true
 RSpec/PredicateMatcher:
@@ -342,6 +346,8 @@ Style/DoubleNegation:
   Enabled: false
 Style/EmptyCaseCondition:
   Enabled: false
+Style/EmptyClassDefinition:
+  Enabled: true
 Style/EmptyHeredoc:
   Enabled: true
 Style/EmptyMethod:
@@ -424,6 +430,8 @@ Style/NegatedIf:
   Enabled: false
 Style/NegatedIfElseCondition:
   Enabled: true
+Style/NegativeArrayIndex:
+  Enabled: true
 Style/NestedFileDirname:
   Enabled: true
 Style/NilLambda: # TODO
@@ -490,6 +498,8 @@ Style/RedundantStringEscape:
   Enabled: true
 Style/ReturnNilInPredicateMethodDefinition:
   Enabled: true
+Style/ReverseFind:
+  Enabled: true
 Style/SafeNavigationChainLength:
   Enabled: true
 Style/SelectByRegexp:

CHANGELOG.md

@@ -5,6 +5,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
+## 16.4.2 - 2026-02-08
+
+### Changed
+
+* Added more logging to the Thunderbird export utility.
+
 ## 16.4.1 - 2026-01-06
 
 ### Changed

imap-backup.gemspec

@@ -30,7 +30,7 @@ Gem::Specification.new do |gem|
   gem.add_dependency "rake"
   gem.add_dependency "sys-proctable"
   gem.add_dependency "thor", "~> 1.1"
-  gem.add_dependency "thunderbird", "0.3.0"
+  gem.add_dependency "thunderbird", "~> 0.6.0"
 
   gem.metadata = {
     "rubygems_mfa_required" => "true"

lib/imap/backup/cli/utils.rb

@@ -130,18 +130,41 @@ def ignore_folder_history(folder, serializer)
     end
 
     def thunderbird_profile(name = nil)
+      Logger.logger.info("[CLI::Utils] Fetching Thunderbird profile")
       profiles = ::Thunderbird::Profiles.new
+      Logger.logger.debug("[CLI::Utils] Found #{profiles.installs.count} Thunderbird install(s)")
       if name
+        Logger.logger.debug("[CLI::Utils] Using profile name '#{name}'")
         profiles.profile(name)
       else
-        if profiles.installs.count > 1
-          raise <<~MESSAGE
-            Thunderbird has multiple installs, so no default profile exists.
-            Please supply a profile name
-          MESSAGE
-        end
-
-        profiles.installs[0].default
+        choose_default_profile(profiles)
+      end
+    end
+
+    def choose_default_profile(profiles)
+      Logger.logger.debug("[CLI::Utils] No profile name supplied, so looking for default profile")
+      case profiles.installs.count
+      when 0
+        raise "No Thunderbird installs found, so no default profile exists"
+      when 1
+        install = profiles.installs.first
+        Logger.logger.debug(
+          "[CLI::Utils] Only one Thunderbird install found '#{install.title}', " \
+          "so using its default profile"
+        )
+
+        profile = install.default_profile
+        raise "Thunderbird install '#{install.title}' does not have a default profile" if !profile
+
+        Logger.logger.debug(
+          "[CLI::Utils] Default profile '#{profile.title}' has path '#{profile.root}'"
+        )
+        profile
+      else
+        raise <<~MESSAGE
+          Thunderbird has multiple installs, so no default profile exists.
+          Please supply a profile name
+        MESSAGE
       end
     end
   end

lib/imap/backup/thunderbird/mailbox_exporter.rb

@@ -23,6 +23,7 @@ def initialize(email, serializer, profile, force: false)
     # in the format expected by Thunderbird
     # @return [void]
     def run
+      debug "Starting export of '#{email}' to Thunderbird profile '#{profile.title}'"
       if !profile_set_up
         error "The Thunderbird profile '#{profile.title}' " \
               "has not been set up. " \
@@ -59,6 +60,7 @@ def run
     attr_reader :force
 
     def profile_set_up
+      debug "Checking for local folders path '#{profile.local_folders_path}'"
       File.exist?(profile.local_folders_path)
     end
 
@@ -109,6 +111,10 @@ def local_folder
       end
     end
 
+    def debug(message)
+      Logger.logger.debug("[Thunderbird::MailboxExporter] #{message}")
+    end
+
     def error(message)
       Logger.logger.error("[Thunderbird::MailboxExporter] #{message}")
     end

lib/imap/backup/version.rb

@@ -6,7 +6,7 @@ module Imap::Backup
   # @private
   MINOR    = 4
   # @private
-  REVISION = 1
+  REVISION = 2
   # @private
   PRE      = nil
   # The application version

spec/features/backup_spec.rb

@@ -22,6 +22,7 @@
   let(:config_options) { {accounts: [account_config]} }
   let(:write_config) { create_config(**config_options) }
 
+  let!(:logger) { stub_logger }
   let!(:pre) { test_server.warn_about_non_default_folders }
   let!(:setup) do
     test_server.create_folder folder

spec/features/support/20_test_email_server.rb

@@ -156,7 +156,7 @@ def warn_about_non_default_folders
     actual = folders.map(&:name).sort
     extra = actual - expected
     extra.each do |name|
-      puts "Unexpected folder '#{name}' found - deleting"
+      warn "Unexpected folder '#{name}' found - deleting"
       delete_folder name
     end
   end

spec/spec_helper.rb

@@ -7,5 +7,3 @@
 
 support_glob = File.join(__dir__, "support", "**", "*.rb")
 Dir[support_glob].each { |f| require f }
-
-silence_logging

spec/support/silence_logging.rb

@@ -3,11 +3,29 @@
 
 require "imap/backup/logger"
 
-def silence_logging
-  RSpec.configure do |config|
-    config.before do
-      Imap::Backup::Logger.logger.level = Logger::Severity::UNKNOWN
-      Net::IMAP.debug = false
-    end
+# This function can be used in specs/examples do logging and alter the logger configuration
+def stub_logger
+  logger = instance_double(
+    Logger,
+    debug: nil,
+    error: nil,
+    info: nil,
+    "level=": nil
+  )
+  allow(Imap::Backup::Logger).to receive(:logger) { logger }
+  logger
+end
+
+# Pass the `:silence_logging` option to `RSpec.describe`
+# for specs that do logging, but do not alter logging setup
+RSpec.configure do |config|
+  config.around(:each, :silence_logging) do |example|
+    previous_logger_level = Imap::Backup::Logger.logger.level
+    previous_net_imap_debug = Net::IMAP.debug
+    Imap::Backup::Logger.logger.level = Logger::Severity::UNKNOWN
+    Net::IMAP.debug = false
+    example.run
+    Imap::Backup::Logger.logger.level = previous_logger_level
+    Net::IMAP.debug = previous_net_imap_debug
   end
 end