Skip to content

A platform for community discussion. Free, open, simple.

DEV: Key plugin builds on the asset processor digest (#44843)

Jarek Radosz68159ebf0368
diff --git a/lib/asset_processor.rb b/lib/asset_processor.rb
index d114f5f8b96..c15dc35dcdf 100644
--- a/lib/asset_processor.rb
+++ b/lib/asset_processor.rb
@@ -1,6 +1,8 @@
# frozen_string_literal: true
class AssetProcessor
+ # Bump only when theme JS output changes; it rebakes every theme on every site. Plugin builds
+ # also key on the processor's digest, so JS changes there rebuild them without a bump.
BASE_COMPILER_VERSION = 120
BUNDLE =
@@ -157,6 +159,12 @@ class AssetProcessor
v8_call("emberVersion")
end
+ # Identifies the processor source loaded into the V8 context
+ def self.digest
+ v8
+ BUNDLE.loaded_digest
+ end
+
def initialize(skip_module: false)
@skip_module = skip_module
end
diff --git a/lib/plugin/js_manager.rb b/lib/plugin/js_manager.rb
index e3c432db84c..03ffac923b1 100644
--- a/lib/plugin/js_manager.rb
+++ b/lib/plugin/js_manager.rb
@@ -184,6 +184,7 @@ module Plugin
*tree.keys,
*tree.values,
AssetProcessor::BASE_COMPILER_VERSION,
+ AssetProcessor.digest,
AssetProcessor.ember_version,
minify?.to_s,
plugin.name,
diff --git a/lib/precompiled_bundle.rb b/lib/precompiled_bundle.rb
index 44b07ac32c8..2b0fbaaab9b 100644
--- a/lib/precompiled_bundle.rb
+++ b/lib/precompiled_bundle.rb
@@ -5,6 +5,9 @@
class PrecompiledBundle
attr_reader :dependency_globs
+ # The digest of the source most recently returned by `load_or_build`
+ attr_reader :loaded_digest
+
def initialize(dir:, filename_prefix:, dependency_globs:, &build)
@dir = dir
@filename_prefix = filename_prefix
@@ -12,7 +15,7 @@ class PrecompiledBundle
@build = build
end
- def path
+ def path(digest = self.digest)
Rails.root.join(@dir, "#{@filename_prefix}-#{digest}.js")
end
@@ -21,7 +24,8 @@ class PrecompiledBundle
end
def load_or_build
- cache_path = path
+ @loaded_digest = digest
+ cache_path = path(@loaded_digest)
return File.read(cache_path) if File.exist?(cache_path)
with_lock do
diff --git a/spec/lib/asset_processor_spec.rb b/spec/lib/asset_processor_spec.rb
index 1d6c42987ff..acf25cb3ae7 100644
--- a/spec/lib/asset_processor_spec.rb
+++ b/spec/lib/asset_processor_spec.rb
@@ -658,6 +658,12 @@ RSpec.describe AssetProcessor do
expect(AssetProcessor.ember_version).to match(/\A\d+\.\d+\.\d+\z/)
end
+ it "identifies the loaded processor source by the digest in its bundle path" do
+ expect(AssetProcessor::BUNDLE.path.basename.to_s).to eq(
+ "asset-processor-#{AssetProcessor.digest}.js",
+ )
+ end
+
it "errors on missing relative imports for a plugin without a hyphenated name" do
mod_1 = <<~JS.chomp
import SomeModule from "../some-module";
diff --git a/spec/lib/precompiled_bundle_spec.rb b/spec/lib/precompiled_bundle_spec.rb
new file mode 100644
index 00000000000..73021a6879a
--- /dev/null
+++ b/spec/lib/precompiled_bundle_spec.rb
@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+RSpec.describe PrecompiledBundle do
+ let(:root) { "tmp/precompiled_bundle_spec_#{SecureRandom.hex(4)}" }
+ let(:source_path) { Rails.root.join(root, "src/source.js") }
+ let(:builds) { [] }
+ let(:bundle) do
+ described_class.new(
+ dir: "#{root}/out",
+ filename_prefix: "bundle",
+ dependency_globs: ["#{root}/src/*.js"],
+ ) do
+ builds << File.read(source_path)
+ "built from #{builds.last}"
+ end
+ end
+
+ before do
+ FileUtils.mkdir_p(File.dirname(source_path))
+ File.write(source_path, "v1")
+
+ # The build is a plain block, so it doesn't need the installed node_modules
+ allow(bundle).to receive(:verify_node_modules!)
+ end
+
+ after { FileUtils.rm_rf(Rails.root.join(root)) }
+
+ describe "#load_or_build" do
+ it "builds once and records the digest of the cached source" do
+ 2.times { expect(bundle.load_or_build).to eq("built from v1") }
+
+ expect(builds).to eq(["v1"])
+ expect(bundle.path.basename.to_s).to eq("bundle-#{bundle.loaded_digest}.js")
+ end
+
+ it "rebuilds and replaces the cached source when a dependency changes" do
+ bundle.load_or_build
+ first_digest = bundle.loaded_digest
+
+ File.write(source_path, "v2")
+
+ expect(bundle.load_or_build).to eq("built from v2")
+ expect(bundle.loaded_digest).not_to eq(first_digest)
+ expect(Dir.glob("bundle-*.js", base: Rails.root.join(root, "out"))).to contain_exactly(
+ bundle.path.basename.to_s,
+ )
+ end
+ end
+end