Configure Fast.ly

jonsgreen · jonsgreen · commit cf61bf406cd5 · 2022-05-13T10:50:48.000-04:00
- Controls headers for Fastly and server caching - Adds FastlyService singleton used for purging api requests - Adds Surrogate-Key response header for website/event scoped cache purging - Adds ability to change caching setting to off/automatic/manual - Adds purging callbacks to website to purge automatically when updated or touched through pages or sponsors - Adds manual purge button on the Website edit page - Adds when_fresh call to add Last-Modified header based on website#purged_at - Adds cache-control for s3 uploads [Configure Fast.ly](https://miro.com/app/board/uXjVO6C1LxA=/?moveToWidget=3458764524414700733&cot=14)
diff --git a/Gemfile b/Gemfile
@@ -39,6 +39,7 @@ gem 'coderay', '~> 1.0'
 gem 'country_select', '~> 1.3'
 gem 'draper', '~> 4.0'
 gem 'faker'
+gem 'fastly'
 gem 'groupdate'
 gem 'nokogiri'
 gem 'pundit'
diff --git a/Gemfile.lock b/Gemfile.lock
@@ -200,6 +200,7 @@ GEM
     faraday-net_http_persistent (1.2.0)
     faraday-patron (1.0.0)
     faraday-rack (1.0.0)
+    fastly (3.0.2)
     ffi (1.15.4)
     foreman (0.87.2)
     formatador (0.3.0)
@@ -525,6 +526,7 @@ DEPENDENCIES
   draper (~> 4.0)
   factory_bot_rails
   faker
+  fastly
   foreman
   groupdate
   growl
diff --git a/app/controllers/application_controller.rb b/app/controllers/application_controller.rb
@@ -198,6 +198,20 @@ def program_tracks
   end
 
   def set_cache_headers
-    expires_in 1.hour, public: true
+    return unless Rails.configuration.action_controller.perform_caching
+
+    server_cache_age =
+      current_website.caching_off? ? 0 : ENV.fetch('CACHE_CONTROL_S_MAXAGE', 1.week)
+
+    expires_in(
+      ENV.fetch('CACHE_CONTROL_MAX_AGE', 0).to_i,
+      public: !current_website.caching_off?,
+      's-maxage': server_cache_age.to_i
+    )
+    response.headers['Surrogate-Key'] = current_website.event.slug if FastlyService.service
+    fresh_when(
+      current_website,
+      last_modified: current_website.purged_at || current_website.updated_at
+    ) unless current_website.caching_off?
   end
 end
diff --git a/app/controllers/staff/websites_controller.rb b/app/controllers/staff/websites_controller.rb
@@ -27,6 +27,13 @@ def update
     end
   end
 
+  def purge
+    @website.manual_purge
+
+    flash[:success] = "Website was successfully purged."
+    redirect_to edit_event_staff_website_path(current_event)
+  end
+
   private
 
   def set_website
@@ -55,6 +62,7 @@ def website_params
         :facebook_url,
         :instagram_url,
         :head_content,
+        :caching,
         footer_categories: [],
         navigation_links: [],
         session_format_configs_attributes: [
diff --git a/app/models/page.rb b/app/models/page.rb
@@ -4,7 +4,7 @@ class Page < ApplicationRecord
     'home' => { },
   }
 
-  belongs_to :website
+  belongs_to :website, touch: :purged_at
 
   scope :published, -> { where.not(published_body: nil).where(hide_page: false) }
   scope :in_footer, -> { published.where.not(footer_category: [nil, ""]) }
diff --git a/app/models/sponsor.rb b/app/models/sponsor.rb
@@ -1,5 +1,6 @@
 class Sponsor < ApplicationRecord
   belongs_to :event
+  has_one :website, through: :event, touch: :purged_at
 
   has_one_attached :primary_logo
   has_one_attached :footer_logo
diff --git a/app/models/website.rb b/app/models/website.rb
@@ -1,4 +1,6 @@
 class Website < ApplicationRecord
+  enum caching: { off: 'off', automatic: 'automatic', manual: 'manual' }, _prefix: true
+
   belongs_to :event
   has_many :pages, dependent: :destroy
   has_many :fonts, class_name: 'Website::Font', dependent: :destroy
@@ -19,11 +21,26 @@ class Website < ApplicationRecord
   has_one_attached :background
   has_one_attached :favicon
 
+  after_touch :purge_cache, if: :caching_automatic?
+  around_update :purge_cache, if: :caching_automatic?
+
   DEFAULT = 'default'.freeze
 
   def self.domain_match(domain)
     where(arel_table[:domains].matches("%#{(domain)}"))
   end
+
+  def manual_purge
+    purge_cache { save }
+  end
+
+  private
+
+  def purge_cache
+    self.purged_at = Time.current
+    yield if block_given?
+    FastlyService.service&.purge_by_key(event.slug)
+  end
 end
 
 # == Schema Information
diff --git a/app/policies/website_policy.rb b/app/policies/website_policy.rb
@@ -18,4 +18,8 @@ def edit?
   def update?
     show?
   end
+
+  def purge?
+    show?
+  end
 end
diff --git a/app/views/staff/websites/_form.html.haml b/app/views/staff/websites/_form.html.haml
@@ -72,6 +72,9 @@
         = ff.input :author
         = ff.input :description
         = image_input(ff, :image)
+
+      %legend.fieldset-legent Caching
+      = f.input :caching, collection: Website.cachings, include_blank: false
   .row
     .col-sm-12
       = submit_tag("Save", class: "pull-right btn btn-success", type: "submit")
diff --git a/app/views/staff/websites/edit.html.haml b/app/views/staff/websites/edit.html.haml
@@ -1,7 +1,13 @@
 .row
   .col-md-12
     .page-header.clearfix
-      .btn-navbar.pull-right
+      .btn-navbar
         %h1 Edit Website
+      - if FastlyService.service
+        .pull-right
+          = button_to "Purge",
+            purge_event_staff_website_path(current_event),
+            class: 'btn btn-success',
+            data: { confirm: "Are you sure you want to purge all website cached content in Fastly?" }
 
 = render 'form', website: @website
diff --git a/app/views/staff/websites/new.html.haml b/app/views/staff/websites/new.html.haml
@@ -1,7 +1,7 @@
 .row
   .col-md-12
     .page-header.clearfix
-      .btn-navbar.pull-right
+      .btn-navbar
         %h1 New Website
 
 = render 'form', website: @website
diff --git a/config/initializers/fastly_service.rb b/config/initializers/fastly_service.rb
@@ -0,0 +1,16 @@
+class FastlyService
+  include Singleton
+
+  attr_reader :service
+
+  def initialize
+    if ENV['FASTLY_API_KEY']
+      fastly  = Fastly.new(api_key: ENV['FASTLY_API_KEY'])
+      @service = Fastly::Service.new({ id: ENV['FASTLY_SERVICE_ID'] }, fastly)
+    end
+  end
+
+  def self.service
+    self.instance.service
+  end
+end
diff --git a/config/routes.rb b/config/routes.rb
@@ -120,7 +120,11 @@
 
       resources :session_formats, except: :show
       resources :tracks, except: [:show]
-      resource :website, only: [:new, :create, :edit, :update]
+      resource :website, only: [:new, :create, :edit, :update] do
+        member do
+          post :purge
+        end
+      end
       resources :pages do
         member do
           get :preview
diff --git a/config/storage.yml b/config/storage.yml
@@ -13,6 +13,8 @@ amazon:
   secret_access_key: <%= ENV.fetch("AWS_SECRET_ACCESS_KEY", "")  %>
   region: <%= ENV.fetch("AWS_REGION", "us-east-1") %>
   bucket: <%= ENV.fetch("AWS_S3_BUCKET", "") %>
+  upload:
+    cache_control: 'max-age=<%= ENV.fetch('AWS_CACHE_CONTROL', 86400) %>, private'
 
 # Remember not to checkin your GCS keyfile to a repository
 # google:
diff --git a/db/migrate/20220512134224_add_caching_fields_to_websites.rb b/db/migrate/20220512134224_add_caching_fields_to_websites.rb
@@ -0,0 +1,6 @@
+class AddCachingFieldsToWebsites < ActiveRecord::Migration[6.1]
+  def change
+    add_column :websites, :caching, :string, default: 'off', null: false
+    add_column :websites, :purged_at, :datetime
+  end
+end
diff --git a/db/schema.rb b/db/schema.rb
@@ -10,7 +10,7 @@
 #
 # It's strongly recommended that you check this file into your version control system.
 
-ActiveRecord::Schema.define(version: 2022_05_08_071747) do
+ActiveRecord::Schema.define(version: 2022_05_12_134224) do
 
   # These are extensions that must be enabled in order to support this database
   enable_extension "plpgsql"
@@ -384,6 +384,8 @@
     t.string "facebook_url"
     t.string "instagram_url"
     t.string "navigation_links", default: [], array: true
+    t.string "caching", default: "off", null: false
+    t.datetime "purged_at"
     t.index ["event_id"], name: "index_websites_on_event_id"
   end
 
diff --git a/spec/features/website/configuration_spec.rb b/spec/features/website/configuration_spec.rb
@@ -101,4 +101,62 @@
 
     expect(computed_style("#red-dog", "color")).to eq("rgb(218, 55, 61)")
   end
+
+  scenario "Organizer adjusts website caching", :caching do
+    fastly_service = spy("fastly_service")
+    allow(FastlyService).to receive(:service).and_return fastly_service
+    website = create(:website, event: event)
+    home_page = create(:page, website: website, published_body: 'Home Content')
+
+    visit page_path(event, home_page)
+    expect(response_headers["Cache-Control"]).to eq("max-age=0, private, s-maxage=0")
+
+    login_as(organizer)
+    visit edit_event_staff_website_path(event)
+
+    select("automatic", from: "Caching")
+    click_on("Save")
+
+    visit page_path(event, home_page)
+    expect(response_headers["Cache-Control"]).to eq("max-age=0, public, s-maxage=604800")
+    expect(response_headers["Surrogate-Key"]).to eq(event.slug)
+    last_modified = response_headers["Last-Modified"]
+
+    visit page_path(event, home_page)
+    expect(response_headers["Last-Modified"]).to eq(last_modified)
+
+    RSpec::Mocks.space.proxy_for(fastly_service).reset
+    sleep 1
+    visit event_staff_pages_path(event)
+    click_on("Publish")
+    expect(fastly_service).to have_received(:purge_by_key).with(event.slug)
+
+    visit page_path(event, home_page)
+    expect(response_headers["Last-Modified"]).not_to eq(last_modified)
+
+    visit edit_event_staff_website_path(event)
+
+    select("manual", from: "Caching")
+    click_on("Save")
+
+    visit page_path(event, home_page)
+    expect(response_headers["Cache-Control"]).to eq("max-age=0, public, s-maxage=604800")
+    expect(response_headers["Surrogate-Key"]).to eq(event.slug)
+    last_modified = response_headers["Last-Modified"]
+
+    RSpec::Mocks.space.proxy_for(fastly_service).reset
+    sleep 1
+    visit event_staff_pages_path(event)
+    click_on("Publish")
+    expect(fastly_service).not_to have_received(:purge_by_key).with(event.slug)
+
+    visit page_path(event, home_page)
+    expect(response_headers["Last-Modified"]).to eq(last_modified)
+
+    visit edit_event_staff_website_path(event)
+    click_on("Purge")
+
+    visit page_path(event, home_page)
+    expect(response_headers["Last-Modified"]).not_to eq(last_modified)
+  end
 end
diff --git a/spec/policies/website_policy_spec.rb b/spec/policies/website_policy_spec.rb
@@ -12,7 +12,7 @@ def pundit_user(user)
     CurrentEventContext.new(user, event)
   end
 
-  permissions :show?, :new?, :create?, :edit?, :update? do
+  permissions :show?, :new?, :create?, :edit?, :update?, :purge? do
     it 'allows organizers for event' do
       expect(subject).to permit(pundit_user(organizer))
     end
diff --git a/spec/rails_helper.rb b/spec/rails_helper.rb
@@ -62,6 +62,12 @@
       save_timestamped_screenshot(Capybara.page)
     end
   end
+
+  config.around(:each, caching: true) do |example|
+    Rails.configuration.action_controller.perform_caching = true
+    example.run
+    Rails.configuration.action_controller.perform_caching = false
+  end
 end
 
 Capybara.register_driver :chrome do |app|

Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,7 @@ class Page < ApplicationRecord`
`4`	`4`	`'home' => { },`
`5`	`5`	`}`
`6`	`6`
`7`		`- belongs_to :website`
	`7`	`+ belongs_to :website, touch: :purged_at`
`8`	`8`
`9`	`9`	`scope :published, -> { where.not(published_body: nil).where(hide_page: false) }`
`10`	`10`	`scope :in_footer, -> { published.where.not(footer_category: [nil, ""]) }`