Module: Banzai::Filter::Concerns::PipelineTimingCheck

Extended by:
ActiveSupport::Concern
Included in:
AbsoluteLinkFilter, AsciiDocPostProcessingFilter, AssetProxyFilter, AttributesFilter, BroadcastMessagePlaceholdersFilter, Banzai::Filter::CodeLanguageFilter, Banzai::Filter::ColorFilter, Banzai::Filter::CommitTrailersFilter, Banzai::Filter::CustomEmojiFilter, EmojiFilter, EscapedCharFilter, FootnoteFilter, FrontMatterFilter, GollumTagsFilter, ImageLazyLoadFilter, ImageLinkFilter, InlineDiffFilter, IssuableReferenceExpansionFilter, KrokiFilter, MathFilter, MermaidFilter, PlantumlFilter, PlayableLinkFilter, References::AbstractReferenceFilter, References::ReferenceFilter, RepositoryLinkFilter, ServiceDeskUploadLinkFilter, SetDirectionFilter, SpacedLinkFilter, SuggestionFilter, SyntaxHighlightFilter, TableOfContentsTagFilter, TaskListFilter, UploadLinkFilter, WikiLinkFilter, WikiLinkGollumFilter
Defined in:
lib/banzai/filter/concerns/pipeline_timing_check.rb

Overview

This provides the ability to check if the pipeline has run longer than some maximum. Usually a filter will check this and simply return if exceeded.

This allows for filters to be skipped in order to keep pipeline execution time within a certain threshold.

If the check is used for a filter that does sanitization or redaction, then the TimeoutFilterHandler::COMPLEX_MARKDOWN_MESSAGE should be returned to ensure we don’t return compromised HTML.

Constant Summary collapse

MAX_PIPELINE_SECONDS =

This value was chosen to achieve roughly 20 requests per second when using the API (3 secs), plus a 2 sec buffer

5

Instance Method Summary collapse

Instance Method Details

#call ⇒ Object 



23
24
25
26
27
 
# File 'lib/banzai/filter/concerns/pipeline_timing_check.rb', line 23

def call
  return doc if exceeded_pipeline_max?

  super
end

#exceeded_pipeline_max? ⇒ Boolean

Returns:

  • (Boolean) 


29
30
31
32
33
 
# File 'lib/banzai/filter/concerns/pipeline_timing_check.rb', line 29

def exceeded_pipeline_max?
  return false if Gitlab::RenderTimeout.banzai_timeout_disabled?

  result[:pipeline_timing] && result[:pipeline_timing] > MAX_PIPELINE_SECONDS
end