appmap 0.77.2 → 0.78.0

data/lib/appmap/hook/method/ruby3.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module AppMap
+  class Hook
+    # Delegation methods for Ruby 3.
+    class Method
+      def call(receiver, *args, **kwargs, &block)
+        return do_call(receiver, *args, **kwargs, &block) unless trace?
+
+        call_event = with_disabled_hook { before_hook receiver, *args, **kwargs }
+        trace_call call_event, receiver, *args, **kwargs, &block
+      end
+
+      protected
+
+      def before_hook(receiver, *args, **kwargs)
+        args = [*args, kwargs] if !kwargs.empty? || keyrest?
+        call_event = handle_call(receiver, args)
+        if call_event
+          AppMap.tracing.record_event \
+            call_event,
+            package: hook_package,
+            defined_class: defined_class,
+            method: hook_method
+        end
+        call_event
+      end
+
+      def keyrest?
+        @keyrest ||= parameters.map(&:last).include? :keyrest
+      end
+
+      def do_call(receiver, *args, **kwargs, &block)
+        hook_method.bind_call(receiver, *args, **kwargs, &block)
+      end
+
+      def trace_call(call_event, receiver, *args, **kwargs, &block)
+        start_time = gettime
+        begin
+          return_value = do_call(receiver, *args, **kwargs, &block)
+        rescue # rubocop:disable Style/RescueStandardError
+          exception = $ERROR_INFO
+          raise
+        ensure
+          with_disabled_hook { after_hook receiver, call_event, gettime - start_time, return_value, exception } \
+            if call_event
+        end
+      end
+
+      def hook_method_def
+        this = self
+        proc { |*args, **kwargs, &block| this.call self, *args, **kwargs, &block }
+      end
+    end
+  end
+end

data/lib/appmap/hook/method.rb

@@ -1,17 +1,11 @@
 # frozen_string_literal: true
 
 module AppMap
-  NEW_RUBY = Util.ruby_minor_version >= 2.7
-  if NEW_RUBY && !Proc.instance_methods.include?(:ruby2_keywords)
-    warn "Ruby is #{RUBY_VERSION}, but Procs don't respond to #ruby2_keywords"
-  end
-
   class Hook
     SIGNATURES = {}
-
     LOOKUP_SIGNATURE = lambda do |id|
       method = super(id)
-    
+
       signature = SIGNATURES[[ method.owner, method.name ]]
       if signature
         method.singleton_class.module_eval do
@@ -20,36 +14,24 @@ module AppMap
           end
         end
       end
-    
+
       method
     end
-    
-    class Method
-      attr_reader :hook_package, :hook_class, :hook_method
 
-      # +method_display_name+ may be nil if name resolution gets
-      # deferred until runtime (e.g. for a singleton method on an
-      # embedded Struct).
-      attr_reader :method_display_name
+    # Single hooked method.
+    # Call #activate to override the original.
+    class Method
+      attr_reader :hook_package, :hook_class, :hook_method, :parameters, :arity
 
       HOOK_DISABLE_KEY = 'AppMap::Hook.disable'
       private_constant :HOOK_DISABLE_KEY
 
-      # Grab the definition of Time.now here, to avoid interfering
-      # with the method we're hooking.
-      TIME_NOW = Time.method(:now)
-      private_constant :TIME_NOW
-
-      ARRAY_OF_EMPTY_HASH = [{}.freeze].freeze
-
       def initialize(hook_package, hook_class, hook_method)
         @hook_package = hook_package
         @hook_class = hook_class
         @hook_method = hook_method
-
-        # Get the class for the method, if it's known.
-        @defined_class, method_symbol = Hook.qualify_method_name(@hook_method)
-        @method_display_name = [@defined_class, method_symbol, @hook_method.name].join if @defined_class
+        @parameters = hook_method.parameters
+        @arity = hook_method.arity
       end
 
       def activate
@@ -62,64 +44,6 @@ module AppMap
           warn "AppMap: Hooking #{msg} at line #{(hook_method.source_location || []).join(':')}"
         end
 
-        defined_class = @defined_class
-        hook_package = self.hook_package
-        hook_method = self.hook_method
-        before_hook = self.method(:before_hook)
-        after_hook = self.method(:after_hook)
-        with_disabled_hook = self.method(:with_disabled_hook)
-
-        is_array_containing_empty_hash = ->(obj) {
-          obj.is_a?(Array) && obj.length == 1 && obj[0].is_a?(Hash) && obj[0].size == 0
-        }
-
-        call_instance_method = lambda do |receiver, args, &block|
-          # https://github.com/applandinc/appmap-ruby/issues/153
-          if NEW_RUBY && is_array_containing_empty_hash.(args) && hook_method.arity == 1
-            hook_method.bind_call(receiver, {}, &block)
-          else
-            if NEW_RUBY
-              hook_method.bind_call(receiver, *args, &block)
-            else
-              hook_method.bind(receiver).call(*args, &block)
-            end
-          end
-        end
-
-        hook_method_def = Proc.new do |*args, &block|
-          # We may not have gotten the class for the method during
-          # initialization (e.g. for a singleton method on an embedded
-          # struct), so make sure we have it now.
-          defined_class, = Hook.qualify_method_name(hook_method) unless defined_class
-
-          reentrant = Thread.current[HOOK_DISABLE_KEY]
-          disabled_by_shallow_flag = \
-            -> { hook_package&.shallow? && AppMap.tracing.last_package_for_current_thread == hook_package }
-
-          enabled = true if AppMap.tracing.enabled? && !reentrant && !disabled_by_shallow_flag.call
-
-          enabled = false if %i[instance_eval instance_exec].member?(hook_method.name) && args.empty?
-
-          return call_instance_method.call(self, args, &block) unless enabled
-
-          call_event, start_time = with_disabled_hook.call do
-            before_hook.call(self, defined_class, args)
-          end
-          return_value = nil
-          exception = nil
-          begin
-            return_value = call_instance_method.call(self, args, &block)
-          rescue
-            exception = $ERROR_INFO
-            raise
-          ensure
-            with_disabled_hook.call do
-              after_hook.call(self, call_event, start_time, return_value, exception) if call_event
-            end
-          end
-        end
-        hook_method_def = hook_method_def.ruby2_keywords if hook_method_def.respond_to?(:ruby2_keywords)
-
         hook_method_parameters = hook_method.parameters.dup.freeze
         SIGNATURES[[ hook_class, hook_method.name ]] = hook_method_parameters
 
@@ -140,28 +64,42 @@ module AppMap
 
       protected
 
-      def before_hook(receiver, defined_class, args)
-        call_event = hook_package.handler_class.handle_call(defined_class, hook_method, receiver, args)
-        AppMap.tracing.record_event(call_event, package: hook_package, defined_class: defined_class, method: hook_method) if call_event
-        [ call_event, TIME_NOW.call ]
+      def gettime
+        Process.clock_gettime Process::CLOCK_MONOTONIC
+      end
+
+      def trace?
+        return false unless AppMap.tracing.enabled?
+        return false if Thread.current[HOOK_DISABLE_KEY]
+        return false if hook_package&.shallow? && AppMap.tracing.last_package_for_current_thread == hook_package
+
+        true
       end
 
-      def after_hook(_receiver, call_event, start_time, return_value, exception)
-        elapsed = TIME_NOW.call - start_time
-        return_event = hook_package.handler_class.handle_return(call_event.id, elapsed, return_value, exception)
+      def method_display_name
+        return @method_display_name if @method_display_name
+
+        return @method_display_name = [defined_class, method_symbol, hook_method.name].join if defined_class
+
+        "#{hook_method.name} (class resolution deferred)"
+      end
+
+      def defined_class
+        @defined_class ||= Hook.qualify_method_name(hook_method)&.first
+      end
+
+      def after_hook(_receiver, call_event, elapsed, return_value, exception)
+        return_event = handle_return(call_event.id, elapsed, return_value, exception)
         AppMap.tracing.record_event(return_event) if return_event
-        nil
       end
 
-      def with_disabled_hook(&function)
+      def with_disabled_hook
         # Don't record functions, such as to_s and inspect, that might be called
         # by the fn. Otherwise there can be a stack overflow.
         Thread.current[HOOK_DISABLE_KEY] = true
-        begin
-          function.call
-        ensure
-          Thread.current[HOOK_DISABLE_KEY] = false
-        end
+        yield
+      ensure
+        Thread.current[HOOK_DISABLE_KEY] = false
       end
     end
   end
@@ -189,3 +127,9 @@ unless ENV['APPMAP_NO_PATCH_MODULE'] == 'true'
     prepend AppMap::ModuleMethods
   end
 end
+
+if RUBY_VERSION < '3'
+  require 'appmap/hook/method/ruby2'
+else
+  require 'appmap/hook/method/ruby3'
+end

data/lib/appmap/hook.rb

@@ -118,7 +118,7 @@ module AppMap
                 cls, method = entry
                 return false if config.never_hook?(cls, method)
 
-                Hook::Method.new(hook.package, cls, method).activate
+                hook.package.handler_class.new(hook.package, cls, method).activate
               end
 
               methods = []
@@ -209,7 +209,7 @@ module AppMap
           package = config.lookup_package(hook_cls, method)
           next unless package
 
-          Hook::Method.new(package, hook_cls, method).activate
+          package.handler_class.new(package, hook_cls, method).activate
         end
       end
 

data/lib/appmap/version.rb

@@ -3,7 +3,7 @@
 module AppMap
   URL = 'https://github.com/applandinc/appmap-ruby'
 
-  VERSION = '0.77.2'
+  VERSION = '0.78.0'
 
   APPMAP_FORMAT_VERSION = '1.5.1'
 

data/spec/fixtures/rails7_users_app/.dockerignore

@@ -0,0 +1 @@
+Gemfile.lock

data/spec/fixtures/rails7_users_app/.gitattributes

@@ -0,0 +1,7 @@
+# See https://git-scm.com/docs/gitattributes for more about git attribute files.
+
+# Mark the database schema as having been generated.
+db/schema.rb linguist-generated
+
+# Mark any vendored files as having been vendored.
+vendor/* linguist-vendored

data/spec/fixtures/rails7_users_app/.gitignore

@@ -0,0 +1,31 @@
+# See https://help.github.com/articles/ignoring-files for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile '~/.gitignore_global'
+
+# Ignore bundler config.
+/.bundle
+
+# Ignore all logfiles and tempfiles.
+/log/*
+/tmp/*
+!/log/.keep
+!/tmp/.keep
+
+# Ignore pidfiles, but keep the directory.
+/tmp/pids/*
+!/tmp/pids/
+!/tmp/pids/.keep
+
+# Ignore uploaded files in development.
+/storage/*
+!/storage/.keep
+/tmp/storage/*
+!/tmp/storage/
+!/tmp/storage/.keep
+
+/public/assets
+
+# Ignore master key for decrypting credentials and more.
+/config/master.key

data/spec/fixtures/rails7_users_app/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/spec/fixtures/rails7_users_app/.ruby-version

@@ -0,0 +1 @@
+ruby-3.1.0

data/spec/fixtures/rails7_users_app/Dockerfile

@@ -0,0 +1,30 @@
+ARG GEM_VERSION
+ARG RUBY_VERSION
+
+FROM appmap:${GEM_VERSION} as appmap
+FROM ruby:${RUBY_VERSION}
+
+SHELL ["/bin/bash", "-c"]
+
+RUN apt-get update && apt-get install -y vim less
+RUN apt-get install -y postgresql-client
+
+RUN mkdir /app
+WORKDIR /app
+
+RUN gem install -N bundler
+
+COPY Gemfile .
+
+RUN bundle
+
+COPY . .
+
+COPY --from=appmap /pkg/appmap.gem /tmp/
+RUN gem install /tmp/appmap.gem && \
+    bundle update --local appmap && \
+    bundle binstubs appmap --force
+
+EXPOSE 3000
+
+HEALTHCHECK --interval=1s --retries=10 CMD curl --fail http://localhost:3000/health || exit 1

data/spec/fixtures/rails7_users_app/Dockerfile.pg

@@ -0,0 +1,3 @@
+FROM postgres:10
+
+HEALTHCHECK --interval=1s --retries=10 CMD psql -U postgres -c "select 1" || exit 1

data/spec/fixtures/rails7_users_app/Gemfile

@@ -0,0 +1,99 @@
+source "https://rubygems.org"
+git_source(:github) { |repo| "https://github.com/#{repo}.git" }
+
+# Bundle edge Rails instead: gem "rails", github: "rails/rails", branch: "main"
+gem "rails", "~> 7.0.2", ">= 7.0.2.3"
+
+# The original asset pipeline for Rails [https://github.com/rails/sprockets-rails]
+gem "sprockets-rails"
+
+# Use postgresql as the database for Active Record
+gem "pg", "~> 1.1"
+
+# Use the Puma web server [https://github.com/puma/puma]
+gem "puma", "~> 5.0"
+
+# Use JavaScript with ESM import maps [https://github.com/rails/importmap-rails]
+gem "importmap-rails"
+
+# Hotwire's SPA-like page accelerator [https://turbo.hotwired.dev]
+gem "turbo-rails"
+
+# Hotwire's modest JavaScript framework [https://stimulus.hotwired.dev]
+gem "stimulus-rails"
+
+# Build JSON APIs with ease [https://github.com/rails/jbuilder]
+gem "jbuilder"
+
+# Use Redis adapter to run Action Cable in production
+# gem "redis", "~> 4.0"
+
+# Use Kredis to get higher-level data types in Redis [https://github.com/rails/kredis]
+# gem "kredis"
+
+# Use Active Model has_secure_password [https://guides.rubyonrails.org/active_model_basics.html#securepassword]
+# gem "bcrypt", "~> 3.1.7"
+
+# Windows does not include zoneinfo files, so bundle the tzinfo-data gem
+gem "tzinfo-data", platforms: %i[ mingw mswin x64_mingw jruby ]
+
+# Reduces boot times through caching; required in config/boot.rb
+gem "bootsnap", require: false
+
+# Use Sass to process CSS
+# gem "sassc-rails"
+
+# Use Active Storage variants [https://guides.rubyonrails.org/active_storage_overview.html#transforming-images]
+# gem "image_processing", "~> 1.2"
+
+group :development, :test do
+  # See https://guides.rubyonrails.org/debugging_rails_applications.html#debugging-with-the-debug-gem
+  gem "debug", platforms: %i[ mri mingw x64_mingw ]
+end
+
+group :development do
+  # Use console on exceptions pages [https://github.com/rails/web-console]
+  gem "web-console"
+
+  # Add speed badges [https://github.com/MiniProfiler/rack-mini-profiler]
+  # gem "rack-mini-profiler"
+
+  # Speed up commands on slow machines / big apps [https://github.com/rails/spring]
+  # gem "spring"
+end
+
+group :test do
+  # Use system testing [https://guides.rubyonrails.org/testing.html#system-testing]
+  gem "capybara"
+  gem "selenium-webdriver"
+  gem "webdrivers"
+end
+
+appmap_path = \
+  # Support debugging inside the container with volume-mounted source
+  if File.directory?('/src/appmap-ruby')
+    '/src/appmap-ruby'
+  elsif File.exist?('../../../appmap.gemspec')
+    '../../..'
+  end
+
+if appmap_path
+  # Set the branch parameter, so that 'bundle config local.appmap' will work
+  appmap_branch = Dir.chdir appmap_path do
+    `git rev-parse --abbrev-ref HEAD`.strip
+  end
+end
+
+appmap_options = \
+  if appmap_path && appmap_branch
+    { git: appmap_path, branch: appmap_branch }
+  elsif appmap_path
+    { path: appmap_path }
+  else
+    {}
+  end.merge(require: %w[appmap])
+
+group :development, :test do
+  gem 'appmap', appmap_options
+  gem 'pry-byebug', '>=0', '< 99'
+end

data/spec/fixtures/rails7_users_app/README.md

@@ -0,0 +1,24 @@
+# README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...

data/spec/fixtures/rails7_users_app/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require_relative "config/application"
+
+Rails.application.load_tasks

data/spec/fixtures/rails7_users_app/app/assets/config/manifest.js

@@ -0,0 +1,4 @@
+//= link_tree ../images
+//= link_directory ../stylesheets .css
+//= link_tree ../../javascript .js
+//= link_tree ../../../vendor/javascript .js

data/spec/fixtures/rails7_users_app/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS (and SCSS, if configured) file within this directory, lib/assets/stylesheets, or any plugin's
+ * vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/spec/fixtures/rails7_users_app/app/channels/application_cable/channel.rb

@@ -0,0 +1,4 @@
+module ApplicationCable
+  class Channel < ActionCable::Channel::Base
+  end
+end

data/spec/fixtures/rails7_users_app/app/channels/application_cable/connection.rb

@@ -0,0 +1,4 @@
+module ApplicationCable
+  class Connection < ActionCable::Connection::Base
+  end
+end

data/spec/fixtures/rails7_users_app/app/controllers/application_controller.rb

@@ -0,0 +1,2 @@
+class ApplicationController < ActionController::Base
+end

data/spec/fixtures/rails7_users_app/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/spec/fixtures/rails7_users_app/app/javascript/application.js

@@ -0,0 +1,3 @@
+// Configure your import map in config/importmap.rb. Read more: https://github.com/rails/importmap-rails
+import "@hotwired/turbo-rails"
+import "controllers"

data/spec/fixtures/rails7_users_app/app/javascript/controllers/application.js

@@ -0,0 +1,9 @@
+import { Application } from "@hotwired/stimulus"
+
+const application = Application.start()
+
+// Configure Stimulus development experience
+application.debug = false
+window.Stimulus   = application
+
+export { application }

data/spec/fixtures/rails7_users_app/app/javascript/controllers/hello_controller.js

@@ -0,0 +1,7 @@
+import { Controller } from "@hotwired/stimulus"
+
+export default class extends Controller {
+  connect() {
+    this.element.textContent = "Hello World!"
+  }
+}

data/spec/fixtures/rails7_users_app/app/javascript/controllers/index.js

@@ -0,0 +1,11 @@
+// Import and register all your controllers from the importmap under controllers/*
+
+import { application } from "controllers/application"
+
+// Eager load all controllers defined in the import map under controllers/**/*_controller
+import { eagerLoadControllersFrom } from "@hotwired/stimulus-loading"
+eagerLoadControllersFrom("controllers", application)
+
+// Lazy load controllers as they appear in the DOM (remember not to preload controllers in import map!)
+// import { lazyLoadControllersFrom } from "@hotwired/stimulus-loading"
+// lazyLoadControllersFrom("controllers", application)

data/spec/fixtures/rails7_users_app/app/jobs/application_job.rb

@@ -0,0 +1,7 @@
+class ApplicationJob < ActiveJob::Base
+  # Automatically retry jobs that encountered a deadlock
+  # retry_on ActiveRecord::Deadlocked
+
+  # Most jobs are safe to ignore if the underlying records are no longer available
+  # discard_on ActiveJob::DeserializationError
+end

data/spec/fixtures/rails7_users_app/app/mailers/application_mailer.rb

@@ -0,0 +1,4 @@
+class ApplicationMailer < ActionMailer::Base
+  default from: "from@example.com"
+  layout "mailer"
+end

data/spec/fixtures/rails7_users_app/app/models/application_record.rb

@@ -0,0 +1,3 @@
+class ApplicationRecord < ActiveRecord::Base
+  primary_abstract_class
+end

data/spec/fixtures/rails7_users_app/app/models/instance.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class Instance < ApplicationRecord
+  belongs_to :course
+  has_and_belongs_to_many :instructor
+end
+

data/spec/fixtures/rails7_users_app/app/models/instructor.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class Instructor < ApplicationRecord
+  belongs_to :user
+  has_and_belongs_to_many :instance
+end
+

data/spec/fixtures/rails7_users_app/app/views/layouts/application.html.erb

@@ -0,0 +1,16 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>App</title>
+    <meta name="viewport" content="width=device-width,initial-scale=1">
+    <%= csrf_meta_tags %>
+    <%= csp_meta_tag %>
+
+    <%= stylesheet_link_tag "application", "data-turbo-track": "reload" %>
+    <%= javascript_importmap_tags %>
+  </head>
+
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/spec/fixtures/rails7_users_app/app/views/layouts/mailer.html.erb

@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+    <style>
+      /* Email styles need to be inline */
+    </style>
+  </head>
+
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/spec/fixtures/rails7_users_app/app/views/layouts/mailer.text.erb

@@ -0,0 +1 @@
+<%= yield %>

data/spec/fixtures/rails7_users_app/appmap.yml

@@ -0,0 +1,3 @@
+name: rails7_users_app
+packages:
+- path: app