Generate safe `email` and `domain_name` by default (RFC 2606) #2733

stefannibrasil · 2023-03-21T02:34:23Z

Summary

Fixes #2431

faker-ruby is transitioning to no longer generating potentially real email and url addresses.

The migration plan is:

First step:

change email and domain_name to be RFC 2606 compliant. Both now generate safe values by default using the Reserved Top Level DNS Names: example and test. To maintain backwards compatibility and give users the option to use non-safe domains at their own risk, custom domains are allowed.
add deprecation message for free_email and safe_email to use email instead.

Second step (after October 2023):

remove deprecated generators and locales.

To give users time, once the first step is released, users will have until October 2023 to make the necessary changes.

Other Information

Disabling # rubocop:disable Style/IfUnlessModifier because inline conditionals are hard to read and therefore to refactor. With the explicit conditionals, it's easier to extract them to a method, etc.
Unfortunately, the locale tests are only asserting that the results are strings. There is an opportunity to improve them. Help is welcomed!

faker-ruby is transitioning to no longer generating potentially real email and url addresses. The migration plan is: First step: - change `email` and `domain_name` to be RFC 2606 compliant. Both now generate safe values by default using the Reserved Top Level DNS Names: `example` and `test`. To maintain backwards compatibility and give users the option to use non-safe domains at their own risk, custom domains are allowed. Documentation and tests have been updated. - add deprecation message for `free_email` and `safe_email` to use `email` instead. Second step: - remove deprecated generators and locales. Co-authored-by: Thiago Araujo <thd.araujo@gmail.com>

Zeragamba · 2023-03-21T11:22:00Z

doc/default/internet.md

+# Keyword arguments: safe ('example' and 'test' suffixes)
 Faker::Internet.domain_suffix #=> "info"
+Faker::Internet.domain_suffix(safe: true) #=> "example"


suggestion (minor): since we're making breaking changes here, it may be good to also rename this to #tld

Could you clarify more why you think this is a breaking change? If the argument is not provided, the generator still works 🤔

I like the idea of using tld. Maybe we can introduce an alias in another PR? This one is already getting too big 😅

let me know what you think and I will merge this once I hear back from you :) Thanks for the review @Zeragamba

I was thinking about this PR being a breaking change or not. The way this PR handles the problem is by maintaining backwards compatibility for those who want to use unsafe domains. What is going to change is the behavior: the results will be safe by default. It doesn't seem like a breaking change to me. What am I missing?

I agree with you, Stefanni.

@vbrazo did you mean to approve this PR? Just checking because I see your comments but not an approval 🍡 Thank you!

Zeragamba · 2023-03-21T11:22:44Z

lib/faker/default/internet.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true

 module Faker
+  # rubocop:disable Style/IfUnlessModifier


question: should this also be disabled in the project's rubocop?

I don't mind disabling it for the project! I wasn't sure this was what we wanted so I only added it here.

I will push a commit once I figure out how to fix my ssh keys to be able to push again ><

Changed it in 4a46759

vbrazo · 2023-03-29T16:01:51Z

doc/default/internet.md

+Faker::Internet.email(name: 'Nancy') #=> "nancy@terry.test"
+Faker::Internet.email(name: 'Janelle Santiago', separators: ['+']) #=> "janelle+santiago@becker.example"
+Faker::Internet.email(domain: 'gmail.com')  #=> "foo@gmail.com"
+Faker::Internet.email(name: 'sam smith', separators: ['-'], domain: 'test') #=> "sam-smith@test.test"


Thanks for adding more examples and completing the Internet doc.

Faker now does the right thing by default, awesome! faker-ruby/faker#2733

Prior to this commit, the following deprecation warning was appearing in the terminal: NOTE: Faker::Internet.safe_email is deprecated; use email instead. It will be removed on or after 2023-10. More here: faker-ruby/faker#2733

## Related PR - faker-ruby/faker#2733 - faker-ruby/faker#2841

* build(deps-dev): Bump faker from 3.2.3 to 3.3.1 Bumps [faker](https://github.com/faker-ruby/faker) from 3.2.3 to 3.3.1. - [Release notes](https://github.com/faker-ruby/faker/releases) - [Changelog](https://github.com/faker-ruby/faker/blob/main/CHANGELOG.md) - [Commits](faker-ruby/faker@v3.2.3...v3.3.1) --- updated-dependencies: - dependency-name: faker dependency-type: direct:development update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> * fix: Use `Faker::Internet.email` instead of `free_email` ## Related PR - faker-ruby/faker#2733 - faker-ruby/faker#2841 --------- Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Toshimaru <me@toshimaru.net>

stefannibrasil assigned stefannibrasil and thdaraujo Mar 21, 2023

stefannibrasil requested a review from a team March 21, 2023 02:35

stefannibrasil mentioned this pull request Mar 21, 2023

Faker is unsafe to use in automated tests - real urls and email addresses are generated #2431

Closed

Zeragamba approved these changes Mar 21, 2023

View reviewed changes

Disable Rubocop Style/IfUnlessModifier globally

4a46759

stefannibrasil mentioned this pull request Mar 29, 2023

Faker::Internet.password method doesn't add numbers anymore #2704

Closed

stefannibrasil requested a review from vbrazo March 29, 2023 15:26

vbrazo reviewed Mar 29, 2023

View reviewed changes

vbrazo approved these changes Apr 5, 2023

View reviewed changes

thdaraujo merged commit 82d7a86 into faker-ruby:main Apr 5, 2023

thdaraujo deleted the safe-email-and-domains-by-default branch April 5, 2023 01:46

pablobm mentioned this pull request Apr 25, 2023

Adapt to deprecations in the Faker API thoughtbot/administrate#2371

Merged

hatsu38 mentioned this pull request Sep 13, 2023

Faker safe_email -> email lynndylanhurley/devise_token_auth#1607

Merged

hatsu38 mentioned this pull request Oct 17, 2023

Remove deprecate safe_email and free_email methods #2841

Merged

7 tasks

ariccio added a commit to ariccio/COVID-CO2-tracker that referenced this pull request Oct 17, 2023

Remove depreciated Faker safe_email

4eed3d9

Faker now does the right thing by default, awesome! faker-ruby/faker#2733

stefannibrasil mentioned this pull request Nov 13, 2023

Deprecate Generators with External Calls #2852

Closed

aaronskiba mentioned this pull request Jan 31, 2024

Fix MySQL and PostgreSQL GitHub Actions DMPRoadmap/roadmap#3375

Closed

aaronskiba mentioned this pull request Feb 1, 2024

Fix MySQL and PostgreSQL GitHub Actions DMPRoadmap/roadmap#3376

Merged

stefannibrasil mentioned this pull request May 8, 2024

Add test range param to NHS numbers #2947

Merged

4 tasks

toshimaru added a commit to toshimaru/RailsTwitterClone that referenced this pull request May 15, 2024

fix: Use Faker::Internet.email instead of free_email

dc28976

## Related PR - faker-ruby/faker#2733 - faker-ruby/faker#2841

yannklein mentioned this pull request Jun 22, 2024

Fix/seed deprecation and version issues dmbf29/predictor-api#125

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Generate safe `email` and `domain_name` by default (RFC 2606) #2733

Generate safe `email` and `domain_name` by default (RFC 2606) #2733

stefannibrasil commented Mar 21, 2023 •

edited

Loading

Zeragamba Mar 21, 2023

stefannibrasil Mar 24, 2023

stefannibrasil Mar 28, 2023

stefannibrasil Mar 29, 2023

vbrazo Mar 29, 2023

stefannibrasil Mar 31, 2023

Zeragamba Mar 21, 2023

stefannibrasil Mar 24, 2023

stefannibrasil Mar 27, 2023

vbrazo Mar 29, 2023

stefannibrasil Mar 31, 2023

Generate safe email and domain_name by default (RFC 2606) #2733

Generate safe email and domain_name by default (RFC 2606) #2733

Conversation

stefannibrasil commented Mar 21, 2023 • edited Loading

Summary

Other Information

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Generate safe `email` and `domain_name` by default (RFC 2606) #2733

Generate safe `email` and `domain_name` by default (RFC 2606) #2733

stefannibrasil commented Mar 21, 2023 •

edited

Loading