proscenium 0.1.2-x86_64-linux → 0.2.1-x86_64-linux

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 446ad2f069aa35ab275b66632c447318d4f6b58306e4de6f6812b1b4cd3292b3
-  data.tar.gz: 9e620e076b80ae0bc7613b09743b19eceec98a2e16818d19177e01e77394efe0
+  metadata.gz: 3865fbb2c2e0c606febd498305b5c547f4ed96ff271012f0a0a0069f7178bed0
+  data.tar.gz: 4961bfa53fb5f2e495e7b5d60903fc9898cf61f9c6ac4b7fe1d33fd6e7c028d6
 SHA512:
-  metadata.gz: c933cfec773e60aea31f7262bf16dc22471a6dcbb7ede70d9631ba97652f3723c8c2761872ea5276e99cdfab19481e084a6818857580b85cd905260c6d14e8f4
-  data.tar.gz: 82116ba5093880d9a81080fc90b5611271033c595ea3799b04bb99fc8bf2790d40b517c94b5b8999745b9f93487fb85ed2ac8ea4cbc7f5e7479c800bb2bba051
+  metadata.gz: c270f788bc4f61af038d19ce5250f70bbd3684061cfb2d865a5522c148ca78e713c47506c1813a73e72e11cd37f9c30d471bb04f617bbda14b7d26ded41b1b40
+  data.tar.gz: 894ff8cc3f247356d8cf1983fda1dba591d33fb309aaedc765d30445a2d9eba97608f656c9e4c5fb72c12c81da088e7dd15d2f55685128bdd1cda9966156b80c

data/README.md

@@ -110,6 +110,10 @@ resulting in conflicts. For example, esm.sh also supports a `?bundle` param, bun
 dependencies into a single file. Instead, you should install the module locally using your favourite
 package manager.
 
+Note that `?bundle` will only bundle that exact path. It will not bundle any descendant imports. You
+can bundle all imports within a file by using the `?bundle-all` query string. Use this with caution,
+as you could end up swallowing everything, resulting in a very large file.
+
 ## Import Map
 
 Import map for both JS and CSS is supported out of the box, and works with no regard to the browser
@@ -246,6 +250,31 @@ p {
 }
 ```
 
+## Cache Busting
+
+By default, all assets are not cached by the browser. But if in production, you populate the
+`REVISION` env variable, all CSS and JS URL's will be appended with its value as a query string, and
+the `Cache-Control` response header will be set to `public` and a max-age of 30 days.
+
+For example, if you set `REVISION=v1`, URL's will be appended with `?v1`: `/my/imported/file.js?v1`.
+
+It is assumed that the `REVISION` env var will be unique between deploys. If it isn't, then assets
+will continue to be cached as the same version between deploys. I recommend you assign a version
+number or to use the Git commit hash of the deploy. Just make sure it is unique for each deploy.
+
+You can set the `cache_query_string` config option directly to define any query string you wish:
+
+```ruby
+Rails.application.config.proscenium.cache_query_string = 'my-cache-busting-version-string'
+```
+
+The cache is set with a `max-age` of 30 days. You can customise this with the `cache_max_age` config
+option:
+
+```ruby
+Rails.application.config.proscenium.cache_max_age = 12.months.to_i
+```
+
 ## How It Works
 
 Proscenium provides a Rails middleware that proxies requests for your frontend code. By default, it will simply search for a file of the same name in your Rails root. For example, a request for '/app/views/layouts/application.js' or '/lib/hooks.js' will return that exact file relative to your Rails root.
@@ -258,10 +287,6 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
-### Compile the compilers
-
-`deno compile --no-config -o bin/compilers/esbuild --import-map import_map.json -A lib/proscenium/compilers/esbuild.js`
-
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/joelmoss/proscenium. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/joelmoss/proscenium/blob/master/CODE_OF_CONDUCT.md).

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',
@@ -21,6 +24,8 @@ export default setup('resolve', (build, options) => {
           args.path = path
           args.suffix = `?${query}`
           args.queryParams = new URLSearchParams(query)
+        } else if (options.cacheQueryString && options.cacheQueryString !== '') {
+          args.suffix = `?${options.cacheQueryString}`
         }
 
         // Mark remote modules as external.
@@ -28,24 +33,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 +76,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 +107,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)
     }
@@ -138,6 +135,10 @@ export default setup('resolve', (build, options) => {
       result.external = true
     }
 
+    if (result.suffix && result.suffix !== '') {
+      result.path = `${result.path}${result.suffix}`
+    }
+
     return result
   }
 })

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

@@ -3,11 +3,12 @@ import { join } from 'std/path/mod.ts'
 import compile from './esbuild.js'
 
 const root = join(Deno.cwd(), 'test', 'internal')
+const lightningcssBin = join(Deno.cwd(), 'bin', 'lightningcss')
 
 Deno.bench('esbuild js', async () => {
-  await compile(['lib/foo.js'], { root })
+  await compile(['lib/foo.js'], { root, lightningcssBin })
 })
 
 Deno.bench('esbuild css', async () => {
-  await compile(['lib/foo.css'], { root })
+  await compile(['lib/foo.css'], { root, lightningcssBin })
 })

data/lib/proscenium/compilers/esbuild.js

@@ -23,18 +23,20 @@ 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
+ *   --root <PATH>
  *       Relative or absolute path to the root or current working directory when compilation will
  *       take place.
- *   --import-map
+ *   --import-map <PATH>
  *       Path to an import map, relative to the <root>.
- *   --lightningcss-bin
+ *   --lightningcss-bin <PATH>
  *       Path to the lightningcss CLI binary.
  *   --write
  *       Write output to the filesystem according to esbuild logic.
+ *   --cache-query-string <STRING>
+ *       Query string to append to all imports as a cache buster. Example: `v1`.
  *   --debug
  *       Debug output,
  */
@@ -42,10 +44,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', 'lightningcss-bin'],
+    string: ['root', 'import-map', 'lightningcss-bin', 'cache-query-string'],
     boolean: ['write', 'debug'],
     alias: {
       'import-map': 'importMap',
+      'cache-query-string': 'cacheQueryString',
       'lightningcss-bin': 'lightningcssBin'
     }
   })
@@ -80,8 +83,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]
 
@@ -89,6 +92,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))
     }
@@ -123,7 +130,7 @@ async function main(paths = [], options = {}) {
     bundle: true,
     plugins: [
       envPlugin(),
-      resolvePlugin({ runtimeDir, importMap, debug }),
+      resolvePlugin({ runtimeDir, importMap, debug, cacheQueryString: options.cacheQueryString }),
       cssPlugin({ lightningcssBin: options.lightningcssBin, debug })
     ],
     metafile: 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 && Proscenium.config.cache_max_age
+          response['Cache-Control'] = "public, max-age=#{Proscenium.config.cache_max_age}"
+        end
+
         yield response if block_given?
 
         response.finish

data/lib/proscenium/middleware/esbuild.rb

@@ -15,9 +15,11 @@ module Proscenium
 
       def attempt
         benchmark :esbuild do
-          render_response build(
-            "#{cli} --root #{root} --lightningcss-bin #{lightningcss_cli} #{path}"
-          )
+          render_response build([
+            "#{cli} --root #{root}",
+            cache_query_string,
+            "--lightningcss-bin #{lightningcss_cli} #{path}"
+          ].compact.join(' '))
         end
       rescue CompileError => e
         render_response "export default #{e.detail.to_json}" do |response|
@@ -33,9 +35,7 @@ module Proscenium
 
       def cli
         if ENV['PROSCENIUM_TEST']
-          [
-            'deno run -q --import-map import_map.json -A', 'lib/proscenium/compilers/esbuild.js'
-          ].join(' ')
+          'deno run -q --import-map import_map.json -A lib/proscenium/compilers/esbuild.js'
         else
           Gem.bin_path 'proscenium', 'esbuild'
         end
@@ -48,6 +48,11 @@ module Proscenium
           Gem.bin_path 'proscenium', 'lightningcss'
         end
       end
+
+      def cache_query_string
+        q = Proscenium.config.cache_query_string
+        q ? "--cache-query-string #{q}" : nil
+      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,8 @@ 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.cache_max_age = 2_592_000 # 30 days
     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/runtime/auto_reload.js

@@ -1,5 +1,4 @@
-import { createConsumer } from 'https://esm.sh/@rails/actioncable@6.0.5'
-import debounce from 'https://esm.sh/debounce@1.2.1'
+import { createConsumer } from 'https://esm.sh/v96/@rails/actioncable@7.0.4/es2022/actioncable.js'
 
 export default socketPath => {
   const uid = (Date.now() + ((Math.random() * 100) | 0)).toString()
@@ -9,7 +8,7 @@ export default socketPath => {
     received: debounce(() => {
       console.log('[Proscenium] Files changed; reloading...')
       location.reload()
-    }, 200),
+    }, 200, true),
 
     connected() {
       console.log('[Proscenium] Auto-reload websocket connected')
@@ -20,3 +19,22 @@ export default socketPath => {
     }
   })
 }
+
+function debounce(func, wait, immediate) {
+  let timeout
+
+  return function () {
+    const args = arguments
+
+    const later = () => {
+      timeout = null
+      !immediate && func.apply(this, args)
+    }
+
+    const callNow = immediate && !timeout
+    clearTimeout(timeout)
+    timeout = setTimeout(later, wait)
+
+    callNow && func.apply(this, args)
+  }
+}

data/lib/proscenium/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: proscenium
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.1
 platform: x86_64-linux
 authors:
 - Joel Moss
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-10-16 00:00:00.000000000 Z
+date: 2022-10-20 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