docbrown/app/labor/cache_buster.rb
Vaidehi Joshi 9e40e68682
Allow Nginx cached static content to be purged (#9857) [deploy]
* Only bust_fastly_cache if fastly is enabled

* Conditionally bust nginx cache from CacheBuster#bust

* Don't _actually_ call out to openresty

* Remove redundant check for FASTLY_API_KEY in CacheBuster

* Clean up and add a spec

* Do not call .purge_ methods if fastly is not configured

* Add OPENRESTY_ ENV vars to .env_sample

* Remove extra / prepending path

* Remove ConfigurationError, clean up Purgeable concern

* Use raise instead of fail like fastly-ruby

* No longer check for Rails.env.production?

* Use let! to create article in BustMultipleCachesWorker spec
2020-08-21 09:31:23 -07:00

248 lines
7.3 KiB
Ruby

module CacheBuster
TIMEFRAMES = [
[1.week.ago, "week"],
[1.month.ago, "month"],
[1.year.ago, "year"],
[5.years.ago, "infinity"],
].freeze
def self.bust(path)
# TODO: (Alex Smith) - It would be "nice to have" the ability to use the
# Fastly gem here instead of custom API calls. We'd want to keep thread
# safety in mind. We'll also want to consider making this modular for those
# who don't want to use Fastly at all.
#
# Instead of HTTP calls, we could do:
# fastly = Fastly.new(api_key: ApplicationConfig["FASTLY_API_KEY"])
# service = Fastly::Service.new({ id: ApplicationConfig["FASTLY_SERVICE_ID"] }, fastly)
# fastly.purge(path)
#
# https://github.com/fastly/fastly-ruby#efficient-purging
if fastly_enabled?
bust_fastly_cache(path)
elsif nginx_enabled?
bust_nginx_cache(path)
end
rescue URI::InvalidURIError => e
Rails.logger.error("Trying to bust cache of an invalid uri: #{e}")
DatadogStatsClient.increment("cache_buster.invalid_uri", tags: ["path:#{path}"])
end
def self.fastly_enabled?
ApplicationConfig["FASTLY_API_KEY"].present? && ApplicationConfig["FASTLY_SERVICE_ID"].present?
end
def self.nginx_enabled?
ApplicationConfig["OPENRESTY_PROTOCOL"].present? && ApplicationConfig["OPENRESTY_DOMAIN"].present?
end
def self.bust_fastly_cache(path)
HTTParty.post(
"https://api.fastly.com/purge/https://#{ApplicationConfig['APP_DOMAIN']}#{path}",
headers: {
"Fastly-Key" => ApplicationConfig["FASTLY_API_KEY"]
},
)
HTTParty.post(
"https://api.fastly.com/purge/https://#{ApplicationConfig['APP_DOMAIN']}#{path}?i=i",
headers: {
"Fastly-Key" => ApplicationConfig["FASTLY_API_KEY"]
},
)
end
def self.bust_nginx_cache(path)
uri = URI.parse("#{ApplicationConfig['OPENRESTY_PROTOCOL']}#{ApplicationConfig['OPENRESTY_DOMAIN']}#{path}")
http = Net::HTTP.new(uri.host, uri.port)
response = http.request Net::HTTP::NginxPurge.new(uri.request_uri)
raise StandardError, "NginxPurge request failed: #{response.body}" unless response.is_a?(Net::HTTPSuccess)
response.body
end
def self.bust_comment(commentable)
return unless commentable
bust_article_comment(commentable) if commentable.is_a?(Article)
commentable.touch(:last_comment_at) if commentable.respond_to?(:last_comment_at)
bust("#{commentable.path}/comments/")
bust(commentable.path.to_s)
commentable.comments.includes(:user).find_each do |comment|
bust(comment.path)
bust("#{comment.path}?i=i")
end
bust("#{commentable.path}/comments/*")
end
def self.bust_article(article)
article.purge
bust(article.path)
bust("/#{article.user.username}")
bust("#{article.path}/")
bust("#{article.path}?i=i")
bust("#{article.path}/?i=i")
bust("#{article.path}/comments")
bust("#{article.path}?preview=#{article.password}")
bust("#{article.path}?preview=#{article.password}&i=i")
bust("/#{article.organization.slug}") if article.organization.present?
bust_home_pages(article)
bust_tag_pages(article)
bust("/api/articles/#{article.id}")
return unless article.collection_id
article.collection&.articles&.find_each do |collection_article|
bust(collection_article.path)
end
end
def self.bust_home_pages(article)
if article.featured_number.to_i > Time.current.to_i
bust("/")
bust("?i=i")
end
if article.video.present? && article.featured_number.to_i > 10.days.ago.to_i
bust("/videos")
bust("/videos?i=i")
end
TIMEFRAMES.each do |timestamp, interval|
next unless Article.published.where("published_at > ?", timestamp)
.order(public_reactions_count: :desc).limit(3).ids.include?(article.id)
bust("/top/#{interval}")
bust("/top/#{interval}?i=i")
bust("/top/#{interval}/?i=i")
end
if article.published && article.published_at > 1.hour.ago
bust("/latest")
bust("/latest?i=i")
end
bust("/") if Article.published.order(hotness_score: :desc).limit(4).ids.include?(article.id)
end
def self.bust_tag_pages(article)
return unless article.published
article.tag_list.each do |tag|
if article.published_at.to_i > 2.minutes.ago.to_i
bust("/t/#{tag}/latest")
bust("/t/#{tag}/latest?i=i")
end
TIMEFRAMES.each do |timestamp, interval|
next unless Article.published.where("published_at > ?", timestamp).tagged_with(tag)
.order(public_reactions_count: :desc).limit(3).ids.include?(article.id)
bust("/top/#{interval}")
bust("/top/#{interval}?i=i")
bust("/top/#{interval}/?i=i")
12.times do |i|
bust("/api/articles?tag=#{tag}&top=#{i}")
end
end
next unless rand(2) == 1 &&
Article.published.tagged_with(tag)
.order(hotness_score: :desc).limit(2).ids.include?(article.id)
bust("/t/#{tag}")
bust("/t/#{tag}?i=i")
end
end
def self.bust_page(slug)
bust "/page/#{slug}"
bust "/page/#{slug}?i=i"
bust "/#{slug}"
bust "/#{slug}?i=i"
end
def self.bust_tag(tag)
tag.purge
bust("/t/#{tag.name}")
bust("/t/#{tag.name}?i=i")
bust("/t/#{tag.name}/?i=i")
bust("/t/#{tag.name}/")
bust("/tags")
end
def self.bust_events
bust("/events")
bust("/events?i=i")
end
def self.bust_podcast(path)
bust("/#{path}")
end
def self.bust_organization(organization, slug)
bust("/#{slug}")
begin
organization.articles.find_each do |article|
bust(article.path)
end
rescue StandardError => e
Rails.logger.error("Tag issue: #{e}")
end
end
def self.bust_podcast_episode(podcast_episode, path, podcast_slug)
podcast_episode.purge
podcast_episode.purge_all
begin
bust(path)
bust("/#{podcast_slug}")
bust("/pod")
bust(path)
rescue StandardError => e
Rails.logger.warn(e)
end
podcast_episode.purge
podcast_episode.purge_all
end
def self.bust_listings(listing)
# we purge all listings as it's the wanted behavior with the following URL purging
listing.purge_all
bust("/listings")
bust("/listings?i=i")
bust("/listings/#{listing.category}/#{listing.slug}")
bust("/listings/#{listing.category}/#{listing.slug}?i=i")
bust("/listings/#{listing.category}")
end
def self.bust_user(user)
username = user.username
paths = [
"/#{username}", "/#{username}?i=i",
"/#{username}/comments",
"/#{username}/comments?i=i", "/#{username}/comments/?i=i",
"/live/#{username}", "/live/#{username}?i=i",
"/feed/#{username}"
]
paths.each { |path| bust(path) }
end
# bust commentable if it's an article
def self.bust_article_comment(commentable)
bust("/") if Article.published.order(hotness_score: :desc).limit(3).ids.include?(commentable.id)
if commentable.decorate.cached_tag_list_array.include?("discuss") &&
commentable.featured_number.to_i > 35.hours.ago.to_i
bust("/")
bust("/?i=i")
bust("?i=i")
end
end
end
# Creates our own purge method for an HTTP request,
# which is used by Nginx to bust a cache.
# See Net::HTTPGenericRequest for attributes/methods.
class Net::HTTP::NginxPurge < Net::HTTPRequest # rubocop:disable Style/ClassAndModuleChildren
METHOD = "PURGE".freeze
REQUEST_HAS_BODY = false
RESPONSE_HAS_BODY = true
end