imap-backup 3.1.0 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a62efa6b4c2e63180629e4a9770cf6b636eb48fa1aaad0177d7bab975ce3f251
-  data.tar.gz: ab0dee2784879df462e8fa1d622436b4a23f332dc731dd34ce353451a7164ce9
+  metadata.gz: b8661c03b8bf66e47c88fb69c476105945dad6fed867c510a151d62d0c401139
+  data.tar.gz: 8964a8ef14fd1f8b04d23745513b3bdb8ad8283d3875bd6d559ef00e5092d1f2
 SHA512:
-  metadata.gz: ffe7443b8450980b05b170e8b4ed2d8cdaa093b17a60bf72c6c87c07e30752de1010aa444da3d4aea1b4348cbdd7b4fff0f2793e100f66de592796a8fa9885b6
-  data.tar.gz: 5779c9d8bc98070cba06a68c571b849cdb33fb994954f6f3cf320642d1d49023ab9db5c6f713db26c413703caf046745589a61e5d4cde2e2c6bce751e7d6f3a1
+  metadata.gz: 8da502abc6b622f9261a223001a594e5e528d4f8871d209dd14a3bfd34693415bf5317b89d3bce892b0190027579d43f5c23f106f634423cb8fbf03fb82839e9
+  data.tar.gz: 610d08941b592e2cbdd29b46404f1e31f83bb31c5c83f57994cbef576ab9ec31b1f11d92851fec55810242661fc31cdb0fffe0816357cfe4177c29ba7c1d3134

data/lib/imap/backup/account/connection.rb

@@ -2,6 +2,7 @@ require "net/imap"
 require "gmail_xoauth"
 
 require "gmail/authenticator"
+require "retry_on_error"
 
 module Imap::Backup
   module Account; end
@@ -9,6 +10,10 @@ module Imap::Backup
   class Account::Connection
     class InvalidGmailOauth2RefreshToken < StandardError; end
 
+    include RetryOnError
+
+    LOGIN_RETRY_CLASSES = [EOFError, Errno::ECONNRESET, SocketError].freeze
+
     attr_reader :connection_options
     attr_reader :local_path
     attr_reader :password
@@ -79,26 +84,27 @@ module Imap::Backup
     end
 
     def imap
-      return @imap unless @imap.nil?
-
-      options = provider_options
-      Imap::Backup.logger.debug(
-        "Creating IMAP instance: #{server}, options: #{options.inspect}"
-      )
-      @imap = Net::IMAP.new(server, options)
-      if gmail? && Gmail::Authenticator.refresh_token?(password)
-        authenticator = Gmail::Authenticator.new(email: username, token: password)
-        credentials = authenticator.credentials
-        raise InvalidGmailOauth2RefreshToken if !credentials
-
-        Imap::Backup.logger.debug "Logging in with OAuth2 token: #{username}"
-        @imap.authenticate("XOAUTH2", username, credentials.access_token)
-      else
-        Imap::Backup.logger.debug "Logging in: #{username}/#{masked_password}"
-        @imap.login(username, password)
-      end
-      Imap::Backup.logger.debug "Login complete"
-      @imap
+      @imap ||=
+        retry_on_error(errors: LOGIN_RETRY_CLASSES) do
+          options = provider_options
+          Imap::Backup.logger.debug(
+            "Creating IMAP instance: #{server}, options: #{options.inspect}"
+          )
+          imap = Net::IMAP.new(server, options)
+          if gmail? && Gmail::Authenticator.refresh_token?(password)
+            authenticator = Gmail::Authenticator.new(email: username, token: password)
+            credentials = authenticator.credentials
+            raise InvalidGmailOauth2RefreshToken if !credentials
+
+            Imap::Backup.logger.debug "Logging in with OAuth2 token: #{username}"
+            imap.authenticate("XOAUTH2", username, credentials.access_token)
+          else
+            Imap::Backup.logger.debug "Logging in: #{username}/#{masked_password}"
+            imap.login(username, password)
+          end
+          Imap::Backup.logger.debug "Login complete"
+          imap
+        end
     end
 
     def server
@@ -175,7 +181,7 @@ module Imap::Backup
     def backup_folders
       @backup_folders ||=
         begin
-          if @config_folders && @config_folders.any?
+          if @config_folders&.any?
             @config_folders
           else
             folders.map { |name| {name: name} }

data/lib/imap/backup/account/folder.rb

@@ -1,5 +1,7 @@
 require "forwardable"
 
+require "retry_on_error"
+
 module Imap::Backup
   module Account; end
 
@@ -7,8 +9,10 @@ module Imap::Backup
 
   class Account::Folder
     extend Forwardable
+    include RetryOnError
 
     REQUESTED_ATTRIBUTES = %w[RFC822 FLAGS INTERNALDATE].freeze
+    UID_FETCH_RETRY_CLASSES = [EOFError].freeze
 
     attr_reader :connection
     attr_reader :name
@@ -66,7 +70,10 @@ module Imap::Backup
 
     def fetch(uid)
       examine
-      fetch_data_items = imap.uid_fetch([uid.to_i], REQUESTED_ATTRIBUTES)
+      fetch_data_items =
+        retry_on_error(errors: UID_FETCH_RETRY_CLASSES) do
+          imap.uid_fetch([uid.to_i], REQUESTED_ATTRIBUTES)
+        end
       return nil if fetch_data_items.nil?
 
       fetch_data_item = fetch_data_items[0]

data/lib/imap/backup/configuration/store.rb

@@ -51,18 +51,18 @@ module Imap::Backup
     private
 
     def data
-      return @data if @data
-
-      if File.exist?(pathname)
-        Utils.check_permissions pathname, 0o600
-        contents = File.read(pathname)
-        @data = JSON.parse(contents, symbolize_names: true)
-      else
-        @data = {accounts: []}
-      end
-      @data[:debug] = false unless @data.include?(:debug)
-      @data[:debug] = false unless [true, false].include?(@data[:debug])
-      @data
+      @data ||=
+        begin
+          if File.exist?(pathname)
+            Utils.check_permissions pathname, 0o600
+            contents = File.read(pathname)
+            data = JSON.parse(contents, symbolize_names: true)
+          else
+            data = {accounts: []}
+          end
+          data[:debug] = data.key?(:debug) ? data[:debug] == true : false
+          data
+        end
     end
 
     def remove_modified_flags

data/lib/imap/backup/serializer/mbox_store.rb

@@ -161,7 +161,7 @@ module Imap::Backup
     def load_nth(index)
       enumerator = Serializer::MboxEnumerator.new(mbox_pathname)
       enumerator.each.with_index do |raw, i|
-        next unless i == index
+        next if i != index
 
         return Email::Mboxrd::Message.from_serialized(raw)
       end
@@ -169,7 +169,7 @@ module Imap::Backup
     end
 
     def imap_looks_like_json?
-      return false unless imap_exist?
+      return false if !imap_exist?
 
       content = File.read(imap_pathname)
       content.start_with?("{")

data/lib/imap/backup/version.rb

@@ -2,7 +2,7 @@ module Imap; end
 
 module Imap::Backup
   MAJOR    = 3
-  MINOR    = 1
+  MINOR    = 2
   REVISION = 0
   PRE      = nil
   VERSION  = [MAJOR, MINOR, REVISION, PRE].compact.map(&:to_s).join(".")

data/lib/retry_on_error.rb

@@ -0,0 +1,14 @@
+module RetryOnError
+  def retry_on_error(errors:, limit: 10)
+    tries ||= 1
+    yield
+  rescue *errors => e
+    if tries < limit
+      message = "#{e}, attempt #{tries} of #{limit}"
+      Imap::Backup.logger.debug message
+      tries += 1
+      retry
+    end
+    raise e
+  end
+end

data/spec/unit/imap/backup/account/connection_spec.rb

@@ -77,13 +77,15 @@ describe Imap::Backup::Account::Connection do
   end
 
   describe "#imap" do
-    let!(:result) { subject.imap }
+    let(:result) { subject.imap }
 
     it "returns the IMAP connection" do
       expect(result).to eq(imap)
     end
 
     it "uses the password" do
+      result
+
       expect(imap).to have_received(:login).with(USERNAME, PASSWORD)
     end
 
@@ -138,7 +140,24 @@ describe Imap::Backup::Account::Connection do
       end
     end
 
-    include_examples "connects to IMAP"
+    context "when the first login attempt fails" do
+      before do
+        outcomes = [-> { raise EOFError }, -> { true }]
+        allow(imap).to receive(:login) { outcomes.shift.call }
+      end
+
+      it "retries" do
+        subject.imap
+
+        expect(imap).to have_received(:login).twice
+      end
+    end
+
+    context "when run" do
+      before { subject.imap }
+
+      include_examples "connects to IMAP"
+    end
   end
 
   describe "#folders" do

data/spec/unit/imap/backup/account/folder_spec.rb

@@ -1,8 +1,8 @@
 # rubocop:disable RSpec/PredicateMatcher
 
 describe Imap::Backup::Account::Folder do
-  FOLDER_NAME = "Gelöscht"
-  ENCODED_FOLDER_NAME = "Gel&APY-scht"
+  FOLDER_NAME = "Gelöscht".freeze
+  ENCODED_FOLDER_NAME = "Gel&APY-scht".freeze
 
   subject { described_class.new(connection, FOLDER_NAME) }
 
@@ -103,6 +103,23 @@ describe Imap::Backup::Account::Folder do
         expect(subject.fetch(123)).to be_nil
       end
     end
+
+    context "when the first fetch_uid attempts fail" do
+      before do
+        outcomes = [-> { raise EOFError }, -> { [fetch_data_item] }]
+        allow(imap).to receive(:uid_fetch) { outcomes.shift.call }
+      end
+
+      it "retries" do
+        subject.fetch(123)
+
+        expect(imap).to have_received(:uid_fetch).twice
+      end
+
+      it "succeeds" do
+        subject.fetch(123)
+      end
+    end
   end
 
   describe "#folder" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: imap-backup
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.2.0
 platform: ruby
 authors:
 - Joe Yates
@@ -221,6 +221,7 @@ files:
 - lib/imap/backup/uploader.rb
 - lib/imap/backup/utils.rb
 - lib/imap/backup/version.rb
+- lib/retry_on_error.rb
 - spec/features/backup_spec.rb
 - spec/features/helper.rb
 - spec/features/restore_spec.rb