Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[30] Proxy Static Pages #317

Merged
merged 9 commits into from
Dec 17, 2024
Merged
Show file tree
Hide file tree
Changes from 6 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .codeclimate.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,4 @@ exclude_patterns:
- vendor/
- "**/vendor/**/*"
- app/assets/images/
- spec/**/*
- spec/**/*
1 change: 1 addition & 0 deletions .simplecov
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ SimpleCov.start 'rails' do
add_filter '/app/jobs/application_job.rb'
add_filter '/app/mailers/application_mailer.rb'
add_filter '/app/models/application_record.rb'
add_filter '/app/controllers/pages_controller.rb'

add_filter '/app/controllers/sandbox_controller.rb'

Expand Down
2 changes: 2 additions & 0 deletions Gemfile
Original file line number Diff line number Diff line change
Expand Up @@ -102,3 +102,5 @@ end
gem "factory_bot", "~> 6.5"

gem "faker", "~> 3.4"

gem "rails-reverse-proxy"
4 changes: 4 additions & 0 deletions Gemfile.lock
Original file line number Diff line number Diff line change
Expand Up @@ -255,6 +255,9 @@ GEM
rails-html-sanitizer (1.6.0)
loofah (~> 2.21)
nokogiri (~> 1.14)
rails-reverse-proxy (0.13.0)
actionpack
addressable
railties (7.2.2)
actionpack (= 7.2.2)
activesupport (= 7.2.2)
Expand Down Expand Up @@ -398,6 +401,7 @@ DEPENDENCIES
puma (>= 6.4.3)
rails (~> 7.2.1)
rails-controller-testing
rails-reverse-proxy
rspec-rails
rspec_junit_formatter
rubocop (>= 1.66.0)
Expand Down
65 changes: 65 additions & 0 deletions app/controllers/pages_controller.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
# frozen_string_literal: true

# Proxy Cloud.gov pages content at the root of the application
class PagesController < ApplicationController
include ReverseProxy::Controller
# We must remove this for proxy of JS assets to be loaded by the browser
protect_from_forgery except: :assets
Fixed Show fixed Hide fixed
Dismissed Show dismissed Hide dismissed

# TODO: When launched, the cloud.gov pages need to move off the www.challenge.gov domain
# and these constants will need to be updated. The will be similar to the commented out versions
DOMAIN = "federalist-2c628203-05c2-48ab-8f87-3eda79380559.sites.pages.cloud.gov"
HOST = "https://federalist-2c628203-05c2-48ab-8f87-3eda79380559.sites.pages.cloud.gov"
BASE_URL = "/preview/gsa/challenges-and-prizes/eval-dev/"
# DOMAIN = "content.challenge.gov".freeze
# HOST = "https://content.challenge.gov".freeze
# BASE_URL = "/".freeze

def index
path = "#{BASE_URL}#{params[:path]}/"
reverse_proxy(HOST, path:, reset_accept_encoding: true, headers: { host: DOMAIN }) do |config|
config.on_missing do |_code, _response|
redirect_to "/dashboard"
return true
end

config.on_response do |_code, response|
response.body = rewrite_links(response.body)
end
end
end

def assets
if params[:ext] == "min"
path = "#{HOST}#{BASE_URL}assets/#{params[:path]}.#{params[:ext]}.js"
response = Faraday.get(path)
send_data(response.body, type: 'application/javascript')
else
path = "#{BASE_URL}assets/#{params[:path]}.#{params[:ext]}"
reverse_proxy(HOST, path:, reset_accept_encoding: true, headers: { host: DOMAIN })
end
end

def root
path = BASE_URL
reverse_proxy(HOST, path:, reset_accept_encoding: true, headers: { host: DOMAIN }) do |config|
config.on_response do |_code, response|
if response.body.present?
response.body = rewrite_links(response.body)
end
end
end
end

private

def rewrite_links(html)
parsed_html = html.gsub(HOST, "/")
if BASE_URL.length > 1
parsed_html = parsed_html.gsub(BASE_URL, "/")
end
# rubocop:disable Rails/OutputSafety
parsed_html.html_safe
# rubocop:enable Rails/OutputSafety
end
end
3 changes: 2 additions & 1 deletion config/initializers/assets.rb
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,8 @@

Rails.application.config.assets.enabled = true


# Move the rails assets so they don't conflict with the static pages
Rails.application.config.assets.prefix = "/platform-assets"

# Rails.application.config.assets.paths << Rails.root.join("app", "assets", "plugins", "uswds","js")

Expand Down
7 changes: 4 additions & 3 deletions config/routes.rb
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@
delete 'timeout'
end

get '/', to: "dashboard#index"
get '/dashboard', to: "dashboard#index"

resources :evaluations, only: [:index]
Expand All @@ -35,13 +34,15 @@
# Can be used by load balancers and uptime monitors to verify that the app is live.
get "up" => "rails/health#show", as: :rails_health_check

# Defines the root path route ("/")
# root "posts#index"
if Rails.env.development? || Rails.env.dev? || Rails.env.test?
namespace :dev do
get "/sandbox", to: "sandbox#index"
get "/accounts", to: "accounts#index"
post "/login", to: "accounts#login"
end
end

match '/assets/*path.:ext' => 'pages#assets', via: [:get]
match '/*path' => 'pages#index', via: [:get]
match '/' => 'pages#root', via: [:get]
end
55 changes: 0 additions & 55 deletions spec/requests/dashboard_request_spec.rb
Original file line number Diff line number Diff line change
Expand Up @@ -3,61 +3,6 @@
RSpec.describe "DashboardController" do
let(:user) { create_and_log_in_user }

describe "GET /" do
before { get "/" }

it_behaves_like "a page with footer content"
it_behaves_like "a page with header content"

context "when logged in as super admin on the root url" do
before do
user.update(role: "super_admin")
get "/"
end

it_behaves_like "a page with dashboard content for a super admin"
end

context "when logged in as admin on the root url" do
before do
user.update(role: "admin")
get "/"
end

it_behaves_like "a page with dashboard content for an admin"
end

context "when logged in as public solver on the root url" do
before do
user.update(role: "solver")
get "/"
end

it_behaves_like "a page with dashboard content for a public solver"
end

context "when logged in as a challenge manager on the root url" do
before do
user.update(role: "challenge_manager")
get "/"
end

it_behaves_like "a page with utility menu links for all users"
it_behaves_like "a page with utility menu links for a challenge manager"
it_behaves_like "a page with dashboard content for a challenge manager"
end

context "when logged in as an evaluator on the root url" do
before do
user.update(role: "evaluator")
get "/"
end

it_behaves_like "a page with utility menu links for all users"
it_behaves_like "a page with dashboard content for an evaluator"
end
end

describe "GET /dashboard" do
before { get "/dashboard" }

Expand Down
43 changes: 43 additions & 0 deletions spec/requests/pages_spec.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
require "rails_helper"

RSpec.describe "PagesController" do
it "get new renders successfully" do
stub_request(:get, PagesController::HOST + PagesController::BASE_URL).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

to_return(status: 200, body: "", headers: {})

get "/"
expect(response).to be_ok
end

it "removes full paths to assets so they proxy too" do
stub_request(:get, PagesController::HOST + PagesController::BASE_URL).
to_return(status: 200, body: PagesController::HOST + PagesController::BASE_URL, headers: {})

get "/"
expect(response.body).to eq("//")
end

it "works for minified js assets" do
stub_request(:get, PagesController::HOST + PagesController::BASE_URL + "assets/uswds.min.js").
to_return(status: 200, body: "", headers: {})

get "/assets/uswds.min.js"
expect(response).to be_ok
end

it "works for image assets" do
stub_request(:get, PagesController::HOST + PagesController::BASE_URL + "assets/logo.svg").
to_return(status: 200, body: "", headers: {})

get "/assets/logo.svg"
expect(response).to be_ok
end

it "404s to the dashboard" do
stub_request(:get, PagesController::HOST + PagesController::BASE_URL + "not_found/").
to_return(status: 404, body: "", headers: {})

get "/not_found"
expect(response).to redirect_to("/dashboard")
end
end
3 changes: 2 additions & 1 deletion spec/system/logins_spec.rb
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,8 @@
end

describe "Logged-out" do
it "web root page is accessible" do
xit "web root page is accessible" do
# Marking as pending as the root page is proxied pages content for now
visit "/"
expect(page).to(be_axe_clean)
end
Expand Down
Loading