proscenium 0.21.6 → 0.22.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4f6398d463cbc86473d175ecfe1eeb67fdfcff9aee35e04b6bbbc1d4e83d3bb0
-  data.tar.gz: 9fb3fe80e98382aca739064f7a67da2251d04f1d15a975542a6d9d74765fe93f
+  metadata.gz: 25c8afc9ba8ceb38580394723a1a348ad223c6cd4d2746a2491581e73bfbc801
+  data.tar.gz: abfa8c374b6633064079f24c68f3ed94fe6e8a7364bb871a4f5bd3942e3b0a56
 SHA512:
-  metadata.gz: 6e125eef70da31e9e308b59ddbbaad8bbb3deb3e685f07fde61af1c65684e97f812e6ded7be1ace54dcc659f64b2686e22d272d9837d206edaf645dc9f39c940
-  data.tar.gz: a109fe9faa1e1a25e578f9ce903f0361143e6607b9331e217590a2f6c933a1f9a7eeb973122dd2aa43ca1661b57bb3dca845516a14c4e8ae53b59022273f71b6
+  metadata.gz: 9fdde9277820a78e9fab18b4c8dd5fe78be9fca04ff2b866523ed3f2a9d42474fe194f733a69172452bfb5f02c44eb390fa157298594688beb390ed16cbf0fad
+  data.tar.gz: 7f7440d3caca1d84ffead3c5cafecc114e0a5f4e5aa5ae39052d0599b1946527bc2302c0042337fc6260f74c9212a5124141823ed33caa8adac2675c8862ae07

data/lib/proscenium/builder.rb

@@ -4,8 +4,6 @@ require 'ffi'
 
 module Proscenium
   class Builder
-    class CompileError < StandardError; end
-
     ENVIRONMENTS = { development: 1, test: 2, production: 3 }.freeze
 
     class Result < FFI::Struct
@@ -14,6 +12,11 @@ module Proscenium
              :content_hash, :string
     end
 
+    class CompileResult < FFI::Struct
+      layout :success, :bool,
+             :messages, :string
+    end
+
     module Request
       extend FFI::Library
 
@@ -32,30 +35,36 @@ module Proscenium
         :pointer # Config as JSON.
       ], Result.by_value
 
+      attach_function :compile, [
+        :pointer # Config as JSON.
+      ], CompileResult.by_value
+
       attach_function :reset_config, [], :void
     end
 
-    class BuildError < StandardError
-      attr_reader :error
+    class BuildError < Error
+      attr_reader :error, :path
 
-      def initialize(error)
-        @error = JSON.parse(error, strict: true).deep_transform_keys(&:underscore)
+      def initialize(path, error)
+        @path = path
+        @error = JSON.parse(error, strict: true)
 
-        msg = @error['text']
-        msg << ' - ' << @error['detail'] if @error['detail'].is_a?(String)
-        if (location = @error['location'])
-          msg << " at #{location['file']}:#{location['line']}:#{location['column']}"
+        msg = @error['Text']
+        msg << ' - ' << @error['Detail'] if @error['Detail'].is_a?(String)
+        if (location = @error['Location'])
+          msg << " at #{location['File']}:#{location['Line']}:#{location['Column']}"
         end
 
-        super(msg)
+        super("Failed to build #{path} - #{msg}")
       end
     end
 
-    class ResolveError < StandardError
-      attr_reader :error_msg, :path
+    class ResolveError < Error
+      attr_reader :path
 
-      def initialize(path, error_msg)
-        super("Failed to resolve '#{path}' -- #{error_msg}")
+      def initialize(path, msg)
+        @path = path
+        super("Failed to resolve #{path} - #{msg}")
       end
     end
 
@@ -67,6 +76,10 @@ module Proscenium
       new(root:).resolve(path)
     end
 
+    def self.compile(root: nil)
+      new(root:).compile
+    end
+
     # Intended for tests only.
     def self.reset_config!
       Request.reset_config
@@ -75,6 +88,7 @@ module Proscenium
     def initialize(root: nil)
       @request_config = FFI::MemoryPointer.from_string({
         RootPath: (root || Rails.root).to_s,
+        OutputDir: "public#{Proscenium.config.output_dir}",
         GemPath: gem_root,
         Environment: ENVIRONMENTS.fetch(Rails.env.to_sym, 2),
         EnvVars: env_vars,
@@ -82,6 +96,7 @@ module Proscenium
         RubyGems: Proscenium::BundledGems.paths,
         Bundle: Proscenium.config.bundle,
         Aliases: Proscenium.config.aliases,
+        Precompile: Proscenium.config.precompile,
         QueryString: Proscenium.config.cache_query_string.presence || '',
         Debug: Proscenium.config.debug
       }.to_json)
@@ -91,7 +106,7 @@ module Proscenium
       ActiveSupport::Notifications.instrument('build.proscenium', identifier: path) do
         result = Request.build_to_string(path, cache_query_string, @request_config)
 
-        raise BuildError, result[:response] unless result[:success]
+        raise BuildError.new(path, result[:response]) unless result[:success]
 
         result
       end
@@ -107,6 +122,11 @@ module Proscenium
       end
     end
 
+    def compile
+      result = Request.compile(@request_config)
+      result[:success]
+    end
+
     private
 
     # Build the ENV variables as determined by `Proscenium.config.env_vars` and

data/lib/proscenium/css_module.rb

@@ -7,7 +7,7 @@ module Proscenium::CssModule
   autoload :Transformer
   autoload :Rewriter
 
-  class TransformError < StandardError
+  class TransformError < Proscenium::Error
     def initialize(name, additional_msg = nil)
       msg = "Failed to transform CSS module `#{name}`"
       msg << ' - ' << additional_msg if additional_msg

data/lib/proscenium/ensure_loaded.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Proscenium
-  NotIncludedError = Class.new(StandardError)
+  NotIncludedError = Class.new(Error)
 
   module EnsureLoaded
     def self.included(child)

data/lib/proscenium/ext/proscenium.h

@@ -25,6 +25,10 @@ struct Result {
 	int success;
 	char* response;
 	char* contentHash;
+	};
+struct CompileResult {
+	int success;
+	char* messages;
 };
 
 #line 1 "cgo-generated-wrapper"
@@ -88,6 +92,7 @@ extern void reset_config();
 // Build the given `path` using the `config`.
 //
 // - path - The path to build relative to `root`.
+// - cache_query_string - The current query string used for cache busting, taken from the URL.
 // - config
 //
 extern struct Result build_to_string(char* filePath, char* cacheQueryString, char* configJson);
@@ -99,6 +104,12 @@ extern struct Result build_to_string(char* filePath, char* cacheQueryString, cha
 //
 extern struct Result resolve(char* filePath, char* configJson);
 
+// Compile assets using the given `config`.
+//
+// - config
+//
+extern struct CompileResult compile(char* configJson);
+
 #ifdef __cplusplus
 }
 #endif

data/lib/proscenium/helper.rb

@@ -11,18 +11,9 @@ module Proscenium
       end
     end
 
-    # Overriden to allow regular use of javascript_include_tag and stylesheet_link_tag, while still
-    # building with Proscenium. It's important to note that `include_assets` will not call this, as
-    # those asset paths all begin with a slash, which the Rails asset helpers do not pass through to
-    # here.
-    #
-    # If the given `path` is a bare path (does not start with `./` or `../`), then we use
-    # Rails default conventions, and serve CSS from /app/assets/stylesheets and JS from
-    # /app/javascript.
     def compute_asset_path(path, options = {})
       if %i[javascript stylesheet].include?(options[:type])
-        path.prepend DEFAULT_RAILS_ASSET_PATHS[options[:type]] if !path.start_with?('./', '../')
-        return path
+        return Proscenium::Manifest[path] || "/#{path}"
       end
 
       super

data/lib/proscenium/manifest.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Proscenium
+  module Manifest
+    mattr_accessor :manifest, default: {}
+    mattr_accessor :loaded, default: false
+
+    module_function
+
+    def loaded?
+      loaded
+    end
+
+    def load!
+      self.manifest = {}
+      self.loaded = false
+
+      if Proscenium.config.manifest_path.exist?
+        self.loaded = true
+
+        JSON.parse(Proscenium.config.manifest_path.read)['outputs'].each do |output_path, details|
+          next if !details.key?('entryPoint')
+
+          manifest[details['entryPoint']] = "/#{output_path.delete_prefix('public/')}"
+        end
+      end
+
+      manifest
+    end
+
+    def reset!
+      self.manifest = {}
+      self.loaded = false
+    end
+
+    def [](key)
+      loaded? ? manifest[key] : "/#{key}"
+    end
+  end
+end

data/lib/proscenium/middleware/base.rb

@@ -5,18 +5,6 @@ module Proscenium
     class Base
       include ActiveSupport::Benchmarkable
 
-      # Error when the result of the build returns an error. For example, when esbuild returns
-      # errors.
-      class CompileError < StandardError
-        attr_reader :detail, :file
-
-        def initialize(args)
-          @detail = args[:detail]
-          @file = args[:file]
-          super("Failed to build '#{args[:file]}' -- #{detail}")
-        end
-      end
-
       def self.attempt(request)
         new(request).renderable!&.attempt
       end

data/lib/proscenium/middleware/esbuild.rb

@@ -3,26 +3,8 @@
 module Proscenium
   class Middleware
     class Esbuild < Base
-      class CompileError < Base::CompileError
-        def initialize(args)
-          detail = args[:detail]
-          detail = JSON.parse(detail, mode: :strict)
-
-          args['detail'] = if detail['location']
-                             "#{detail['text']} in #{detail['location']['file']}:" +
-                               detail['location']['line'].to_s
-                           else
-                             detail['text']
-                           end
-
-          super
-        end
-      end
-
       def attempt
         render_response Builder.build_to_string(path_to_build, cache_query_string:)
-      rescue Builder::CompileError => e
-        raise self.class::CompileError, { file: @request.fullpath, detail: e.message }, caller
       end
     end
   end

data/lib/proscenium/middleware.rb

@@ -4,7 +4,7 @@ module Proscenium
   class Middleware
     extend ActiveSupport::Autoload
 
-    class BuildError < StandardError; end
+    class BuildError < Error; end
 
     autoload :Base
     autoload :Esbuild
@@ -24,7 +24,7 @@ module Proscenium
       # cache lifetime, since these are content-hashed and will never change.
       if request.path.match?(CHUNKS_PATH)
         ::ActionDispatch::FileHandler.new(
-          Rails.public_path.join('assets').to_s,
+          Proscenium.config.output_path.to_s,
           headers: {
             'Cache-Control' => "public, max-age=#{100.years}, immutable",
             'etag' => request.path.match(/-\$([a-z0-9]+)\$/i)[1]

data/lib/proscenium/railtie.rb

@@ -17,8 +17,9 @@ module Proscenium
     config.proscenium.ensure_loaded = :raise
     config.proscenium.cache_query_string = Rails.env.production? && ENV.fetch('REVISION', nil)
     config.proscenium.cache_max_age = 2_592_000 # 30 days
-
     config.proscenium.aliases = {}
+    config.proscenium.precompile = Set.new
+    config.proscenium.output_dir = '/assets'
 
     # List of environment variable names that should be passed to the builder, which will then be
     # passed to esbuild's `Define` option. Being explicit about which environment variables are
@@ -29,7 +30,13 @@ module Proscenium
       'Proscenium::Builder::BuildError' => 'build_error'
     }
 
-    config.after_initialize do |_app|
+    config.after_initialize do |app|
+      config.proscenium.output_path ||=
+        Pathname.new(File.join(app.config.paths['public'].first, app.config.proscenium.output_dir))
+      config.proscenium.manifest_path = config.proscenium.output_path.join('.manifest.json')
+
+      Proscenium::Manifest.load!
+
       if config.proscenium.logging
         require 'proscenium/log_subscriber'
         Proscenium::LogSubscriber.attach_to :proscenium
@@ -65,5 +72,9 @@ module Proscenium
         ActionView::PartialRenderer.prepend Monkey::PartialRenderer
       end
     end
+
+    rake_tasks do
+      load 'proscenium/railties/assets.rake'
+    end
   end
 end

data/lib/proscenium/railties/assets.rake

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+namespace :assets do
+  desc 'Compile Proscenium assets'
+  task precompile: :environment do
+    puts "\nPre-compiling assets..."
+
+    raise 'Assets pre-compilation failed!' unless Proscenium::Builder.compile
+
+    puts "\nAssets pre-compiled successfully."
+
+    if Rails.env.development?
+      puts "\nWarning: You are precompiling assets in development. Rails will not " \
+           'serve any changed assets until you delete ' \
+           "public#{Rails.application.config.proscenium.output_dir}/.manifest.json"
+    end
+  end
+end

data/lib/proscenium/side_load.rb

@@ -43,7 +43,7 @@ module Proscenium
           if Proscenium.config.cache_query_string.present?
             path += "?#{Proscenium.config.cache_query_string}"
           end
-          out << helpers.stylesheet_link_tag(path, extname: false, **opts)
+          out << helpers.stylesheet_link_tag(path.delete_prefix('/'), extname: false, **opts)
         end
 
         if fragments
@@ -74,7 +74,7 @@ module Proscenium
           if Proscenium.config.cache_query_string.present?
             path += "?#{Proscenium.config.cache_query_string}"
           end
-          out << helpers.javascript_include_tag(path, extname: false, **opts)
+          out << helpers.javascript_include_tag(path.delete_prefix('/'), extname: false, **opts)
         end
 
         if fragments

data/lib/proscenium/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Proscenium
-  VERSION = '0.21.6'
+  VERSION = '0.22.0.beta1'
 end

data/lib/proscenium.rb

@@ -26,6 +26,7 @@ module Proscenium
   autoload :Utils
   autoload :Monkey
   autoload :Middleware
+  autoload :Manifest
   autoload :EnsureLoaded
   autoload :SideLoad
   autoload :CssModule
@@ -44,7 +45,20 @@ module Proscenium
     end
   end
 
-  class PathResolutionFailed < StandardError
+  class Error < StandardError; end
+
+  class MissingAssetError < Error
+    def initialize(path)
+      super
+      @path = path
+    end
+
+    def message
+      "The asset '#{@path}' was not found."
+    end
+  end
+
+  class PathResolutionFailed < Error
     def initialize(path)
       @path = path
       super

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: proscenium
 version: !ruby/object:Gem::Version
-  version: 0.21.6
+  version: 0.22.0.beta1
 platform: ruby
 authors:
 - Joel Moss
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-10-24 00:00:00.000000000 Z
+date: 2025-10-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -66,6 +66,7 @@ files:
 - lib/proscenium/helper.rb
 - lib/proscenium/importer.rb
 - lib/proscenium/log_subscriber.rb
+- lib/proscenium/manifest.rb
 - lib/proscenium/middleware.rb
 - lib/proscenium/middleware/base.rb
 - lib/proscenium/middleware/esbuild.rb
@@ -73,6 +74,7 @@ files:
 - lib/proscenium/middleware/silence_request.rb
 - lib/proscenium/monkey.rb
 - lib/proscenium/railtie.rb
+- lib/proscenium/railties/assets.rake
 - lib/proscenium/react-manager/index.jsx
 - lib/proscenium/react-manager/react.js
 - lib/proscenium/react_componentable.rb