spec/elastic_apm/spies/net_http_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 'net/http'

module ElasticAPM
  RSpec.describe 'Spy: NetHTTP', :intercept do
    it 'spans http calls' do
      WebMock.stub_request(:get, %r{http://example.com/.*})

      with_agent do
        ElasticAPM.with_transaction 'Net::HTTP test' do
          Net::HTTP.start('example.com') do |http|
            http.get '/'
          end
        end
      end

      span, = @intercepted.spans

      expect(span.name).to eq 'GET example.com'
      expect(span.outcome).to eq 'success'
    end

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

      with_agent do
        ElasticAPM.with_transaction 'Net::HTTP test' do
          Net::HTTP.get('example.com', '/index.html')
        end
      end

      span, = @intercepted.spans

      expect(span.name).to eq 'GET example.com'
    end

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

      with_agent do
        ElasticAPM.with_transaction 'Net::HTTP test' do
          Net::HTTP.start('example.com') do |http|
            http.get '/page.html'
          end
        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 both TraceContext headers' 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(req.headers['Elastic-Apm-Traceparent']).to_not be nil
          expect { TraceContext::Traceparent.parse(header) }.to_not raise_error
        end

      with_agent do
        ElasticAPM.with_transaction 'Net::HTTP test' do
          Net::HTTP.start('example.com') do |http|
            http.get '/'
          end
        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
          Net::HTTP.start('example.com') do |http|
            http.get '/'
          end
        end
      end

      expect(req_stub).to have_been_requested
    end

    it 'skips prefixed traceparent header when disabled' do
      req_stub =
        WebMock.stub_request(:get, %r{http://example.com/.*}).with do |req|
          expect(req.headers['Elastic-Apm-Traceparent']).to be nil
          expect(req.headers['Traceparent']).to_not be nil
        end

      with_agent(use_elastic_traceparent_header: false) do
        ElasticAPM.with_transaction 'Net::HTTP test' do
          Net::HTTP.start('example.com') do |http|
            http.get '/'
          end
        end
      end

      expect(req_stub).to have_been_requested
    end

    it 'can be disabled' do
      WebMock.stub_request(:any, %r{http://example.com/.*})

      with_agent do
        expect(ElasticAPM::Spies::NetHTTPSpy).to_not be_disabled

        ElasticAPM.with_transaction 'Net::HTTP test' do
          ElasticAPM::Spies::NetHTTPSpy.disable_in do
            Net::HTTP.start('example.com') do |http|
              http.get '/'
            end
          end

          Net::HTTP.start('example.com') do |http|
            http.post '/', 'a=1'
          end
        end
      end

      expect(@intercepted.transactions.length).to be 1
      expect(@intercepted.spans.length).to be 1

      span, = @intercepted.spans
      expect(span.name).to eq 'POST example.com'
      expect(span.type).to eq 'external'
      expect(span.subtype).to eq 'http'
      expect(span.action).to be nil

      ElasticAPM.stop
    end

    describe 'destination info' do
      it 'adds to span context' do
        WebMock.stub_request(:get, %r{http://example.com:1234/.*})

        with_agent do
          ElasticAPM.with_transaction 'Net::HTTP test' do
            Net::HTTP.start('example.com', 1234) do |http|
              http.get '/some/path?a=1'
            end
          end
        end

        span, = @intercepted.spans

        expect(span.context.destination.service.resource).to eq 'example.com:1234'
        expect(span.context.destination.address).to eq 'example.com'
        expect(span.context.destination.port).to eq 1234
      end

      it 'adds IPv6 info to span context' do
        WebMock.stub_request(:get, %r{http://\[::1\]:8080/.*})

        with_agent(central_config: false) do
          ElasticAPM.with_transaction 'Net::HTTP test IPv6' do
            Net::HTTP.start('[::1]', 8080) do |http|
              http.get '/some/path?a=1'
            end
          end
        end

        span, = @intercepted.spans

        expect(span.context.destination.service.resource).to eq '[::1]:8080'
        expect(span.context.destination.address).to eq '::1'
        expect(span.context.destination.port).to eq 8080
      end
    end

    it 'allows underscores in hostnames' do
      WebMock.stub_request(:get, %r{http://exa_ple.com/.*})

      with_agent do
        ElasticAPM.with_transaction 'Net::HTTP test' do
          Net::HTTP.start('exa_ple.com', 80) do |http|
            http.get '/somewhere?thing=1'
          end
        end
      end

      span, = @intercepted.spans

      expect(span.name).to eq 'GET exa_ple.com'
    end

    it 'sets outcome to `failure` for failed requests' do
      WebMock.stub_request(:get, 'http://example.com')
             .to_return(status: [400, 'Bad Request'])

      with_agent do
        ElasticAPM.with_transaction 'Net::HTTP test' do
          Net::HTTP.start('example.com') do |http|
            http.get '/'
          end
        end
      end

      span, = @intercepted.spans

      expect(span.outcome).to eq 'failure'
    end

    # See issue #1304
    # it 'defaults missing host to localhost' do
    #   WebMock.stub_request(:any, %r{http://*})
    #
    #   with_agent do
    #     ElasticAPM.with_transaction 'Net::HTTP test' do
    #       Net::HTTP.start(nil) do |http|
    #         http.get '/bar'
    #       end
    #     end
    #   end
    #
    #   span, = @intercepted.spans
    #   expect(span.context.http.url).to eq 'http://localhost/bar'
    # end
    #
    # it 'supports path being a uri' do
    #   WebMock.stub_request(:any, %r{http://*})
    #
    #   with_agent do
    #     ElasticAPM.with_transaction 'Net::HTTP test' do
    #       Net::HTTP.start(nil) do |http|
    #         http.get 'https://www.foo.bar/test'
    #       end
    #     end
    #   end
    #
    #   span, = @intercepted.spans
    #   expect(span.context.http.url).to eq 'https://www.foo.bar/test'
    # end
  end
end