vite_rails 1.0.5 → 1.0.10

data/test/commands_test.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+
+class CommandsTest < ViteRails::Test
+  def stub_builder(stale:, build_with_vite:)
+    ViteRails.builder.stub :stale?, stale do
+      ViteRails.builder.stub :build_with_vite, build_with_vite do
+        yield
+      end
+    end
+  end
+
+  def test_bootstrap
+    assert ViteRails.bootstrap
+  end
+
+  def test_build_returns_success_status_when_stale
+    stub_builder(stale: true, build_with_vite: true) {
+      assert_equal true, ViteRails.build
+      assert_equal true, ViteRails.build_from_rake
+    }
+  end
+
+  def test_build_returns_success_status_when_fresh
+    stub_builder(stale: false, build_with_vite: true) {
+      assert_equal true, ViteRails.build
+      assert_equal true, ViteRails.build_from_rake
+    }
+  end
+
+  def test_build_returns_failure_status_when_stale
+    stub_builder(stale: true, build_with_vite: false) {
+      assert_equal false, ViteRails.build
+    }
+  end
+
+  def test_clean
+    with_rails_env('test') { |config|
+      manifest = config.build_output_dir.join('manifest.json')
+
+      # Should not clean, the manifest does not exist.
+      config.build_output_dir.mkdir unless config.build_output_dir.exist?
+      refute ViteRails.clean
+
+      # Should not clean, the file is recent.
+      manifest.write('{}')
+      assert ViteRails.clean_from_rake(OpenStruct.new)
+      assert manifest.exist?
+
+      # Should clean if we remove age restrictions.
+      assert ViteRails.clean(keep_up_to: 0, age_in_seconds: 0)
+      assert config.build_output_dir.exist?
+      refute manifest.exist?
+    }
+  end
+
+  def test_clobber
+    with_rails_env('test') { |config|
+      config.build_output_dir.mkdir unless config.build_output_dir.exist?
+      config.build_output_dir.join('manifest.json').write('{}')
+      assert config.build_output_dir.exist?
+      ViteRails.clobber
+      refute config.build_output_dir.exist?
+    }
+  end
+end

data/test/config_test.rb

@@ -0,0 +1,133 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+
+class ConfigTest < ViteRails::Test
+  def expand_path(path)
+    File.expand_path(Pathname.new(__dir__).join(path).to_s)
+  end
+
+  def assert_path(expected, actual)
+    assert_equal expand_path(expected), actual.to_s
+  end
+
+  def assert_pathname(expected, actual)
+    assert_equal Pathname.new(expand_path("test_app/#{ expected }")), actual
+  end
+
+  def resolve_config(mode: 'production', root: test_app_path, **attrs)
+    ViteRails::Config.resolve_config(mode: mode, root: root, **attrs)
+  end
+
+  def setup
+    @config = resolve_config
+  end
+
+  def test_source_code_dir
+    assert_equal 'app/frontend', @config.source_code_dir
+  end
+
+  def test_entrypoints_dir
+    assert_path 'test_app/app/frontend/entrypoints', @config.resolved_entrypoints_dir
+  end
+
+  def test_public_dir
+    assert_equal 'public', @config.public_dir
+  end
+
+  def test_build_output_dir
+    assert_path 'test_app/public/vite-production', @config.build_output_dir
+
+    @config = resolve_config(config_path: 'config/vite_public_dir.json')
+    assert_path 'public/vite', @config.build_output_dir
+  end
+
+  def test_manifest_path
+    assert_path 'test_app/public/vite-production/manifest.json', @config.manifest_path
+  end
+
+  def test_build_cache_dir
+    assert_path 'test_app/tmp/cache/vite', @config.build_cache_dir
+  end
+
+  def test_watch_additional_paths
+    assert_equal [], @config.watch_additional_paths
+    @config = resolve_config(config_path: 'config/vite_additional_paths.json')
+    assert_equal ['config/*'], @config.watch_additional_paths
+  end
+
+  def test_auto_build
+    refute @config.auto_build
+
+    with_rails_env('development') do |config|
+      assert config.auto_build
+    end
+
+    with_rails_env('test') do |config|
+      assert config.auto_build
+    end
+
+    with_rails_env('staging') do |config|
+      refute config.auto_build
+    end
+  end
+
+  def test_protocol
+    assert_equal 'http', @config.protocol
+  end
+
+  def test_host_with_port
+    assert_equal 3036, @config.port
+
+    with_rails_env('development') do |config|
+      assert_equal 3535, config.port
+      assert_equal 'localhost:3535', config.host_with_port
+    end
+  end
+
+  def test_to_env
+    env = @config.to_env
+    assert_nil env['VITE_RUBY_ASSET_HOST']
+
+    Rails.application.config.action_controller.asset_host = 'assets-cdn.com'
+    env = refresh_config.to_env
+    assert_equal env['VITE_RUBY_ASSET_HOST'], 'assets-cdn.com'
+  ensure
+    Rails.application.config.action_controller.asset_host = nil
+  end
+
+  def test_environment_vars
+    ViteRails.env = {
+      'VITE_RUBY_AUTO_BUILD' => 'true',
+      'VITE_RUBY_HOST' => 'example.com',
+      'VITE_RUBY_PORT' => '1920',
+      'VITE_RUBY_HTTPS' => 'true',
+      'VITE_RUBY_CONFIG_PATH' => 'config/vite_additional_paths.json',
+      'VITE_RUBY_BUILD_CACHE_DIR' => 'tmp/vitebuild',
+      'VITE_RUBY_PUBLIC_DIR' => 'pb',
+      'VITE_RUBY_PUBLIC_OUTPUT_DIR' => 'ft',
+      'VITE_RUBY_ASSETS_DIR' => 'as',
+      'VITE_RUBY_SOURCE_CODE_DIR' => 'app',
+      'VITE_RUBY_ENTRYPOINTS_DIR' => 'frontend/entrypoints',
+      'VITE_RUBY_HIDE_BUILD_CONSOLE_OUTPUT' => 'true',
+    }
+    @config = resolve_config
+    assert_equal true, @config.auto_build
+    assert_equal 'example.com', @config.host
+    assert_equal 1920, @config.port
+    assert_equal true, @config.https
+    assert_equal 'https', @config.protocol
+    assert_equal 'config/vite_additional_paths.json', @config.config_path
+    assert_pathname 'tmp/vitebuild', @config.build_cache_dir
+    assert_equal 'pb', @config.public_dir
+    assert_equal Pathname.new('ft'), @config.public_output_dir
+    assert_pathname 'pb/ft', @config.build_output_dir
+    assert_equal 'as', @config.assets_dir
+    assert_equal 'app', @config.source_code_dir
+    assert_equal 'frontend/entrypoints', @config.entrypoints_dir
+    assert_pathname 'app/frontend/entrypoints', @config.resolved_entrypoints_dir
+    assert_equal true, @config.hide_build_console_output
+  ensure
+    ViteRails.env = {}
+  end
+end

data/test/dev_server_proxy_test.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+
+class DevServerProxyTest < ViteRails::Test
+  include Rack::Test::Methods
+
+  def app
+    # Capture all changes to the env made by the proxy.
+    capture_app = Rack::Builder.new.run(->(env) {
+      [200, { 'Content-Type' => 'application/json' }, env.to_json]
+    })
+    # Avoid actually using the proxy.
+    Rack::Proxy.define_method(:perform_request) { |env| capture_app.call(env) }
+
+    ViteRails::DevServerProxy.new(capture_app)
+  end
+
+  def test_non_asset
+    get_with_dev_server_running '/'
+    assert_not_forwarded
+  end
+
+  def test_non_vite_asset
+    get_with_dev_server_running '/example_import.js'
+    assert_not_forwarded
+  end
+
+  def test_vite_asset
+    get_with_dev_server_running '/vite-production/application.js'
+    assert_forwarded to: '/application.js'
+  end
+
+  def test_vite_client
+    get_with_dev_server_running '/@vite/client'
+    assert_forwarded to: '/@vite/client'
+  end
+
+  def test_vite_import
+    get_with_dev_server_running '/@fs//package/example/app/frontend/App.vue?import&t=1611322300214&vue&type=style&index=0&lang.css'
+    assert_forwarded to: '/@fs//package/example/app/frontend/App.vue?import&t=1611322300214&vue&type=style&index=0&lang.css'
+  end
+
+  def test_hmr_for_stylesheet
+    get_with_dev_server_running '/colored.css?t=1611322562923'
+    assert_forwarded to: '/colored.css?t=1611322562923'
+  end
+
+  def test_hmr_for_imported_entrypoint
+    get_with_dev_server_running '/colored.css?import&t=1611322562923'
+    assert_forwarded to: '/colored.css?import&t=1611322562923'
+  end
+
+  def test_entrypoint_imported_from_entrypoint
+    header 'Referer', 'http://localhost:3000/vite-production/application.js'
+    get_with_dev_server_running '/example_import.js'
+    assert_forwarded to: '/example_import.js'
+  end
+
+  def test_without_dev_server_running
+    get '/vite-production/application.js'
+    assert_not_forwarded
+
+    get '/colored.css?import&t=1611322562923'
+    assert_not_forwarded
+
+    header 'Referer', 'http://localhost:3000/vite-production/application.js'
+    get '/example_import.js'
+    assert_not_forwarded
+  end
+
+private
+
+  def get_with_dev_server_running(*args)
+    with_dev_server_running {
+      get(*args)
+    }
+  end
+
+  def assert_not_forwarded
+    assert last_response.ok?
+    env = JSON.parse(last_response.body)
+    assert_nil env['HTTP_X_FORWARDED_HOST']
+    assert_nil env['HTTP_X_FORWARDED_PORT']
+  end
+
+  def assert_forwarded(to: nil)
+    assert last_response.ok?
+    env = JSON.parse(last_response.body)
+
+    assert_equal ViteRails.config.host, env['HTTP_X_FORWARDED_HOST']
+    assert_equal ViteRails.config.port, Integer(env['HTTP_X_FORWARDED_PORT'])
+
+    return unless to
+
+    path, query = to.split('?')
+    assert_equal path, env['PATH_INFO']
+    assert_equal query, env['QUERY_STRING']
+    assert_equal to, env['REQUEST_URI']
+  end
+end

data/test/dev_server_test.rb

@@ -6,34 +6,4 @@ class DevServerTest < ViteRails::Test
   def test_running?
     refute ViteRails.dev_server.running?
   end
-
-  def test_host
-    with_rails_env('development') do
-      assert_equal ViteRails.config.host, 'localhost'
-    end
-  end
-
-  def test_port
-    with_rails_env('development') do
-      assert_equal ViteRails.config.port, 3035
-    end
-  end
-
-  def test_https?
-    with_rails_env('development') do
-      assert_equal ViteRails.config.https, false
-    end
-  end
-
-  def test_protocol
-    with_rails_env('development') do
-      assert_equal ViteRails.config.protocol, 'http'
-    end
-  end
-
-  def test_host_with_port
-    with_rails_env('development') do
-      assert_equal ViteRails.config.host_with_port, 'localhost:3035'
-    end
-  end
 end

data/test/engine_rake_tasks_test.rb

@@ -4,39 +4,77 @@ require 'test_helper'
 
 class EngineRakeTasksTest < Minitest::Test
   def setup
-    remove_vite_binstubs
+    remove_vite_files
   end
 
   def teardown
-    remove_vite_binstubs
+    remove_vite_files
   end
 
-  def test_task_mounted
-    output = Dir.chdir(mounted_app_path) { `rake -T` }
+  def test_tasks_mounted
+    output = within_mounted_app { `bundle exec rake -T` }
     assert_includes output, 'app:vite'
   end
 
-  def test_binstubs
-    Dir.chdir(mounted_app_path) { `bundle exec rake app:vite:binstubs` }
-    vite_binstub_paths.each { |path| assert File.exist?(path) }
+  def test_rake_tasks
+    within_mounted_app { `bundle exec rake app:vite:binstubs` }
+    assert vite_binstub_path.exist?
+
+    within_mounted_app { `bundle exec rake app:vite:install` }
+    assert vite_config_ts_path.exist?
+    assert app_frontend_dir.exist?
+
+    within_mounted_app { `bundle exec rake app:vite:build` }
+    assert app_public_dir.exist?
+    assert app_public_dir.join('manifest.json').exist?
+    assert app_public_dir.join('assets').exist?
+
+    within_mounted_app { `bundle exec rake app:vite:clean` }
+    assert app_public_dir.join('manifest.json').exist? # Still fresh
+
+    within_mounted_app { `bundle exec rake app:vite:clean[0,0]` }
+    refute app_public_dir.join('manifest.json').exist?
+
+    within_mounted_app { `bundle exec rake app:vite:clobber` }
+    refute app_public_dir.exist?
+  rescue Minitest::Assertion => error
+    raise error unless Rails.gem_version >= Gem::Version.new('6.1.0')
   end
 
 private
 
+  def within_mounted_app
+    Dir.chdir(mounted_app_path) { yield }
+  end
+
   def mounted_app_path
-    File.expand_path('mounted_app', __dir__)
+    Pathname.new(File.expand_path(__dir__)).join('mounted_app')
+  end
+
+  def root_dir
+    mounted_app_path.join('test/dummy')
+  end
+
+  def vite_binstub_path
+    root_dir.join('bin/vite')
+  end
+
+  def vite_config_ts_path
+    root_dir.join('vite.config.ts')
+  end
+
+  def app_frontend_dir
+    root_dir.join('app/frontend')
   end
 
-  def vite_binstub_paths
-    [
-      "#{ mounted_app_path }/test/dummy/bin/vite",
-      "#{ mounted_app_path }/test/dummy/bin/vite-dev-server",
-    ]
+  def app_public_dir
+    root_dir.join('public/vite-dev')
   end
 
-  def remove_vite_binstubs
-    vite_binstub_paths.each do |path|
-      File.delete(path) if File.exist?(path)
-    end
+  def remove_vite_files
+    vite_binstub_path.delete if vite_binstub_path.exist?
+    vite_config_ts_path.delete if vite_config_ts_path.exist?
+    app_frontend_dir.rmtree if app_frontend_dir.exist?
+    app_public_dir.rmtree if app_public_dir.exist?
   end
 end

data/test/helper_test.rb

@@ -3,6 +3,8 @@
 require 'test_helper'
 
 class HelperTest < ActionView::TestCase
+  include ViteRailsTestHelpers
+
   tests ViteRails::Helper
 
   attr_reader :request
@@ -17,122 +19,52 @@ class HelperTest < ActionView::TestCase
     end.new
   end
 
-  def test_asset_pack_path
-    assert_equal '/packs/bootstrap-300631c4f0e0f9c865bc.js', asset_pack_path('bootstrap.js')
-    assert_equal '/packs/bootstrap-c38deda30895059837cf.css', asset_pack_path('bootstrap.css')
-  end
-
-  def test_asset_pack_url
-    assert_equal 'https://example.com/packs/bootstrap-300631c4f0e0f9c865bc.js', asset_pack_url('bootstrap.js')
-    assert_equal 'https://example.com/packs/bootstrap-c38deda30895059837cf.css', asset_pack_url('bootstrap.css')
+  def test_vite_client_tag
+    assert_nil vite_client_tag
+    with_dev_server_running {
+      assert_equal '<script src="/@vite/client" type="module"></script>', vite_client_tag
+    }
   end
 
-  def test_image_pack_path
-    assert_equal '/packs/application-k344a6d59eef8632c9d1.png', image_pack_path('application.png')
-    assert_equal '/packs/media/images/image-c38deda30895059837cf.jpg', image_pack_path('image.jpg')
-    assert_equal '/packs/media/images/image-c38deda30895059837cf.jpg', image_pack_path('media/images/image.jpg')
-    assert_equal '/packs/media/images/nested/image-c38deda30895059837cf.jpg', image_pack_path('nested/image.jpg')
-    assert_equal '/packs/media/images/nested/image-c38deda30895059837cf.jpg', image_pack_path('media/images/nested/image.jpg')
+  def test_vite_asset_path
+    assert_equal '/vite-production/assets/colored.1173bfe0.js', vite_asset_path('colored.js')
+    assert_equal '/vite-production/assets/colored.84277fd6.css', vite_asset_path('colored.css')
+    with_dev_server_running {
+      assert_equal '/vite-production/colored.js', vite_asset_path('colored.js')
+      assert_equal '/vite-production/colored.css', vite_asset_path('colored.css')
+    }
   end
 
-  def test_image_pack_url
-    assert_equal 'https://example.com/packs/application-k344a6d59eef8632c9d1.png', image_pack_url('application.png')
-    assert_equal 'https://example.com/packs/media/images/image-c38deda30895059837cf.jpg', image_pack_url('image.jpg')
-    assert_equal 'https://example.com/packs/media/images/image-c38deda30895059837cf.jpg', image_pack_url('media/images/image.jpg')
-    assert_equal 'https://example.com/packs/media/images/nested/image-c38deda30895059837cf.jpg', image_pack_url('nested/image.jpg')
-    assert_equal 'https://example.com/packs/media/images/nested/image-c38deda30895059837cf.jpg', image_pack_url('media/images/nested/image.jpg')
-  end
+  def test_vite_stylesheet_tag
+    assert_equal %(<link rel="stylesheet" media="screen" href="/vite-production/assets/colored.84277fd6.css" />),
+      vite_stylesheet_tag('colored')
 
-  def test_image_pack_tag
-    assert_equal \
-      '<img alt="Edit Entry" src="/packs/application-k344a6d59eef8632c9d1.png" width="16" height="10" />',
-      image_pack_tag('application.png', size: '16x10', alt: 'Edit Entry')
-    assert_equal \
-      '<img alt="Edit Entry" src="/packs/media/images/image-c38deda30895059837cf.jpg" width="16" height="10" />',
-      image_pack_tag('image.jpg', size: '16x10', alt: 'Edit Entry')
-    assert_equal \
-      '<img alt="Edit Entry" src="/packs/media/images/image-c38deda30895059837cf.jpg" width="16" height="10" />',
-      image_pack_tag('media/images/image.jpg', size: '16x10', alt: 'Edit Entry')
-    assert_equal \
-      '<img alt="Edit Entry" src="/packs/media/images/nested/image-c38deda30895059837cf.jpg" width="16" height="10" />',
-      image_pack_tag('nested/image.jpg', size: '16x10', alt: 'Edit Entry')
-    assert_equal \
-      '<img alt="Edit Entry" src="/packs/media/images/nested/image-c38deda30895059837cf.jpg" width="16" height="10" />',
-      image_pack_tag('media/images/nested/image.jpg', size: '16x10', alt: 'Edit Entry')
-    assert_equal \
-      '<img srcset="/packs/media/images/image-2x-7cca48e6cae66ec07b8e.jpg 2x" src="/packs/media/images/image-c38deda30895059837cf.jpg" />',
-      image_pack_tag('media/images/image.jpg', srcset: { 'media/images/image-2x.jpg' => '2x' })
-  end
+    assert_equal vite_stylesheet_tag('colored'), vite_stylesheet_tag('colored.css')
 
-  def test_favicon_pack_tag
-    assert_equal \
-      '<link rel="apple-touch-icon" type="image/png" href="/packs/application-k344a6d59eef8632c9d1.png" />',
-      favicon_pack_tag('application.png', rel: 'apple-touch-icon', type: 'image/png')
-    assert_equal \
-      '<link rel="apple-touch-icon" type="image/png" href="/packs/media/images/mb-icon-c38deda30895059837cf.png" />',
-      favicon_pack_tag('mb-icon.png', rel: 'apple-touch-icon', type: 'image/png')
-    assert_equal \
-      '<link rel="apple-touch-icon" type="image/png" href="/packs/media/images/mb-icon-c38deda30895059837cf.png" />',
-      favicon_pack_tag('media/images/mb-icon.png', rel: 'apple-touch-icon', type: 'image/png')
-    assert_equal \
-      '<link rel="apple-touch-icon" type="image/png" href="/packs/media/images/nested/mb-icon-c38deda30895059837cf.png" />',
-      favicon_pack_tag('nested/mb-icon.png', rel: 'apple-touch-icon', type: 'image/png')
-    assert_equal \
-      '<link rel="apple-touch-icon" type="image/png" href="/packs/media/images/nested/mb-icon-c38deda30895059837cf.png" />',
-      favicon_pack_tag('media/images/nested/mb-icon.png', rel: 'apple-touch-icon', type: 'image/png')
-  end
+    with_dev_server_running {
+      assert_equal %(<link rel="stylesheet" media="screen" href="/vite-production/colored.css" />),
+        vite_stylesheet_tag('colored')
 
-  def test_javascript_pack_tag
-    assert_equal \
-      %(<script src="/packs/bootstrap-300631c4f0e0f9c865bc.js"></script>),
-      javascript_pack_tag('bootstrap.js')
+      assert_equal vite_stylesheet_tag('colored'), vite_stylesheet_tag('colored.css')
+    }
   end
 
-  def test_javascript_pack_tag_symbol
-    assert_equal \
-      %(<script src="/packs/bootstrap-300631c4f0e0f9c865bc.js"></script>),
-      javascript_pack_tag(:bootstrap)
-  end
+  def test_vite_javascript_tag
+    assert_equal [
+      %(<script src="/vite-production/assets/application.a0ba047e.js" crossorigin="anonymous" type="module"></script>),
+      %(<link rel="preload" href="/vite-production/assets/example_import.8e1fddc0.js" as="script" type="text/javascript" crossorigin="anonymous">),
+      %(<link rel="stylesheet" media="screen" href="/vite-production/assets/application.cccfef34.css" />),
+    ].join, vite_javascript_tag('application')
 
-  def test_javascript_pack_tag_splat
-    assert_equal \
-      %(<script src="/packs/bootstrap-300631c4f0e0f9c865bc.js" defer="defer"></script>\n) +
-      %(<script src="/packs/application-k344a6d59eef8632c9d1.js" defer="defer"></script>),
-      javascript_pack_tag('bootstrap.js', 'application.js', defer: true)
-  end
+    assert_equal vite_javascript_tag('application'), vite_javascript_tag('application.js')
+    assert_equal vite_javascript_tag('application'), vite_typescript_tag('application')
 
-  def test_javascript_pack_tag_split_chunks
-    assert_equal \
-      %(<script src="/packs/vendors~application~bootstrap-c20632e7baf2c81200d3.chunk.js"></script>\n) +
-      %(<script src="/packs/vendors~application-e55f2aae30c07fb6d82a.chunk.js"></script>\n) +
-      %(<script src="/packs/application-k344a6d59eef8632c9d1.js"></script>),
-      javascript_packs_with_chunks_tag('application')
-  end
-
-  def test_stylesheet_pack_tag_split_chunks
-    assert_equal \
-      %(<link rel="stylesheet" media="screen" href="/packs/1-c20632e7baf2c81200d3.chunk.css" />\n) +
-      %(<link rel="stylesheet" media="screen" href="/packs/application-k344a6d59eef8632c9d1.chunk.css" />\n) +
-      %(<link rel="stylesheet" media="screen" href="/packs/hello_stimulus-k344a6d59eef8632c9d1.chunk.css" />),
-      stylesheet_packs_with_chunks_tag('application', 'hello_stimulus')
-  end
-
-  def test_stylesheet_pack_tag
-    assert_equal \
-      %(<link rel="stylesheet" media="screen" href="/packs/bootstrap-c38deda30895059837cf.css" />),
-      stylesheet_pack_tag('bootstrap.css')
-  end
-
-  def test_stylesheet_pack_tag_symbol
-    assert_equal \
-      %(<link rel="stylesheet" media="screen" href="/packs/bootstrap-c38deda30895059837cf.css" />),
-      stylesheet_pack_tag(:bootstrap)
-  end
+    with_dev_server_running {
+      assert_equal %(<script src="/vite-production/application.js" crossorigin="anonymous" type="module"></script>),
+        vite_javascript_tag('application')
 
-  def test_stylesheet_pack_tag_splat
-    assert_equal \
-      %(<link rel="stylesheet" media="all" href="/packs/bootstrap-c38deda30895059837cf.css" />\n) +
-      %(<link rel="stylesheet" media="all" href="/packs/application-dd6b1cd38bfa093df600.css" />),
-      stylesheet_pack_tag('bootstrap.css', 'application.css', media: 'all')
+      assert_equal %(<script src="/vite-production/application.ts" crossorigin="anonymous" type="module"></script>),
+        vite_typescript_tag('application')
+    }
   end
 end