#1659 fix method `faker.text().text(1, 64, true, false, true)` by asolntsev · Pull Request #1660 · datafaker-net/datafaker

asolntsev · 2025-09-16T20:23:50Z

... to return a valid string of length 2..64 instead of empty string.

NB! This PR contains a breaking change:

    lorem.characters(-1) // before: returned "", now: throws exception
    lorem.characters(-1, true) // before: returned "", now: throws exception
    lorem.characters(-1, true, true, true) // before: returned "", now: throws exception

codecov-commenter · 2025-09-16T20:25:55Z

⚠️ Please install the to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

❌ Patch coverage is 83.33333% with 3 lines in your changes missing coverage. Please review.
✅ Project coverage is 92.42%. Comparing base (2923e4a) to head (7558ba1).

Files with missing lines	Patch %	Lines
...c/main/java/net/datafaker/providers/base/Text.java	80.00%	1 Missing and 2 partials ⚠️
❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files

@@             Coverage Diff              @@
##               main    #1660      +/-   ##
============================================
- Coverage     92.45%   92.42%   -0.04%     
- Complexity     3388     3393       +5     
============================================
  Files           333      333              
  Lines          6697     6706       +9     
  Branches        665      667       +2     
============================================
+ Hits           6192     6198       +6     
- Misses          346      347       +1     
- Partials        159      161       +2

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

kingthorin · 2025-09-16T20:46:50Z

src/main/java/net/datafaker/providers/base/Text.java

-    public String text(int minimumLength, int maximumLength, boolean includeUppercase, boolean includeSpecial, boolean includeDigit) {
+    public String text(int requestedMinimumLength, int maximumLength, boolean includeUppercase, boolean includeSpecial, boolean includeDigit) {
+        if (requestedMinimumLength > maximumLength) {
+            throw new IllegalArgumentException("Min length (%s) should be not greater than max length (%s)".formatted(


"...should not be..."

thanks, fixed.

kingthorin · 2025-09-16T20:47:38Z

src/main/java/net/datafaker/providers/base/Text.java

+
+        final int minimumLength = Math.max(requestedMinimumLength, min(includeUppercase) + min(includeSpecial) + min(includeDigit));
+        if (minimumLength > maximumLength) {
+            throw new IllegalArgumentException("Minimum number of required characters (%s) should be not greater than max length (%s)".formatted(


"...should not be..."

kingthorin

Thanks!

erikpragt-connectid · 2025-09-17T03:53:43Z

I'm not sure about this change. If we implement this, suddenly uppercase/lowercase becomes more important than the String length, since when you say: 1..64, it will never be one.

Also, this change would be a breaking change without people knowing it. I'm not a huge fan.

Would it be possible to have some validation logic on it? Like if you do:

faker.text().text(1, 64, true, false, true)

It will throw an exception, since this configuration can never work? (note, this would also be a breaking runtime change without clear communication to our users), some code might suddenly start failing.

Perhaps we should keep it as in, and instead make a (validating) text builder or so? faker.text().minLength(1).maxLength(60).withUppercase().withLowercase()

asolntsev · 2025-09-17T08:24:09Z

some code might suddenly start failing

@erikpragt-connectid
No, nothing will fail. Let me clearly emphasize: the line faker.text().text(1, 64, true, false, true) did not fail, and will not fail.
What actually will change is:

BEFORE: sometimes it returned an empty string - which clearly breaks the requirement "from 1 to 64".
AFTER: it will always return a valid string of length 2...64 - which is totally valid response to the requirement "from 1 to 64".

asolntsev · 2025-09-17T18:39:47Z

@erikpragt-connectid Added javadoc:

     * @param minimumLength The generated text will not be shorter than this length
     * @param maximumLength The generated text will not be longer than this length

bodiam · 2025-09-19T02:16:44Z

No, nothing will fail.

How so? The behaviour of the method changed, and consumers might be depending on this behaviour in their code. Why do you think they won't fail?

In my understanding:

faker.text().text(1, 64, true, false, false)
faker.text().text(1, 64, true, true, false)
faker.text().text(1, 64, true, true, true)

Should all return a String of 1..64, wouldn't that make a lot of sense?
Not 1..64, 2..64, 3..64, just because you might also allow numbers and lower case.
I would assume that the flags indicate that the string MAY contain one of the characters, not that it MUST contain.

I wouldn't know what this would do though:

faker.text().text(1, 64, false, false, false)

asolntsev · 2025-09-19T04:19:46Z

@bodiam No, this method works differently. :)

faker.text().text(1, 64, false, false, false) returns 1..64, all lower case Latin letters
faker.text().text(1, 64, true, false, false) returns 1..64, lower and upper case; at least one upper guaranteed.
faker.text().text(1, 64, false, false, true) returns 1..64, lower case and digits; at least one digit guaranteed.
etc.

This is the logic usually needed for password generation.

snuyanzin · 2025-09-23T17:13:08Z

src/main/java/net/datafaker/providers/base/Text.java

+     * @param includeSpecial  is at least one special symbol required
+     * @param includeDigit  is at least one digit required
+     * @return a random string withing given length interval
+     * @see Text#DEFAULT_SPECIAL


seems need to add a comment that it could throw exception

Thanks, added @throws javadoc.

... to return a valid string of length 2..64 instead of empty string.

We just don't need to spend so much energy. Let's keep the nature. :)

asolntsev added the bug Something isn't working label Sep 16, 2025

asolntsev linked an issue Sep 16, 2025 that may be closed by this pull request

Faker().text().text(1, 64, true, false, true) returns empty String when length is 1 #1659

Closed

asolntsev self-assigned this Sep 16, 2025

asolntsev added this to the 2.5.1 milestone Sep 16, 2025

asolntsev requested review from bodiam, kingthorin and snuyanzin and removed request for kingthorin and snuyanzin September 16, 2025 20:26

kingthorin reviewed Sep 16, 2025

View reviewed changes

asolntsev force-pushed the fix/1659-min-text-length branch from 747df61 to 4c4f62c Compare September 16, 2025 21:06

asolntsev requested a review from kingthorin September 16, 2025 21:09

kingthorin approved these changes Sep 16, 2025

View reviewed changes

asolntsev force-pushed the fix/1659-min-text-length branch from 91cb744 to 057fa44 Compare September 17, 2025 18:38

snuyanzin reviewed Sep 23, 2025

View reviewed changes

asolntsev added 2 commits September 23, 2025 22:20

#1659 fix method faker.text().text(1, 64, true, false, true)

dce03c4

... to return a valid string of length 2..64 instead of empty string.

avoid running too many tests

7558ba1

We just don't need to spend so much energy. Let's keep the nature. :)

asolntsev force-pushed the fix/1659-min-text-length branch from 057fa44 to 7558ba1 Compare September 23, 2025 19:20

asolntsev requested a review from snuyanzin September 23, 2025 19:21

snuyanzin approved these changes Sep 23, 2025

View reviewed changes

asolntsev merged commit e83d53c into main Sep 23, 2025
13 checks passed

asolntsev deleted the fix/1659-min-text-length branch September 23, 2025 19:45

Conversation

asolntsev commented Sep 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov-commenter commented Sep 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

kingthorin Sep 16, 2025

Choose a reason for hiding this comment

Uh oh!

asolntsev Sep 16, 2025

Choose a reason for hiding this comment

Uh oh!

kingthorin Sep 16, 2025

Choose a reason for hiding this comment

Uh oh!

asolntsev Sep 16, 2025

Choose a reason for hiding this comment

Uh oh!

kingthorin left a comment

Choose a reason for hiding this comment

Uh oh!

erikpragt-connectid commented Sep 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

asolntsev commented Sep 17, 2025

Uh oh!

asolntsev commented Sep 17, 2025

Uh oh!

bodiam commented Sep 19, 2025

Uh oh!

asolntsev commented Sep 19, 2025

Uh oh!

snuyanzin Sep 23, 2025

Choose a reason for hiding this comment

Uh oh!

asolntsev Sep 23, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

asolntsev commented Sep 16, 2025 •

edited

Loading

codecov-commenter commented Sep 16, 2025 •

edited

Loading

erikpragt-connectid commented Sep 17, 2025 •

edited

Loading