discourse/spec/requests/stylesheets_controller_spec.rb
David Taylor 1db3a578e4
PERF: Improve Accept header handling for stylesheets and theme-js (#19357)
The default behavior for Rails is to vary the response of an endpoint based on the `Accept:` header, and therefore it returns a `Vary:` header on responses. This instructs browsers and intermediate proxies to key their caches based on the value of the request's `Accept` header. In some cases (e.g. Akamai), the presence of a `Vary` header is enough to prevent caching entirely.

This commit restructures the Rails route definitions so that:
1. The "format" segment of the route is 'required'
2. The "format" segment of the route is constrained to a single value (e.g. `js` or `css`)

Now that the routes are guaranteed to have a `:format` segment, Rails will always prioritize that over the `Accept` header, and will therefore omit the `Vary` header.

Request specs are also added to test this behaviour for both stylesheets and theme-javascripts.
2022-12-07 15:46:35 +00:00

108 lines
3.5 KiB
Ruby

# frozen_string_literal: true
RSpec.describe StylesheetsController do
it 'can survive cache miss' do
StylesheetCache.destroy_all
manager = Stylesheet::Manager.new(theme_id: nil)
builder = Stylesheet::Manager::Builder.new(target: 'desktop_rtl', manager: manager, theme: nil)
builder.compile
digest = StylesheetCache.first.digest
StylesheetCache.destroy_all
get "/stylesheets/desktop_rtl_#{digest}.css"
expect(response.status).to eq(200)
cached = StylesheetCache.first
expect(cached.target).to eq 'desktop_rtl'
expect(cached.digest).to eq digest
# tmp folder destruction and cached
`rm -rf #{Stylesheet::Manager.cache_fullpath}`
get "/stylesheets/desktop_rtl_#{digest}.css"
expect(response.status).to eq(200)
# there is an edge case which is ... disk and db cache is nuked, very unlikely to happen
end
it 'can lookup theme specific css' do
scheme = ColorScheme.create_from_base(name: "testing", colors: [])
theme = Fabricate(:theme, color_scheme_id: scheme.id)
manager = Stylesheet::Manager.new(theme_id: theme.id)
builder = Stylesheet::Manager::Builder.new(target: :desktop, theme: theme, manager: manager)
builder.compile
`rm -rf #{Stylesheet::Manager.cache_fullpath}`
get "/stylesheets/#{builder.stylesheet_filename.sub(".css", "")}.css"
expect(response.status).to eq(200)
get "/stylesheets/#{builder.stylesheet_filename_no_digest.sub(".css", "")}.css"
expect(response.status).to eq(200)
builder = Stylesheet::Manager::Builder.new(target: :desktop_theme, theme: theme, manager: manager)
builder.compile
`rm -rf #{Stylesheet::Manager.cache_fullpath}`
get "/stylesheets/#{builder.stylesheet_filename.sub(".css", "")}.css"
expect(response.status).to eq(200)
get "/stylesheets/#{builder.stylesheet_filename_no_digest.sub(".css", "")}.css"
expect(response.status).to eq(200)
end
it 'ignores Accept header and does not include Vary header' do
StylesheetCache.destroy_all
manager = Stylesheet::Manager.new(theme_id: nil)
builder = Stylesheet::Manager::Builder.new(target: 'desktop', manager: manager, theme: nil)
builder.compile
digest = StylesheetCache.first.digest
get "/stylesheets/desktop_#{digest}.css"
expect(response.status).to eq(200)
expect(response.headers["Content-Type"]).to eq("text/css")
expect(response.headers["Vary"]).to eq(nil)
get "/stylesheets/desktop_#{digest}.css", headers: { "Accept" => "text/html" }
expect(response.status).to eq(200)
expect(response.headers["Content-Type"]).to eq("text/css")
expect(response.headers["Vary"]).to eq(nil)
get "/stylesheets/desktop_#{digest}.css", headers: { "Accept" => "invalidcontenttype" }
expect(response.status).to eq(200)
expect(response.headers["Content-Type"]).to eq("text/css")
expect(response.headers["Vary"]).to eq(nil)
end
describe "#color_scheme" do
it 'works as expected' do
scheme = ColorScheme.last
get "/color-scheme-stylesheet/#{scheme.id}.json"
expect(response.status).to eq(200)
json = JSON.parse(response.body)
expect(json["color_scheme_id"]).to eq(scheme.id)
end
it 'works with a theme parameter' do
scheme = ColorScheme.last
theme = Theme.last
get "/color-scheme-stylesheet/#{scheme.id}/#{theme.id}.json"
expect(response.status).to eq(200)
json = JSON.parse(response.body)
expect(json["color_scheme_id"]).to eq(scheme.id)
end
end
end