proscenium 0.11.0.pre.7-x86_64-linux → 0.11.0.pre.8-x86_64-linux

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 88c960e2cb342e9d27c84cfc7f14545e9c900876d64c7ae27db96e9c470d387f
-  data.tar.gz: 18c2090d81ccfb1d012d4c8c2a5a72ef66d76555eb3def406dddd17726264238
+  metadata.gz: 90ea3174caa7312b84d189b74ec6a5171cf0ee934eec92f3b0bca057aa4aee81
+  data.tar.gz: 9c865f250eb246a0e418a0c88cdd53db37b86f907fe61c90bfc8c6bf49b6a8aa
 SHA512:
-  metadata.gz: 63ab8a8d80c739cbafaf8f2f5f3b51eb321a856fc5aed3e4aaf5d92b7574b8d0310ce8b476cf7faa09bc104a3365895c67789b70cb86ac8ea61a4cc542e8a644
-  data.tar.gz: e301f752d5a149daf30c11a4c0de268c37a1a5af69761cb92721c8d1850dd25aa43fa895c3fcda566bea2794c6ce9db0a7b353f63567272ab628498ace7df3ee
+  metadata.gz: 9c789cf77502528b0132e29199ae2896a7aa2da6ed438ce7a0f42ffa72b27875da48209edad61dd240d0d24d3797ce0d1d4166c506b569a462a59e733093e527
+  data.tar.gz: 8c038b9c6afca87a4b16ea3efd89f6309a270d907b249fa3c33523ba15bee7e8ad1c5acdf29214f49bd3c4fa75c9e743f5d3cbe4adb48478fdbac018e3a8cf85

data/README.md

@@ -757,18 +757,35 @@ Rails.application.config.proscenium.cache_max_age = 12.months.to_i
 
 Proscenium brings back RJS! Any path ending in .rjs will be served from your Rails app. This allows you to import server rendered javascript.
 
+## Resolution
 
-## Included Paths
-
-Proscenium will serve files ending with any of these extension: `js,mjs,ts,css,jsx,tsx` from the following directories, and their sub-directories: `/app`, `/lib`, `/config`, `/node_modules`, `/vendor`.
+Proscenium will serve files ending with any of these extension: `js,mjs,ts,css,jsx,tsx` from the following directories, and their sub-directories of your Rails application's root: `/app`, `/lib`, `/config`, `/node_modules`, `/vendor`.
 
 So a file at `/app/views/users/index.js` will be served from `https://yourapp.com/app/views/users/index.js`.
 
-You can continue to access any file in the `/public` directory as you normally would, but any file ending with a supported extension (`js,mjs,ts,css,jsx,tsx`) will be processed by Proscenium. For example, `/public/some/file.js` will be served from `https://yourapp.com/some/file.js`.
+You can continue to access any file in the `/public` directory as you normally would. Proscenium will not process files in the `/public` directory.
+
+If requesting a file that exists in a root directory and the public directory, the file in the public directory will be served. For example, if you have a file at `/lib/foo.js` and `/public/lib/foo.js`, and you request `/lib/foo.js`, the file in the public directory (`/public/lib/foo.js`) will be served.
+
+### Assets from Rails Engines
+
+Proscenium can serve assets from Rails Engines that are installed in your Rails app.
+
+An engine that wants to expose its assets via Proscenium to the application must add Proscenium as a dependency, and add itself to the list of engines in the Proscenium config options `Proscenium.config.engines`.
+
+For example, we have a gem called `gem1` that has Proscenium as a dependency, and exposes a Rails engine. It has some assets that it wants to expose to the application. To do this, it adds itself to the list of engines in the Proscenium config `engines` option:
+
+```ruby
+class Gem1::Engine < ::Rails::Engine
+  config.proscenium.engines << self
+end
+```
+
+When this gem is installed in any Rails application, its assets will be available at the URL `/gem1/...`. For example, if the gem has a file `lib/styles.css`, it can be requested at `/gem1/lib/styles.css`.
 
-## Serving from Ruby Gems and Rails Engines
+The same directories and file extensions are supported as for the application itself.
 
-Proscenium can serve assets from Ruby Gems and Rails Engines.
+It is important to note that the application takes precedence over the gem. So if the application has a file at `/public/gem1/lib/styles.css`, and the gem also has a file at `/lib/styles.css`, then the file in the application will be served. This is because both files would be accessible at the same URL: `/gem1/lib/styles.css`.
 
 ## Thanks
 

data/lib/proscenium/builder.rb

@@ -29,6 +29,7 @@ module Proscenium
         :string,      # Proscenium gem root
         :environment, # Rails environment as a Symbol
         :bool,        # code splitting enabled?
+        :string,      # engine names and paths as a JSON string
         :bool         # debugging enabled?
       ], Result.by_value
 
@@ -45,12 +46,17 @@ module Proscenium
     end
 
     class BuildError < StandardError
-      attr_reader :error, :path
+      attr_reader :error
 
-      def initialize(path, error)
-        error = Oj.load(error, mode: :strict).deep_transform_keys(&:underscore)
+      def initialize(error)
+        @error = Oj.load(error, mode: :strict).deep_transform_keys(&:underscore)
 
-        super "Failed to build '#{path}' -- #{error['text']}"
+        msg = @error['text']
+        if (location = @error['location'])
+          msg << " at #{location['file']}:#{location['line']}:#{location['column']}"
+        end
+
+        super msg
       end
     end
 
@@ -82,9 +88,10 @@ module Proscenium
                                Pathname.new(__dir__).join('..', '..').to_s,
                                Rails.env.to_sym,
                                Proscenium.config.code_splitting,
+                               engines.to_json,
                                Proscenium.config.debug)
 
-        raise BuildError.new(path, result[:response]) unless result[:success]
+        raise BuildError, result[:response] unless result[:success]
 
         result[:response]
       end
@@ -116,6 +123,10 @@ module Proscenium
       q ? "--cache-query-string #{q}" : nil
     end
 
+    def engines
+      Proscenium.config.engines.to_h { |e| [e.engine_name, e.root.to_s] }
+    end
+
     def import_map
       return unless (path = Rails.root&.join('config'))
 

data/lib/proscenium/ext/proscenium.h

@@ -97,7 +97,7 @@ extern "C" {
 //	- codeSpitting?
 //	- debug?
 //
-extern struct Result build(char* filepath, char* baseUrl, char* importMap, char* envVars, char* appRoot, char* gemPath, unsigned int env, GoUint8 codeSplitting, GoUint8 debug);
+extern struct Result build(char* filepath, char* baseUrl, char* importMap, char* envVars, char* appRoot, char* gemPath, unsigned int env, GoUint8 codeSplitting, char* engines, GoUint8 debug);
 
 // Resolve the given `path` relative to the `root`.
 //

data/lib/proscenium/importer.rb

@@ -21,7 +21,7 @@ module Proscenium
     class << self
       # Import the given `filepath`. This is idempotent - it will never include duplicates.
       #
-      # @param filepath [String] Absolute path (relative to Rails root) of the file to import.
+      # @param filepath [String] Absolute URL path (relative to Rails root) of the file to import.
       #   Should be the actual asset file, eg. app.css, some/component.js.
       # @param resolve [String] description of the file to resolve and import.
       # @return [String] the digest of the imported file path if a css module (*.module.css).

data/lib/proscenium/middleware/engines.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Proscenium
+  class Middleware
+    # This middleware handles requests for assets in Rails engines. An engine that wants to expose
+    # its assets via Proscenium to the application must add itself to the list of engines in the
+    # Proscenium config options `Proscenium.config.engines`.
+    #
+    # For example, we have a gem that exposes a Rails engine.
+    #
+    #   module Gem1
+    #     class Engine < ::Rails::Engine
+    #       config.proscenium.engines << self
+    #     end
+    #   end
+    #
+    # When this gem is installed in any Rails application, its assets will be available at the URL
+    # `/gem1/...`. For example, if the gem has a file `lib/styles.css`, it can be requested at
+    # `/gem1/lib/styles.css`.
+    #
+    class Engines < Esbuild
+      def real_path
+        @real_path ||= Pathname.new(@request.path.delete_prefix("/#{engine.engine_name}")).to_s
+      end
+
+      def root_for_readable
+        engine.root
+      end
+
+      def engine
+        @engine ||= Proscenium.config.engines.find do |engine|
+          @request.path.start_with?("/#{engine.engine_name}")
+        end
+      end
+    end
+  end
+end

data/lib/proscenium/middleware/esbuild.rb

@@ -20,9 +20,9 @@ module Proscenium
       end
 
       def attempt
-        render_response Proscenium::Builder.build(path_to_build, root: Rails.root.to_s,
-                                                                 base_url: @request.base_url)
-      rescue Proscenium::Builder::CompileError => e
+        render_response Builder.build(path_to_build, root: Rails.root.to_s,
+                                                     base_url: @request.base_url)
+      rescue Builder::CompileError => e
         raise self.class::CompileError, { file: @request.fullpath, detail: e.message }, caller
       end
     end

data/lib/proscenium/middleware.rb

@@ -9,6 +9,7 @@ module Proscenium
 
     autoload :Base
     autoload :Esbuild
+    autoload :Engines
     autoload :Runtime
     autoload :Url
 
@@ -42,12 +43,19 @@ module Proscenium
     def find_type(request)
       return Url if request.path.match?(%r{^/https?%3A%2F%2F})
       return Runtime if request.path.match?(%r{^/@proscenium/})
+      return Esbuild if Pathname.new(request.path).fnmatch?(app_path_glob, File::FNM_EXTGLOB)
 
-      Esbuild if Pathname.new(request.path).fnmatch?(app_path_glob, File::FNM_EXTGLOB)
+      Engines if Pathname.new(request.path).fnmatch?(engines_path_glob, File::FNM_EXTGLOB)
     end
 
     def app_path_glob
-      "/{#{Proscenium::ALLOWED_DIRECTORIES.join(',')}}/**.{#{FILE_EXTENSIONS.join(',')}}"
+      "/{#{Proscenium::ALLOWED_DIRECTORIES}}/**.{#{FILE_EXTENSIONS.join(',')}}"
+    end
+
+    def engines_path_glob
+      names = Proscenium.config.engines.map(&:engine_name)
+
+      "/{#{names.join(',')}}/{#{Proscenium::ALLOWED_DIRECTORIES}}/**.{#{FILE_EXTENSIONS.join(',')}}"
     end
 
     # TODO: handle precompiled assets

data/lib/proscenium/monkey.rb

@@ -3,6 +3,14 @@
 module Proscenium
   # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
   module Monkey
+    module DebugView
+      def initialize(assigns)
+        paths = [RESCUES_TEMPLATE_PATH, Rails.root.join('lib', 'templates').to_s]
+        lookup_context = ActionView::LookupContext.new(paths)
+        super(lookup_context, assigns, nil)
+      end
+    end
+
     module TemplateRenderer
       private
 

data/lib/proscenium/railtie.rb

@@ -29,31 +29,29 @@ module Proscenium
     # defined means a faster build, as esbuild will have less to do.
     config.proscenium.env_vars = Set.new
 
-    # A hash of gems that can be side loaded. Assets from gems listed here can be side loaded.
+    # Rails engines to expose and allow Proscenium to serve their assets.
     #
-    # Because side loading uses URL paths, any gem dependencies that side load assets will fail,
-    # because the URL path will be relative to the application's root, and not the gem's root. By
-    # specifying a list of gems that can be side loaded, Proscenium will be able to resolve the URL
-    # path to the gem's root, and side load the asset.
-    #
-    # Side loading gems rely on NPM and a package.json file in the gem root. This ensures that any
-    # dependencies are resolved correctly. This is required even if your gem has no package
-    # dependencies.
+    # A Rails engine that has assets, can add Proscenium as a gem dependency, and then add itself
+    # to this list. Proscenium will then serve the engine's assets at the URL path beginning with
+    # the engine name.
     #
     # Example:
-    #   config.proscenium.side_load_gems['mygem'] = {
-    #     root: gem_root,
-    #     package_name: 'mygem'
-    #   }
-    config.proscenium.side_load_gems = {}
+    #   class Gem1::Engine < ::Rails::Engine
+    #     config.proscenium.engines << self
+    #   end
+    config.proscenium.engines = Set.new
+
+    config.action_dispatch.rescue_templates = {
+      'Proscenium::Builder::BuildError' => 'build_error'
+    }
 
     initializer 'proscenium.middleware' do |app|
       app.middleware.insert_after ActionDispatch::Static, Middleware
-      app.middleware.insert_after ActionDispatch::Static, Rack::ETag, 'no-cache'
-      app.middleware.insert_after ActionDispatch::Static, Rack::ConditionalGet
+      # app.middleware.insert_after ActionDispatch::Static, Rack::ETag, 'no-cache'
+      # app.middleware.insert_after ActionDispatch::Static, Rack::ConditionalGet
     end
 
-    initializer 'proscenium.monkey_views' do
+    initializer 'proscenium.monkey_patches' do
       ActiveSupport.on_load(:action_view) do
         ActionView::TemplateRenderer.prepend Monkey::TemplateRenderer
         ActionView::PartialRenderer.prepend Monkey::PartialRenderer
@@ -71,3 +69,13 @@ module Proscenium
     end
   end
 end
+
+# Monkey path ActionDispatch::DebugView to use our custom error template on BuildError exceptions.
+class ActionDispatch::DebugView
+  def initialize(assigns)
+    paths = [RESCUES_TEMPLATE_PATH,
+             Proscenium::Railtie.root.join('lib', 'proscenium', 'templates').to_s]
+    lookup_context = ActionView::LookupContext.new(paths)
+    super(lookup_context, assigns, nil)
+  end
+end

data/lib/proscenium/resolver.rb

@@ -11,7 +11,9 @@ module Proscenium
     #
     # @param path [String] Can be URL path, file system path, or bare specifier (ie. NPM package).
     # @return [String] URL path.
-    def self.resolve(path) # rubocop:disable Metrics/AbcSize, Metrics/PerceivedComplexity
+    #
+    # rubocop:disable Metrics/*
+    def self.resolve(path)
       self.resolved ||= {}
 
       self.resolved[path] ||= begin
@@ -21,15 +23,8 @@ module Proscenium
 
         if path.start_with?('@proscenium/')
           "/#{path}"
-        elsif (gem = Proscenium.config.side_load_gems.find do |_, x|
-                 path.start_with? "#{x[:root]}/"
-               end)
-          unless (package_name = gem[1][:package_name] || gem[0])
-            # TODO: manually resolve the path without esbuild
-            raise PathResolutionFailed, path
-          end
-
-          Builder.resolve "#{package_name}/#{path.delete_prefix("#{gem[1][:root]}/")}"
+        elsif (engine = Proscenium.config.engines.find { |e| path.start_with? "#{e.root}/" })
+          path.sub(/^#{engine.root}/, "/#{engine.engine_name}")
         elsif path.start_with?("#{Rails.root}/")
           path.delete_prefix Rails.root.to_s
         else
@@ -37,5 +32,6 @@ module Proscenium
         end
       end
     end
+    # rubocop:enable Metrics/*
   end
 end

data/lib/proscenium/templates/rescues/build_error.html.erb

@@ -0,0 +1,27 @@
+<header>
+  <h1>
+    <%= @exception.class.to_s %>
+  </h1>
+</header>
+
+<main role="main" id="container">
+  <%= render "rescues/message_and_suggestions", exception: @exception %>
+
+  <% if @exception.error['location'] %>
+    <div class="source">
+      <div class="data">
+<pre>
+
+    <%= @exception.error['location']['file'] %>:<%= @exception.error['location']['line'] %>:<%= @exception.error['location']['column'] %>
+
+<%= @exception.error['location']['line'].to_s.rjust 5 %> │    <%= @exception.error['location']['line_text'] %>
+      │    <%= (@exception.error['location']['length'] > 1 ? "~" * @exception.error['location']['length'] : "^").rjust(@exception.error['location']['column'] + @exception.error['location']['length']) %>
+<%- if @exception.error['location']['suggestion'].present? -%>    + │    <%= @exception.error['location']['suggestion'].rjust(@exception.error['location']['column'] + 1) %>
+<% else %> <%- end -%>
+</pre>
+      </div>
+    </div>
+  <% end %>
+
+  <%= render template: "rescues/_request_and_response" %>
+</main>

data/lib/proscenium/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Proscenium
-  VERSION = '0.11.0.pre.7'
+  VERSION = '0.11.0.pre.8'
 end

data/lib/proscenium.rb

@@ -8,7 +8,7 @@ module Proscenium
   FILE_EXTENSIONS = ['js', 'mjs', 'ts', 'jsx', 'tsx', 'css', 'js.map', 'mjs.map', 'jsx.map',
                      'ts.map', 'tsx.map', 'css.map'].freeze
 
-  ALLOWED_DIRECTORIES = %w[app lib config vendor node_modules].freeze
+  ALLOWED_DIRECTORIES = 'app,lib,config,vendor,node_modules'
 
   # Environment variables that should always be passed to the builder.
   DEFAULT_ENV_VARS = Set['RAILS_ENV', 'NODE_ENV'].freeze

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: proscenium
 version: !ruby/object:Gem::Version
-  version: 0.11.0.pre.7
+  version: 0.11.0.pre.8
 platform: x86_64-linux
 authors:
 - Joel Moss
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-09-20 00:00:00.000000000 Z
+date: 2023-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -105,6 +105,7 @@ files:
 - lib/proscenium/log_subscriber.rb
 - lib/proscenium/middleware.rb
 - lib/proscenium/middleware/base.rb
+- lib/proscenium/middleware/engines.rb
 - lib/proscenium/middleware/esbuild.rb
 - lib/proscenium/middleware/runtime.rb
 - lib/proscenium/middleware/url.rb
@@ -118,6 +119,7 @@ files:
 - lib/proscenium/resolver.rb
 - lib/proscenium/side_load.rb
 - lib/proscenium/source_path.rb
+- lib/proscenium/templates/rescues/build_error.html.erb
 - lib/proscenium/utils.rb
 - lib/proscenium/version.rb
 - lib/proscenium/view_component.rb