webpacker-remote 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 635f4710cb86e3d78d8ae1da64807ae12f0bf97e7e3b476fb87a58098c9370f5
-  data.tar.gz: 0aa52bce7bfcf825119c82aa1cc215274c929fe3572c8e4e54523555693504ec
+  metadata.gz: 475ff81ecaa533d711986b6b21c70ef0e3e26b3b9934168bacba2bc27f64025e
+  data.tar.gz: c0b2f5706cc157d3d082435a38887c870f07e90a8228fca224e5b4d043b4ebd2
 SHA512:
-  metadata.gz: 823dab789035d9160449e109532bac324ee377ed8afd8caea5d4a72395d625cc1826902d2554ac5f7ee8930f3232d759f0276b79e7b703ba033bd62b439fb34e
-  data.tar.gz: 799fc8946cdc5a09b83ebe58ec6f7a244041b3e9607a0a33436feb1755fe0a3db7e3ae32ba0c00c2c6029023568e0b960f1ec5d6b75305e108691b321539afea
+  metadata.gz: 96e16850f5db27b9e12bba5877b29bab23cf617d409b6da98b37431b3b137af973ee3559f1593070c62cdf130d672bafea72ac24b72034622fbb851b3a287963
+  data.tar.gz: 2574263c55709fb4890190f57255572be16ba4887729be0c5ee1fcbe3e905092ac935f936d8eb3ff975d8193c0d4f895506dca2f500de02fe5f69b5aef826081

data/.github/workflows/branch.yml

@@ -8,8 +8,8 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby: [ '2.7' ]
-        webpacker: [ '4.3.0', '5.2.1' ]
+        ruby: [ '2.7', '3.0', '3.1' ]
+        webpacker: [ 'webpacker|~> 4.3', 'webpacker|~> 5.4', 'shakapacker|~> 6.2' ]
     name: Ruby ${{ matrix.ruby }}, Webpacker ${{ matrix.webpacker }}
     steps:
       - uses: actions/checkout@v2

data/.github/workflows/ci.yml

@@ -13,8 +13,8 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby: [ '2.7' ]
-        webpacker: [ '4.3.0', '5.2.1' ]
+        ruby: [ '2.7', '3.0', '3.1' ]
+        webpacker: [ 'webpacker|~> 4.3', 'webpacker|~> 5.4', 'shakapacker|~> 6.2' ]
     name: Ruby ${{ matrix.ruby }}, Webpacker ${{ matrix.webpacker }}
     steps:
       - uses: actions/checkout@v2

data/.gitignore

@@ -5,3 +5,4 @@ Gemfile.lock
 bin
 coverage/
 *gem
+.DS_Store

data/.rubocop.yml

@@ -16,5 +16,20 @@ Metrics/BlockLength:
 Style/Documentation:
   Enabled: false
 
+Gemspec/RequireMFA:
+  Enabled: false
+
+Style/OpenStructUse:
+  Enabled: false
+
+Gemspec/RequiredRubyVersion:
+  Enabled: false
+
+Style/MutableConstant:
+  Enabled: false
+
+Style/HashSyntax:
+  EnforcedShorthandSyntax: never
+
 Style/ClassAndModuleChildren:
   EnforcedStyle: compact

data/Gemfile

@@ -14,6 +14,10 @@ gem 'rubocop-performance', '~> 1.9.2'
 gem 'rubocop-rake', '~> 0.5.1'
 gem 'rubocop-rspec', '~> 2.1.0'
 
+# webpacker-4.3.0 default webpacker yml config
+# incompatible with ruby-3.1 (comes with psych-4)
+gem 'psych', '< 4'
+
 group :development do
   gem 'benchmark-ips', require: false
   gem 'pry-byebug', '~> 3.9'

data/README.md

@@ -6,23 +6,30 @@
 
 - support for `create-react-app` developed in a separate repo
 - support for multiple external frontend builds, right now `webpacker` is [a singleton](https://github.com/rails/webpacker/blob/6ba995aed2b609a27e4e35ec28b2a7f688cce0cf/lib/webpacker/helper.rb#L5L7)
+- support [shakapacker](https://github.com/shakacode/shakapacker)
+- support for both webpack-asset-manifest-3 and webpack-asset-manifest-5 (including `assets` and without this key)
 
 ## Usage
 
+- ensure you're using `webpack-asset-manifest` to generate proper manifest structure
 - build `webpack` bundle & upload `build` directory (incl. `manifest.json`) before deploy
 - in `config/initializers/remote_webpacker.rb`
 
 ```rb
+# given we can fetch `https://asset_host/build/manifest.json`
+# and it contains paths relative to `https://asset_host/build/`
 REMOTE_WEBPACKER = Webpacker::Remote.new(root_path: 'https://asset_host/build/', config_path: 'manifest.json')
 ```
 
 - in `app/views/layouts/application.html.erb` (**not** `javascript_pack_tag`)
 
 ```rb
-<%= javascript_packs_with_chunks_tag 'main', webpacker: REMOTE_WEBPACKER %>
+<%= javascript_pack_tag 'main', webpacker: REMOTE_WEBPACKER %>
 #=> <script src='https://asset_host/build/static/js/main.2e302672.chunk.js'>
 ```
 
+**NOTE** if you're on `webpacker` (not `shakapacker`), then you should use `javascript_packs_with_chunks_tag`
+
 Of course, you can use as many build as you like and do blue-green deployments using gems like `rollout`
 
 ## CRA Requirements
@@ -33,8 +40,8 @@ For `create-react-app` you should use `webpack-assets-manifest` instead of built
 
 ```diff
 +    "customize-cra": "^1.0.0",
-+    "react-app-rewired": "^2.1.8"
-+    "webpack-assets-manifest": "^3.1.1"
++    "react-app-rewired": "^2.2.1"
++    "webpack-assets-manifest": "^5.1.0"
 ...
 -    "build": "react-scripts build"
 +    "build": "react-app-rewired build"
@@ -79,26 +86,26 @@ module.exports = override(
 {
   "entrypoints": {
     "main": {
-      "js": [
-        "static/js/runtime-main...js",
-        "static/js/2...chunk.js",
-        "static/js/main...chunk.js"
-      ],
-      "js.map": [
-        "static/js/runtime-main...js.map",
-        "static/js/2...chunk.js.map",
-        "static/js/main...chunk.js.map"
-      ],
-      "css": [
-        "static/css/2...chunk.css",
-        "static/css/main...chunk.css"
-      ]
+      "assets": {
+        "js": [
+          "static/js/main.hashsum.js"
+        ],
+        "css": [
+          "static/css/main.hashsum.css"
+        ]
+      }
     }
   },
-  "main.css": "static/css/main...chunk.css",
-  "main.js": "static/js/main...chunk.js",
-  "main.js.map": "static/js/main...chunk.js.map",
-  "runtime-main.js": "static/js/runtime-main...js",
-  "runtime-main.js.map": "static/js/runtime-main...js.map"
+  "main.css": "static/css/main.hashsum.css",
+  "main.js": "static/js/main.hashsum.js"
 }
+```
+
+## Tests
+
+Specify webpacker gem explicitly:
+
+```sh
+WEBPACKER_GEM_VERSION='shakapacker|6.2.1' bundle exec rspec
+WEBPACKER_GEM_VERSION='webpacker|5.4.3' bundle exec rspec
 ```

data/lib/webpacker/remote/configuration.rb

@@ -3,11 +3,34 @@
 require 'webpacker/configuration'
 
 class Webpacker::Remote::Configuration < Webpacker::Configuration
+  # rubocop:disable Lint/MissingSuper
+  def initialize(root_path:, config_path:, env:, **config_content)
+    # deliberately not calling `super` just emulating what's done there
+    # because we accept overloading to DI the content of `webpacker.yml` inline
+    @root_path = root_path
+    @config_path = config_path
+    @env = env
+
+    # addition
+    @config_content = config_content
+  end
+  # rubocop:enable Lint/MissingSuper
+
   def load
     {
       cache_manifest: true,
       check_yarn_integrity: false,
       compile: false
-    }
+    }.merge(@config_content)
+  end
+
+  # shakapacker error message
+  def manifest_path
+    File.join(root_path.to_s, config_path.to_s)
+  end
+
+  # webpacker error message
+  def public_manifest_path
+    manifest_path
   end
 end

data/lib/webpacker/remote/helper.rb

@@ -3,6 +3,7 @@
 # better version of https://github.com/rails/webpacker/issues/2054#issuecomment-564173103
 # rewrite all methods by accept direct injection instead of calling `current_webpacker_instance`
 # because we can have same layout with script/link tags from different webpackers
+require 'webpacker/helper'
 module Webpacker::Remote::Helper
   METHODS = %i[
     javascript_pack_tag
@@ -11,7 +12,7 @@ module Webpacker::Remote::Helper
     stylesheet_packs_with_chunks_tag
   ].freeze
 
-  METHODS.each do |meth|
+  METHODS.select { |meth| ::Webpacker::Helper.instance_methods.include?(meth) }.each do |meth|
     define_method meth do |*names, **options|
       return super(*names, **options) unless options[:webpacker]
 
@@ -24,7 +25,4 @@ module Webpacker::Remote::Helper
   end
 end
 
-unless ENV['SKIP_WEBPACKER_HELPER_OVERRIDE']
-  require 'webpacker/helper'
-  Webpacker::Helper.prepend Webpacker::Remote::Helper
-end
+Webpacker::Helper.prepend Webpacker::Remote::Helper unless ENV['SKIP_WEBPACKER_HELPER_OVERRIDE']

data/lib/webpacker/remote/manifest.rb

@@ -4,13 +4,49 @@ require 'webpacker/manifest'
 
 class Webpacker::Remote::Manifest < Webpacker::Manifest
   def load
-    @webpacker.public_manifest_content
+    # load from network, upstream version operates pathnames:
+    # if config.manifest_path.exist?
+    #   JSON.parse config.manifest_path.read
+    # else
+    #   {}
+    # end
+    if public_manifest_content_uri
+      public_manifest_content
+    else
+      {}
+    end
+  end
+
+  def public_manifest_content
+    JSON.parse(Net::HTTP.get_response(public_manifest_content_uri).body)
+  rescue JSON::ParserError, Errno::ECONNREFUSED, Net::OpenTimeout, Net::ReadTimeout, Errno::ENOENT => e
+    raise Webpacker::Remote::Error, <<~MSG
+      having {root_path: #{config.root_path.inspect}, config_path: #{config.config_path.inspect}}
+      #{e.class}: #{e.message}
+    MSG
   end
 
   def lookup_pack_with_chunks(name, pack_type = {})
-    return unless (paths = super)
+    # `super` method copy
+    manifest_pack_type = manifest_type(pack_type[:type])
+    manifest_pack_name = manifest_name(name, manifest_pack_type)
+    assets = find('entrypoints')[manifest_pack_name]
+    # patched super behavior:
+    # - keys in webpack-assets-manifest-3: entrypoints.main.{js/css}
+    # - keys in webpack-assets-manifest-5: entrypoints.main.assets.{js/css}
+    # `shakapacker` just has this inline:
+    # find("entrypoints")[manifest_pack_name]["assets"][manifest_pack_type]
+    assets = assets['assets'] if assets.key?('assets')
+    paths = assets[manifest_pack_type]
+    # end of `super` method copy
 
+    # remote-webpacker addition: full URIs
+    # railsy webpacker returns relative paths from its manifest
+    # because `action_view` resolves them using `config.action_controller.asset_host`
+    # but remote-webpacker tuned to have bundles from several locations
     paths.map { |p| File.join(config.root_path.to_s, p) }
+  rescue NoMethodError
+    nil
   end
 
   def lookup(name, pack_type = {})
@@ -18,4 +54,18 @@ class Webpacker::Remote::Manifest < Webpacker::Manifest
 
     File.join(config.root_path.to_s, path)
   end
+
+  # additional api to be able to put additional data into the manifest
+  # because `find` and `data` are private
+  def manifest_data
+    data
+  end
+
+  private
+
+  def public_manifest_content_uri
+    URI.parse(File.join(config.root_path.to_s, config.config_path.to_s))
+  rescue URI::InvalidURIError
+    nil
+  end
 end

data/lib/webpacker/remote.rb

@@ -14,21 +14,18 @@ class Webpacker::Remote < Webpacker::Instance
 
   class Error < StandardError; end
 
-  attr_reader :public_manifest_content
-
-  # fetch early, fail fast
   # rubocop:disable Lint/MissingSuper
-  def initialize(root_path: nil, config_path: nil)
-    uri = File.join(root_path.to_s, config_path.to_s)
-    @public_manifest_content = JSON.parse(self.class.get_http_response(uri))
+  def initialize(root_path: nil, config_path: nil, **config_content)
     # deliberately not calling `super` just emulating what's done there
+    # otherwise defaults in super initialize would call `Rails`
+    # let's unbind the gem from rails
     @config_path = config_path
     @root_path = root_path
-  rescue StandardError => e
-    raise Error, <<~MSG
-      having {root_path: #{root_path.inspect}, config_path: #{config_path.inspect}}
-      #{e.class}: #{e.message}
-    MSG
+
+    # additions
+    @config_content = config_content.symbolize_keys
+    # fetch manifest eagerly to fail fast in initiazer unless cache_manifest: false
+    manifest.manifest_data if @config_content.fetch(:cache_manifest, true)
   end
   # rubocop:enable Lint/MissingSuper
 
@@ -40,7 +37,7 @@ class Webpacker::Remote < Webpacker::Instance
     @config ||= Webpacker::Remote::Configuration.new(
       root_path: root_path,
       config_path: config_path,
-      env: env
+      **config_content
     )
   end
 
@@ -49,7 +46,9 @@ class Webpacker::Remote < Webpacker::Instance
     'production'
   end
 
-  def self.get_http_response(uri)
-    Net::HTTP.get_response(URI.parse(uri)).body
+  private
+
+  def config_content
+    { env: env }.merge(@config_content)
   end
 end

data/webpacker-remote.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name          = 'webpacker-remote'
-  spec.version       = '0.2.0'
+  spec.version       = '0.3.0'
   spec.authors       = ['Vlad Bokov']
   spec.email         = ['vlad@lunatic.cat']
   spec.license       = 'MIT'
@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.summary       = 'Inject external webpack builds into Rails'
   spec.description   = 'Use your webpack builds independently'
   spec.homepage      = 'https://github.com/lunatic-cat/webpacker-remote'
-  spec.required_ruby_version = Gem::Requirement.new('>= 2.4.0')
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.7.0')
 
   spec.metadata['homepage_uri'] = spec.homepage
   spec.metadata['source_code_uri'] = 'https://github.com/lunatic-cat/webpacker-remote'
@@ -20,8 +20,11 @@ Gem::Specification.new do |spec|
   end
   spec.require_paths = ['lib']
 
-  spec.add_dependency('webpacker', ENV.fetch('WEBPACKER_GEM_VERSION', '< 6'))
-
+  spec.post_install_message = %(
+    This gem is compatible with both `webpacker` and `shakapacker` but has no dependency on any.
+    Specify correct one by yourself
+  )
+  spec.add_development_dependency(*ENV.fetch('WEBPACKER_GEM_VERSION', 'shakapacker|~> 6.2').split('|'))
   spec.add_development_dependency('rspec', '~> 3.0')
   spec.add_development_dependency('simplecov', '~> 0.19')
 end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: webpacker-remote
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Vlad Bokov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-01-30 00:00:00.000000000 Z
+date: 2022-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: webpacker
+  name: shakapacker
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '6'
-  type: :runtime
+        version: '6.2'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '6'
+        version: '6.2'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -78,7 +78,8 @@ licenses:
 metadata:
   homepage_uri: https://github.com/lunatic-cat/webpacker-remote
   source_code_uri: https://github.com/lunatic-cat/webpacker-remote
-post_install_message:
+post_install_message: "\n    This gem is compatible with both `webpacker` and `shakapacker`
+  but has no dependency on any.\n    Specify correct one by yourself\n  "
 rdoc_options: []
 require_paths:
 - lib
@@ -86,14 +87,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Inject external webpack builds into Rails