fix: No longer bundle @appland/appmap with this gem

User must install @appland/appmap to the enclosing project.
Then in will be invoked using 'npx'.
Bundling @appland/appmap is too fragile.

Author: kgilpin

.travis.yml

@@ -36,7 +36,6 @@ jobs:
     env:
       # GEM_ALTERNATIVE_NAME only needed for deployment 
       - GEM_ALTERNATIVE_NAME=''
-    script: bundle exec rake
 
 before_deploy:
   - |
@@ -51,4 +50,4 @@ deploy:
     script: ./release.sh
     on:
       branch: master
-      condition: "$TRAVIS_RUBY_VERSION = 2.7"
+      condition: "$TRAVIS_RUBY_VERSION = 3.0"

Rakefile

@@ -13,21 +13,6 @@ Rake::ExtensionTask.new("appmap") do |ext|
   ext.lib_dir = "lib/appmap"
 end
 
-namespace 'gem' do
-  require 'bundler/gem_tasks'
-  
-  module Bundler
-    class GemHelper
-      # A handy tip - find the location of any Rake task using `rake -W`.
-      # rake -W build
-      # ~/.rbenv/versions/2.6.6/lib/ruby/gems/2.6.0/gems/bundler-2.1.4/lib/bundler/gem_helper.rb:39:in `install'
-      def build_gem
-        raise "Don't use 'rake gem:build' - use 'yarn install --prod && gem build <gemspec>', because that's what ./release.sh does"
-      end
-    end
-  end
-end
-
 RUBY_VERSIONS=%w[2.6 2.7 3.0].select do |version|
   travis_ruby_version = ENV['TRAVIS_RUBY_VERSION']
   next true unless travis_ruby_version
@@ -72,6 +57,11 @@ def build_app_image(app, ruby_version)
   end
 end
 
+desc 'Install non-Ruby dependencies'
+task :install do
+  system 'yarn install' or raise 'yarn install failed'
+end
+
 namespace :build do
   namespace :base do
     RUBY_VERSIONS.each do |ruby_version|
@@ -80,7 +70,6 @@ namespace :build do
         run_system = ->(cmd) { system(cmd) or raise "Command failed: #{cmd}" }
 
         run_system.call 'mkdir -p pkg'
-        run_system.call 'yarn install --prod'
         run_system.call "gem build appmap.gemspec --output pkg/appmap-#{GEM_VERSION}.gem"
         build_base_image(ruby_version)
       end.tap do |t|
@@ -139,7 +128,7 @@ end
 namespace :spec do
   RUBY_VERSIONS.each do |ruby_version|
     desc ruby_version
-    task ruby_version, [:specs] => ["compile", "build:fixtures:#{ruby_version}:all"] do |_, task_args|
+    task ruby_version, [:specs] => ["install", "compile", "build:fixtures:#{ruby_version}:all"] do |_, task_args|
       run_specs(ruby_version, task_args)
     end.tap do |t|
       desc "Run all specs"

appmap.gemspec

@@ -23,12 +23,6 @@ Gem::Specification.new do |spec|
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
 
-  strip_dir = ->(file) { file.index(Dir.pwd) == 0 ? file[Dir.pwd.length+1...file.length] : file }
-  Dir.glob(File.join(__dir__, 'node_modules/**/*')).map(&strip_dir).each do |filename|
-    next if File.directory?(filename) || filename.length > 100
-    spec.files << filename
-  end
-
   spec.extensions << "ext/appmap/extconf.rb"
   spec.require_paths = ['lib']
 

lib/appmap/command/index.rb

@@ -16,7 +16,7 @@ def index(arguments)
 
         arguments.unshift 'index'
         arguments.unshift APPMAP_JS
-        arguments.unshift 'node'
+        arguments.unshift 'npx'
 
         exec(*arguments)
       end

lib/appmap/command/inspect.rb

@@ -16,7 +16,7 @@ def inspect(arguments)
 
         arguments.unshift 'inspect'
         arguments.unshift APPMAP_JS
-        arguments.unshift 'node'
+        arguments.unshift 'npx'
 
         exec(*arguments)
       end

lib/appmap/node_cli.rb

@@ -6,7 +6,7 @@
 module AppMap
   # Utilities for invoking the +@appland/appmap+ CLI.
   class NodeCLI
-    APPMAP_JS = Pathname.new(__dir__).join('../../node_modules/@appland/appmap/src/cli.js').expand_path.to_s
+    APPMAP_JS = '@appland/appmap'
 
     attr_reader :verbose
     # Directory to scan for AppMaps.
@@ -32,7 +32,7 @@ def index_appmaps
     def command(command, options = {})
       command.unshift << '--verbose' if verbose
       command.unshift APPMAP_JS
-      command.unshift 'node'
+      command.unshift 'npx'
 
       warn command.join(' ') if verbose
       stdout, stderr, status = Open3.capture3({ 'NODE_OPTIONS' => '--trace-warnings' }, *command.map(&:shellescape), options)

package.json

@@ -17,6 +17,6 @@
   },
   "homepage": "https://github.com/applandinc/appmap-ruby#readme",
   "dependencies": {
-    "@appland/appmap": "^3.0.0"
+    "@appland/appmap": "^3.18.3"
   }
 }

release.sh

@@ -13,5 +13,4 @@ else
 fi
 
 set -ex
-yarn install --prod
 exec semantic-release $RELEASE_FLAGS

spec/fixtures/rails6_users_app/Dockerfile

@@ -13,13 +13,20 @@ RUN curl -fsSL https://fnm.vercel.app/install | bash \
     && source /root/.bashrc \
     && fnm install --lts \
     && echo 'fnm default $(fnm current)' >> ~/.bashrc \
-    && ln -s $(which node) /usr/local/bin/node
+    && ln -s $(which node) /usr/local/bin/ \
+    && ln -s $(which npx) /usr/local/bin/ \
+    && npm install -g yarn \
+    && ln -s $(which yarn) /usr/local/bin/
 
 RUN mkdir /app
 WORKDIR /app
 
 RUN gem install -N bundler
 
+COPY package.json .
+
+RUN yarn install
+
 COPY Gemfile .
 
 RUN bundle

spec/fixtures/rails6_users_app/package.json

@@ -0,0 +1,8 @@
+{
+  "name": "rails6_users_app",
+  "version": "1.0.0",
+  "license": "MIT",
+  "devDependencies": {
+    "@appland/appmap": "^3.18.3"
+  }
+}