Search code examples
ruby-on-railsazurerails-activestorage

No such file to load -- azure/storage.rb


We're trying to use azure azure-storage-blob with Rails active storage and we're getting an error during puma booting process:

/usr/local/bundle/gems/activesupport-5.2.4.3/lib/active_support/dependencies.rb:291:in `require': No such file to load -- azure/storage.rb (LoadError)`

Rails version: 5.2.4.3 azure-storage-blob version: 2.0.0

Adding the old azure-storage gem and downgrading the azure-storage-blob to 1.1.0 fixes it. But it requires to downgrade other gems (faraday).

Related github issue: https://github.com/Azure/azure-storage-ruby/issues/166

Any idea what could cause it?


Solution

  • Figured this thing out. It's an ActiveStorage issue - when they changed from active-storage to active-storage-blob, they never backported the change back to Rails 5.2. Or, at least not yet

    For anyone still having this issue, until it is backported, anyone can monkey-patch it: Add two empty files: lib/azure/storage/core/auth/shared_access_signature.rb, and lib/azure/storage.rb

    Add this to config/initializers/active_storage_6_patch.rb (this is the current master version of the ActiveStorage module):

    require "azure/storage/blob"
    require 'active_storage/service/azure_storage_service'
    module ActiveStorage
      # Wraps the Microsoft Azure Storage Blob Service as an Active Storage service.
      # See ActiveStorage::Service for the generic API documentation that applies to all services.
      class Service::AzureStorageService < Service
        attr_reader :client, :container, :signer
    
        def initialize(storage_account_name:, storage_access_key:, container:, public: false, **options)
          @client = Azure::Storage::Blob::BlobService.create(storage_account_name: storage_account_name, storage_access_key: storage_access_key, **options)
          @signer = Azure::Storage::Common::Core::Auth::SharedAccessSignature.new(storage_account_name, storage_access_key)
          @container = container
          @public = public
        end
    
        def upload(key, io, checksum: nil, filename: nil, content_type: nil, disposition: nil, **)
          instrument :upload, key: key, checksum: checksum do
            handle_errors do
              content_disposition = content_disposition_with(filename: filename, type: disposition) if disposition && filename
    
              client.create_block_blob(container, key, IO.try_convert(io) || io, content_md5: checksum, content_type: content_type, content_disposition: content_disposition)
            end
          end
        end
    
        def download(key, &block)
          if block_given?
            instrument :streaming_download, key: key do
              stream(key, &block)
            end
          else
            instrument :download, key: key do
              handle_errors do
                _, io = client.get_blob(container, key)
                io.force_encoding(Encoding::BINARY)
              end
            end
          end
        end
    
        def download_chunk(key, range)
          instrument :download_chunk, key: key, range: range do
            handle_errors do
              _, io = client.get_blob(container, key, start_range: range.begin, end_range: range.exclude_end? ? range.end - 1 : range.end)
              io.force_encoding(Encoding::BINARY)
            end
          end
        end
    
        def delete(key)
          instrument :delete, key: key do
            client.delete_blob(container, key)
          rescue Azure::Core::Http::HTTPError => e
            raise unless e.type == "BlobNotFound"
            # Ignore files already deleted
          end
        end
    
        def delete_prefixed(prefix)
          instrument :delete_prefixed, prefix: prefix do
            marker = nil
    
            loop do
              results = client.list_blobs(container, prefix: prefix, marker: marker)
    
              results.each do |blob|
                client.delete_blob(container, blob.name)
              end
    
              break unless marker = results.continuation_token.presence
            end
          end
        end
    
        def exist?(key)
          instrument :exist, key: key do |payload|
            answer = blob_for(key).present?
            payload[:exist] = answer
            answer
          end
        end
    
        def url_for_direct_upload(key, expires_in:, content_type:, content_length:, checksum:)
          instrument :url, key: key do |payload|
            generated_url = signer.signed_uri(
              uri_for(key), false,
              service: "b",
              permissions: "rw",
              expiry: format_expiry(expires_in)
            ).to_s
    
            payload[:url] = generated_url
    
            generated_url
          end
        end
    
        def headers_for_direct_upload(key, content_type:, checksum:, filename: nil, disposition: nil, **)
          content_disposition = content_disposition_with(type: disposition, filename: filename) if filename
    
          { "Content-Type" => content_type, "Content-MD5" => checksum, "x-ms-blob-content-disposition" => content_disposition, "x-ms-blob-type" => "BlockBlob" }
        end
    
        private
          def private_url(key, expires_in:, filename:, disposition:, content_type:, **)
            signer.signed_uri(
              uri_for(key), false,
              service: "b",
              permissions: "r",
              expiry: format_expiry(expires_in),
              content_disposition: content_disposition_with(type: disposition, filename: filename),
              content_type: content_type
            ).to_s
          end
    
          def public_url(key, **)
            uri_for(key).to_s
          end
    
    
          def uri_for(key)
            client.generate_uri("#{container}/#{key}")
          end
    
          def blob_for(key)
            client.get_blob_properties(container, key)
          rescue Azure::Core::Http::HTTPError
            false
          end
    
          def format_expiry(expires_in)
            expires_in ? Time.now.utc.advance(seconds: expires_in).iso8601 : nil
          end
    
          # Reads the object for the given key in chunks, yielding each to the block.
          def stream(key)
            blob = blob_for(key)
    
            chunk_size = 5.megabytes
            offset = 0
    
            raise ActiveStorage::FileNotFoundError unless blob.present?
    
            while offset < blob.properties[:content_length]
              _, chunk = client.get_blob(container, key, start_range: offset, end_range: offset + chunk_size - 1)
              yield chunk.force_encoding(Encoding::BINARY)
              offset += chunk_size
            end
          end
    
          def handle_errors
            yield
          rescue Azure::Core::Http::HTTPError => e
            case e.type
            when "BlobNotFound"
              raise ActiveStorage::FileNotFoundError
            when "Md5Mismatch"
              raise ActiveStorage::IntegrityError
            else
              raise
            end
          end
      end
    end