canvas-lms/lib/canvas/cdn/rev_manifest.rb

140 lines
4.3 KiB
Ruby

# frozen_string_literal: true
#
# Copyright (C) 2015 - present Instructure, Inc.
#
# This file is part of Canvas.
#
# Canvas is free software: you can redistribute it and/or modify it under
# the terms of the GNU Affero General Public License as published by the Free
# Software Foundation, version 3 of the License.
#
# Canvas is distributed in the hope that it will be useful, but WITHOUT ANY
# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
# A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
# details.
#
# You should have received a copy of the GNU Affero General Public License along
# with this program. If not, see <http://www.gnu.org/licenses/>.
require 'set'
# An interface to the manifest file created by `gulp rev` and webpack
module Canvas
module Cdn
module RevManifest
class << self
include ActiveSupport::Benchmarkable
# ActiveSupport::Benchmarkable#benchmark needs a `logger` defined
def logger
Rails.logger
end
def include?(source)
if webpack_request?(source)
true
else
gulp_revved_urls.include?(source)
end
end
def gulp_manifest
load_gulp_data_if_needed
@gulp_manifest
end
def webpack_manifest
load_webpack_data_if_needed
@webpack_manifest
end
def gulp_revved_urls
load_gulp_data_if_needed
@gulp_revved_urls
end
def webpack_request?(source)
source =~ Regexp.new(webpack_dir)
end
def webpack_prod?
ENV['USE_OPTIMIZED_JS'] == 'true' || ENV['USE_OPTIMIZED_JS'] == 'True'
end
def webpack_dir
if webpack_prod?
'dist/webpack-production'
else
'dist/webpack-dev'
end
end
def all_webpack_chunks_for(bundle)
webpack_manifest[bundle]
end
def webpack_url_for(source)
# source will look something like: "dist/webpack-prod/vendor.js"
# the manifest looks something like: {"vendor.js" : "vendor-c-d4be58c989364f9fe7db.js", ...}
# we want to return something like: "/dist/webpack-prod/vendor-c-d4be58c989364f9fe7db.js"
key = source.sub(webpack_dir + '/', '')
fingerprinted = webpack_manifest[key]
"/#{webpack_dir}/#{fingerprinted}" if fingerprinted
end
def revved_url_for(source)
fingerprinted = gulp_manifest[source]
"/dist/#{fingerprinted}" if fingerprinted
end
def url_for(source)
# remove the leading slash if there is one
source = source.sub(/^\//, '')
if webpack_request?(source)
webpack_url_for(source)
else
revved_url_for(source)
end
end
private
def load_gulp_data_if_needed
return if ActionController::Base.perform_caching && defined? @gulp_manifest
RequestCache.cache("rev-manifest") do
benchmark("reading rev-manifest") do
file = Rails.root.join('public', 'dist', 'rev-manifest.json')
if file.exist?
Rails.logger.debug "reading rev-manifest.json"
@gulp_manifest = JSON.parse(file.read).freeze
elsif Rails.env.production?
raise "you need to run `gulp rev` first"
else
@gulp_manifest = {}.freeze
end
@gulp_revved_urls = Set.new(@gulp_manifest.values.map{|s| "/dist/#{s}" }).freeze
end
end
end
def load_webpack_data_if_needed
return if (ActionController::Base.perform_caching || webpack_prod?) && defined? @webpack_manifest
RequestCache.cache("webpack_manifest") do
benchmark("reading webpack_manifest") do
file = Rails.root.join('public', webpack_dir, 'webpack-manifest.json')
if file.exist?
Rails.logger.debug "reading #{file}"
@webpack_manifest = JSON.parse(file.read).freeze
else
raise "you need to run webpack" unless Rails.env.test?
@webpack_manifest = Hash.new(["Error: you need to run webpack"]).freeze
end
end
end
end
end
end
end
end