Add GovukProxy::StaticProxy for development #261
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This is library allows us to add rack middleware to proxy requests.
sengi
approved these changes
Sep 1, 2022
theseanything
added a commit
to alphagov/collections
that referenced
this pull request
Sep 1, 2022
This sets the GOVUK_PROXY_STATIC_URL env var to enable the proxy to Static in production. This is so the application continues, when Static changes to use relative URLs for assets. See alphagov/govuk_app_config#261 and alphagov/govuk-puppet#11801
kevindew
reviewed
Sep 1, 2022
lib/govuk_app_config/railtie.rb
Outdated
| @@ -1,5 +1,10 @@ | |||
| module GovukAppConfig | |||
| class Railtie < Rails::Railtie | |||
| initializer "govuk_app_config.configure_govuk_proxy" do |app| | |||
| static_url = ENV["GOVUK_PROXY_STATIC_URL"] | |||
| app.middleware.use GovukProxy::StaticProxy, backend: static_url if static_url.present? | |||
There was a problem hiding this comment.
Are you sure about switching from the previous iteration where the env var acted as a toggle rather than defining the URL.
It looks a bit more painful doing this rather than using Plek since you'll always have to set two env vars to the same thing to use this. I'm not sure there is a scenario where someone would want a different url for this than they'd have for static?
There was a problem hiding this comment.
Yup agree - was a bit clunky having to set to URLs. Switched by to using Plek.
| end | ||
| end | ||
|
|
||
| def test_request(path, proxied) |
There was a problem hiding this comment.
You should define this helper method within the RSpec describe method, as it'd be only scoped to tests there, whereas here it is a global function available to the whole app (defined as a method on Object)
| let(:app_domain) { "app.domain" } | ||
| let(:static_domain) { "static.domain" } | ||
|
|
||
| subject { GovukProxy::StaticProxy.new(app, backend: "https://static.domain", streaming: false) } |
There was a problem hiding this comment.
I think this use of unnamed subject would fall foul of RSpec linting rules. I've had a look and they're not on for this app so predictably running them is a bit grim. May want to just change this to
let(:proxy) { described_class.new(app, backend: "https://static.domain", streaming: false) } to not leave linting issues.
There was a problem hiding this comment.
Updated - thanks!
This class can be loaded as Rack middleware and will proxy any requests with the path prefix of `/assets/static` to backend specified. This is useful as it enables Static to use relative paths and the dependent frontend application can forward those requests. This allows us to switch Static to use relative path and allow us to have development environment and not run Static locally (i.e. forward request to production version of Static).
This is library allows us to resolve the URL for Static.
This adds a railtie to initialise the proxy middleware with backend set to the URL resolved by Plek for Static. This allows frontend apps to enable the proxying behavior in development by simply setting the env var GOVUK_PROXY_STATIC_ENABLED to "true".
theseanything
force-pushed
the
add-govuk-proxy
branch
from
033db16
to
819d01e
Compare
theseanything
force-pushed
the
add-govuk-proxy
branch
from
819d01e
to
ef546c3
Compare
theseanything
added a commit
to alphagov/collections
that referenced
this pull request
Sep 1, 2022
This sets the GOVUK_PROXY_STATIC_ENABLED env var to enable the proxy to Static in production. This is so the application continues, when Static changes to use relative URLs for assets. See alphagov/govuk_app_config#261 and alphagov/govuk-puppet#11801
This was referenced Sep 1, 2022
theseanything
added a commit
to alphagov/finder-frontend
that referenced
this pull request
Sep 1, 2022
This sets the GOVUK_PROXY_STATIC_ENABLED env var to enable the proxy to Static in production. This is so the application continues, when Static changes to use relative URLs for assets. See alphagov/govuk_app_config#261 and alphagov/govuk-puppet#11801
theseanything
added a commit
to alphagov/frontend
that referenced
this pull request
Sep 1, 2022
This sets the GOVUK_PROXY_STATIC_ENABLED env var to enable the proxy to Static in production. This is so the application continues, when Static changes to use relative URLs for assets. See alphagov/govuk_app_config#261 and alphagov/govuk-puppet#11801
theseanything
added a commit
to alphagov/government-frontend
that referenced
this pull request
Sep 1, 2022
This sets the GOVUK_PROXY_STATIC_ENABLED env var to enable the proxy to Static in production. This is so the application continues, when Static changes to use relative URLs for assets. See alphagov/govuk_app_config#261 and alphagov/govuk-puppet#11801
theseanything
added a commit
to alphagov/info-frontend
that referenced
this pull request
Sep 1, 2022
This sets the GOVUK_PROXY_STATIC_ENABLED env var to enable the proxy to Static in production. This is so the application continues, when Static changes to use relative URLs for assets. See alphagov/govuk_app_config#261 and alphagov/govuk-puppet#11801
theseanything
added a commit
to alphagov/licence-finder
that referenced
this pull request
Sep 1, 2022
This sets the GOVUK_PROXY_STATIC_ENABLED env var to enable the proxy to Static in production. This is so the application continues, when Static changes to use relative URLs for assets. See alphagov/govuk_app_config#261 and alphagov/govuk-puppet#11801
theseanything
added a commit
to alphagov/service-manual-frontend
that referenced
this pull request
Sep 1, 2022
This sets the GOVUK_PROXY_STATIC_ENABLED env var to enable the proxy to Static in production. This is so the application continues, when Static changes to use relative URLs for assets. See alphagov/govuk_app_config#261 and alphagov/govuk-puppet#11801
theseanything
added a commit
to alphagov/smart-answers
that referenced
this pull request
Sep 1, 2022
This sets the GOVUK_PROXY_STATIC_ENABLED env var to enable the proxy to Static in production. This is so the application continues, when Static changes to use relative URLs for assets. See alphagov/govuk_app_config#261 and alphagov/govuk-puppet#11801
theseanything
added a commit
to alphagov/govuk-docker
that referenced
this pull request
Sep 1, 2022
This sets the GOVUK_PROXY_STATIC_ENABLED env var to enable the proxy to Static in production. This is so the application continues, when Static changes to use relative URLs for assets. See alphagov/govuk_app_config#261 and alphagov/govuk-puppet#11801
kevindew
approved these changes
Sep 2, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This class can be loaded as Rack middleware and will proxy any requests with the path prefix of
/assets/staticto backend specified. This is useful as it enables Static to use relative paths and the dependent frontend application can forward those requests. This allows us to switch Static to use relative path and allow us to have development environment and not run Static locally (i.e. forward request to production version of Static).Rails can be made to initialise the proxy middleware by setting the
GOVUK_PROXY_STATIC_ENABLED=trueenv var.