Merge pull request #14221 from chahmedejaz/task/13547-replace-wicked_pdf-with-ferrum-pdf

mkllnk · web-flow · commit 971d80fda63b · 2026-05-21T12:50:57.000+10:00
Replace wicked_pdf with ferrum_pdf for PDF generation
diff --git a/Gemfile b/Gemfile
@@ -111,8 +111,7 @@ gem "turbo_power"
 gem "turbo-rails"
 
 gem 'combine_pdf'
-gem 'wicked_pdf', github: "openfoodfoundation/wicked_pdf", branch: "master"
-gem 'wkhtmltopdf-binary', source: 'https://rubygems.org' # due to https://github.com/gem-coop/gem.coop/issues/36
+gem 'ferrum_pdf'
 
 gem 'immigrant'
 gem 'roo' # read spreadsheets
diff --git a/Gemfile.lock b/Gemfile.lock
@@ -16,15 +16,6 @@ GIT
     select2-rails (3.4.9)
       thor (>= 0.14)
 
-GIT
-  remote: https://github.com/openfoodfoundation/wicked_pdf.git
-  revision: bce498de547cdf00d037fdbec29fae844d69ee8e
-  branch: master
-  specs:
-    wicked_pdf (2.8.1)
-      activesupport
-      ostruct
-
 GIT
   remote: https://github.com/podia/stimulus_reflex_testing.git
   revision: abac2ee34de347c589795b4d1a8e83e0baafb201
@@ -339,6 +330,9 @@ GEM
       concurrent-ruby (~> 1.1)
       webrick (~> 1.7)
       websocket-driver (~> 0.7)
+    ferrum_pdf (3.1.0)
+      actionpack (>= 6.0.0)
+      ferrum (~> 0.15)
     ffaker (2.25.0)
     ffi (1.17.3)
     flipper (1.4.2)
@@ -971,11 +965,6 @@ GEM
       nokogiri (~> 1.8)
     zeitwerk (2.7.5)
 
-GEM
-  remote: https://rubygems.org/
-  specs:
-    wkhtmltopdf-binary (0.12.6.10)
-
 PLATFORMS
   ruby
 
@@ -1020,6 +1009,7 @@ DEPENDENCIES
   dotenv
   factory_bot_rails (= 6.2.0)
   faraday
+  ferrum_pdf
   ffaker
   flipper
   flipper-active_record
@@ -1122,8 +1112,6 @@ DEPENDENCIES
   web!
   web-console
   webmock
-  wicked_pdf!
-  wkhtmltopdf-binary!
 
 CHECKSUMS
   Ascii85 (2.0.1) sha256=15cb5d941808543cbb9e7e6aea3c8ec3877f154c3461e8b3673e97f7ecedbe5a
@@ -1231,6 +1219,7 @@ CHECKSUMS
   faraday-follow_redirects (0.4.0) sha256=d3fa1118ab1350e24035a272b4cff64948643bb7182846db89acaf87abadd5d9
   faraday-net_http (3.4.2) sha256=f147758260d3526939bf57ecf911682f94926a3666502e24c69992765875906c
   ferrum (0.17.1) sha256=51d591120fc593e5a13b5d9d6474389f5145bb92a91e36eab147b5d096c8cbe7
+  ferrum_pdf (3.1.0) sha256=5e2e7adf70ffef0c78dd5f9431cc38061984926968f012725b885f453f634945
   ffaker (2.25.0) sha256=e485c5adf8195aac55662875b7f515469bca46d77b60d0e7d08db6861bcbec40
   ffi (1.17.3) sha256=0e9f39f7bb3934f77ad6feab49662be77e87eedcdeb2a3f5c0234c2938563d4c
   flipper (1.4.2) sha256=dca7d65b5ec660b525b6c599e727219ac4994073c855b41b6656b2d91a9cb304
@@ -1464,8 +1453,6 @@ CHECKSUMS
   webrick (1.9.2) sha256=beb4a15fc474defed24a3bda4ffd88a490d517c9e4e6118c3edce59e45864131
   websocket-driver (0.8.0) sha256=ed0dba4b943c22f17f9a734817e808bc84cdce6a7e22045f5315aa57676d4962
   websocket-extensions (0.1.5) sha256=1c6ba63092cda343eb53fc657110c71c754c56484aad42578495227d717a8241
-  wicked_pdf (2.8.1)
-  wkhtmltopdf-binary (0.12.6.10) sha256=863060a4559253d20f9a73c76106bd972a443aec9fdd5013b45e1d1a9a44f352
   xml-simple (1.1.9) sha256=d21131e519c86f1a5bc2b6d2d57d46e6998e47f18ed249b25cad86433dbd695d
   xpath (3.2.0) sha256=6dfda79d91bb3b949b947ecc5919f042ef2f399b904013eb3ef6d20dd3a4082e
   zeitwerk (2.7.5) sha256=d8da92128c09ea6ec62c949011b00ed4a20242b255293dd66bf41545398f73dd
diff --git a/app/controllers/spree/admin/orders_controller.rb b/app/controllers/spree/admin/orders_controller.rb
@@ -112,7 +112,13 @@ def print
                    end
         end
 
-        render_with_wicked_pdf InvoiceRenderer.new.args(@order, spree_current_user)
+        renderer = InvoiceRenderer.new
+        send_data(
+          renderer.render_to_string(@order, spree_current_user),
+          filename: renderer.filename(@order),
+          type: "application/pdf",
+          disposition: "inline"
+        )
       end
 
       def bulk_credit
diff --git a/app/helpers/application_helper.rb b/app/helpers/application_helper.rb
@@ -78,17 +78,7 @@ def cache_key_with_locale(key, locale)
   end
 
   def pdf_stylesheet_pack_tag(source)
-    # With shakapacker dev server running, the wicked_pdf_stylesheet_pack_tag will produce a
-    # relative path, because we don't have `config.action_controller.asset_host`. Relative path
-    # can't be resolved by `wkhtmltopdf`. So we pass the wepacker dev server host and port to
-    # the shakapacker helper, so it generates the correct url.
-    # For more info: https://stackoverflow.com/questions/58490299/how-to-include-css-stylesheet-into-wicked-pdf/60541688#60541688
-    if running_in_development?
-      options = { media: "all",
-                  host: "#{Shakapacker.dev_server.host}:#{Shakapacker.dev_server.port}" }
-      stylesheet_pack_tag(source, **options)
-    else
-      wicked_pdf_stylesheet_pack_tag(source)
-    end
+    # FerrumPdf uses the current page URL to resolve relative asset paths.
+    stylesheet_pack_tag(source, media: "all")
   end
 end
diff --git a/app/services/invoice_renderer.rb b/app/services/invoice_renderer.rb
@@ -1,29 +1,36 @@
 # frozen_string_literal: true
 
 class InvoiceRenderer
-  def initialize(renderer = ApplicationController.new, user = nil)
+  def initialize(renderer = ApplicationController.new, user = nil, pdf_renderer = PdfRenderer.new)
     @renderer = renderer
     @user = user
+    @pdf_renderer = pdf_renderer
   end
 
   def render_to_string(order, user = @user)
     renderer.instance_variable_set(:@order, order)
-    renderer.render_to_string_with_wicked_pdf(args(order, user))
+    html = renderer.render_to_string(args(user))
+
+    pdf_renderer.render(html)
   end
 
-  def args(order, user = @user)
+  def args(user = @user)
     @user = user
     {
-      pdf: "invoice-#{order.number}.pdf",
       template: invoice_template,
       formats: [:html],
-      encoding: "UTF-8"
+      encoding: "UTF-8",
+      layout: false
     }
   end
 
+  def filename(order)
+    "invoice-#{order.number}.pdf"
+  end
+
   private
 
-  attr_reader :renderer
+  attr_reader :renderer, :pdf_renderer
 
   def invoice_template
     if OpenFoodNetwork::FeatureToggle.enabled?(:invoices, @user)
diff --git a/app/services/pdf_renderer.rb b/app/services/pdf_renderer.rb
@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+class PdfRenderer
+  def render(html)
+    FerrumPdf.render_pdf(html: html_document(html), display_url:)
+  end
+
+  private
+
+  def html_document(html)
+    # If the string already starts like a full HTML document just return it.
+    return html if html.match?(/\A\s*(<!doctype|<html)/i)
+
+    <<~HTML
+      <!DOCTYPE html>
+      <html>
+      <head>
+        <meta charset="utf-8">
+      </head>
+      <body>
+      #{html}
+      </body>
+      </html>
+    HTML
+  end
+
+  def display_url
+    options = Rails.application.routes.default_url_options.symbolize_keys
+    host = options.fetch(:host)
+    protocol = options[:protocol].presence || "http"
+    port = options[:port]
+
+    "#{protocol}://#{host}#{":#{port}" if port}/"
+  end
+end
diff --git a/app/views/layouts/pdf.html.haml b/app/views/layouts/pdf.html.haml
@@ -2,9 +2,6 @@
 %html
   %head
     %meta{charset: 'utf-8'}
-    -# Using wicked_pdf_stylesheet_pack_tag with a new pdf pack was not working when using
-    -# WickedPdf.new.pdf_from_string cause the css file reference was not absolute
-    -# So I ended up putting inline css here, so it's included for sure in the PDF
     :css
       body {
         width: 100%;
diff --git a/app/views/spree/admin/orders/invoice2.html.haml b/app/views/spree/admin/orders/invoice2.html.haml
@@ -8,7 +8,7 @@
           = t :tax_invoice
       - if @order.distributor.display_invoice_logo? && @order.distributor.logo.variable?
         %td{ :align => "right", rowspan: 2 }
-          = wicked_pdf_image_tag @order.distributor.logo_url(:small)
+          = image_tag @order.distributor.logo_url(:small)
     %tr{ valign: "top" }
       %td{ :align => "left" }
         - if @order.distributor.business_address.blank?
diff --git a/app/views/spree/admin/orders/invoice4.html.haml b/app/views/spree/admin/orders/invoice4.html.haml
@@ -8,7 +8,7 @@
           = t :tax_invoice
       - if @order.distributor.display_invoice_logo? && @order.distributor.logo_url
         %td{ :align => "right", rowspan: 2 }
-          = wicked_pdf_image_tag @order.distributor.logo_url
+          = image_tag @order.distributor.logo_url
     %tr{ valign: "top" }
       %td{ :align => "left" }
         - if @order.distributor.business_address.blank?
diff --git a/app/webpacker/css/mail/email.scss b/app/webpacker/css/mail/email.scss
@@ -413,7 +413,6 @@ ul {
 /*
  * Fix overlapping table header on second page of long invoices.
  * Problem description: https://github.com/openfoodfoundation/openfoodnetwork/issues/1738
- * Solution: https://github.com/wkhtmltopdf/wkhtmltopdf/issues/1770#issuecomment-73530576
  */
 thead { display: table-header-group }
 tfoot { display: table-row-group }
diff --git a/config/initializers/ferrum_pdf.rb b/config/initializers/ferrum_pdf.rb
@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+FerrumPdf.configure do |config|
+  config.process_timeout = 60
+  config.window_size = [1280, 800]
+
+  # Conversion from PDF to text struggles with multi-line text.
+  # We avoid that by printing on bigger pages in test environment.
+  # https://github.com/openfoodfoundation/openfoodnetwork/pull/9674
+  config.pdf_options.format = Rails.env.test? ? :A3 : :A4
+  config.pdf_options.scale = 0.85 # Scale down the content to fit better on the page, matching the wicked_pdf scale
+  config.pdf_options.print_background = true
+
+  next unless ENV["CI"] || ENV["DOCKER"]
+
+  config.browser_options = {
+    "no-sandbox" => nil,
+    "disable-dev-shm-usage" => nil,
+  }
+end
diff --git a/config/initializers/wicked_pdf.rb b/config/initializers/wicked_pdf.rb
diff --git a/lib/reporting/report_renderer.rb b/lib/reporting/report_renderer.rb
@@ -84,7 +84,7 @@ def to_xlsx
 
     def to_pdf
       html = to_html(layout: "pdf")
-      WickedPdf.new.pdf_from_string(html)
+      PdfRenderer.new.render(html)
     end
 
     private
diff --git a/spec/lib/reports/report_renderer_spec.rb b/spec/lib/reports/report_renderer_spec.rb
@@ -35,6 +35,15 @@
     end
   end
 
+  describe "#to_pdf" do
+    it "renders the report as a real PDF" do
+      result = subject.to_pdf
+
+      # Verify result is a valid PDF
+      expect(result).to start_with("%PDF")
+    end
+  end
+
   # metadata headers
 
   describe '#metadata_headers' do
diff --git a/spec/services/invoice_renderer_spec.rb b/spec/services/invoice_renderer_spec.rb
@@ -3,7 +3,8 @@
 RSpec.describe InvoiceRenderer do
   include Spree::PaymentMethodsHelper
 
-  let(:service) { described_class.new }
+  let(:pdf_renderer) { instance_double(PdfRenderer, render: "%PDF invoice") }
+  let(:service) { described_class.new(ApplicationController.new, nil, pdf_renderer) }
   let(:order) do
     order = create(:completed_order_with_fees)
     order.bill_address = order.ship_address
@@ -17,10 +18,11 @@
     it 'uses the invoice2 template' do
       renderer = instance_double(ApplicationController)
       expect(renderer)
-        .to receive(:render_to_string_with_wicked_pdf)
+        .to receive(:render_to_string)
         .with(include(template: 'spree/admin/orders/invoice2'))
+        .and_return("<html>invoice</html>")
 
-      described_class.new(renderer).render_to_string(order)
+      described_class.new(renderer, nil, pdf_renderer).render_to_string(order)
     end
 
     it 'creates a PDF invoice' do
@@ -35,10 +37,11 @@
     it 'uses the invoice template' do
       renderer = instance_double(ApplicationController)
       expect(renderer)
-        .to receive(:render_to_string_with_wicked_pdf)
+        .to receive(:render_to_string)
         .with(include(template: 'spree/admin/orders/invoice'))
+        .and_return("<html>invoice</html>")
 
-      described_class.new(renderer).render_to_string(order)
+      described_class.new(renderer, nil, pdf_renderer).render_to_string(order)
     end
 
     it 'creates a PDF invoice' do
diff --git a/spec/services/pdf_renderer_spec.rb b/spec/services/pdf_renderer_spec.rb
@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+RSpec.describe PdfRenderer do
+  describe "#render" do
+    it "wraps HTML fragments in a complete document" do
+      expect(FerrumPdf).to receive(:render_pdf)
+        .with(
+          html: include("<!DOCTYPE html>", "<body>", "<h1>Invoice</h1>", "</body>"),
+          display_url: "http://test.host/"
+        )
+
+      described_class.new.render("<h1>Invoice</h1>")
+    end
+
+    it "passes complete HTML documents through unchanged" do
+      html = "<!DOCTYPE html><html><body>Report</body></html>"
+
+      expect(FerrumPdf).to receive(:render_pdf)
+        .with(html:, display_url: "http://test.host/")
+
+      described_class.new.render(html)
+    end
+  end
+end
