rails_vite 0.3.0.rc1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8e7210773488e0deadb365f2fb2ab6782d1b347d77ca2f63007eada5cbe6c59f
-  data.tar.gz: 687c142b64c7eb24431696f56c105be88b06c68686689d40005f773f8d70aebf
+  metadata.gz: fc4469f0512e076ff2acb18a110d7b346082837a0b46ef4d7369907df851883d
+  data.tar.gz: f6e624fcb760ca2b5d61c2a7954d98c491f3150a44a735cc1d62de21b2692763
 SHA512:
-  metadata.gz: d4a84d843acb2feb2c9f80d26386b5071ca8c4a8093332d8e71880cddbbf608351709f30fb7cef147b25f7114818eb2b09b8d35ea0808affdf19b67594574446
-  data.tar.gz: e483f34f03fed33786db337c84b5cb290e7ce2ad65e3c73b7294f5e75b77aabffe934dac00b2cb55d79517b65181b699b43f7c4ef9feedadf2ea1190ec1781a6
+  metadata.gz: c46090d913dd40e3fd9e9c78b3010917463ce9a3fc297c810d7f2f5fd7418298299d1a8e7c165bb96e44a4685b611323ce173f1ab26cda04d98d8f3584298691
+  data.tar.gz: 2f092d13f0a7d3ff5d25ada3faf133d77fc4e660e376ff5c6301168fd68980b0b84b4cfdee1fbdaf6f8d18db49b8cdc536ca1a080b03a493309bad270402acdf

data/CHANGELOG.md

@@ -5,7 +5,24 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog],
 and this project adheres to [Semantic Versioning].
 
-## rails_vite@0.3.0.rc1 / rails-vite-plugin@0.3.0-rc.1 - 2026-10-11
+## rails_vite@0.4.0 / rails-vite-plugin@0.4.0 - 2026-11-12
+
+### Added
+
+- `rake vite:auto_build` builds stale assets the way auto build does, so a parallel test runner can build once before it starts its workers. `RailsVite::AutoBuild.build_if_stale` does the same from Ruby. Both do nothing when assets are fresh, and fail with `RailsVite::BuildError` when the build fails (#59) ([@brodienguyen])
+
+### Changed
+
+- `RailsVite.digest` is computed once outside development and test, instead of hashing the manifest file on every call (#57) ([@thomasklemm])
+- A failed auto build raises `RailsVite::BuildError` instead of logging and serving the previous assets, and a process does not run it again until a source changes or `rake vite:build` writes a fresh manifest (#59) ([@brodienguyen])
+
+### Fixed
+
+- `bin/rails test` keeps the test environment's `eager_load` setting. The `test:prepare` build loaded the app through Rake's `environment` task, which turned eager loading off for the whole run (#62) ([@skryukov])
+- Auto build no longer walks the whole Rails root when Vite's `root` is the source directory (`prependSourceDirToEntries: false`). `log/` and `tmp/` made assets look stale on every request. The plugin now also writes the source directory to its metadata as `sourcePath`, and auto build watches it. Upgrade `rails-vite-plugin` together with the gem: metadata from older plugin versions has no `sourcePath`, so auto build falls back to `sourceDir` (#61) ([@mdesantis])
+- Auto builds hold a file lock in `tmp/`, so parallel test workers and a server beside a test run no longer build into the same directory at once. The first process to find stale assets builds them, and the others wait and reuse that build (#59) ([@brodienguyen])
+
+## rails_vite@0.3.0 / rails-vite-plugin@0.3.0 - 2026-10-11
 
 ### Added
 
@@ -23,7 +40,7 @@ and this project adheres to [Semantic Versioning].
 - Vite asset URLs are built with Rails' `path_to_asset`, so `asset_host` works as it does for other Rails assets: procs that take the request, `%d` hosts and per-controller hosts. Mailers now use `config.action_mailer.asset_host` (or `config.asset_host`) instead of the controller's. With `relative_url_root`, tags now include the prefix; set Vite's `base` to match (#36) ([@skryukov])
 - `rake vite:build` loads the Rails environment first, so `config.rails_vite` settings from initializers (such as `vite_executable`) also apply to it and to `bin/rails test` (#42) ([@cole-robertson])
 - The install generator writes `vite dev` instead of `vite` to `Procfile.dev` (#42) ([@cole-robertson])
-- **Breaking:** `vite:build` (and therefore `assets:precompile`) runs the package.json `build` script when one exists, so `"build": "vite build && vite build --ssr"` produces both client and SSR bundles on deploy. Apps without a `build` script keep the bare `vite build`. If package.json already has a `build` script (e.g. one left over from jsbundling-rails), make sure it builds with Vite before upgrading. Test builds and auto-builds always use the bare command, since their extra flags (`--mode test`, `--logLevel warn`) would only reach the last command of a compound script (#38) ([@skryukov])
+- **Breaking:** `vite:build` (and therefore `assets:precompile`) runs the package.json `build` script when one exists, so `"build": "vite build && vite build --ssr"` produces both client and SSR bundles on deploy. Apps without a `build` script keep the bare `vite build`. If package.json already has a `build` script (e.g. one left over from jsbundling-rails), change it to `"build": "vite build"` or remove it before upgrading; otherwise precompile succeeds without Vite assets and production raises `RailsVite::MissingManifestError`. The install generator warns about such a script. Test builds and auto-builds always use the bare command, since their extra flags (`--mode test`, `--logLevel warn`) would only reach the last command of a compound script (#38) ([@skryukov])
 
 ### Fixed
 
@@ -128,6 +145,8 @@ and this project adheres to [Semantic Versioning].
 [@cole-robertson]: https://github.com/cole-robertson
 [@madogiwa0124]: https://github.com/madogiwa0124
 [@janko]: https://github.com/janko
+[@thomasklemm]: https://github.com/thomasklemm
+[@mdesantis]: https://github.com/mdesantis
 
 [Keep a Changelog]: https://keepachangelog.com/en/1.0.0/
 [Semantic Versioning]: https://semver.org/spec/v2.0.0.html

data/README.md

@@ -48,7 +48,7 @@ bundle install
 bin/rails generate rails_vite:install
 ```
 
-This creates `vite.config.ts`, installs dependencies, and updates your layout.
+This creates `vite.config.ts`, installs dependencies, and replaces `javascript_include_tag "application"` and `stylesheet_link_tag "application"` in your layout with `vite_tags`. Other layouts, such as the Rails 8 default, need it by hand: replace `javascript_importmap_tags` with `<%= vite_tags "application" %>`.
 
 Start development:
 
@@ -374,7 +374,15 @@ Rails.application.config.rails_vite.auto_build = false
 
 By default, auto build is enabled in development and test (`Rails.env.local?`).
 
-Note: for parallel test runners, disable auto build and use `rake vite:build` before the suite instead.
+Auto builds hold a file lock in `tmp/`, so parallel test workers and a server beside a test run never build at once: the first process to find stale assets builds them, and the others wait and reuse that build. A failed build raises `RailsVite::BuildError`, and a process does not retry it until a source changes.
+
+A parallel test runner can build once before it starts its workers, so no worker spends its first test waiting for the build. `rake vite:auto_build` runs the same check, lock and build as the middleware: it builds only when sources changed, does nothing while the dev server runs or with auto build off, and fails with `RailsVite::BuildError` when the build fails. Run it in the environment the workers use:
+
+```bash
+RAILS_ENV=test bin/rails vite:auto_build && bundle exec parallel_rspec
+```
+
+From Ruby, for example in a script that starts the workers itself, call `RailsVite::AutoBuild.build_if_stale`.
 
 ## CDN
 
@@ -431,6 +439,7 @@ Defaults match the plugin defaults — no config needed if you follow convention
 | Task | Description |
 |------|-------------|
 | `rake vite:build` | Build assets for production |
+| `rake vite:auto_build` | Build assets only if sources changed, as [auto build](#auto-build) does |
 | `rake vite:install` | Install JavaScript dependencies |
 | `rake vite:clobber` | Remove `public/vite/` |
 
@@ -533,7 +542,7 @@ In development, jsbundling mode writes `tmp/rails-vite.json` — the same file t
 ```json
 // package.json — replace vite-plugin-ruby with rails-vite-plugin
 - "vite-plugin-ruby": "^5.1.1"
-+ "rails-vite-plugin": "^0.2.0"
++ "rails-vite-plugin": "^0.4.0"
 ```
 
 ### 2. Replace `vite.config.ts`

data/lib/generators/rails_vite/install/install_generator.rb

@@ -28,6 +28,15 @@ module RailsVite
         end
       end
 
+      def warn_about_build_script
+        return unless File.exist?("package.json")
+
+        script = JSON.parse(File.read("package.json")).dig("scripts", "build")
+        return if script.blank? || script.match?(/\b(vite|vp)\b/)
+
+        say %(package.json has a "build" script that assets:precompile will run instead of `vite build`: #{script}. Change it to "vite build" or remove it.), :yellow
+      end
+
       def create_vite_config
         template "vite.config.ts.tt", @esm_package ? "vite.config.ts" : "vite.config.mts"
       end

data/lib/rails_vite/auto_build.rb

@@ -1,3 +1,4 @@
+require "fileutils"
 require "find"
 
 module RailsVite
@@ -5,6 +6,17 @@ module RailsVite
     NEVER = Time.at(0).freeze
     SOURCE_CHECK_INTERVAL = 2 # seconds
 
+    # Auto build runs when it is on and no dev server serves the assets.
+    def self.enabled?(config)
+      config.auto_build? && !config.dev_server_running?
+    end
+
+    # Builds stale assets outside a request, as the middleware does on the
+    # first one; for example, before a test runner starts its workers.
+    def self.build_if_stale(config = RailsVite.config)
+      new(nil, config).build_if_stale if enabled?(config)
+    end
+
     def initialize(app, config)
       @app = app
       @config = config
@@ -14,30 +26,67 @@ module RailsVite
     end
 
     def call(env)
-      build! if stale?
+      build_if_stale
       @app.call(env)
     end
 
+    # Builds the assets when a source is newer than the manifest, or waits for
+    # another process's build. Raises BuildError when the build fails.
+    def build_if_stale
+      build! if stale?
+    end
+
     private
 
     def build!
       @mutex.synchronize do
         return unless stale?
 
-        # Build quietly: vite's per-build summary is noise on every auto-build
-        # (e.g. each local system-test run). Warnings and errors still stream.
-        Rails.logger.error("rails-vite: build failed") unless system(RailsVite::Tasks.build_env, "#{RailsVite::Tasks.build_command} --logLevel warn", chdir: Rails.root)
+        with_build_lock do
+          # Another process may have finished a build while this one waited.
+          return unless stale?
+
+          sources = compute_latest_source_mtime
+          raise BuildError.new(skipped: true) if @failed_sources == sources
+
+          # Build quietly: vite's per-build summary is noise on every auto-build
+          # (e.g. each local system-test run). Warnings and errors still stream.
+          next if system(RailsVite::Tasks.build_env, "#{RailsVite::Tasks.build_command} --logLevel warn", chdir: Rails.root)
+
+          # Remember the failure for these sources, so this process does not
+          # rebuild them until a source changes.
+          @failed_sources = sources
+          raise BuildError
+        end
+        @failed_sources = nil
         @cached_source_mtime = nil
         @source_mtime_checked_at = nil
       end
     end
 
+    # Serializes builds across processes (parallel test workers, a server
+    # beside a test run): Vite empties the build directory first, so the lock
+    # lives outside it.
+    def with_build_lock
+      path = Rails.root.join("tmp", "rails-vite-build-#{@config.build_dir}.lock")
+      FileUtils.mkdir_p(path.dirname)
+      File.open(path, File::RDWR | File::CREAT, 0o644) do |lock|
+        lock.flock(File::LOCK_EX)
+        yield
+      end
+    end
+
     def stale?
       # The manifest file's mtime is our persisted "last build" timestamp: it
       # lives on disk, so freshness survives process restarts (e.g. a new Rails
-      # process per local system-test run) without any extra state.
-      !File.exist?(@config.manifest_path) ||
-        latest_source_mtime > File.mtime(@config.manifest_path)
+      # process per local system-test run) without any extra state. A missing
+      # manifest is stale, including one another process's build has just
+      # removed: Vite empties the build directory first, so it can vanish
+      # between any check and the read. Stale takes the build lock, which
+      # waits for that build and then checks again.
+      latest_source_mtime > File.mtime(@config.manifest_path)
+    rescue Errno::ENOENT
+      true
     end
 
     def latest_source_mtime
@@ -52,7 +101,7 @@ module RailsVite
 
     def compute_latest_source_mtime
       latest = NEVER
-      source_path = Rails.root.join(@config.source_dir).to_s
+      source_path = Rails.root.join(@config.source_path).to_s
 
       Find.find(source_path, *auto_build_path_matches) do |path|
         next unless File.file?(path)

data/lib/rails_vite/config.rb

@@ -34,6 +34,10 @@ module RailsVite
       plugin_meta["sourceDir"] || "app/javascript"
     end
 
+    def source_path
+      plugin_meta["sourcePath"].presence || source_dir
+    end
+
     def entrypoints_dir
       plugin_meta["entrypointsDir"]
     end
@@ -44,7 +48,7 @@ module RailsVite
     end
 
     # Paths or globs relative to Rails.root that auto build checks for changes,
-    # in addition to source_dir. Directories are walked recursively.
+    # in addition to source_path. Directories are walked recursively.
     def auto_build_paths
       @auto_build_paths ||= [
         "vite.config.*",

data/lib/rails_vite/engine.rb

@@ -6,7 +6,7 @@ module RailsVite
 
     initializer "rails_vite.auto_build", after: :load_config_initializers do |app|
       vite_config = RailsVite.config
-      if vite_config.auto_build? && !vite_config.dev_server_running?
+      if RailsVite::AutoBuild.enabled?(vite_config)
         app.middleware.use RailsVite::AutoBuild, vite_config
       end
     end

data/lib/rails_vite/errors.rb

@@ -12,6 +12,19 @@ module RailsVite
     end
   end
 
+  class BuildError < Error
+    # skipped: Vite did not run because these sources already failed to build
+    # in an earlier request, so its errors are not in this output.
+    def initialize(skipped: false)
+      message = if skipped
+        "Vite auto build failed earlier for these sources and is not retried until a source changes or the app restarts. Run `rake vite:build` to see its errors."
+      else
+        "Vite auto build failed; its errors are in the output above. It retries once a source changes, or run `rake vite:build`."
+      end
+      super(message)
+    end
+  end
+
   class MissingEntryError < Error
     def initialize(name, path)
       super("Entry \"#{name}\" not found in Vite manifest at #{path}.")

data/lib/rails_vite/manifest.rb

@@ -32,7 +32,11 @@ module RailsVite
     end
 
     def digest
-      Digest::MD5.file(@path).hexdigest
+      if Rails.env.local?
+        load_digest
+      else
+        @digest ||= load_digest
+      end
     rescue Errno::ENOENT
       NO_MANIFEST_DIGEST
     end
@@ -47,6 +51,10 @@ module RailsVite
       end
     end
 
+    def load_digest
+      Digest::MD5.file(@path).hexdigest
+    end
+
     def load_manifest
       JSON.parse(File.read(@path))
     rescue Errno::ENOENT

data/lib/rails_vite/version.rb

@@ -1,3 +1,3 @@
 module RailsVite
-  VERSION = "0.3.0.rc1"
+  VERSION = "0.4.0"
 end

data/lib/tasks/rails_vite/build.rake

@@ -13,6 +13,15 @@ namespace :vite do
 
   Rake::Task["vite:build"].prereqs << :install unless ENV["SKIP_VITE_INSTALL"]
 
+  desc "Build Vite assets the way auto build does, only if sources changed"
+  task auto_build: :environment do
+    RailsVite::AutoBuild.build_if_stale
+  end
+
+  task :keep_eager_load do
+    ActiveSupport.on_load(:before_initialize) { config.rake_eager_load = config.eager_load }
+  end
+
   desc "Remove Vite build artifacts"
   task :clobber do
     rm_rf Rails.root.join("public", RailsVite.config.asset_prefix.delete_prefix("/"))
@@ -36,7 +45,7 @@ unless ENV["SKIP_VITE_BUILD"]
 
   %w[test:prepare spec:prepare db:test:prepare].each do |t|
     if Rake::Task.task_defined?(t)
-      Rake::Task[t].enhance(["vite:build"])
+      Rake::Task[t].enhance(["vite:keep_eager_load", "vite:build"])
       break
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails_vite
 version: !ruby/object:Gem::Version
-  version: 0.3.0.rc1
+  version: 0.4.0
 platform: ruby
 authors:
 - Svyatoslav Kryukov