shakapacker 8.0.0.rc.3 → 8.0.0.rc.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e72a54f983e2119580919efc77ce450a4ffb2f7978732baf3d5867a77ad50bc7
-  data.tar.gz: 9ffa35b16d167fde5a0a8dbf68744dd7017461c91f7aedf405e1372d40614aaf
+  metadata.gz: b80f21f0131e58e60f67a6f091e573f22b3d7c72b3699b4b7aee547635292189
+  data.tar.gz: 45d54a9d54a72207ba2e83f9bc04a0214d6c0af98974710a42eee99faf4c74e1
 SHA512:
-  metadata.gz: 69fcfa1c1d2cf18918faff7db4c1a9a116a887425629ec4f69e8dc162a4008e99661b058af8e88ae7560b9c684b9494ef047072162e600a00136d0740721767a
-  data.tar.gz: 81448d6f15ccc851c0c56cf6d7be04b205e02c87dcb489d3ab25a5db7886f999949508c907d10d08e13d732a9c0ec35179ab9cf375af74fe3cefebc4abd2f8c6
+  metadata.gz: 256858b1e4735261071074a563fe1aa6638181ed0e7716076ba9381776044aaa4e86bf94f9bfad6e8d49d9621ab7044817d27a3ca4480049ffd56bf0a817ce6e
+  data.tar.gz: 0dceb48507cf9b28ff44d980cda954d117a152021f2f8751984b32a650b0be894bbfb43fff9025e26c2a4bc1f43cd718e86dfc818d4915da0f779126697a9067

data/CHANGELOG.md

@@ -10,6 +10,17 @@ _next_ branch is for v8 changes
 ## [Unreleased]
 Changes since the last non-beta release.
 
+### Breaking changes
+- Removes CDN url from the manifest.json paths. [PR 473](https://github.com/shakacode/shakapacker/pull/473) by [tomdracz](https://github.com/tomdracz).
+
+  This returns to the Webpacker behaviour prior to the aborted Webpacker v6.
+
+### Fixed
+
+- Fixes incorrect removal of files in the assets:clean task [PR 474](https://github.com/shakacode/shakapacker/pull/474) by [tomdracz](https://github.com/tomdracz).
+
+## [v8.0.0.rc.3] - May 9, 2024
+
 ### Fixed
 
 - Support v9 PNPM lockfiles [PR 472](https://github.com/shakacode/shakapacker/pull/472) by [G-Rath](https://github.com/g-rath).
@@ -359,7 +370,8 @@ Note: [Rubygem is 6.3.0.pre.rc.1](https://rubygems.org/gems/shakapacker/versions
 ## v5.4.3 and prior changes from rails/webpacker
 See [CHANGELOG.md in rails/webpacker (up to v5.4.3)](https://github.com/rails/webpacker/blob/master/CHANGELOG.md)
 
-[Unreleased]: https://github.com/shakacode/shakapacker/compare/v8.0.0-rc.2...main
+[Unreleased]: https://github.com/shakacode/shakapacker/compare/v8.0.0-rc.3...main
+[v8.0.0.rc.3]: https://github.com/shakacode/shakapacker/compare/v8.0.0-rc.2...v8.0.0-rc.3
 [v8.0.0.rc.2]: https://github.com/shakacode/shakapacker/compare/v7.2.3...v8.0.0-rc.2
 [v7.2.3]: https://github.com/shakacode/shakapacker/compare/v7.2.2...v7.2.3
 [v7.2.2]: https://github.com/shakacode/shakapacker/compare/v7.2.1...v7.2.2

data/README.md

@@ -27,11 +27,17 @@ See a comparison of [Shakapacker with jsbundling-rails](https://github.com/rails
 For discussions, see our [Slack Channel](https://reactrails.slack.com/join/shared_invite/enQtNjY3NTczMjczNzYxLTlmYjdiZmY3MTVlMzU2YWE0OWM0MzNiZDI0MzdkZGFiZTFkYTFkOGVjODBmOWEyYWQ3MzA2NGE1YWJjNmVlMGE).
 
 ---
-### ShakaCode Support
+## ShakaCode Support
 
-[ShakaCode](https://www.shakacode.com) offers support for upgrading from Webpacker and using Shakapacker. If interested, contact Justin Gordon, [justin@shakacode.com](mailto:justin@shakacode.com). We're also [hiring](https://jobs.lever.co/shakacode/3bdbfdb3-4495-4611-a279-01dddb351abe)!
+[ShakaCode](https://www.shakacode.com) focuses on helping Ruby on Rails teams use React and Webpack better. We can upgrade your project and improve your development and customer experiences, allowing you to focus on building new features or fixing bugs instead. 
 
-Here's a testimonial of how ShakaCode can help, from [Florian Gößler](https://github.com/FGoessler) of [Blinkist](https://www.blinkist.com/), January 2, 2023:
+For an overview of working with us, see our [Client Engagement Model](https://www.shakacode.com/blog/client-engagement-model/) article and [how we bill for time](https://www.shakacode.com/blog/shortcut-jira-trello-github-toggl-time-and-task-tracking/).
+
+We also specialize in helping development teams lower infrastructure and CI costs. Check out our project [Control Plane Flow](https://github.com/shakacode/control-plane-flow/), which can allow you to get the ease of Heroku with the power of Kubernetes and big cost savings.
+
+If you think ShakaCode can help your project, [click here](https://meetings.hubspot.com/justingordon/30-minute-consultation) to book a call with [Justin Gordon](mailto:justin@shakacode.com), the creator of React on Rails and Shakapacker.
+
+Here's a testimonial of how ShakaCode can help from [Florian Gößler](https://github.com/FGoessler) of [Blinkist](https://www.blinkist.com/), January 2, 2023:
 > Hey Justin 👋
 >
 > I just wanted to let you know that we today shipped the webpacker to shakapacker upgrades and it all seems to be running smoothly! Thanks again for all your support and your teams work! 😍
@@ -40,7 +46,7 @@ Here's a testimonial of how ShakaCode can help, from [Florian Gößler](https://
 >
 > Have a great 2023 and maybe we get to work together again later in the year! 🙌
 
-Read the [full review here](https://clutch.co/profile/shakacode#reviews?sort_by=date_DESC#review-2118154). Here's [another review of a Shakapacker migration that led to more work](https://clutch.co/profile/shakacode#reviews?sort_by=date_DESC#review-2096078).
+Read the [full review here](https://clutch.co/profile/shakacode#reviews?sort_by=date_DESC#review-2118154).
 
 ---
 
@@ -985,7 +991,7 @@ The following companies support our Open Source projects, and ShakaCode uses the
     <img alt="ScoutAPM" src="https://user-images.githubusercontent.com/4244251/184881152-9f2d8fba-88ac-4ba6-873b-22387f8711c5.png" height="120px">
   </picture>
 </a>
-<a href="https://controlplane.com">
+<a href="https://shakacode.controlplane.com">
   <picture>
     <img alt="Control Plane" src="https://github.com/shakacode/.github/assets/20628911/90babd87-62c4-4de3-baa4-3d78ef4bec25" height="120px">
   </picture>

data/docs/v8_upgrade.md

@@ -7,9 +7,55 @@ manager is used to manage JavaScript dependencies.
 Support for Ruby 2.6 and Node v12 has also been dropped since they're very old
 at this point.
 
+## CDN host is stripped from the manifest output
+
+In Webpacker v5, the manifest.json file did not include the CDN asset host if defined. THis has been added in the aborted v6 and we've retained this in Shakapacker.
+
+Presence of this host in the output could lead to unexpected issues and required [some workarounds](https://github.com/shakacode/shakapacker/blob/main/docs/troubleshooting.md#wrong-cdn-src-from-javascript_pack_tag) in certain cases.
+
+If you are not using CDN, then this change will have no effect on your setup.
+
+If you are using CDN and your CDN host is static, `config.asset_host` setting in Rails will be respected during compilation and when referencing assets through view helpers.
+
+If your host might differ, between various environments for example, you will either need to:
+- Ensure the assets are specifically rebuilt for each environment (Heroku pipeline promote feature for example does not do that by default).
+- Make sure the assets are compiled with `SHAKAPACKER_ASSET_HOST=''` ENV variable to avoid hardcording URLs in packs output.
+
+Second option has got a certain gotcha - dynamic imports and static asset references (like image paths in CSS) will end up without host reference and the app will try and fetch them from your app host rather than defined `config.asset_host`.
+
+Make sure the assets are compiled with `SHAKAPACKER_ASSET_HOST=''` ENV variable to avoid hardcoding URLs in packs output.
+
+To get around that, you can use dynamic override as outlined by [Webpack documentation](https://webpack.js.org/guides/asset-modules/#on-the-fly-override).
+
+Setting for example:
+
+```
+__webpack_public_path__ = 'https://mycdn.url.com/packs';
+```
+
+In your code and ensuring it is run first in the app, will allow the dynamic imports lookup path to be overriden at runtime.
+
+You can also try Webpack `output.publicPath` option of `'auto'` as per https://webpack.js.org/guides/public-path/#automatic-publicpath.
+
+For example in your `webpack.config.js`:
+
+```
+const { generateWebpackConfig } = require('shakapacker')
+
+const customConfig = {
+  output: {
+    publicPath: 'auto'
+  }
+};
+
+module.exports = generateWebpackConfig(customConfig);
+```
+
+This will work in number of environments although some older browsers like IE will require a polyfill as mentioned in the Webpack documentation linked above.
+
 ## The `packageManager` property in `package.json` is used to determine the package manager
 
-The biggest functional change in v8, `shakapacker` is now able to work with any
+The biggest functional change in v8, `shakapacker` can now work with any
 of the major JavaScript package managers thanks to the
 [`package_json`](https://github.com/shakacode/package_json) gem which uses the
 [`packageManager`](https://nodejs.org/api/packages.html#packagemanager) property

data/lib/shakapacker/commands.rb

@@ -61,7 +61,7 @@ class Shakapacker::Commands
 
       packs = all_files - manifest_config - current_version
       packs.reject { |file| File.directory?(file) }.group_by do |path|
-        base, _, ext = File.basename(path).scan(/(.*)(-[\da-f]+)(\.\w+)/).flatten
+        base, _, ext = File.basename(path).scan(/(.*)(-[\da-f]+)([.\w]+)/).flatten
         "#{File.dirname(path)}/#{base}#{ext}"
       end.values
     end

data/lib/shakapacker/version.rb

@@ -1,4 +1,4 @@
 module Shakapacker
   # Change the version in package.json too, please!
-  VERSION = "8.0.0.rc.3".freeze
+  VERSION = "8.0.0.rc.4".freeze
 end

data/package/environments/base.js

@@ -80,7 +80,7 @@ const getPlugins = () => {
       writeToDisk: true,
       output: config.manifestPath,
       entrypointsUseAssets: true,
-      publicPath: true
+      publicPath: config.publicPathWithoutCDN
     })
   ]
 

data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "shakapacker",
-  "version": "8.0.0-rc.3",
+  "version": "8.0.0-rc.4",
   "description": "Use webpack to manage app-like JavaScript modules in Rails",
   "homepage": "https://github.com/shakacode/shakapacker",
   "bugs": {

data/spec/shakapacker/command_spec.rb

@@ -46,6 +46,18 @@ describe "Command" do
         "js/brandnew-0002.js" => now - 10,
         "js/brandnew-0003.js" => now - 20,
         "js/brandnew-0004.js" => now - 40,
+
+        # Compressed and map files
+        "js/application-deadbeef.js.br" => now - 4000,
+        "js/application-deadbeef.js.gz" => now - 4000,
+        "js/application-deadbeef.js.map" => now - 4000,
+        "js/application-deadbeef.js.map.br" => now - 4000,
+        "js/application-deadbeef.js.map.gz" => now - 4000,
+        "js/application-1eadbeef.js.br" => now - 4000,
+        "js/application-1eadbeef.js.gz" => now - 4000,
+        "js/application-1eadbeef.js.map" => now - 4000,
+        "js/application-1eadbeef.js.map.br" => now - 4000,
+        "js/application-1eadbeef.js.map.gz" => now - 4000,
       }.transform_keys { |path| "#{Shakapacker.config.public_output_path}/#{path}" }
     end
 
@@ -56,6 +68,12 @@ describe "Command" do
         "js/common-0eadbeee.js" => now - 9002,
         "css/common-0eadbeed.css" => now - 9004,
         "js/brandnew-0005.js" => now - 3640,
+        # Compressed and map files
+        "js/application-0eadbeef.js.br" => now - 9000,
+        "js/application-0eadbeef.js.gz" => now - 9000,
+        "js/application-0eadbeef.js.map" => now - 9000,
+        "js/application-0eadbeef.js.map.br" => now - 9000,
+        "js/application-0eadbeef.js.map.gz" => now - 9000,
       }.transform_keys { |path| "#{Shakapacker.config.public_output_path}/#{path}" }
     end
 

data/test/package/config.test.js

@@ -21,6 +21,13 @@ describe("Config", () => {
     expect(config.publicPath).toBe("http://foo.com/packs/")
   })
 
+  test("public path without CDN is not affected by the asset host", () => {
+    process.env.RAILS_ENV = "development"
+    process.env.SHAKAPACKER_ASSET_HOST = "http://foo.com/"
+    const config = require("../../package/config")
+    expect(config.publicPathWithoutCDN).toBe("/packs/")
+  })
+
   test("should return additional paths as listed in app config, with resolved paths", () => {
     const config = require("../../package/config")
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shakapacker
 version: !ruby/object:Gem::Version
-  version: 8.0.0.rc.3
+  version: 8.0.0.rc.4
 platform: ruby
 authors:
 - David Heinemeier Hansson
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-05-10 00:00:00.000000000 Z
+date: 2024-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -506,7 +506,7 @@ homepage: https://github.com/shakacode/shakapacker
 licenses:
 - MIT
 metadata:
-  source_code_uri: https://github.com/shakacode/shakapacker/tree/v8.0.0-rc.3
+  source_code_uri: https://github.com/shakacode/shakapacker/tree/v8.0.0-rc.4
 post_install_message:
 rdoc_options: []
 require_paths: