react-email-rails 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 87e5a6099e4591961f8568f277d6470364c52b35ef9a5f859ddba645834d97e9
-  data.tar.gz: 8130ded931b6caa0d9b0c5a72ce2671891cd6eca53ab7cb29704b7ff65e90891
+  metadata.gz: d5d324a8d629ad252aa11946478dd3b610c78920675bb027aedabf8c96c36239
+  data.tar.gz: eaa690f2caecb96ef322bac6e587bb1dbf2bfe51e9c601a8b1b9dceb4d43d7a8
 SHA512:
-  metadata.gz: 0654a149d0fc2e8f5bdeafd42e26059ed7b4cf41a223b147a6c45ff42cf5ac8af9d346b13d8a5660682ebf9d7a59b167d3c89e815e2f9cdb719a69b1c2ee9171
-  data.tar.gz: 37abce1546d5fc5382bcfc9932030433f1e2a6b557fa83f98a4cd30ad3f9e465613148866933f4801281f2c1229935cc3e09a57e54900164ab97da7d6510f8e6
+  metadata.gz: ca696714d6b95038f96fc579c8040fb9eaf6e98b213ddf42ba7ab92fdb49e5ab8d1dc3bb6b8a095d8fc91573314df6f4ae06136c4af41f3ec9cf66ea2bd22c85
+  data.tar.gz: 77c513dfda5a19d5296396433d4adb79e198cffcda518311e4fe5f780efb19f532baba3743dd0b0d08928528eece7d74047280f0d3bde34a89a565ab06ddd975

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Changelog
 
+## 0.1.3
+
+- Remove the `verify_render_on_boot` configuration option, which only logged on failure and duplicated the render-time `ReactEmailRails::RenderError`.
+- Add the `react_email_rails:verify` rake task that checks the renderer and exits non-zero on failure.
+
+## 0.1.2
+
+- Support Vite 8 hook filters while keeping production email bundles standalone by default.
+- Keep development email rendering compatible with Vite's module runner.
+
 ## 0.1.1
 
 - Build production React Email bundles from Rails asset tasks with an isolated email-only Vite build.

data/README.md

@@ -19,7 +19,7 @@ Build and send emails using React and Rails — a seamless integration between [
 
 ## Why
 
-Building HTML emails is painfully archaic. [React Email](https://react.email) is a collection of unstyled components for building emails with React, Tailwind, and TypeScript. This gem brings that power directly into your Rails app: write emails as React components and send them through Action Mailer.
+Building HTML emails is painfully archaic. [React Email](https://react.email) is a collection of unstyled components for building emails with React, Tailwind, and TypeScript. This gem brings that power directly into your Rails app. Write emails as React components, send them through Action Mailer, and recipients get automatically generated HTML and text emails.
 
 ## How
 
@@ -27,7 +27,7 @@ Building HTML emails is painfully archaic. [React Email](https://react.email) is
 
 **In production,** Rails builds a server-side email bundle during `assets:precompile`. The bundled rake task runs an isolated email-only Vite build, using `reactEmailRails()` in your app's Vite config for discovery and options.
 
-Delivery, headers, multipart parts, previews, queues, and callbacks all stay normal Action Mailer. If rendering fails, no email is sent and `ReactEmailRails::RenderError` is raised.
+React Email Rails automatically renders both HTML and plain-text versions from the same component. Delivery, headers, previews, queues, and callbacks all stay normal Action Mailer. If rendering fails, no email is sent and `ReactEmailRails::RenderError` is raised.
 
 ## Status
 
@@ -308,7 +308,6 @@ If the defaults don't fit, override them in `config/initializers/react_email_rai
 | `render_timeout` | `10` seconds |
 | `render_process_max_requests` | `1_000` |
 | `on_render_error` | `nil` |
-| `verify_render_on_boot` | `false` |
 
 #### Prop Transformation
 
@@ -391,10 +390,7 @@ Every render emits an [ActiveSupport::Notifications](https://guides.rubyonrails.
 
 ```ruby
 ActiveSupport::Notifications.subscribe("render.react-email-rails") do |event|
-  Rails.logger.info(
-    "[react-email-rails] rendered #{event.payload[:component]} " \
-    "(#{event.payload[:html_bytes]} bytes) in #{event.duration.round(1)}ms"
-  )
+  Rails.logger.info("[react-email-rails] Rendered #{event.payload[:component]} (Duration: #{event.duration.round}ms | Size: #{event.payload[:html_bytes]} bytes)")
 end
 ```
 
@@ -411,7 +407,7 @@ In development and production, the isolated renderer loads the `reactEmailRails(
 | `emails.path` | `"app/javascript/emails"` | Directory containing email components |
 | `emails.extension` | `[".tsx", ".jsx"]` | Component extension, or an array of extensions |
 | `emails.ignore` | `["**/_*", "**/_*/**"]` | Glob patterns ignored under `emails.path` |
-| `standalone` | `true` | Inline SSR dependencies with `ssr.noExternal: true` |
+| `standalone` | `true` | Inline production email bundle dependencies |
 | `vite` | `{}` | Extra email-only Vite config for compilation and resolution |
 
 Use a custom directory:
@@ -458,7 +454,7 @@ These `vite` options are used by `react-email-rails-dev` and `react-email-rails-
 
 #### Standalone Builds
 
-By default the email bundle inlines React, `@react-email/render`, and other Node dependencies. That makes the bundle larger, but it works well for Rails deploys that build assets in one stage and run without `node_modules` in the final runtime image.
+By default the production email bundle inlines React, `@react-email/render`, and other Node dependencies. That makes the bundle larger, but it works well for Rails deploys that build assets in one stage and run without `node_modules` in the final runtime image. Development previews keep dependencies external for Vite's module runner, even when `standalone` is enabled.
 
 Set `standalone: false` when your runtime already ships `node_modules` and you prefer a smaller SSR-style bundle:
 
@@ -496,18 +492,23 @@ The Ruby gem and npm package must stay on the same version. The renderer include
 
 The build command preserves `emails.path`, `emails.extension`, `emails.ignore`, `standalone`, and email-only `vite` options.
 
-### Runtime Dependencies
+### Renderer Verification
+
+To confirm the renderer is ready before relying on it, run:
 
-For runtime dependency tradeoffs, see [Standalone Builds](#standalone-builds).
+```sh
+bin/rails react_email_rails:verify
+```
 
-### Boot Verification
+It checks that the render command runs and that the npm package version matches the gem, then exits non-zero with an actionable message on failure. Wire it into your CI or release step to catch a missing bundle or version drift before a deploy ships — a renderer failure won't otherwise surface until the first email is sent.
 
-Boot verification is disabled by default. If you want the app to check the renderer during boot, scope it to the same processes that build or ship the bundle:
+For programmatic checks (for example, a health endpoint), `ReactEmailRails.healthy?` returns a boolean. If you specifically want a check at boot, call it from your own initializer and scope it to the processes that send mail so others don't pay the cost:
 
 ```ruby
-ReactEmailRails.configure do |config|
-  config.render_mode = :persistent if Rails.env.production? && Sidekiq.server?
-  config.verify_render_on_boot = -> { Rails.env.production? && Sidekiq.server? }
+Rails.application.config.after_initialize do
+  if Rails.env.production? && Sidekiq.server? && !ReactEmailRails.healthy?
+    Rails.logger.error("[react-email-rails] renderer verification failed")
+  end
 end
 ```
 

data/lib/react_email_rails/configuration.rb

@@ -27,14 +27,11 @@ class ReactEmailRails::Configuration
     end
   end
 
-  DEFAULT_VERIFY_RENDER_ON_BOOT = false
-
   attr_accessor(
     :component_path_resolver,
     :render_options,
     :transform_props,
     :on_render_error,
-    :verify_render_on_boot,
   )
   attr_reader(
     :render_mode,
@@ -52,15 +49,10 @@ class ReactEmailRails::Configuration
         config.render_process_max_requests = DEFAULT_RENDER_PROCESS_MAX_REQUESTS
         config.transform_props = :lower_camel
         config.on_render_error = nil
-        config.verify_render_on_boot = DEFAULT_VERIFY_RENDER_ON_BOOT
       end
     end
   end
 
-  def verify_render_on_boot?
-    verify_render_on_boot.respond_to?(:call) ? !!verify_render_on_boot.call : !!verify_render_on_boot
-  end
-
   def render_mode=(value)
     if (value.is_a?(Symbol) || value.is_a?(String)) && !RENDER_MODES.key?(value.to_sym)
       raise(ArgumentError, "Unknown react-email-rails render mode: #{value.inspect}")

data/lib/react_email_rails/railtie.rb

@@ -6,13 +6,4 @@ class ReactEmailRails::Railtie < Rails::Railtie
   end
 
   rake_tasks { load(File.expand_path("../tasks/react_email_rails/build.rake", __dir__)) }
-
-  config.after_initialize do
-    if ReactEmailRails.configuration.verify_render_on_boot? && !ReactEmailRails.healthy?
-      Rails.logger.error(
-        "[react-email-rails] render verification failed for command: " \
-          "#{ReactEmailRails.configuration.send(:resolved_render_command).inspect}",
-      )
-    end
-  end
 end

data/lib/react_email_rails/tasks.rb

@@ -14,6 +14,13 @@ module ReactEmailRails::Tasks
       FileUtils.rm_rf(Rails.root.join(File.dirname(ReactEmailRails::Configuration::BUNDLE_PATH)))
     end
 
+    def verify
+      return if ReactEmailRails.healthy?
+
+      command = ReactEmailRails.configuration.send(:resolved_render_command)
+      raise("react-email-rails renderer verification failed for command: #{command.inspect}")
+    end
+
     private
 
     def build_command

data/lib/react_email_rails/version.rb

@@ -1,3 +1,3 @@
 module ReactEmailRails
-  VERSION = "0.1.1"
+  VERSION = "0.1.3"
 end

data/lib/tasks/react_email_rails/build.rake

@@ -4,6 +4,9 @@ namespace(:react_email_rails) do
 
   desc("Remove the React Email Rails production bundle")
   task(clobber: :environment) { ReactEmailRails::Tasks.clobber }
+
+  desc("Verify the React Email Rails renderer is healthy (exits non-zero on failure)")
+  task(verify: :environment) { ReactEmailRails::Tasks.verify }
 end
 
 unless ENV["SKIP_REACT_EMAIL_RAILS_BUILD"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: react-email-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors:
 - Supertape