appmap 0.83.4 → 0.84.0

data/spec/open_spec.rb

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-
-describe AppMap::Open do
-  context 'a block of Ruby code' do
-    it 'opens in the browser' do
-      appmap = AppMap.record do
-        File.read __FILE__
-      end
-
-      open = AppMap::Open.new(appmap)
-      server = open.run_server
-      page = Net::HTTP.get URI.parse("http://localhost:#{open.port}")
-      expect(page).to include(%(name="data" value='{"version))
-      server.kill
-    end
-  end
-end

data/spec/rails_recording_spec.rb

@@ -1,281 +0,0 @@
-require 'rails_spec_helper'
-
-# Rails5 doesn't work with Ruby 3.x
-def default_rails_versions
-  testing_ruby_2? ? [ 5, 6 ] : [ 6 ]
-end
-
-def rails_versions
-  Array(ENV['RAILS_VERSIONS'] || default_rails_versions)
-end
-
-describe 'Rails' do
-  rails_versions.each do |rails_major_version| # rubocop:disable Metrics/BlockLength
-    context "#{rails_major_version}" do
-      include_context 'Rails app pg database', "spec/fixtures/rails#{rails_major_version}_users_app" unless use_existing_data?
-      include_context 'rails integration test setup'
-
-      describe 'an API route' do
-        describe 'creating an object' do
-          let(:appmap_json_file) do
-            'Api_UsersController_POST_api_users_with_required_parameters_creates_a_user.appmap.json'
-          end
-
-          it 'http_server_request is recorded in the appmap' do
-            expect(events).to include(
-              hash_including(
-                'http_server_request' => hash_including(
-                  'request_method' => 'POST',
-                  'normalized_path_info' => '/api/users',
-                  'path_info' => '/api/users',
-                  'headers' => hash_including('Content-Type' => 'application/x-www-form-urlencoded'),
-                ),
-                'message' => include(
-                  hash_including(
-                    'name' => 'login',
-                    'class' => 'String',
-                    'value' => 'alice',
-                    'object_id' => Integer
-                  ),
-                  hash_including(
-                    'name' => 'password',
-                    'class' => 'String',
-                    'value' => '[FILTERED]',
-                    'object_id' => Integer
-                  )
-                )
-              )
-            )
-          end
-
-          it 'http_server_response is recorded in the appmap' do
-            expect(events).to include(
-              hash_including(
-                'http_server_response' => hash_including(
-                  'status_code' => 201,
-                  'headers' => hash_including('Content-Type' => 'application/json; charset=utf-8'),
-                ),
-                'return_value' => hash_including('class' => 'Hash', 'object_id' => Integer, 'properties' => include({'name' => 'login', 'class' => 'String'})),
-              )
-            )
-          end
-
-          it 'properly captures method parameters in the appmap' do
-            expect(events).to include hash_including(
-              'event' => 'call',
-              'thread_id' => Integer,
-              'defined_class' => 'Api::UsersController',
-              'method_id' => 'build_user',
-              'path' => 'app/controllers/api/users_controller.rb',
-              'lineno' => Integer,
-              'static' => false,
-              'parameters' => include(
-                'name' => 'params',
-                'class' => 'ActiveSupport::HashWithIndifferentAccess',
-                'object_id' => Integer,
-                'size' => 1,
-                'value' => '{login=>alice}',
-                'kind' => 'req'
-              ),
-              'receiver' => anything
-            )
-          end
-
-          it 'returns a minimal event' do
-            expect(events).to include hash_including(
-              'event' => 'return',
-              'return_value' => Hash,
-              'id' => Integer,
-              'thread_id' => Integer,
-              'parent_id' => Integer,
-              'elapsed' => Numeric
-            )
-          end
-
-          it 'captures log events' do
-            expect(events).to include hash_including(
-              'event' => 'call',
-              'defined_class' => 'Logger::LogDevice',
-              'method_id' => 'write',
-              'static' => false
-            )
-          end
-
-          context 'with an object-style message' do
-            let(:appmap_json_file) { 'Api_UsersController_POST_api_users_with_required_parameters_with_object-style_parameters_creates_a_user.appmap.json' }
-
-            it 'message properties are recorded in the appmap' do
-              expect(events).to include(
-                hash_including(
-                  'message' => include(
-                    hash_including(
-                      'name' => 'user',
-                      'properties' => [
-                        { 'name' => 'login', 'class' => 'String' },
-                        { 'name' => 'password', 'class' => 'String' }
-                      ]
-                    )
-                  )
-                )
-              )
-            end
-          end
-        end
-
-        describe 'listing objects' do
-          context 'with a custom header' do
-            let(:appmap_json_file) { 'Api_UsersController_GET_api_users_with_a_custom_header_lists_the_users.appmap.json' }
-
-            it 'custom header is recorded in the appmap' do
-              expect(events).to include(
-                hash_including(
-                  'http_server_request' => hash_including(
-                    'headers' => hash_including('X-Sandwich' => 'turkey')
-                  )
-                )
-              )
-            end
-          end
-        end
-      end
-
-      describe 'a UI route' do
-        describe 'rendering a page using a template file' do
-          let(:appmap_json_file) do
-            'UsersController_GET_users_lists_the_users.appmap.json'
-          end
-
-          it 'records the template file' do
-            expect(events).to include hash_including(
-              'event' => 'call',
-              'defined_class' => 'app_views_users_index_html_haml',
-              'method_id' => 'render',
-              'path' => 'app/views/users/index.html.haml'
-            )
-
-            expect(appmap['classMap']).to include hash_including(
-              'name' => 'app',
-              'children' => include(hash_including(
-                'name' => 'views',
-                'children' => include(hash_including(
-                  'name' => 'app_views_users_index_html_haml',
-                  'children' => include(hash_including(
-                    'name' => 'render',
-                    'type' => 'function',
-                    'location' => 'app/views/users/index.html.haml',
-                    'static' => true,
-                    'labels' => [ 'mvc.template' ]
-                  )))))))
-            expect(appmap['classMap']).to include hash_including(
-              'name' => 'app',
-              'children' => include(hash_including(
-                'name' => 'views',
-                'children' => include(hash_including(
-                  'name' => 'app_views_layouts_application_html_haml',
-                  'children' => include(hash_including(
-                    'name' => 'render',
-                    'type' => 'function',
-                    'location' => 'app/views/layouts/application.html.haml',
-                    'static' => true,
-                    'labels' => [ 'mvc.template' ]
-                  )))))))
-          end
-        end
-
-        describe 'rendering a page using a text template' do
-          let(:appmap_json_file) do
-            'UsersController_GET_users_login_shows_the_user.appmap.json'
-          end
-
-          it 'records the normalized path info' do
-            expect(events).to include(
-              hash_including(
-                'http_server_request' => {
-                  'request_method' => 'GET',
-                  'path_info' => '/users/alice',
-                  'normalized_path_info' => '/users/{id}',
-                  'headers' => {
-                    'Host' => 'test.host',
-                    'User-Agent' => 'Rails Testing'
-                  }
-                }
-              )
-            )
-          end
-
-          it 'ignores the text template' do
-            expect(events).to_not include hash_including(
-              'event' => 'call',
-              'method_id' => 'render',
-              'render_template' => anything
-            )
-
-            expect(appmap['classMap']).to_not include hash_including(
-              'name' => 'views',
-              'children' => include(hash_including(
-                'name' => 'ViewTemplate',
-                'children' => include(hash_including(
-                  'name' => 'render',
-                  'type' => 'function',
-                  'location' => 'text template'
-                ))
-              ))
-            )
-          end
-
-          it 'records and labels view rendering' do
-            expect(events).to include hash_including(
-              'event' => 'call',
-              'thread_id' => Numeric,
-              'defined_class' => 'inline_template',
-              'method_id' => 'render'
-            )
-
-            expect(appmap['classMap']).to include hash_including(
-              'name' => 'actionview',
-              'children' => include(hash_including(
-                'name' => 'ActionView',
-                'children' => include(hash_including(
-                  # Rails 6/5 difference
-                  'name' => /^(Template)?Renderer$/,
-                  'children' => include(hash_including(
-                    'name' => 'render',
-                    'labels' => ['mvc.view']
-                  ))
-                ))
-              ))
-            )
-          end
-        end
-      end
-    end
-  end
-
-  describe 'with default appmap.yml' do
-    include_context 'Rails app pg database', "spec/fixtures/rails6_users_app" unless use_existing_data?
-    include_context 'rails integration test setup'
-
-    let(:appmap_json_file) do
-      'Api_UsersController_POST_api_users_with_required_parameters_creates_a_user.appmap.json'
-    end
-
-    it 'http_server_request is recorded' do
-      expect(events).to include(
-        hash_including(
-          'http_server_request' => hash_including(
-            'request_method' => 'POST',
-            'path_info' => '/api/users'
-          )
-        )
-      )
-    end
-
-    it 'controller method is recorded' do
-      expect(events).to include hash_including(
-        'defined_class' => 'Api::UsersController',
-        'method_id' => 'build_user',
-        'path' => 'app/controllers/api/users_controller.rb',
-      )
-    end
-  end
-end

data/spec/rails_spec_helper.rb

@@ -1,107 +0,0 @@
-# frozen_string_literal: true
-
-require 'open3'
-
-require 'spec_helper'
-require 'active_support'
-require 'active_support/core_ext'
-
-def testing_ruby_2?
-  RUBY_VERSION.split('.')[0].to_i == 2
-end
-
-class TestRailsApp
-  def initialize(fixture_dir)
-    @fixture_dir = fixture_dir
-  end
-
-  attr_reader :fixture_dir
-
-  def run_cmd(cmd, env = {})
-    run_process method(:system), cmd, env
-  end
-
-  def spawn_cmd(cmd, env = {})
-    puts "Spawning `#{cmd}` in #{fixture_dir}..."
-    run_process Process.method(:spawn), cmd, env
-  end
-
-  def capture_cmd(cmd, env = {})
-    puts "Capturing `#{cmd}` in #{fixture_dir}..."
-    run_process(Open3.method(:capture2), cmd, env).first
-  end
-
-  def database_name
-    # This is used locally too, so make the name nice and unique.
-    @database_name ||= "appland-rails-test-#{Random.new.bytes(8).unpack1('h*')}"
-  end
-
-  def bundle
-    return if @bundled
-
-    run_cmd 'bundle'
-    @bundled = true
-  end
-
-  def prepare_db
-    return if @db_prepared
-
-    bundle
-    run_cmd './bin/rake db:create db:schema:load'
-    @db_prepared = true
-    at_exit { drop_db }
-  end
-
-  def drop_db
-    return unless @db_prepared
-
-    run_cmd './bin/rake db:drop'
-    @db_prepared = false
-  end
-
-  def tmpdir
-    @tmpdir ||= File.join(fixture_dir, 'tmp')
-  end
-
-  def run_specs
-    return if @specs_ran or use_existing_data?
-
-    prepare_db
-    FileUtils.rm_rf tmpdir
-    run_cmd \
-      './bin/rspec spec/controllers/users_controller_spec.rb spec/controllers/users_controller_api_spec.rb',
-      'APPMAP' => 'true'
-    @specs_ran = true
-  end
-
-  def self.for_fixture(fixture_dir)
-    @apps ||= {}
-    @apps[fixture_dir] ||= TestRailsApp.new fixture_dir
-  end
-
-  protected
-
-  def run_process(method, cmd, env, options = {})
-    Bundler.with_clean_env do
-      method.call \
-        env.merge('TEST_DATABASE' => database_name),
-        cmd,
-        options.merge(chdir: fixture_dir)
-    end
-  end
-end
-
-shared_context 'Rails app pg database' do |dir|
-  before(:all) { @app = TestRailsApp.for_fixture dir }
-  let(:app) { @app }
-end
-
-shared_context 'rails integration test setup' do
-  let(:tmpdir) { app.tmpdir }
-
-  before(:all) { @app.run_specs } unless use_existing_data?
-
-  let(:appmap_json_path) { File.join(tmpdir, 'appmap/rspec', appmap_json_file) }
-  let(:appmap) { JSON.parse File.read(appmap_json_path) }
-  let(:events) { appmap['events'] }
-end

data/spec/rails_test_spec.rb

@@ -1,35 +0,0 @@
-require 'rails_spec_helper'
-
-# Rails5 doesn't work with Ruby 3.x, Rails 7 doesn't work with Ruby < 2.7.
-def default_rails_versions
-  if testing_ruby_2?
-    if Gem::Requirement.create('>= 2.7') =~ Gem::Version.new(RUBY_VERSION)
-      [ 5, 6, 7 ]
-    else
-      [ 5, 6 ]
-    end
-  else
-    [ 6, 7 ]
-  end
-end
-
-def rails_versions
-  Array(ENV['RAILS_VERSIONS'] || default_rails_versions)
-end
-
-describe 'Rails' do
-  rails_versions.each do |rails_major_version| # rubocop:disable Metrics/BlockLength
-    context "#{rails_major_version}" do
-      include_context 'Rails app pg database', "spec/fixtures/rails#{rails_major_version}_users_app" unless use_existing_data?
-
-      it 'runs tests with APPMAP=true' do
-        app.prepare_db
-        app.run_cmd \
-          'bundle exec rake',
-          'RAILS_ENV' => 'test',
-          'APPMAP' => 'true',
-          'TEST_OPTS' => '--verbose'
-      end
-    end
-  end
-end

data/spec/railtie_spec.rb

@@ -1,25 +0,0 @@
-require 'rails_spec_helper'
-
-describe 'AppMap tracer via Railtie' do
-  include_context 'Rails app pg database', 'spec/fixtures/rails6_users_app' do
-    let(:env) { {} }
-
-    let(:command_output) do
-      app.prepare_db
-      app.capture_cmd(%{./bin/rails r "puts AppMap.instance_variable_get('@configuration').nil?"}, env).strip
-    end
-
-    describe 'with APPMAP=false' do
-      let(:env) { { 'APPMAP' => 'false' } }
-      it 'is disabled' do
-        expect(command_output).to eq('true')
-      end
-    end
-    describe 'with APPMAP=true' do
-      let(:env) { { 'APPMAP' => 'true' } }
-      it 'is enabled' do
-        expect(command_output).to eq('false')
-      end
-    end
-  end
-end

data/spec/record_net_http_spec.rb

@@ -1,161 +0,0 @@
-require 'spec_helper'
-require 'diffy'
-require 'rack'
-require 'webrick'
-require 'rack/handler/webrick'
-
-class HelloWorldApp
-  def call(env)
-    req = Rack::Request.new(env)
-    case req.path_info
-    when /hello/
-      [200, {"Content-Type" => "text/html"}, ["Hello World!"]]
-    when /goodbye/  
-      [500, {"Content-Type" => "text/html"}, ["Goodbye Cruel World!"]]
-    else
-      [404, {"Content-Type" => "text/html"}, ["I'm Lost!"]]
-    end
-  end
-end
-
-describe 'Net::HTTP handler' do
-  include_context 'collect events'
-
-  def get_hello(params: nil)
-    http = Net::HTTP.new('localhost', 19292)
-    http.get [ '/hello', params ].compact.join('?')
-  end
-  
-  before(:all) do
-    @rack_thread = Thread.new do
-      Rack::Handler::WEBrick.run HelloWorldApp.new, Port: 19292
-    end
-    10.times do
-      sleep 0.1
-      break if get_hello.code.to_i == 200
-    end
-    raise "Web server didn't start" unless get_hello.code.to_i == 200
-  end
-
-  after(:all) do
-    @rack_thread.kill
-  end
-
-  def start_recording
-    AppMap.configuration = configuration
-    AppMap::Hook.new(configuration).enable
-
-    @tracer = AppMap.tracing.trace
-    AppMap::Event.reset_id_counter
-  end
-
-  def record(&block)
-    start_recording
-    begin
-      yield
-    ensure
-      stop_recording
-    end
-  end
-
-  def stop_recording
-    AppMap.tracing.delete(@tracer)
-  end
-
-  context 'with trace enabled' do
-    let(:configuration) { AppMap::Config.new('record_net_http_spec') }
-
-    after do
-      AppMap.configuration = nil
-    end
-    
-    describe 'GET request' do
-      it 'with a single query parameter' do
-        record do
-          get_hello(params: 'msg=hi')
-        end
-
-        events = collect_events(@tracer).to_yaml
-        expect(Diffy::Diff.new(<<~EVENTS, events).to_s).to eq('')
-        ---
-        - :id: 1
-          :event: :call
-          :http_client_request:
-            :request_method: GET
-            :url: http://localhost:19292/hello
-            :headers:
-              Accept-Encoding: gzip;q=1.0,deflate;q=0.6,identity;q=0.3
-              Accept: "*/*"
-              User-Agent: Ruby
-              Connection: close
-          :message:
-          - :name: msg
-            :class: String
-            :value: hi
-        - :id: 2
-          :event: :return
-          :parent_id: 1
-          :http_client_response:
-            :status_code: 200
-            :headers:
-              Content-Type: text/html
-              Server: WEBrick
-              Date: "<instanceof date>"
-              Content-Length: '12'
-              Connection: close
-        EVENTS
-      end
-
-      it 'with a multi-valued query parameter' do
-        record do
-          get_hello(params: 'ary[]=1&ary[]=2')
-        end
-
-        event = collect_events(@tracer).first.to_yaml
-        expect(Diffy::Diff.new(<<~EVENT, event).to_s).to eq('')
-        ---
-        :id: 1
-        :event: :call
-        :http_client_request:
-          :request_method: GET
-          :url: http://localhost:19292/hello
-          :headers:
-            Accept-Encoding: gzip;q=1.0,deflate;q=0.6,identity;q=0.3
-            Accept: "*/*"
-            User-Agent: Ruby
-            Connection: close
-        :message:
-        - :name: ary
-          :class: Array
-          :value: "[1, 2]"
-        EVENT
-      end
-
-      it 'with a URL encoded query parameter' do
-        msg = 'foo/bar?baz'
-        record do
-          get_hello(params: "msg=#{CGI.escape msg}")
-        end
-
-        event = collect_events(@tracer).first.to_yaml
-        expect(Diffy::Diff.new(<<~EVENT, event).to_s).to eq('')
-        ---
-        :id: 1
-        :event: :call
-        :http_client_request:
-          :request_method: GET
-          :url: http://localhost:19292/hello
-          :headers:
-            Accept-Encoding: gzip;q=1.0,deflate;q=0.6,identity;q=0.3
-            Accept: "*/*"
-            User-Agent: Ruby
-            Connection: close
-        :message:
-        - :name: msg
-          :class: String
-          :value: #{msg}
-        EVENT
-      end
-    end
-  end
-end

data/spec/record_sql_rails_pg_spec.rb

@@ -1,59 +0,0 @@
-require 'rails_spec_helper'
-
-describe 'SQL events' do
-  include_context 'Rails app pg database', 'spec/fixtures/rails6_users_app' do
-    def self.check_queries(cases)
-      cases.each do |test_case, query|
-        context "in #{test_case}" do
-          let(:test_case) { test_case }
-          it "captures #{query}" do
-            expect(sql_events).to include sql_query query
-          end
-        end
-      end
-    end
-
-    context 'with Sequel' do
-      before(:context) { run_specs 'sequel' }
-
-      check_queries(
-        'Api_UsersController_POST_api_users_with_required_parameters_creates_a_user' =>
-          %(INSERT INTO "users" ("login") VALUES ('alice') RETURNING *),
-        'Api_UsersController_GET_api_users_lists_the_users' => %(SELECT * FROM "users")
-      )
-    end
-
-    context 'with ActiveRecord' do
-      before(:context) { run_specs 'activerecord' }
-
-      check_queries(
-        'Api_UsersController_POST_api_users_with_required_parameters_creates_a_user' =>
-          %(INSERT INTO "users" ("login") VALUES ($1) RETURNING "id"),
-        'Api_UsersController_GET_api_users_lists_the_users' => %(SELECT "users".* FROM "users")
-      )
-    end
-
-    def run_specs(orm_module)
-      @app.prepare_db
-      @app.run_cmd \
-        './bin/rspec spec/controllers/users_controller_api_spec.rb:8 spec/controllers/users_controller_api_spec.rb:29',
-        'ORM_MODULE' => orm_module,
-        'RAILS_ENV' => 'test',
-        'APPMAP' => 'true'
-    end
-
-    let(:appmap_json) { File.join tmpdir, "appmap/rspec/#{test_case}.appmap.json" }
-    let(:appmap) { JSON.parse(File.read(appmap_json)) }
-    let(:tmpdir) { app.tmpdir }
-    let(:sql_events) { appmap['events'].select { |ev| ev.include? 'sql_query' } }
-
-    RSpec::Matchers.define_negated_matcher :not_include, :include
-    def sql_query(query)
-      (include('sql_query' => (include 'sql' => query)))
-        .and(not_include('defined_class'))
-        .and(not_include('method_id'))
-        .and(not_include('path'))
-        .and(not_include('lineno'))
-    end
-  end
-end