Move pre_process into render_result

The method Banzai::Renderer.pre_process would always be called, regardless of whether the Markdown to render was already cached or not. In cache the document _was_ cached the output of the pre-processing pipeline was ignored resulting in it doing nothing but wasting CPU cycles. This commit moves Banzai::Renderer.pre_process into Banzai::Renderer.render_result so that it's _only_ used when needed.

Move pre_process into render_result
d9a4ca59 · Yorick Peterse · 0468deaf · d9a4ca59 · d9a4ca59 · d9a4ca59
Unverified Commit d9a4ca59 authored Jun 21, 2016 by Yorick Peterse
Show whitespace changes
Inline Side-by-side

Showing with 3 additions and 12 deletions

CHANGELOG CHANGELOG +1 -0

gitlab_markdown_helper.rb app/helpers/gitlab_markdown_helper.rb +0 -2

banzai.rb lib/banzai.rb +0 -4

renderer.rb lib/banzai/renderer.rb +2 -6

No files found.
--- a/CHANGELOG
+++ b/CHANGELOG
@@ -14,6 +14,7 @@ v 8.9.0 (unreleased)
  - Fix issue with arrow keys not working in search autocomplete dropdown
  - Fix an issue where note polling stopped working if a window was in the
    background during a refresh.
+  - Pre-processing Markdown now only happens when needed
  - Make EmailsOnPushWorker use Sidekiq mailers queue
  - Redesign all Devise emails. !4297
  - Don't show 'Leave Project' to group members

--- a/app/helpers/gitlab_markdown_helper.rb
+++ b/app/helpers/gitlab_markdown_helper.rb
@@ -50,8 +50,6 @@ module GitlabMarkdownHelper

    context[:project] ||= @project

-    text = Banzai.pre_process(text, context)
-
    html = Banzai.render(text, context)

    context.merge!(

--- a/lib/banzai.rb
+++ b/lib/banzai.rb
@@ -7,10 +7,6 @@ module Banzai
    Renderer.render_result(text, context)
  end

-  def self.pre_process(text, context)
-    Renderer.pre_process(text, context)
-  end
-
  def self.post_process(html, context)
    Renderer.post_process(html, context)
  end

--- a/lib/banzai/renderer.rb
+++ b/lib/banzai/renderer.rb
@@ -30,13 +30,9 @@ module Banzai
    end

    def self.render_result(text, context = {})
-      Pipeline[context[:pipeline]].call(text, context)
-    end
+      text = Pipeline[:pre_process].to_html(text, context) if text

-    def self.pre_process(text, context)
-      pipeline = Pipeline[:pre_process]
-
-      pipeline.to_html(text, context)
+      Pipeline[context[:pipeline]].call(text, context)
    end

    # Perform post-processing on an HTML String