Add integrity method on static and dynamic resolvers

Author: zcei

lib/propshaft/manifest.rb

@@ -50,8 +50,8 @@ def to_json
 
     class << self
       def from_path(manifest_path)
-        JSON.parse(manifest_path.read, symbolize_names: false).tap do |serialized_manifest|
-          Manifest.new.tap do |manifest|
+        Manifest.new.tap do |manifest|
+          JSON.parse(manifest_path.read, symbolize_names: false).tap do |serialized_manifest|
             serialized_manifest.each_pair do |key, value|
               # Compatibility mode to be able to
               # read the old "simple manifest" format

lib/propshaft/resolver/dynamic.rb

@@ -12,6 +12,13 @@ def resolve(logical_path)
       end
     end
 
+    def integrity(logical_path)
+      hash_algorithm = load_path.integrity_hash_algorithm
+      if (asset = load_path.find(logical_path)) && hash_algorithm
+        asset.integrity(hash_algorithm:)
+      end
+    end
+
     def read(logical_path, options = {})
       if asset = load_path.find(logical_path)
         asset.content(**options)

lib/propshaft/resolver/static.rb

@@ -12,6 +12,12 @@ def resolve(logical_path)
       end
     end
 
+    def integrity(logical_path)
+      entry = manifest[logical_path]
+
+      entry&.integrity
+    end
+
     def read(logical_path, encoding: "ASCII-8BIT")
       if asset_path = digested_path(logical_path)
         File.read(manifest_path.dirname.join(asset_path), encoding: encoding)
@@ -26,11 +32,7 @@ def manifest
       def digested_path(logical_path)
         entry = manifest[logical_path]
 
-        if entry.is_a?(String)
-          return entry
-        elsif entry.is_a?(Hash)
-          entry["digested_path"]
-        end
+        entry&.digested_path
       end
   end
 end

test/fixtures/output/.manifest_with_integrity.json renamed to test/fixtures/output/.extensible_manifest.json

@@ -1 +1 @@
-{"one.txt": {"digested_path": "one-f2e1ec14.txt","integrity": "sha384-LdS8l2QTAF8bD8WPb8QSQv0skTWHhmcnS2XU5LBkVQneGzqIqnDRskQtJvi7ADMe"}}
+{"one.txt": {"digested_path": "one-f2e1ec14.txt","integrity": "sha384-LdS8l2QTAF8bD8WPb8QSQv0skTWHhmcnS2XU5LBkVQneGzqIqnDRskQtJvi7ADMe"}}

test/propshaft/assembly_test.rb

@@ -44,11 +44,11 @@ class Propshaft::AssemblyTest < ActiveSupport::TestCase
     assert assembly.processor.is_a?(Propshaft::Processor)
   end
 
-  class Propshaft::AssemblyTest::WithIntegrityTest < ActiveSupport::TestCase
+  class Propshaft::AssemblyTest::WithExtensibleManifest < ActiveSupport::TestCase
     test "uses static resolver when manifest is present" do
       assembly = Propshaft::Assembly.new(ActiveSupport::OrderedOptions.new.tap { |config|
         config.output_path = Pathname.new("#{__dir__}/../fixtures/output")
-        config.manifest_path = config.output_path.join(".manifest_with_integrity.json")
+        config.manifest_path = config.output_path.join(".extensible_manifest.json")
         config.prefix = "/assets"
 
         config.integrity_hash_algorithm = "sha384"
@@ -60,7 +60,7 @@ class Propshaft::AssemblyTest::WithIntegrityTest < ActiveSupport::TestCase
     test "uses dynamic resolver when manifest is missing" do
       assembly = Propshaft::Assembly.new(ActiveSupport::OrderedOptions.new.tap { |config|
         config.output_path = Pathname.new("#{__dir__}/../fixtures/assets")
-        config.manifest_path = config.output_path.join(".manifest_with_integrity.json")
+        config.manifest_path = config.output_path.join(".extensible_manifest.json")
         config.prefix = "/assets"
 
         config.integrity_hash_algorithm = "sha384"

test/propshaft/output_path_test.rb

@@ -8,7 +8,7 @@ class Propshaft::OutputPathTest < ActiveSupport::TestCase
   setup do
     @manifest    = {
       ".manifest.json": ".manifest.json",
-      ".manifest_with_integrity.json": ".manifest_with_integrity.json",
+      ".extensible_manifest.json": ".extensible_manifest.json",
       "one.txt": "one-f2e1ec14.txt",
       "one.txt.map": "one-f2e1ec15.txt.map"
     }.stringify_keys

test/propshaft/resolver/dynamic_test.rb

@@ -3,8 +3,7 @@
 
 class Propshaft::Resolver::DynamicTest < ActiveSupport::TestCase
   setup do
-    @load_path = Propshaft::LoadPath.new Pathname.new("#{__dir__}/../../fixtures/assets/first_path"), compilers: Propshaft::Compilers.new(nil)
-    @resolver  = Propshaft::Resolver::Dynamic.new(load_path: @load_path, prefix: "/assets")
+    @resolver = create_resolver
   end
 
   test "resolving present asset returns uri path" do
@@ -25,4 +24,27 @@ class Propshaft::Resolver::DynamicTest < ActiveSupport::TestCase
   test "resolving missing asset returns nil" do
     assert_nil @resolver.resolve("nowhere.txt")
   end
+
+  test "integrity for asset returns value for configured hash format" do
+    resolver = create_resolver(load_path_integrity_hash_algorithm: "sha384")
+    assert_equal "sha384-LdS8l2QTAF8bD8WPb8QSQv0skTWHhmcnS2XU5LBkVQneGzqIqnDRskQtJvi7ADMe", resolver.integrity("one.txt")
+  end
+
+  test "integrity for asset returns nil for no configured hash format" do
+    assert_nil @resolver.integrity("one.txt")
+  end
+
+  test "integrity for missing asset returns nil" do
+    assert_nil @resolver.integrity("nowhere.txt")
+  end
+
+  private
+    def create_resolver(load_path_integrity_hash_algorithm: nil)
+      load_path = Propshaft::LoadPath.new(
+        Pathname.new("#{__dir__}/../../fixtures/assets/first_path"),
+        compilers: Propshaft::Compilers.new(nil),
+        integrity_hash_algorithm: load_path_integrity_hash_algorithm
+      )
+      Propshaft::Resolver::Dynamic.new(load_path: load_path, prefix: "/assets")
+    end
 end

test/propshaft/resolver/static_test.rb

@@ -30,6 +30,14 @@ class Propshaft::Resolver::StaticTest < ActiveSupport::TestCase
     assert_nil @resolver.resolve("nowhere.txt")
   end
 
+  test "integrity for asset returns nil for simple manifest" do
+    assert_nil @resolver.integrity("one.txt")
+  end
+
+  test "integrity for missing asset returns nil" do
+    assert_nil @resolver.integrity("nowhere.txt")
+  end
+
   test "resolver requests json optimizer gems to keep parsed manifest keys as strings" do
     stub = Proc.new do |_, opts|
       assert_equal false, opts[:symbolize_names]
@@ -41,10 +49,10 @@ class Propshaft::Resolver::StaticTest < ActiveSupport::TestCase
     end
   end
 
-  class Propshaft::Resolver::StaticTest::WithIntegrityTest < ActiveSupport::TestCase
+  class Propshaft::Resolver::StaticTest::WithExtensibleManifest < ActiveSupport::TestCase
     setup do
       @resolver = Propshaft::Resolver::Static.new(
-        manifest_path: Pathname.new("#{__dir__}/../../fixtures/output/.manifest_with_integrity.json"),
+        manifest_path: Pathname.new("#{__dir__}/../../fixtures/output/.extensible_manifest.json"),
         prefix: "/assets"
       )
     end
@@ -69,6 +77,14 @@ class Propshaft::Resolver::StaticTest::WithIntegrityTest < ActiveSupport::TestCa
       assert_nil @resolver.resolve("nowhere.txt")
     end
 
+    test "integrity for asset returns value from extensible manifest" do
+      assert_equal "sha384-LdS8l2QTAF8bD8WPb8QSQv0skTWHhmcnS2XU5LBkVQneGzqIqnDRskQtJvi7ADMe", @resolver.integrity("one.txt")
+    end
+
+    test "integrity for missing asset returns nil" do
+      assert_nil @resolver.integrity("nowhere.txt")
+    end
+
     test "resolver requests json optimizer gems to keep parsed manifest keys as strings" do
       stub = Proc.new do |_, opts|
         assert_equal false, opts[:symbolize_names]