appmap 0.47.1 → 0.50.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 12dbe41efff7d8fd40a884be376ff1579d961371b780eddf18d4724e7ce5997f
-  data.tar.gz: fb038cfbcc6c2432b780d4555b8948729fd65a2943a4bc1200c7d6943a62f5a8
+  metadata.gz: ce006905408a0ee15ccaee33ecb13e8bfbf1bc7b93f3cc4cbb105e2be9849bee
+  data.tar.gz: 4f73e289a332301d6efbf0c7e8985b5e62a8a030f90c4265b221fc1d67c801be
 SHA512:
-  metadata.gz: 07a9ec31b08915e1d630a90200393d88db2b85b49b8dc21ffa595e598fa57ff8ed3afa463e3e9dc2ae9485d5dff399eb1724c6aa38cbcceeb0d3c6c0757d0f70
-  data.tar.gz: 3c6e629772604730b6acc14409c98694624cbfcbbc14a661182b6bb5388664b15a918c3e82ca5b55dd1daf6ca142741d0380a3e88c152f5bafcd57cb9b38dd6c
+  metadata.gz: 86108afa917712908800f9303368ee48c8b0bf7d66892e6aadd76a18d76d355106f751984579bf57f9fdd876f7e4071f75a0d6cdf4fd90dfa5ce90a93d1ed9a1
+  data.tar.gz: b62b7793fd03c9d3cb43792b0a9b056547b4dd9f75a6b31f582a12d7a19cfdf4eaee7f566b27eaaf9a36dd4477afa396184b31bc753858b979ac5fb6804d3027

data/.dockerignore

@@ -2,4 +2,3 @@ vendor
 node_modules
 spec/fixtures/rails*_users_app
 spec/fixtures/rack_users_app
-

data/CHANGELOG.md

@@ -1,3 +1,47 @@
+# [0.50.0](https://github.com/applandinc/appmap-ruby/compare/v0.49.0...v0.50.0) (2021-06-17)
+
+
+### Bug Fixes
+
+* Remove appmap configuration in test cases which now occurs automatically ([7391c4c](https://github.com/applandinc/appmap-ruby/commit/7391c4c36ed80f98a6b82ccd43f05de488e7cd2f))
+
+
+### Features
+
+* Direct minitest and rspec startup messages to the Rails log, when available ([15f6444](https://github.com/applandinc/appmap-ruby/commit/15f6444b0fad3ce7d9e91273b6a1116e470c2a89))
+* Enroll railtie, rspec, and minitest helpers automatically ([1709374](https://github.com/applandinc/appmap-ruby/commit/1709374ee7b5183482c55cf4c7386266fa517262))
+* railtie enrolls the app in remote recording ([3a1f8aa](https://github.com/applandinc/appmap-ruby/commit/3a1f8aac1d83c4df04b5da55ed33d418235e348b))
+
+# [0.49.0](https://github.com/applandinc/appmap-ruby/compare/v0.48.2...v0.49.0) (2021-06-16)
+
+
+### Features
+
+* Add refinement to the labels ([6a93396](https://github.com/applandinc/appmap-ruby/commit/6a93396ba73f1b3ed21b4e9e15a2c271af04d866))
+
+## [0.48.2](https://github.com/applandinc/appmap-ruby/compare/v0.48.1...v0.48.2) (2021-05-26)
+
+
+### Bug Fixes
+
+* Correct the method-hooking logic to capture some missing model methods ([be529bd](https://github.com/applandinc/appmap-ruby/commit/be529bdce7d4fdf9f1a2fdd32259d792f29f4f13))
+
+## [0.48.1](https://github.com/applandinc/appmap-ruby/compare/v0.48.0...v0.48.1) (2021-05-25)
+
+
+### Bug Fixes
+
+* Account for bundle path when normalizing source path ([095c278](https://github.com/applandinc/appmap-ruby/commit/095c27818fc8ae8dfa39b30516d37c6dfd642d9c))
+* Scan exception messages for non-UTF8 characters ([3dcaeae](https://github.com/applandinc/appmap-ruby/commit/3dcaeae44da5e40e432eda41caf5b9ebff5bea12))
+
+# [0.48.0](https://github.com/applandinc/appmap-ruby/compare/v0.47.1...v0.48.0) (2021-05-19)
+
+
+### Features
+
+* Hook the code only when APPMAP=true ([dd9e383](https://github.com/applandinc/appmap-ruby/commit/dd9e383024d1d9205a617d46bd64b90820035533))
+* Remove server process recording from doc and tests ([383ba0a](https://github.com/applandinc/appmap-ruby/commit/383ba0ad444922a0a85409477d11bc7ed06a9160))
+
 ## [0.47.1](https://github.com/applandinc/appmap-ruby/compare/v0.47.0...v0.47.1) (2021-05-13)
 
 

data/README.md

@@ -1,17 +1,6 @@
 
 - [About](#about)
-    - [Supported versions](#supported-versions)
-- [Installation](#installation)
-- [Configuration](#configuration)
-- [Labels](#labels)
-- [Running](#running)
-  - [RSpec](#rspec)
-  - [Minitest](#minitest)
-  - [Cucumber](#cucumber)
-  - [Remote recording](#remote-recording)
-- [AppMap for VSCode](#appmap-for-vscode)
-- [AppMap Swagger](#appmap-swagger)
-- [Uploading AppMaps](#uploading-appmaps)
+- [Usage](#usage)
 - [Development](#development)
   - [Internal architecture](#internal-architecture)
   - [Running tests](#running-tests)
@@ -19,7 +8,6 @@
     - [`test/fixtures`](#testfixtures)
     - [`spec/fixtures`](#specfixtures)
 
-
 # About
 
 `appmap-ruby` is a Ruby Gem for recording
@@ -29,342 +17,9 @@
 SHA, labels, etc). It's more granular than a performance profile, but it's less
 granular than a full debug trace. It's designed to be optimal for understanding the design intent and structure of code and key data flows.
 
-There are several ways to record AppMaps of your Ruby program using the `appmap` gem:
-
-* Run your tests (RSpec, Minitest, Cucumber) with the environment variable `APPMAP=true`. An AppMap will be generated for each spec.
-* Run your application server with AppMap remote recording enabled, and use the [AppLand
-  browser extension](https://github.com/applandinc/appland-browser-extension) to start,
-  stop, and upload recordings.
-* Wrap some code in an `AppMap.record` block, which returns JSON containing the code execution trace.
-
-Once you have made a recording, there are two ways to view automatically generated diagrams of the AppMaps.
-
-The first option is to load the diagrams directly in your IDE, using the [AppMap extension for VSCode](https://marketplace.visualstudio.com/items?itemName=appland.appmap).
-
-The second option is to upload them to the [AppLand server](https://app.land) using the [AppLand CLI](https://github.com/applandinc/appland-cli/releases).
-
-### Supported versions
-
-* Ruby 2.5, 2.6, 2.7
-* Rails 5, 6
-
-Support for new versions is added frequently, please check back regularly for updates.
-
-# Installation
-
-<a href="https://www.loom.com/share/78ab32a312ff4b85aa8827a37f1cb655"> <p>Quick and easy setup of the AppMap gem for Rails - Watch Video</p> <img style="max-width:300px;" src="https://cdn.loom.com/sessions/thumbnails/78ab32a312ff4b85aa8827a37f1cb655-with-play.gif"> </a>
-
-
-Add `gem 'appmap'` to **beginning** of your Gemfile. We recommend that you add the `appmap` gem to the `:development, :test` group. Your Gemfile should look something like this:
-
-```
-source 'https://rubygems.org'
-git_source(:github) { |repo| "https://github.com/#{repo}.git" }
-
-# Optional rubRuby version
-# ruby '2.7.2'
-
-group :development, :test do
-  gem 'appmap'
-end
-```
-
-Install with `bundle install`, as usual.
-
-It's important to add the `appmap` gem before any other gems that you may want to instrument. There is more about this in the section on adding gems to the *appmap.yml*.
-
-**Railtie**
-
-If you are using Ruby on Rails, require the railtie after Rails is loaded. 
-
-```
-# application.rb is a good place to do this, along with all the other railties.
-# Don't require the railtie in environments that don't bundle the appmap gem.
-require 'appmap/railtie' if defined?(AppMap).
-```
-
-**application.rb**
-
-Add this line to *application.rb*, to enable server recording with `APPMAP_RECORD=true`:
-
-```ruby
-module MyApp
-  class Application < Rails::Application
-    ...
-  
-    config.appmap.enabled = true if ENV['APPMAP_RECORD']
-    
-    ...
-  end
-end
-```
-
-# Configuration
-
-When you run your program, the `appmap` gem reads configuration settings from `appmap.yml`. Here's a sample configuration
-file for a typical Rails project:
-
-```yaml
-# 'name' should generally be the same as the code repo name.
-name: my_project
-packages:
-- path: app/controllers
-- path: app/models
-  # Exclude sub-paths within the package path
-  exclude:
-  - concerns/accessor
-- path: app/jobs
-- path: app/helpers
-# Include the gems that you want to see in the dependency maps.
-# These are just examples.
-- gem: activerecord
-- gem: devise
-- gem: aws-sdk
-- gem: will_paginate
-# Global exclusion of a class name
-exclude:
-- MyClass
-- MyClass#my_instance_method
-- MyClass.my_class_method
-functions:
-- packages: myapp
-  class: ControllerHelper
-  function: logged_in_user
-  labels: [ authentication ]
-```
-
-* **name** Provides the project name (required)
-* **packages** A list of source code directories which should be recorded.
-* **exclude** A list of classes and/or methods to definitively exclude from recording.
-* **functions** A list of specific functions, scoped by package and class, to record.
-
-**packages**
-
-Each entry in the `packages` list is a YAML object which has the following keys:
-
-* **path** The path to the source code directory. The path may be relative to the current working directory, or it may
-  be an absolute path.
-* **gem** As an alternative to specifying the path, specify the name of a dependency gem. When using `gem`, don't specify `path`. In your `Gemfile`, the `appmap` gem **must** be listed **before** any gem that you specify in your *appmap.yml*.
-* **exclude** A list of files and directories which will be ignored. By default, all modules, classes and public
-  functions are inspected. See also: global `exclude` list.
-* **shallow** When set to `true`, only the first function call entry into a package will be recorded. Subsequent function calls within 
-  the same package are not recorded unless code execution leaves the package and re-enters it. Default: `true` when using `gem`,
-  `false` when using `path`.
-
-**exclude**
-
-Optional list of fully qualified class and method names. Separate class and method names with period (`.`) for class methods and hash (`#`) for instance methods.
-
-**functions**
-
-Optional list of `class, function` pairs. The `package` name is used to place the function within the class map, and does not have to match
-the folder or gem name. The primary use of `functions` is to apply specific labels to functions whose source code is not accessible (e.g., it's in a Gem).
-For functions which are part of the application code, use `@label` or `@labels` in code comments to apply labels.
-
-# Labels
-
-The [AppMap data format](https://github.com/applandinc/appmap) provides for class and function `labels`, which can be used to enhance the AppMap visualizations, and to programatically analyze the data.
-
-You can apply function labels using source code comments in your Ruby code. To apply a labels to a function, add a `@label` or `@labels` line to the comment which immediately precedes a function.
-
-For example, if you add this comment to your source code:
-
-```ruby
-class ApiKey
-  # @labels provider.authentication security
-  def authenticate(key)
-    # logic to verify the key here...
-  end
-end
-```
-
-Then the AppMap metadata section for this function will include:
-
-```json
-  {
-    "name": "authenticate",
-    "type": "function",
-    "labels": [ "provider.authentication", "security" ]
-  }
-```
-
-
-# Running
-
-## RSpec
-
-To record RSpec tests, follow these additional steps:
-
-1) Require `appmap/rspec` in your `spec_helper.rb` before any other classes are loaded.
-
-```ruby
-require 'appmap/rspec'
-```
-
-Note that `spec_helper.rb` in a Rails project typically loads the application's classes this way:
-
-```ruby
-require File.expand_path("../../config/environment", __FILE__)
-```
-
-and `appmap/rspec` must be required before this:
-
-```ruby
-require 'appmap/rspec'
-require File.expand_path("../../config/environment", __FILE__)
-```
-
-2) Run the tests with the environment variable `APPMAP=true`:
-
-```sh-session
-$ APPMAP=true bundle exec rspec
-```
-
-Each RSpec test will output an AppMap file into the directory `tmp/appmap/rspec`. For example:
-
-```
-$ find tmp/appmap/rspec
-Hello_says_hello_when_prompted.appmap.json
-```
-
-## Minitest
-
-To record Minitest tests, follow these additional steps:
-
-1) Require `appmap/minitest` in `test_helper.rb`
-
-```ruby
-require 'appmap/minitest'
-```
-
-Note that `test_helper.rb` in a Rails project typically loads the application's classes this way:
-
-```ruby
-require_relative '../config/environment'
-```
-
-and `appmap/minitest` must be required before this:
-
-```ruby
-require 'appmap/minitest'
-require_relative '../config/environment'
-```
-
-2) Run your tests as you normally would with the environment variable `APPMAP=true`. For example:  
-
-```
-$ APPMAP=true bundle exec rake test
-```
-
-or
-
-```
-$ APPMAP=true bundle exec ruby -Ilib -Itest test/*_test.rb
-```
-
-Each Minitest test will output an AppMap file into the directory `tmp/appmap/minitest`. For example:
-
-```
-$ find tmp/appmap/minitest
-Hello_says_hello_when_prompted.appmap.json
-```
-
-## Cucumber
-
-To record Cucumber tests, follow these additional steps:
-
-1) Require `appmap/cucumber` in `support/env.rb`:
-
-```ruby
-require 'appmap/cucumber'
-```
-
-Be sure to require it before `config/environment` is required.
-
-2) Create an `Around` hook in `support/hooks.rb` to record the scenario:
-
-
-```ruby
-if AppMap::Cucumber.enabled?
-  Around('not @appmap-disable') do |scenario, block|
-    appmap = AppMap.record do
-      block.call
-    end
-
-    AppMap::Cucumber.write_scenario(scenario, appmap)
-  end
-end
-```
-
-3) Run the tests with the environment variable `APPMAP=true`:
-
-```sh-session
-$ APPMAP=true bundle exec cucumber
-```
-
-Each Cucumber test will output an AppMap file into the directory `tmp/appmap/cucumber`. For example:
-
-```
-$ find tmp/appmap/cucumber
-Hello_Says_hello_when_prompted.appmap.json
-```
-
-## Remote recording
-
-To manually record ad-hoc AppMaps of your Ruby app, use AppMap remote recording.
-
-1. Add the AppMap remote recording middleware. For example, in `config/initializers/appmap_remote_recording.rb`:
-
-```ruby
-if defined?(AppMap)
-  require 'appmap/middleware/remote_recording'
-
-  Rails.application.config.middleware.insert_after \
-    Rails::Rack::Logger,
-    AppMap::Middleware::RemoteRecording
-end
-```
-
-2. (optional) Download and unpack the [AppLand browser extension](https://github.com/applandinc/appland-browser-extension). Install into Chrome using `chrome://extensions/`. Turn on "Developer Mode" and then load the extension using the "Load unpacked" button.
-
-3. Start your Rails application server, with `APPMAP_RECORD=true`. For example:
-
-```sh-session
-$ APPMAP_RECORD=true bundle exec rails server
-```
-
-4. Start the recording
-
-Option 1: Open the AppLand browser extension and push `Start`.
-Option 2: `curl -XPOST localhost:3000/_appmap/record` (be sure and get the port number right)
-
-5. Use your app. For example, perform a login flow, or run through a manual UI test.
-
-6. Finish the recording.
-
-Option 1: Open the AppLand browser extension and push `Stop`. The recording will be transferred to the AppLand website and opened in your browser.
-Option 2: `curl -XDELETE localhost:3000/_appmap/record > recording.appmap.json` - Saves the recording as a local file.
-
-
-# AppMap for VSCode
-
-The [AppMap extension for VSCode](https://marketplace.visualstudio.com/items?itemName=appland.appmap) helps you navigate your code more efficiently with interactive, accurate software architecture diagrams right in your IDE. In less than two minutes you can go from installing the AppMap extension to exploring maps of your code's architecture. AppMap helps you:
-
-* Onboard to code architecture, with no extra work for the team
-* Conduct code and design reviews using live and accurate data
-* Troubleshoot hard-to-understand bugs using a "top-down" approach.
-
-Each interactive diagram links directly to the source code, and the information is easy to share.
-
-# AppMap Swagger
-
-[appmap_swagger](https://github.com/applandinc/appmap_swagger-ruby) is a tool to generate Swagger files from AppMap data. With `appmap_swagger`, you can add Swagger to your Ruby or Ruby on Rails project, with no need to write or modify code. Use the Swagger UI to interact with your web services API as you build it, and use diffs of Swagger to perform code review of web service changes.
-
-# Uploading AppMaps
-
-[https://app.land](https://app.land) can be used to store, analyze, and share AppMaps.
+# Usage
 
-For instructions on uploading, see the documentation of the [AppLand CLI](https://github.com/applandinc/appland-cli).
+Visit the [AppMap for Ruby](https://appland.com/docs/reference/appmap-ruby.html) reference page on AppLand.com for a complete reference guide.
 
 # Development
 [![Build Status](https://travis-ci.com/applandinc/appmap-ruby.svg?branch=master)](https://travis-ci.com/applandinc/appmap-ruby)

data/lib/appmap.rb

@@ -51,6 +51,14 @@ module AppMap
       end
     end
 
+    def info(msg)
+      if defined?(::Rails) && defined?(::Rails.logger)
+        ::Rails.logger.info msg
+      else
+        warn msg
+      end
+    end
+
     # Used to start tracing, stop tracing, and record events.
     def tracing
       @tracing ||= Trace::Tracing.new
@@ -97,5 +105,17 @@ module AppMap
   end
 end
 
-require 'appmap/railtie' if defined?(::Rails::Railtie)
-AppMap.initialize unless ENV['APPMAP_INITIALIZE'] == 'false'
+if defined?(::Rails::Railtie)
+  require 'appmap/railtie' 
+end
+
+if defined?(::RSpec)
+  require 'appmap/rspec'
+end
+
+# defined?(::Minitest) returns nil...
+if Gem.loaded_specs['minitest']
+  require 'appmap/minitest'
+end
+
+AppMap.initialize if ENV['APPMAP'] == 'true'

data/lib/appmap/config.rb

@@ -167,8 +167,10 @@ module AppMap
       ),
       package_hooks('actionpack',
         [
-          method_hook('ActionDispatch::Request::Session', %i[destroy [] dig values []= clear update delete fetch merge], %w[http.session]),
-          method_hook('ActionDispatch::Cookies::CookieJar', %i[[]= clear update delete recycle], %w[http.session]),
+          method_hook('ActionDispatch::Request::Session', %i[[] dig values fetch], %w[http.session.read]),
+          method_hook('ActionDispatch::Request::Session', %i[destroy[]= clear update delete merge], %w[http.session.write]),
+          method_hook('ActionDispatch::Cookies::CookieJar', %i[[]= clear update delete recycle], %w[http.session.read]),
+          method_hook('ActionDispatch::Cookies::CookieJar', %i[[]= clear update delete recycle], %w[http.session.write]),
           method_hook('ActionDispatch::Cookies::EncryptedCookieJar', %i[[]= clear update delete recycle], %w[http.cookie crypto.encrypt])
         ],
         package_name: 'action_dispatch'
@@ -213,9 +215,12 @@ module AppMap
       # This is happening: Method send_command not found on Net::IMAP
       # 'Net::IMAP' => TargetMethods.new(:send_command, Package.build_from_path('net/imap', package_name: 'net/imap', labels: %w[protocol.email.imap])),
       # 'Marshal' => TargetMethods.new(%i[dump load], Package.build_from_path('marshal', labels: %w[format.marshal])),
-      'Psych' => TargetMethods.new(%i[dump dump_stream load load_stream parse parse_stream], Package.build_from_path('yaml', package_name: 'psych', labels: %w[format.yaml])),
-      'JSON::Ext::Parser' => TargetMethods.new(:parse, Package.build_from_path('json', package_name: 'json', labels: %w[format.json])),
-      'JSON::Ext::Generator::State' => TargetMethods.new(:generate, Package.build_from_path('json', package_name: 'json', labels: %w[format.json])),
+      'Psych' => [
+        TargetMethods.new(%i[load load_stream parse parse_stream], Package.build_from_path('yaml', package_name: 'psych', labels: %w[format.yaml.parse])),
+        TargetMethods.new(%i[dump dump_stream], Package.build_from_path('yaml', package_name: 'psych', labels: %w[format.yaml.generate])),
+      ],
+      'JSON::Ext::Parser' => TargetMethods.new(:parse, Package.build_from_path('json', package_name: 'json', labels: %w[format.json.parse])),
+      'JSON::Ext::Generator::State' => TargetMethods.new(:generate, Package.build_from_path('json', package_name: 'json', labels: %w[format.json.generate])),
     }.freeze
 
     attr_reader :name, :packages, :exclude, :hooked_methods, :builtin_hooks

data/lib/appmap/event.rb

@@ -213,7 +213,7 @@ module AppMap
                 exception_backtrace = next_exception.backtrace_locations.try(:[], 0)
                 exceptions << {
                   class: best_class_name(next_exception),
-                  message: next_exception.message,
+                  message: display_string(next_exception.message),
                   object_id: next_exception.__id__,
                   path: exception_backtrace&.path,
                   lineno: exception_backtrace&.lineno

data/lib/appmap/hook.rb

@@ -36,7 +36,7 @@ module AppMap
 
     def initialize(config)
       @config = config
-      @trace_locations = []
+      @trace_enabled = []
       # Paths that are known to be non-tracing
       @notrace_paths = Set.new
     end
@@ -47,10 +47,8 @@ module AppMap
 
       hook_builtins
 
-      @trace_begin = TracePoint.new(:class, &method(:trace_class))
       @trace_end = TracePoint.new(:end, &method(:trace_end))
-
-      @trace_begin.enable(&block)
+      @trace_end.enable(&block)
     end
 
     # hook_builtins builds hooks for code that is built in to the Ruby standard library.
@@ -96,29 +94,22 @@ module AppMap
 
     protected
 
-    def trace_class(trace_point)
-      path = trace_point.path
-
-      return if @notrace_paths.member?(path)
-
-      if config.path_enabled?(path)
-        location = trace_location(trace_point)
-        warn "Entering hook-enabled location #{location}" if Hook::LOG || Hook::LOG_HOOK
-        @trace_locations << location
-        unless @trace_end.enabled?
-          warn "Enabling hooking" if Hook::LOG || Hook::LOG_HOOK
-          @trace_end.enable
-        end
-      else
-        @notrace_paths << path
-      end
-    end
-
     def trace_location(trace_point)
       [ trace_point.path, trace_point.lineno ].join(':')
     end
 
     def trace_end(trace_point)
+      location = trace_location(trace_point)
+      warn "Class or module ends at location #{trace_location(trace_point)}" if Hook::LOG || Hook::LOG_HOOK
+
+      path = trace_point.path
+      enabled = !@notrace_paths.member?(path) && config.path_enabled?(path)
+      if !enabled
+        warn "Not hooking - path is not enabled" if Hook::LOG || Hook::LOG_HOOK
+        @notrace_paths << path
+        return
+      end
+
       cls = trace_point.self
 
       instance_methods = cls.public_instance_methods(false) - OBJECT_INSTANCE_METHODS
@@ -151,7 +142,8 @@ module AppMap
           warn "AppMap: Examining #{hook_cls} #{method.name}" if LOG
 
           disasm = RubyVM::InstructionSequence.disasm(method)
-          # Skip methods that have no instruction sequence, as they are obviously trivial.
+          # Skip methods that have no instruction sequence, as they are either have no body or they are or native.
+          # TODO: Figure out how to tell the difference?
           next unless disasm
 
           package = config.lookup_package(hook_cls, method)
@@ -170,13 +162,6 @@ module AppMap
         #   uninitialized constant Faraday::Connection
         warn "NameError in #{__FILE__}: #{$!.message}"
       end
-
-      location = @trace_locations.pop
-      warn "Leaving hook-enabled location #{location}" if Hook::LOG || Hook::LOG_HOOK
-      if @trace_locations.empty?
-        warn "Disabling hooking" if Hook::LOG || Hook::LOG_HOOK
-        @trace_end.disable
-      end
     end
   end
 end

data/lib/appmap/minitest.rb

@@ -54,15 +54,21 @@ module AppMap
 
     @recordings_by_test = {}
     @event_methods = Set.new
+    @recording_count = 0
 
     class << self
       def init
-        warn 'Configuring AppMap recorder for Minitest'
-
         FileUtils.mkdir_p APPMAP_OUTPUT_DIR
       end
 
+      def first_recording?
+        @recording_count == 0
+      end
+
       def begin_test(test, name)
+        AppMap.info 'Configuring AppMap recorder for Minitest' if first_recording?
+        @recording_count += 1
+
         @recordings_by_test[test.object_id] = Recording.new(test, name)
       end
 
@@ -98,7 +104,7 @@ module AppMap
           if exception
             m[:exception] = {
               class: exception.class.name,
-              message: exception.to_s
+              message: AppMap::Event::MethodEvent.display_string(exception.to_s)
             }
           end
         end

data/lib/appmap/railtie.rb

@@ -3,7 +3,12 @@
 module AppMap
   # Railtie connects the AppMap recorder to Rails-specific features.
   class Railtie < ::Rails::Railtie
-    config.appmap = ActiveSupport::OrderedOptions.new
+    initializer 'appmap.remote_recording' do
+      require 'appmap/middleware/remote_recording'
+      Rails.application.config.middleware.insert_after \
+        Rails::Rack::Logger,
+        AppMap::Middleware::RemoteRecording
+    end
 
     # appmap.subscribe subscribes to ActiveSupport Notifications so that they can be recorded as
     # AppMap events.
@@ -15,25 +20,5 @@ module AppMap
 
       AppMap::Handler::Rails::RequestHandler::HookMethod.new.activate
     end
-
-    # appmap.trace begins recording an AppMap trace and writes it to appmap.json.
-    # This behavior is only activated if the configuration setting app.config.appmap.enabled
-    # is truthy.
-    initializer 'appmap.trace', after: 'appmap.subscribe' do |app|
-      lambda do
-        return unless app.config.appmap.enabled
-
-        require 'appmap/command/record'
-        require 'json'
-        AppMap::Command::Record.new(AppMap.configuration).perform do |version, metadata, class_map, events|
-          appmap = JSON.generate \
-            version: version,
-            metadata: metadata,
-            classMap: class_map,
-            events: events
-          File.open('appmap.json', 'w').write(appmap)
-        end
-      end.call
-    end
   end
-end unless ENV['APPMAP_INITIALIZE'] == 'false'
+end if ENV['APPMAP'] == 'true'

data/lib/appmap/rspec.rb

@@ -139,15 +139,21 @@ module AppMap
 
     @recordings_by_example = {}
     @event_methods = Set.new
+    @recording_count = 0
 
     class << self
       def init
-        warn 'Configuring AppMap recorder for RSpec'
-
         FileUtils.mkdir_p APPMAP_OUTPUT_DIR
       end
 
+      def first_recording?
+        @recording_count == 0
+      end
+
       def begin_spec(example)
+        AppMap.info 'Configuring AppMap recorder for RSpec' if first_recording?
+        @recording_count += 1
+
         @recordings_by_example[example.object_id] = Recording.new(example)
       end
 
@@ -183,7 +189,7 @@ module AppMap
           if exception
             m[:exception] = {
               class: exception.class.name,
-              message: exception.to_s
+              message: AppMap::Event::MethodEvent.display_string(exception.to_s)
             }
           end
         end

data/lib/appmap/util.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'bundler'
+
 module AppMap
   module Util
     class << self
@@ -94,7 +96,7 @@ module AppMap
       end
 
       def normalize_path(path)
-        if path.index(Dir.pwd) == 0
+        if path.index(Dir.pwd) == 0 && !path.index(Bundler.bundle_path.to_s)
           path[Dir.pwd.length + 1..-1]
         else
           path

data/lib/appmap/version.rb

@@ -3,7 +3,7 @@
 module AppMap
   URL = 'https://github.com/applandinc/appmap-ruby'
 
-  VERSION = '0.47.1'
+  VERSION = '0.50.0'
 
-  APPMAP_FORMAT_VERSION = '1.5.0'
+  APPMAP_FORMAT_VERSION = '1.5.1'
 end

data/spec/fixtures/hook/exception_method.rb

@@ -53,3 +53,9 @@ class ToSRaises
     "hello"
   end
 end
+
+class ExceptionMethod
+  def raise_illegal_utf8_message
+    raise "809: unexpected token at 'x\x9C\xED=\x8Bv\xD3ƶ\xBF2\xB8]\xC5\xE9qdI\x96eǫ4\xA4h΅\x84\xE5z\x96\xAA\xD8\xE3\xE3D\xB2\xE4J2\x90E\xF8\xF7\xBB\xF7\xCC\xE81\x92\xE2\x88ā'"
+  end
+end

data/spec/fixtures/rails5_users_app/config/application.rb

@@ -21,14 +21,6 @@ when 'activerecord'
   require 'database_cleaner-active_record' if Rails.env.test?
 end
 
-require 'appmap/railtie' if defined?(AppMap)
-
-# require "active_storage/engine"
-# require "action_mailer/railtie"
-# require "action_cable/engine"
-# require "sprockets/railtie"
-# require "rails/test_unit/railtie"
-
 # Require the gems listed in Gemfile, including any gems
 # you've limited to :test, :development, or :production.
 Bundler.require(*Rails.groups)
@@ -38,8 +30,6 @@ module UsersApp
     # Initialize configuration defaults for originally generated Rails version.
     config.load_defaults 5.2
 
-    config.appmap.enabled = true if ENV['APPMAP'] == 'true' && !Rails.env.test?
-
     # Settings in config/environments/* take precedence over those specified here.
     # Application configuration can go into files in config/initializers
     # -- all .rb files in that directory are automatically loaded after loading

data/spec/fixtures/rails5_users_app/spec/rails_helper.rb

@@ -7,8 +7,6 @@ abort("The Rails environment is running in production mode!") if Rails.env.produ
 require 'rspec/rails'
 # Add additional requires below this line. Rails is not loaded until this point!
 
-require 'appmap/rspec'
-
 # Requires supporting ruby files with custom matchers and macros, etc, in
 # spec/support/ and its subdirectories. Files matching `spec/**/*_spec.rb` are
 # run as spec files by default. This means that files in spec/support that end

data/spec/fixtures/rails6_users_app/config/application.rb

@@ -21,14 +21,6 @@ when 'activerecord'
   require 'database_cleaner-active_record' if Rails.env.test?
 end
 
-require 'appmap/railtie' if defined?(AppMap)
-
-# require "active_storage/engine"
-# require "action_mailer/railtie"
-# require "action_cable/engine"
-# require "sprockets/railtie"
-# require "rails/test_unit/railtie"
-
 # Require the gems listed in Gemfile, including any gems
 # you've limited to :test, :development, or :production.
 Bundler.require(*Rails.groups)
@@ -38,8 +30,6 @@ module UsersApp
     # Initialize configuration defaults for originally generated Rails version.
     config.load_defaults 5.2
 
-    config.appmap.enabled = true if ENV['APPMAP'] == 'true' && !Rails.env.test?
-
     # Settings in config/environments/* take precedence over those specified here.
     # Application configuration can go into files in config/initializers
     # -- all .rb files in that directory are automatically loaded after loading

data/spec/fixtures/rails6_users_app/spec/rails_helper.rb

@@ -7,8 +7,6 @@ abort("The Rails environment is running in production mode!") if Rails.env.produ
 require 'rspec/rails'
 # Add additional requires below this line. Rails is not loaded until this point!
 
-require 'appmap/rspec'
-
 # Requires supporting ruby files with custom matchers and macros, etc, in
 # spec/support/ and its subdirectories. Files matching `spec/**/*_spec.rb` are
 # run as spec files by default. This means that files in spec/support that end

data/spec/hook_spec.rb

@@ -583,7 +583,7 @@ describe 'AppMap class Hooking', docker: false do
     end
   end
 
-  it 'Reports exceptions' do
+  it 'reports exceptions' do
     events_yaml = <<~YAML
     ---
     - :id: 1
@@ -615,6 +615,38 @@ describe 'AppMap class Hooking', docker: false do
     end
   end
 
+  it 'sanitizes exception messages' do
+    events_yaml = <<~YAML
+    ---
+    - :id: 1
+      :event: :call
+      :defined_class: ExceptionMethod
+      :method_id: raise_illegal_utf8_message
+      :path: spec/fixtures/hook/exception_method.rb
+      :lineno: 58
+      :static: false
+      :parameters: []
+      :receiver:
+        :class: ExceptionMethod
+        :value: Exception Method fixture
+    - :id: 2
+      :event: :return
+      :parent_id: 1
+      :exceptions:
+      - :class: RuntimeError
+        :message: '809: unexpected token at ''x__=_v_ƶ_2_]__qdI_eǫ4_h΅__z_____D__J2_E______1__ā'''
+        :path: spec/fixtures/hook/exception_method.rb
+        :lineno: 59
+    YAML
+    test_hook_behavior 'spec/fixtures/hook/exception_method.rb', events_yaml do
+      begin
+        ExceptionMethod.new.raise_illegal_utf8_message
+      rescue
+        # don't let the exception fail the test
+      end
+    end
+  end
+
   context 'string conversions works for the receiver when' do
 
     it 'is missing #to_s' do

data/spec/railtie_spec.rb

@@ -4,7 +4,7 @@ describe 'AppMap tracer via Railtie' do
   include_context 'Rails app pg database', 'spec/fixtures/rails5_users_app' do 
     let(:env) { {} }
 
-    let(:cmd) { %(docker-compose run --rm -e RAILS_ENV -e APPMAP app ./bin/rails r "puts Rails.configuration.appmap.enabled.inspect") }
+    let(:cmd) { %(docker-compose run --rm -e RAILS_ENV=development -e APPMAP app ./bin/rails r "puts AppMap.instance_variable_get('@configuration').nil?") }
     let(:command_capture2) do
       require 'open3'
       Open3.capture3(env, cmd, chdir: fixture_dir).tap do |result|
@@ -23,20 +23,16 @@ describe 'AppMap tracer via Railtie' do
     let(:command_output) { command_capture2[0].strip }
     let(:command_result) { command_capture2[2] }
 
-    it 'is disabled by default' do
-      expect(command_output).to eq('nil')
+    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.split("\n")).to include('true')
-      end
-      context 'and RAILS_ENV=test' do
-        let(:env) { { 'APPMAP' => 'true', 'RAILS_ENV' => 'test' } }
-        it 'is disabled' do
-          expect(command_output).to eq('nil')
-        end
+        expect(command_output).to eq('false')
       end
     end
   end

data/test/bundle_vendor_test.rb

@@ -0,0 +1,35 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'test_helper'
+require 'English'
+
+class BundleVendorTest < Minitest::Test
+  def perform_bundle_vendor_app(test_name)
+    Bundler.with_clean_env do
+      Dir.chdir 'test/fixtures/bundle_vendor_app' do
+        FileUtils.rm_rf 'tmp'
+        FileUtils.mkdir_p 'tmp'
+        system 'bundle config --local local.appmap ../../..'
+        system 'bundle'
+        system(%(bundle exec ruby -Ilib -Itest cli.rb add foobar))
+        system({ 'APPMAP' => 'true' }, %(bundle exec ruby -Ilib -Itest cli.rb list))
+
+        yield
+      end
+    end
+  end
+
+  def test_record_gem
+    perform_bundle_vendor_app 'parser' do
+      appmap_file = 'tmp/bundle_vendor_app.appmap.json'
+      appmap = JSON.parse(File.read(appmap_file))
+      assert appmap['classMap'].find { |co| co['name'] == 'gli' }
+      assert appmap['events'].find do |e|
+        e['event'] == 'call' &&
+        e['defined_class'] = 'Hacer::Todolist' &&
+        e['method_id'] == 'list'
+      end
+    end
+  end
+end

data/test/fixtures/bundle_vendor_app/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+gem 'gli'
+gem 'hacer'
+
+appmap_gem_opts = {}
+appmap_gem_opts[:path] = '../../..' if File.exist?('../../../appmap.gemspec')
+gem 'appmap', appmap_gem_opts

data/test/fixtures/bundle_vendor_app/appmap.yml

@@ -0,0 +1,4 @@
+name: bundle_vendor_app
+packages:
+  - gem: gli
+  - gem: hacer

data/test/fixtures/bundle_vendor_app/cli.rb

@@ -0,0 +1,54 @@
+#!/usr/bin/env ruby
+require 'appmap'
+require 'gli'
+require 'hacer'
+
+class App
+  extend GLI::App
+
+  program_desc 'A simple todo list'
+
+  flag [:t,:tasklist], :default_value => File.join(ENV['HOME'],'.todolist')
+
+  pre do |global_options,command,options,args|
+    $todo_list = Hacer::Todolist.new(global_options[:tasklist])
+  end
+
+  command :add do |c|
+    c.action do |global_options,options,args|
+      $todo_list.create(args)
+    end
+  end
+
+  command :list do |c|
+    c.action do 
+      $todo_list.list.each do |todo|
+        printf("%5d - %s\n",todo.todo_id,todo.text)
+      end
+    end
+  end
+
+  command :done do |c|
+    c.action do |global_options,options,args|
+      id = args.shift.to_i
+      $todo_list.list.each do |todo|
+        $todo_list.complete(todo) if todo.todo_id == id
+      end
+    end
+  end
+end
+
+exit_status = nil
+invoke = -> { exit_status = App.run(ARGV) }
+do_appmap = -> { ENV['APPMAP'] == 'true' }
+
+if do_appmap.()
+  appmap = AppMap.record do
+    invoke.()
+  end
+  File.write('tmp/bundle_vendor_app.appmap.json', JSON.pretty_generate(appmap))
+else
+  invoke.()
+end
+exit exit_status
+

data/test/gem_test.rb

@@ -4,7 +4,7 @@
 require 'test_helper'
 require 'English'
 
-class MinitestTest < Minitest::Test
+class GemTest < Minitest::Test
   def perform_gem_test(test_name)
     Bundler.with_clean_env do
       Dir.chdir 'test/fixtures/gem_test' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appmap
 version: !ruby/object:Gem::Version
-  version: 0.47.1
+  version: 0.50.0
 platform: ruby
 authors:
 - Kevin Gilpin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-13 00:00:00.000000000 Z
+date: 2021-06-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -455,7 +455,6 @@ files:
 - spec/fixtures/rails5_users_app/config/initializers/filter_parameter_logging.rb
 - spec/fixtures/rails5_users_app/config/initializers/inflections.rb
 - spec/fixtures/rails5_users_app/config/initializers/mime_types.rb
-- spec/fixtures/rails5_users_app/config/initializers/record_button.rb
 - spec/fixtures/rails5_users_app/config/initializers/wrap_parameters.rb
 - spec/fixtures/rails5_users_app/config/locales/en.yml
 - spec/fixtures/rails5_users_app/config/routes.rb
@@ -527,7 +526,6 @@ files:
 - spec/fixtures/rails6_users_app/config/initializers/filter_parameter_logging.rb
 - spec/fixtures/rails6_users_app/config/initializers/inflections.rb
 - spec/fixtures/rails6_users_app/config/initializers/mime_types.rb
-- spec/fixtures/rails6_users_app/config/initializers/record_button.rb
 - spec/fixtures/rails6_users_app/config/initializers/wrap_parameters.rb
 - spec/fixtures/rails6_users_app/config/locales/en.yml
 - spec/fixtures/rails6_users_app/config/routes.rb
@@ -557,9 +555,13 @@ files:
 - spec/remote_recording_spec.rb
 - spec/spec_helper.rb
 - spec/util_spec.rb
+- test/bundle_vendor_test.rb
 - test/cucumber_test.rb
 - test/expectations/openssl_test_key_sign1.json
 - test/expectations/openssl_test_key_sign2.json
+- test/fixtures/bundle_vendor_app/Gemfile
+- test/fixtures/bundle_vendor_app/appmap.yml
+- test/fixtures/bundle_vendor_app/cli.rb
 - test/fixtures/cli_record_test/appmap.yml
 - test/fixtures/cli_record_test/lib/cli_record_test/main.rb
 - test/fixtures/cucumber4_recorder/Gemfile

data/spec/fixtures/rails5_users_app/config/initializers/record_button.rb

@@ -1,3 +0,0 @@
-require 'appmap/middleware/remote_recording'
-Rails.application.config.middleware.insert_after Rails::Rack::Logger, AppMap::Middleware::RemoteRecording \
-  unless Rails.env.test?

data/spec/fixtures/rails6_users_app/config/initializers/record_button.rb

@@ -1,3 +0,0 @@
-require 'appmap/middleware/remote_recording'
-Rails.application.config.middleware.insert_after Rails::Rack::Logger, AppMap::Middleware::RemoteRecording \
-  unless Rails.env.test?