proscenium 0.1.1-x86_64-darwin → 0.2.0-x86_64-darwin

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 82bdc1e3df5b94c577cdd159809c14e40f1222ea4ac95cf5a71edda446e7b7c1
-  data.tar.gz: e93f0dfbdefbfab76434394ccea87ece4fdda8d24c9d0e130e2260268607a1fb
+  metadata.gz: 3e3fd0fe04d0ad74e9c8a799d0f5e7a211f36754e502ae2dead2d87d84153594
+  data.tar.gz: 777c4b1a144554766f1397f72492182ec307c386e7ed0f1fadac5b0891a58907
 SHA512:
-  metadata.gz: 5eda3a1219261bfa360f2934c1a16bf1c2b2829702fe8bc60cdecb27bf409b1d111400b646a9b45a71ec024a11a55facf1db4a8eef4bfa3cbb4d052a7972e6bb
-  data.tar.gz: 8f12932f6f6ca57437f273e7c95d765175ffcac0d8dd569b9570f0d7ca642ba8915f3f3264835eea5c1d0fc8176bc669a8bc9f1ae0bde466dc35220320a6d008
+  metadata.gz: aa754d0f16d6e20158b9ed6d9140f87c6212f81c3fb9a4ab6b075cf33e2ba4dcdd5e5f984eb4dc0cd2506aa1dcfdf6b89c701a9258b3932bc6abe78c63619c33
+  data.tar.gz: b549656184b70c8c5a0b783f39425b1213f14efe24e2e0132dd10d63ad591b843c39b233497f7ba019348992158594112f4bebfbbcdda7ef27c32730406cac87

data/lib/proscenium/compilers/esbuild/argument_error.js

@@ -1,6 +1,8 @@
 export default class ArgumentError extends Error {
   static MESSAGES = {
     rootRequired: 'Current working directory is required as --root.',
+    lightningcssBinRequired:
+      'Path to the lightningcss CLI binary is required as --lightningcss-bin.',
     pathsRequired: 'One or more file paths or globs are required.',
 
     rootUnknown: ({ root }) => `A valid working directory is required - received ${root}`

data/lib/proscenium/compilers/esbuild/css_plugin.js

@@ -1,16 +1,12 @@
 import { crypto } from 'std/crypto/mod.ts'
-import { join, resolve, dirname, basename, fromFileUrl } from 'std/path/mod.ts'
+import { join, dirname, basename } from 'std/path/mod.ts'
 
 import { fileExists } from '../../utils.js'
 import postcss from './css/postcss.js'
 import setup from './setup_plugin.js'
 
-export default setup('css', async build => {
+export default setup('css', async (build, options) => {
   const cwd = build.initialOptions.absWorkingDir
-  const lightningcssBin = resolve(
-    dirname(fromFileUrl(import.meta.url)),
-    '../../../../bin/lightningcss'
-  )
 
   let customMedia
   try {
@@ -40,7 +36,7 @@ export default setup('css', async build => {
         }
 
         let cmd = [
-          lightningcssBin,
+          options.lightningcssBin,
           '--nesting',
           '--error-recovery',
           args.pluginData?.importedFromJs && '--minify',

data/lib/proscenium/compilers/esbuild/resolve_plugin.js

@@ -11,6 +11,9 @@ export default setup('resolve', (build, options) => {
   const runtimeCwdAlias = `${cwd}/proscenium-runtime`
   let bundled = false
 
+  const env = Deno.env.get('RAILS_ENV')
+  const isProd = env === 'production'
+
   return [
     {
       type: 'onResolve',
@@ -28,24 +31,7 @@ export default setup('resolve', (build, options) => {
           return { external: true }
         }
 
-        // Proscenium runtime
-        // if (args.path.startsWith('@proscenium/')) {
-        //   const result = { suffix: args.suffix }
-
-        //   if (args.queryParams?.has('bundle-all')) {
-        //     bundled = true
-        //   }
-
-        //   if (bundled || args.queryParams?.has('bundle')) {
-        //     result.path = join(runtimeDir, `${args.path.replace(/^@proscenium/, '')}/index.js`)
-        //   } else {
-        //     result.path = `${args.path.replace(/^@proscenium/, '/proscenium-runtime')}/index.js`
-        //     result.external = true
-        //   }
-
-        //   return result
-        // }
-
+        // Rewrite the path to the actual runtime directory.
         if (args.path.startsWith(runtimeCwdAlias)) {
           return { path: join(runtimeDir, args.path.slice(runtimeCwdAlias.length)) }
         }
@@ -88,11 +74,12 @@ export default setup('resolve', (build, options) => {
     // Resolve the path using esbuild's internal resolution. This allows us to import node packages
     // and extension-less paths without custom code, as esbuild with resolve them for us.
     const resolveResult = await build.resolve(result.path, {
-      // If path is a bare module (node_modules), and resolveDir is the Proscenium runtime dir, then
-      // use `cwd` as the `resolveDir`, otherwise pass it through as is. This ensures that nested
-      // node_modules are resolved correctly.
+      // If path is a bare module (node_modules), and resolveDir is the Proscenium runtime dir, or
+      // is the current working dir, then use `cwd` as the `resolveDir`, otherwise pass it through
+      // as is. This ensures that nested node_modules are resolved correctly.
       resolveDir:
-        isBareModule(result.path) && params.resolveDir.startsWith(runtimeDir)
+        isBareModule(result.path) &&
+        (!params.resolveDir.startsWith(cwd) || params.resolveDir.startsWith(runtimeDir))
           ? cwd
           : params.resolveDir,
       pluginData: {
@@ -118,9 +105,17 @@ export default setup('resolve', (build, options) => {
 
     if (resolveResult.path.startsWith(runtimeDir)) {
       result.path = '/proscenium-runtime' + resolveResult.path.slice(runtimeDir.length)
-    } else if (!resolveResult.path.startsWith(cwd)) {
-      // If resolved path does not start with cwd, then it is most likely linked, so bundle it.
-      return { ...resolveResult, suffix: '?bundle' }
+    } else if (!resolveResult.path.startsWith(cwd) && !isProd) {
+      // Resolved path is not in the current working directory. It could be linked to a file outside
+      // the CWD, or it's just invalid. If not in production, return as an outsideRoot namespaced,
+      // and externally suffixed path. This lets the Rails Proscenium::Middleware::OutsideRoot
+      // handle the import.
+      return {
+        ...resolveResult,
+        namespace: 'outsideRoot',
+        path: `${resolveResult.path}?outsideRoot`,
+        external: true
+      }
     } else {
       result.path = resolveResult.path.slice(cwd.length)
     }

data/lib/proscenium/compilers/esbuild.js

@@ -23,7 +23,7 @@ import throwCompileError from './esbuild/compile_error.js'
  *   esbuild [OPTIONS] <PATHS_ARG>...
  *
  * ARGS:
- *   <PATHS_ARG>...    One or more file paths to compile.
+ *   <PATHS_ARG>... One or more file paths or globs to compile.
  *
  * OPTIONS:
  *   --root
@@ -31,6 +31,8 @@ import throwCompileError from './esbuild/compile_error.js'
  *       take place.
  *   --import-map
  *       Path to an import map, relative to the <root>.
+ *   --lightningcss-bin
+ *       Path to the lightningcss CLI binary.
  *   --write
  *       Write output to the filesystem according to esbuild logic.
  *   --debug
@@ -40,10 +42,11 @@ if (import.meta.main) {
   !Deno.env.get('RAILS_ENV') && Deno.env.set('RAILS_ENV', 'development')
 
   const { _: paths, ...options } = parseArgs(Deno.args, {
-    string: ['root', 'import-map'],
+    string: ['root', 'import-map', 'lightningcss-bin'],
     boolean: ['write', 'debug'],
     alias: {
-      'import-map': 'importMap'
+      'import-map': 'importMap',
+      'lightningcss-bin': 'lightningcssBin'
     }
   })
 
@@ -62,6 +65,7 @@ async function main(paths = [], options = {}) {
 
   if (!Array.isArray(paths) || paths.length < 1) throw new ArgumentError('pathsRequired')
   if (!options.root) throw new ArgumentError('rootRequired')
+  if (!options.lightningcssBin) throw new ArgumentError('lightningcssBinRequired')
 
   const root = resolve(options.root)
 
@@ -76,8 +80,8 @@ async function main(paths = [], options = {}) {
   const env = Deno.env.get('RAILS_ENV')
   const isProd = env === 'production'
   const isTest = env === 'test'
-
   const entryPoints = new Set()
+
   for (let i = 0; i < paths.length; i++) {
     const path = paths[i]
 
@@ -85,6 +89,10 @@ async function main(paths = [], options = {}) {
       for await (const file of expandGlob(path, { root })) {
         file.isFile && entryPoints.add(file.path)
       }
+    } else if (path.startsWith('/')) {
+      // Path is absolute, so it must be outsideRoot. Don't prefix the root.
+      // See Proscenium::Middleware::OutsideRoot.
+      entryPoints.add(path)
     } else {
       entryPoints.add(join(root, path))
     }
@@ -117,7 +125,11 @@ async function main(paths = [], options = {}) {
     jsxDev: !isTest && !isProd,
     minify: isProd,
     bundle: true,
-    plugins: [envPlugin(), resolvePlugin({ runtimeDir, importMap, debug }), cssPlugin({ debug })],
+    plugins: [
+      envPlugin(),
+      resolvePlugin({ runtimeDir, importMap, debug }),
+      cssPlugin({ lightningcssBin: options.lightningcssBin, debug })
+    ],
     metafile: write,
     write
   }

data/lib/proscenium/helper.rb

@@ -3,7 +3,15 @@
 module Proscenium
   module Helper
     def compute_asset_path(path, options = {})
-      return "/#{path}" if %i[javascript stylesheet].include?(options[:type])
+      if %i[javascript stylesheet].include?(options[:type])
+        result = "/#{path}"
+
+        if (qs = Proscenium.config.cache_query_string)
+          result << "?#{qs}"
+        end
+
+        return result
+      end
 
       super
     end

data/lib/proscenium/middleware/base.rb

@@ -60,6 +60,10 @@ module Proscenium
         response.content_type = content_type
         response['X-Proscenium-Middleware'] = name
 
+        if Proscenium.config.cache_query_string
+          response['Cache-Control'] = "public, max-age=#{2.days.to_i}"
+        end
+
         yield response if block_given?
 
         response.finish

data/lib/proscenium/middleware/esbuild.rb

@@ -15,7 +15,9 @@ module Proscenium
 
       def attempt
         benchmark :esbuild do
-          render_response build("#{cli} --root #{root} #{path}")
+          render_response build(
+            "#{cli} --root #{root} --lightningcss-bin #{lightningcss_cli} #{path}"
+          )
         end
       rescue CompileError => e
         render_response "export default #{e.detail.to_json}" do |response|
@@ -38,6 +40,14 @@ module Proscenium
           Gem.bin_path 'proscenium', 'esbuild'
         end
       end
+
+      def lightningcss_cli
+        if ENV['PROSCENIUM_TEST']
+          'bin/lightningcss'
+        else
+          Gem.bin_path 'proscenium', 'lightningcss'
+        end
+      end
     end
   end
 end

data/lib/proscenium/middleware/outside_root.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Proscenium
+  class Middleware
+    # Provides a way to render files outside of the Rails root during non-production. This is
+    # primarily to support linked NPM modules, for example when using `pnpm link ...`.
+    class OutsideRoot < Esbuild
+      private
+
+      # @override [Esbuild] reassigns root to '/'.
+      def renderable?
+        old_root = root
+        @root = Pathname.new('/')
+
+        super
+      ensure
+        @root = old_root
+      end
+
+      # @override [Esbuild] does not remove leading slash, ensuring it is an absolute path.
+      def path
+        @request.path
+      end
+    end
+  end
+end

data/lib/proscenium/middleware.rb

@@ -10,6 +10,7 @@ module Proscenium
     autoload :Base
     autoload :Esbuild
     autoload :Runtime
+    autoload :OutsideRoot
 
     def initialize(app)
       @app = app
@@ -38,6 +39,12 @@ module Proscenium
     def find_type(request)
       path = Pathname.new(request.path)
 
+      # Non-production only!
+      if request.query_string == 'outsideRoot'
+        return if Rails.env.production?
+        return OutsideRoot if path.fnmatch?(glob_types[:outsideRoot], File::FNM_EXTGLOB)
+      end
+
       return Runtime if path.fnmatch?(glob_types[:runtime], File::FNM_EXTGLOB)
       return Esbuild if path.fnmatch?(glob_types[:esbuild], File::FNM_EXTGLOB)
     end

data/lib/proscenium/railtie.rb

@@ -13,7 +13,8 @@ module Proscenium
   # See https://doc.deno.land/https://deno.land/std@0.145.0/path/mod.ts/~/globToRegExp
   DEFAULT_GLOB_TYPES = {
     esbuild: '/{config,app,lib,node_modules}/**.{js,mjs,jsx,css}',
-    runtime: '/proscenium-runtime/**.{js,jsx}'
+    runtime: '/proscenium-runtime/**.{js,jsx}',
+    outsideRoot: '/**/*.{js,jsx,mjs,css}'
   }.freeze
 
   class << self
@@ -27,6 +28,7 @@ module Proscenium
 
     config.proscenium = ActiveSupport::OrderedOptions.new
     config.proscenium.side_load = true
+    config.proscenium.cache_query_string = Rails.env.production? && ENV.fetch('REVISION', nil)
     config.proscenium.auto_reload = Rails.env.development?
     config.proscenium.auto_reload_paths ||= %w[lib app config]
     config.proscenium.auto_reload_extensions ||= /\.(css|jsx?)$/

data/lib/proscenium/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Proscenium
-  VERSION = '0.1.1'
+  VERSION = '0.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: proscenium
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: x86_64-darwin
 authors:
 - Joel Moss
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-10-16 00:00:00.000000000 Z
+date: 2022-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actioncable
@@ -167,6 +167,7 @@ files:
 - lib/proscenium/middleware/base.rb
 - lib/proscenium/middleware/esbuild.rb
 - lib/proscenium/middleware/lightningcss.rb
+- lib/proscenium/middleware/outside_root.rb
 - lib/proscenium/middleware/runtime.rb
 - lib/proscenium/middleware/static.rb
 - lib/proscenium/phlex.rb