spec/elastic_apm/spies/faraday_spec.rb

# Licensed to Elasticsearch B.V. under one or more contributor
# license agreements. See the NOTICE file distributed with
# this work for additional information regarding copyright
# ownership. Elasticsearch B.V. licenses this file to you under
# the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#   http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied.  See the License for the
# specific language governing permissions and limitations
# under the License.

# frozen_string_literal: true

require 'spec_helper'

require 'faraday'

module ElasticAPM
  RSpec.describe 'Spy: Faraday', :intercept do
    let(:client) do
      Faraday.new(url: 'http://example.com')
    end

    it 'spans http calls' do
      WebMock.stub_request(:get, %r{http://example.com/.*})

      with_agent do
        ElasticAPM.with_transaction 'Faraday test' do
          client.get('http://example.com/page.html')
        end
      end

      span, = @intercepted.spans

      expect(span).to_not be nil
      expect(span.name).to eq 'GET example.com'
      expect(span.type).to eq 'external'
      expect(span.subtype).to eq 'http'
      expect(span.action).to be nil
      expect(span.outcome).to eq 'success'
    end

    it 'adds http context' do
      WebMock.stub_request(:get, %r{http://example.com/.*})

      with_agent do
        ElasticAPM.with_transaction 'Faraday test' do
          client.get('http://example.com/page.html')
        end
      end

      span, = @intercepted.spans

      http = span.context.http
      expect(http.url).to match('http://example.com/page.html')
      expect(http.method).to match('GET')
      expect(http.status_code).to match('200')
    end

    it 'adds destination information' do
      WebMock.stub_request(:get, %r{http://example.com/.*})

      with_agent do
        ElasticAPM.with_transaction 'Faraday test' do
          client.get('http://example.com/page.html')
        end
      end

      span, = @intercepted.spans

      destination = span.context.destination
      expect(destination.service.resource).to match('example.com:80')
      expect(destination.address).to match('example.com')
      expect(destination.port).to match(80)
    end

    it 'spans http calls with prefix' do
      WebMock.stub_request(:get, %r{http://example.com/.*})

      with_agent do
        ElasticAPM.with_transaction 'Faraday test' do
          client.get('/page.html')
        end
      end

      span, = @intercepted.spans

      expect(span).to_not be nil
      expect(span.name).to eq 'GET example.com'
      expect(span.type).to eq 'external'
      expect(span.subtype).to eq 'http'
      expect(span.action).to be nil
    end

    it 'spans http calls when url in block' do
      WebMock.stub_request(:get, %r{http://example.com/.*})

      with_agent do
        client = Faraday.new
        ElasticAPM.with_transaction 'Faraday test' do
          client.get do |req|
            req.url('http://example.com/page.html')
          end
        end
      end

      span, = @intercepted.spans

      expect(span).to_not be nil
      expect(span.name).to eq 'GET example.com'
      expect(span.type).to eq 'external'
      expect(span.subtype).to eq 'http'
      expect(span.action).to be nil
    end

    it 'adds traceparent header' do
      req_stub =
        WebMock.stub_request(:get, %r{http://example.com/.*}).with do |req|
          header = req.headers['Traceparent']
          expect(header).to_not be nil
          expect { TraceContext::Traceparent.parse(header) }.to_not raise_error
        end

      with_agent do
        ElasticAPM.with_transaction 'Faraday test' do
          client.get('http://example.com/page.html')
        end
      end

      expect(req_stub).to have_been_requested
    end

    it 'adds traceparent header with no span' do
      req_stub = WebMock.stub_request(:get, %r{http://example.com/.*})

      with_agent transaction_max_spans: 0 do
        ElasticAPM.with_transaction 'Net::HTTP test' do
          client.get('http://example.com/page.html')
        end
      end

      expect(req_stub).to have_been_requested
    end

    it 'adds failure outcome to a span' do
      WebMock.stub_request(:get, 'http://example.com')
             .to_return(status: [400, 'Bad Request'])

      with_agent do
        ElasticAPM.with_transaction 'Faraday test' do
          client.get('http://example.com')
        end
      end

      span, = @intercepted.spans

      expect(span).to_not be nil
      expect(span.outcome).to eq 'failure'
    end

    context 'when hostname is not provided' do
      before do
        # Webmock throws its own error if there's no address
        # before we get to the instrumented Faraday code
        WebMock.disable!
      end

      after do
        WebMock.enable!
      end

      it 'falls back to localhost when hostname not provided' do
        with_agent do
          begin
            ElasticAPM.with_transaction 'Faraday test' do
              Faraday.get('/test')
            end
          rescue Faraday::ConnectionFailed
          end
        end

        span, = @intercepted.spans

        expect(span.name).to eq 'GET localhost'
      end
    end

    describe 'faraday middleware' do
      let(:client) do
        Faraday.new(url: 'http://example.com') do |faraday|
          faraday.use Faraday::Response::RaiseError
        end
      end

      it 'captures status_code' do
        WebMock.stub_request(:get, 'http://example.com')
          .to_return(status: [404, 'Not Found'])

        with_agent do
          begin
            ElasticAPM.with_transaction 'Faraday Middleware test' do
              client.get('http://example.com')
            end
          rescue Faraday::ResourceNotFound
          end
        end

        span, = @intercepted.spans

        http = span.context.http
        expect(http.status_code).to match('404')
      end

      it 'handles a nil response' do
        WebMock.stub_request(:get, 'http://example.com')
          .to_raise(Faraday::ClientError)

        with_agent do
          begin
            ElasticAPM.with_transaction 'Faraday Middleware test' do
              client.get('http://example.com')
            end
          rescue Faraday::ClientError
          end
        end
        span, = @intercepted.spans

        http = span.context.http
        expect(http.status_code).to be nil
      end

      it 'handles faraday response' do
        class FaradayErrorWithResponseObject < Faraday::ClientError
          def response
            Faraday::Response.new(status: 500)
          end
          undef response_status
        end
        WebMock.stub_request(:get, 'http://example.com')
          .to_raise(FaradayErrorWithResponseObject.new(nil))

        with_agent do
          begin
            ElasticAPM.with_transaction 'Faraday Middleware test' do
              client.get('http://example.com')
            end
          rescue Faraday::ClientError
          end
        end
        span, = @intercepted.spans

        http = span.context.http
        expect(http.status_code).to eq('500')
      end

      it 'handles faraday response hash' do
        class FaradayErrorWithResponseHash < Faraday::ClientError
          def response
            { status: 500 }
          end
          undef response_status
        end
        WebMock.stub_request(:get, 'http://example.com')
          .to_raise(FaradayErrorWithResponseHash.new(nil))

        with_agent do
          begin
            ElasticAPM.with_transaction 'Faraday Middleware test' do
              client.get('http://example.com')
            end
          rescue Faraday::ClientError
          end
        end
        span, = @intercepted.spans

        http = span.context.http
        expect(http.status_code).to eq('500')
      end

      it 'does not raise error when response is string' do
        class FaradayErrorWithResponseString < Faraday::ClientError
          def response
            'whatever'
          end
          undef response_status
        end
        WebMock.stub_request(:get, 'http://example.com')
          .to_raise(FaradayErrorWithResponseString.new(nil))

        with_agent do
          begin
            ElasticAPM.with_transaction 'Faraday Middleware test' do
              client.get('http://example.com')
            end
          rescue Faraday::ClientError
          end
        end
        span, = @intercepted.spans

        http = span.context.http
        expect(http.status_code).to be nil
      end
    end
  end
end