Deprecate asset fallback #375
Conversation
When an asset isn't found the behavior is to pass the string through. For example a valid asset will return a url from pipeline
```
asset_path("application.js")
# => assets/application-123098udasvi0mnafd.js
```
While if you make a typo, you won't get an error or anything, it just falls through:
```
asset_path("app1icati0n.js")
# => "app1icati0n.js"
```
Hopefully I don't have to elaborate on why this is bad.
This PR is a child PR to one in Rails that will introduce a `public_asset_path` API.
There are valid reasons for not using the asset pipeline, if you have a purely static asset in the public folder or if you want to link to a static URL in your assets somewhere it makes sense to declare that intention. Eventually we will replace the behavior of the deprecation with an exception so people don't lose hours of their to typos.
We only emit the deprecation when a `public_` api is available in Rails. This means that sprockets-rails can still be used in a backwards compatible manner.
|
The Rails PR is rails/rails#26226 |
Instead of relying on hard coded indexes, we can look through the called method stack backwards (i.e. the first method called will be the first in the list). If it has a suffix for one of our APIs, then we check to see if there exists a `public_` prefix on the view, if it does it's the first method called that can be deprecated so we point to that.
Use `public_folder: true` instead.
- Use `public_folder: true` instead. - Allow configurable deprecation/error behavior via **`config.assets.unknown_asset_fallback`** When set to a truthy value, the a result will be returned even if the requested asset is not found in the asset pipeline. When set to `false` it will raise an error.
| @@ -6,6 +6,7 @@ | |||
| module Sprockets | |||
| module Rails | |||
| module Helper | |||
| class AssetNotFound < StandardError; end | |||
There was a problem hiding this comment.
Shouldn't we add a newline after this class definition?
Address comments by @kaspth
| message << "The public fallback behavior is being deprecaed and will be removed.\n" | ||
| message << "pass in `skip_pipeline: true` instead.\n" | ||
|
|
||
| call_stack = respond_to?(:caller_locations) ? caller_locations : caller |
There was a problem hiding this comment.
If we're on a Rails new enough to have public_compute_asset_path, that implies we're on a Ruby new enough to have caller_locations, doesn't it?
There was a problem hiding this comment.
The tests don't actually use Rails 5.1, we define the method, and the tests get run on all Ruby versions. The alternative to this would be detecting ruby versions and skipping the tests, which is less clean. I also want to be able to make a gem so that older versions of Rails can use this flag to get the error/deprecation behavior.
|
Does @matthewd's comment about |
👏
|
I know it's been a long time since this PR was merged. Is there any chance we could get an update to the section of the Rails Guides that addresses asset fallback? I'd be glad to submit a PR with the approval of the team (but otherwise, I'm reluctant to spend any time on it). |
When an asset isn't found the behavior is to pass the string through. For example a valid asset will return a url from pipeline
While if you make a typo, you won't get an error or anything, it just falls through:
Hopefully I don't have to elaborate on why this is bad.
This PR is a child PR to one in Rails that will introduce a
public_asset_pathAPI.There are valid reasons for not using the asset pipeline, if you have a purely static asset in the public folder or if you want to link to a static URL in your assets somewhere it makes sense to declare that intention. Eventually we will replace the behavior of the deprecation with an exception so people don't lose hours of their to typos.
We only emit the deprecation when a
public_api is available in Rails. This means that sprockets-rails can still be used in a backwards compatible manner.