Comments (2)
I agree the difference between FormatStringAnnotation
and FormatString
is surprising and seems arbitrary.
When they were created, there were difference use-cases. FormatStringAnnotation
was deliberately stricter, and intended to be used with APIs where a violation might cause more severe problems. FormatString
was more about best-effort bug prevention, while being relatively easy to roll out to code bases with many existing calls to String.format
.
It might be more principled to have stricter and less strict versions of both checks. But that also adds a fair bit of complexity, and isn't something there are plans to do at this point.
Can you share any more background about what the real world use-case was where you encountered this, where you wanted to pass non-constant strings to a @FormatString
-annotated method.
from error-prone.
In our application we had several thousands of calls to String.format()
. Basically, it is our agreed standard way of building strings out of pieces. And then we have discovered that String.format()
is locale-dependent, whereas we never thought about it like that. E.g. we assumed that String.format ("%.2f", 1.23)
would always result in "1.23", but it can also be "1,23" if system locale is German, for example.
In 99% of cases it doesn't matter, but occasionally this can cause bugs. To avoid rechecking all 5000 of calls, we just replaced String.format()
everywhere with a custom function that does exactly the same, with the only difference being that it uses a fixed locale.
But now we cannot use Error-Prone to autocheck our format strings, because it issues errors on ~50 calls (not too many, but I don't want to rewrite them out of principle, sort of) where it didn't have any complaints when we used String.format()
. It can be argued one way or another, but as Error-Prone is capable of accepting non-constant format string for String.format()
, I really would expect it to do the same for customly-annotated functions.
As far as usecases go, 1) arguments may be fairly complex expressions, so one wouldn't want to repeat them in every if
-branch (or whatever one would use to have constant format strings); 2) occasionally formatting string is built dynamically in our application, so it is outright impossible to make it constant, even with additional branching. This one is really rare, but we do have a few calls like that.
from error-prone.
Related Issues (20)
- 2.26.1: An unhandled exception was thrown by the Error Prone static analysis plugin. BugPattern: JUnitIncompatibleType HOT 1
- class com.sun.tools.javac.code.Type$ClassType cannot be cast to class com.sun.tools.javac.code.Type$ArrayType HOT 6
- `JUnitIncompatibleType` on 2.27.0 throws `ClassCastException` for `com.sun.tools.javac.code.Type$TypeVar` around `assertArrayEquals` HOT 1
- False alarm from ClassInitializationDeadlock for inner enum implementing outer interface with default method HOT 4
- [Feature Request] Add check warning against mocking record types HOT 1
- ObjectEqualsForPrimitives should not suggest to convert boxed equals on double or float values HOT 3
- Suggest to use `Double.compare` or `Float.compare` when ObjectEqualsForPrimitives is triggered on floating point primitives
- Patching no longer works for experimental checks like StatementSwitchToExpressionSwitch
- False UnusedVariable warning for method parameters only used in overridden implementations HOT 2
- Jdk 23 now broken with Error prone after github updates to newer cut yesterday HOT 4
- JDK 23 compatibility HOT 1
- [PatternMatchingInstanceof] False-positives
- Refaster includes fully qualified reference to the `@AfterTemplate` to local variable inside the template HOT 4
- Dspace mvn compilation error HOT 6
- BugPattern: ParameterName HOT 3
- SelfAssignment false positive with casting a float variable to int HOT 1
- An unhandled exception was thrown by the Error Prone static analysis plugin: BugPattern: InconsistentCapitalization HOT 1
- UnnecessaryDefaultInEnumSwitch does not work with enhanced switch statement for cases with multiple values
- False positives by UnusedVariable on unnamed variables (Java 22)
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from error-prone.