Set action_mailer.default_url_options values in development and test#51191
Merged
rafaelfranca merged 2 commits intorails:mainfrom Feb 27, 2024
Merged
Conversation
…test`. Prior to this commit, new Rails applications would raise `ActionView::Template::Error` if a mailer included a url built with a `*_path` helper. Since we already know [new apps will be served on `localhost:3000`][new apps], we set this as the value in `development`. In an effort to remain consistent with existing patters, we set the `host` to `www.example.com` in `test. [new apps]: https://github.com/rails/rails/blob/47300002db11d67d7b35103f5c429dad7dacdacd/README.md?plain=1#L81
stevepolitodesign
force-pushed
the
sp-action-mailer-default-url-options
branch
from
fa72229 to
9412008
Compare
|
|
||
| config.action_mailer.perform_caching = false | ||
|
|
||
| config.action_mailer.define_url_options = { host: "localhost", port: 3000 } |
Contributor
Author
There was a problem hiding this comment.
Even though we can set this to anything, I felt it was important to keep it consistent with what Rails is served on, in an effort to make previews link to the application.
Contributor
There was a problem hiding this comment.
This sounds like a helpful change—thanks! Quick question: The bin/rails server command allows a --port XXXX flag (and with bin/dev you set it via an env var, e.g. PORT=XXXX bin/dev). Any reason not to use that value, with a default of 3000? I ask because I often use that flag when I have multiple rails apps running.
Contributor
Author
There was a problem hiding this comment.
That's a great observation. I think we'd somehow need access to the value set in Rails::Commands::Server::ServerCommand:
rails/railties/lib/rails/commands/server/server_command.rb
Lines 213 to 215 in bf8e0f5
I attempted the following implementation, but if ENV["PORT"] is not set, it won't match what's passed to the --port flag.
config.action_mailer.default_url_options = { host: "localhost", port: ENV.fetch("PORT", 3000).to_i }However, this seemed to work for the following cases:
- When
ENV["PORT"]is supplied - When
--portis supplied. - When neither
ENV["PORT"]nor--portis supplied (defaulting to3000)
config.action_mailer.default_url_options = { host: "localhost", port: Rails::Server::Options.new.parse!(ARGV)[:Port] }
rafaelfranca
requested changes
Feb 27, 2024
railties/lib/rails/generators/rails/app/templates/config/environments/development.rb.tt
Outdated
Show resolved
Hide resolved
…onments/development.rb.tt Co-authored-by: Rafael Mendonça França <[email protected]>
jathayde
pushed a commit
to jathayde/rails
that referenced
this pull request
Feb 28, 2024
…test` (rails#51191) * Set `action_mailer.default_url_options` values in `development` and `test`. Prior to this commit, new Rails applications would raise `ActionView::Template::Error` if a mailer included a url built with a `*_path` helper. Since we already know [new apps will be served on `localhost:3000`][new apps], we set this as the value in `development`. In an effort to remain consistent with existing patters, we set the `host` to `www.example.com` in `test. [new apps]: https://github.com/rails/rails/blob/47300002db11d67d7b35103f5c429dad7dacdacd/README.md?plain=1#L81 * Update railties/lib/rails/generators/rails/app/templates/config/environments/development.rb.tt Co-authored-by: Rafael Mendonça França <[email protected]> --------- Co-authored-by: Rafael Mendonça França <[email protected]>
viralpraxis
pushed a commit
to viralpraxis/rails
that referenced
this pull request
Mar 24, 2024
…test` (rails#51191) * Set `action_mailer.default_url_options` values in `development` and `test`. Prior to this commit, new Rails applications would raise `ActionView::Template::Error` if a mailer included a url built with a `*_path` helper. Since we already know [new apps will be served on `localhost:3000`][new apps], we set this as the value in `development`. In an effort to remain consistent with existing patters, we set the `host` to `www.example.com` in `test. [new apps]: https://github.com/rails/rails/blob/47300002db11d67d7b35103f5c429dad7dacdacd/README.md?plain=1#L81 * Update railties/lib/rails/generators/rails/app/templates/config/environments/development.rb.tt Co-authored-by: Rafael Mendonça França <[email protected]> --------- Co-authored-by: Rafael Mendonça França <[email protected]>
fractaledmind
pushed a commit
to fractaledmind/rails
that referenced
this pull request
May 13, 2024
…test` (rails#51191) * Set `action_mailer.default_url_options` values in `development` and `test`. Prior to this commit, new Rails applications would raise `ActionView::Template::Error` if a mailer included a url built with a `*_path` helper. Since we already know [new apps will be served on `localhost:3000`][new apps], we set this as the value in `development`. In an effort to remain consistent with existing patters, we set the `host` to `www.example.com` in `test. [new apps]: https://github.com/rails/rails/blob/47300002db11d67d7b35103f5c429dad7dacdacd/README.md?plain=1#L81 * Update railties/lib/rails/generators/rails/app/templates/config/environments/development.rb.tt Co-authored-by: Rafael Mendonça França <[email protected]> --------- Co-authored-by: Rafael Mendonça França <[email protected]>
xjunior
pushed a commit
to xjunior/rails
that referenced
this pull request
Jun 9, 2024
…test` (rails#51191) * Set `action_mailer.default_url_options` values in `development` and `test`. Prior to this commit, new Rails applications would raise `ActionView::Template::Error` if a mailer included a url built with a `*_path` helper. Since we already know [new apps will be served on `localhost:3000`][new apps], we set this as the value in `development`. In an effort to remain consistent with existing patters, we set the `host` to `www.example.com` in `test. [new apps]: https://github.com/rails/rails/blob/47300002db11d67d7b35103f5c429dad7dacdacd/README.md?plain=1#L81 * Update railties/lib/rails/generators/rails/app/templates/config/environments/development.rb.tt Co-authored-by: Rafael Mendonça França <[email protected]> --------- Co-authored-by: Rafael Mendonça França <[email protected]>
yoones
pushed a commit
to yoones/rails
that referenced
this pull request
Mar 6, 2025
…test` (rails#51191) * Set `action_mailer.default_url_options` values in `development` and `test`. Prior to this commit, new Rails applications would raise `ActionView::Template::Error` if a mailer included a url built with a `*_path` helper. Since we already know [new apps will be served on `localhost:3000`][new apps], we set this as the value in `development`. In an effort to remain consistent with existing patters, we set the `host` to `www.example.com` in `test. [new apps]: https://github.com/rails/rails/blob/47300002db11d67d7b35103f5c429dad7dacdacd/README.md?plain=1#L81 * Update railties/lib/rails/generators/rails/app/templates/config/environments/development.rb.tt Co-authored-by: Rafael Mendonça França <[email protected]> --------- Co-authored-by: Rafael Mendonça França <[email protected]>
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Motivation / Background
Prior to this commit, new Rails applications would raise
ActionView::Template::Errorif a mailer included a url built with a*_pathhelper.Since we already know new apps will be served on
localhost:3000, we set this as the value indevelopment.In an effort to remain consistent with existing patters, we set the
hosttowww.example.comintest.Additional information
If we feel this is not the right solution, how do we feel about at least adding these values, but commented out?
Checklist
Before submitting the PR make sure the following are checked:
[Fix #issue-number]