appmap 0.88.0 → 0.90.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 22745bf509f674a271a3bc42eb870813cf22d6e0c399a87e99377311a0ddaf67
-  data.tar.gz: 482036f94bc62a732263ac7318e6c942efd22282d9b2ace1ae1245bda28de591
+  metadata.gz: 463d826fad7ff1f1f143f350e329e0d9f58c649c6a517b519c42e852d620318a
+  data.tar.gz: f1429c965be9a9913c2163245e3cee99b6b014d73c85d77c19b1d1198b5e92ec
 SHA512:
-  metadata.gz: dd9fe2dc676c639487b19c5ad4c10e52d8dd1ff95ef10f0829077fc6a4100613d220df7bb8aea5c425e65158617112148827136bc2151cfd8e0a13666e49c347
-  data.tar.gz: 5913ce200514ce676f26a6bf20e348fe9481ecd929ac9b8a5874b9f2e2d20d3bdc82722a535afebe7a153c7a7290ccf8e8e510a336f0b5d7265b6b3665b18a69
+  metadata.gz: 8fb3886bd1f864f4619f5dc0bd158381b4c959a385990d786d45228c0a2f01169511ef0a3ebafec6e01874af566bb286edfb38367f34b83facb7959ded3bd4ae
+  data.tar.gz: 96adc82206bf8fb319675a6107281c1ebfb19c8254daac59ae9e88ebceeec8adc446b459a68fa3483108426cb5a65bfbecb42205b4b797ae3301777b6e473233

data/.travis.yml

@@ -5,7 +5,6 @@ cache:
 - yarn
 
 rbenv:
-- 2.5
 - 2.6
 - 2.7
 - 3.0

data/CHANGELOG.md

@@ -1,3 +1,24 @@
+# [0.90.0](https://github.com/applandinc/appmap-ruby/compare/v0.89.0...v0.90.0) (2022-09-15)
+
+
+### Features
+
+* Include required_ruby_version in the gemspec ([a5d7c6b](https://github.com/applandinc/appmap-ruby/commit/a5d7c6b7b255f817f3ceec5924cd799d2565daa4))
+* Save default appmap.yml ([77a08d5](https://github.com/applandinc/appmap-ruby/commit/77a08d5ebbe2f49f19237242a62d05aadcc84228))
+
+# [0.89.0](https://github.com/applandinc/appmap-ruby/compare/v0.88.0...v0.89.0) (2022-09-07)
+
+
+### Bug Fixes
+
+* Make Rack a runtime dependency ([3f2924d](https://github.com/applandinc/appmap-ruby/commit/3f2924d41af291bfe771829c2ea7978332ff1d44))
+
+
+### Features
+
+* Add builtin labels for JWT ([3569333](https://github.com/applandinc/appmap-ruby/commit/3569333e99f82e03fff892001f2b65eb9e8aa52a))
+* Write an AppMap for each observed HTTP request ([2e89eaf](https://github.com/applandinc/appmap-ruby/commit/2e89eaf1b1f327771d1f4f0642fa6c202e0f3afb))
+
 # [0.88.0](https://github.com/applandinc/appmap-ruby/compare/v0.87.0...v0.88.0) (2022-08-31)
 
 

data/Gemfile

@@ -3,3 +3,5 @@ source "https://rubygems.org"
 git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
 
 gemspec
+
+gem 'rack', '~> 2'

data/README.md

@@ -92,9 +92,7 @@ You can launch a database like this:
 ```
 ➜ docker-compose -p appmap-ruby up -d
 ... stuff
-➜ docker-compose ps pg  
-      Name                    Command                 State                Ports         
------------------------------------------------------------------------------------------
-appmap-ruby_pg_1   docker-entrypoint.sh postgres   Up (healthy)   0.0.0.0:59134->5432/tcp
-➜ export DATABASE_URL=postgres://postgres@localhost:59134
+➜ docker-compose port pg 5432
+0.0.0.0:64479
+➜ export DATABASE_URL=postgres://postgres@localhost:64479
 ```

data/appmap.gemspec

@@ -12,6 +12,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Kevin Gilpin']
   spec.email         = ['kgilpin@gmail.com']
 
+  spec.required_ruby_version = '>= 2.6.0'
+
   spec.summary       = %q{Record the operation of a Ruby program, using the AppLand 'AppMap' format.}
   spec.homepage      = AppMap::URL
   spec.license       = 'MIT'
@@ -28,10 +30,10 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_dependency 'method_source'
-  spec.add_dependency 'rack'
   spec.add_dependency 'reverse_markdown'
 
   spec.add_runtime_dependency 'activesupport'
+  spec.add_runtime_dependency 'rack'
 
   spec.add_development_dependency 'bundler', '>= 1.16'
   spec.add_development_dependency 'minitest', '~> 5.15'
@@ -39,7 +41,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake', '>= 12.3.3'
   spec.add_development_dependency 'rdoc'
   spec.add_development_dependency 'rubocop'
-  spec.add_development_dependency "rake-compiler"
+  spec.add_development_dependency 'rake-compiler'
 
   # Testing
   spec.add_development_dependency 'climate_control'

data/lib/appmap/config.rb

@@ -338,28 +338,34 @@ module AppMap
           AppMap uses this file to customize its behavior. For example, you can use
           the 'packages' setting to indicate which local file paths and dependency
           gems you want to include in the AppMap. Since you haven't provided specific
-          settings, the appmap gem will try and guess some reasonable defaults.
-          To suppress this message, create the file:
-          
-          #{Pathname.new(config_file_name).expand_path}
-          
-          Here are the default settings that will be used in the meantime. You can
-          copy and paste this example to start your appmap.yml.
+          settings, the appmap gem will use these default options:
           MISSING_FILE_MSG
           {}
         end
 
         load(config_data).tap do |config|
-          config_yaml = {
+          {
             'name' => config.name,
             'packages' => config.packages.select{|p| p.path}.map do |pkg|
               { 'path' => pkg.path }
             end,
             'exclude' => []
-          }.compact
-          unless config_present
-            warn Util.color(YAML.dump(config_yaml), :magenta)
-            warn logo.()
+          }.compact.tap do |config_yaml|
+            unless config_present
+              warn Util.color(YAML.dump(config_yaml), :magenta)
+              dirname = Pathname.new(config_file_name).dirname.expand_path
+              if Dir.exists?(dirname) && File.writable?(dirname)
+                warn Util.color(<<~CONFIG_FILE_MSG, :magenta)
+                This file will be saved to #{Pathname.new(config_file_name).expand_path},
+                where you can customize it.
+                CONFIG_FILE_MSG
+                File.write(config_file_name, YAML.dump(config_yaml))
+              end
+              warn Util.color(<<~CONFIG_FILE_MSG, :magenta)
+              For more information, see https://appmap.io/docs/reference/appmap-ruby.html#configuration
+              CONFIG_FILE_MSG
+              warn logo.()
+            end
           end
         end
       end

data/lib/appmap/gem_hooks/jwt.yml

@@ -0,0 +1,8 @@
+- method: JWT#decode
+  label: jwt.decode
+
+- method: JWT#encode
+  label: jwt.encode
+
+- method: JWT::Signature#verify
+  label: jwt.signature.verify

data/lib/appmap/middleware/remote_recording.rb

@@ -2,7 +2,8 @@
 
 module AppMap
   module Middleware
-    # RemoteRecording adds `/_appmap/record` routes to control recordings via HTTP requests
+    # RemoteRecording adds `/_appmap/record` routes to control recordings via HTTP requests.
+    # It can also be enabled to emit an AppMap for each request.
     class RemoteRecording
       def initialize(app)
         require 'json'
@@ -21,7 +22,7 @@ module AppMap
         end
       end
 
-      def start_recording
+      def ws_start_recording
         return [ 409, 'Recording is already in progress' ] if @tracer
 
         @events = []
@@ -32,7 +33,7 @@ module AppMap
         [ 200 ]
       end
 
-      def stop_recording(req)
+      def ws_stop_recording(req)
         return [ 404, 'No recording is in progress' ] unless @tracer
 
         tracer = @tracer
@@ -75,10 +76,50 @@ module AppMap
       end
 
       def call(env)
+        # Note: Puma config is avaliable here. For example:
+        # $ env['puma.config'].final_options[:workers]
+        # 0
+
         req = Rack::Request.new(env)
         return handle_record_request(req) if req.path == '/_appmap/record'
 
-        @app.call(env)
+        start_time = Time.now
+        # Support multi-threaded web server such as Puma by recording each thread
+        # into a separate Tracer.
+        tracer = AppMap.tracing.trace(thread: Thread.current) if record_all_requests?
+
+        @app.call(env).tap do |status, headers|
+          if tracer
+            AppMap.tracing.delete(tracer)
+
+            events = tracer.events.map(&:to_h)
+
+            appmap_name = "#{req.request_method} #{req.path} (#{status}) - #{start_time.strftime('%T.%L')}"
+            appmap_file_name = AppMap::Util.scenario_filename([ start_time.to_f, req.url ].join('_'))
+            output_dir = File.join(AppMap::DEFAULT_APPMAP_DIR, 'requests')
+            appmap_file_path = File.join(output_dir, appmap_file_name)
+
+            metadata = AppMap.detect_metadata
+            metadata[:name] = appmap_name
+            metadata[:timestamp] = start_time.to_f
+            metadata[:recorder] = {
+              name: 'record_requests'
+            }
+    
+            appmap = {
+              version: AppMap::APPMAP_FORMAT_VERSION,
+              classMap: AppMap.class_map(tracer.event_methods),
+              metadata: metadata,
+              events: events
+            }
+
+            FileUtils.mkdir_p(output_dir)
+            File.write(appmap_file_path, JSON.generate(appmap))
+
+            headers['AppMap-Name'] = File.expand_path(appmap_name)
+            headers['AppMap-File-Name'] = File.expand_path(appmap_file_path)
+          end
+        end
       end
 
       def recording_state
@@ -92,9 +133,9 @@ module AppMap
           if method.eql?('GET')
             recording_state
           elsif method.eql?('POST')
-            start_recording
+            ws_start_recording
           elsif method.eql?('DELETE')
-            stop_recording(req)
+            ws_stop_recording(req)
           else
             [ 404, '' ]
           end
@@ -106,6 +147,10 @@ module AppMap
         headers['Content-Type'] && headers['Content-Type'] =~ /html/
       end
 
+      def record_all_requests?
+        ENV['APPMAP_RECORD_REQUESTS'] == 'true'
+      end
+
       def recording?
         !@event_thread.nil?
       end

data/lib/appmap/trace.rb

@@ -48,8 +48,8 @@ module AppMap
         @tracers.empty?
       end
 
-      def trace(enable: true)
-        Tracer.new.tap do |tracer|
+      def trace(enable: true, thread: nil)
+        Tracer.new(thread_id: thread&.object_id).tap do |tracer|
           @tracers << tracer
           tracer.enable if enable
         end
@@ -64,7 +64,7 @@ module AppMap
       end
 
       def record_event(event, package: nil, defined_class: nil, method: nil)
-        @tracers.each do |tracer|
+        @tracers.select { |tracer| tracer.thread_id.nil? || tracer.thread_id === event.thread_id }.each do |tracer|
           tracer.record_event(event, package: package, defined_class: defined_class, method: method)
         end
       end
@@ -114,14 +114,16 @@ module AppMap
 
   class Tracer
     attr_accessor :stacks
+    attr_reader   :thread_id, :events
 
     # Records the events which happen in a program.
-    def initialize
+    def initialize(thread_id: nil)
       @events = []
       @last_package_for_thread = {}
       @methods = Set.new
       @stack_printer = StackPrinter.new if StackPrinter.enabled?
       @enabled = false
+      @thread_id = thread_id
     end
 
     def enable
@@ -143,6 +145,8 @@ module AppMap
     def record_event(event, package: nil, defined_class: nil, method: nil)
       return unless @enabled
 
+      raise "Expected event in thread #{@thread_id}, got #{event.thread_id}" if @thread_id && @thread_id != event.thread_id 
+
       @stack_printer.record(event) if @stack_printer
       @last_package_for_thread[Thread.current.object_id] = package if package
       @events << event

data/lib/appmap/version.rb

@@ -3,7 +3,7 @@
 module AppMap
   URL = 'https://github.com/applandinc/appmap-ruby'
 
-  VERSION = '0.88.0'
+  VERSION = '0.90.0'
 
   APPMAP_FORMAT_VERSION = '1.7.0'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appmap
 version: !ruby/object:Gem::Version
-  version: 0.88.0
+  version: 0.90.0
 platform: ruby
 authors:
 - Kevin Gilpin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-08-31 00:00:00.000000000 Z
+date: 2022-09-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: method_source
@@ -25,7 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rack
+  name: reverse_markdown
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -39,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: reverse_markdown
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: rack
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -386,6 +386,7 @@ files:
 - lib/appmap/gem_hooks/activerecord.yml
 - lib/appmap/gem_hooks/cancancan.yml
 - lib/appmap/gem_hooks/devise.yml
+- lib/appmap/gem_hooks/jwt.yml
 - lib/appmap/gem_hooks/pandoc-ruby.yml
 - lib/appmap/gem_hooks/rails.yml
 - lib/appmap/gem_hooks/railties.yml
@@ -445,7 +446,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="