* Enable additional Error Prone checks & fix violations
Some of them also enforce additional Google Java Format requirements which
are not handled by google-java-format, such as disallowing wildcard imports.
Not all experimental checks have been listed because some are not applicable,
such as Dependency Injection framework checks, or checks related to Guava's
immutable collections (since Gson's main code does not have a dependency on
Guava).
Other checks have been omitted because they are probably not relevant
(this was a subjective choice), or would require larger refactoring or
would flag issues with the public API, which cannot be changed easily.
* Address review feedback
---------
Co-authored-by: Éamonn McManus <emcmanus@google.com>
* Perform minor code clean-up
Notable changes:
- Replace most usages of `<code>` with `{@code ...}` in Javadoc
- Add proper summary sentence to `GsonBuilder.enableComplexMapKeySerialization`
- Extend documentation for `GsonBuilder.setDateFormat` methods
- Fix `TypeToken.isAssignableFrom(Type)` throwing AssertionError in some cases
Maybe the method should not throw an exception in the first place, but it
might not matter much since it is deprecated already anyway.
- Remove outdated `throws NumberFormatException` from internal
`JsonReader.nextQuotedValue`; the behavior had been changed by
85ebaf7c35
- Fix incorrect documentation on JsonScope fields
- Fix unit tests having 'expected' and 'actual' switched
- Use dedicated Truth methods instead of `isTrue()` / `isFalse()`
- Use common helper methods in JsonWriterTest to avoid duplication
* Implement `toString()` for ReflectionAccessFilter constants
* Address most of the review comments
* Add comment about `source.scm.tag=HEAD` warning
Actually it looks like the warning is not actually caused by usage of
`HEAD` as value, but rather because the project has a snapshot version
during development (which is expected though), see
https://github.com/apache/maven-artifact-plugin/blob/maven-artifact-plugin-3.5.0/src/main/java/org/apache/maven/plugins/artifact/buildinfo/BuildInfoWriter.java#L140
But this is not a problem either since during release a non-snapshot
version is used.
* Formatting follow-up
- Adds formatting commits to .git-blame-ignore-revs so that they don't
distract during Git blame
- Restores hard line breaks in Troubleshooting.md using `\` instead of
trailing spaces
- Changes formatting of some string literals and comments
- Fixes accidental Javadoc and comment issues introduced by manual changes
of formatting commit
- Fixes license header in $Gson$Types.java erroneously being a Javadoc
comment and being reformatted
- Slightly changes `JsonReader` `getPath` and `getPreviousPath` documentation
to help Javadoc detect first sentence as summary
* Remove `spotless:off` markers
* Add empty line before comment
* Check format for .github YAML files
Previous fix in 392cc65ff3 only covered writing
name as top level value, but not when trying to write name inside JSON array.
Removed `stackSize == 0` check from `JsonWriter.name` because that is done
already by `peek()` call.
* Strict mode for JSON parsing (#2323)
* Feat #6: Add strict flag to Gson and GsonBuilder
* Test #2: Add failing tests for capitalized keywords
* Feat #2: JsonReader does not read (partially) capitalized keywords if strict mode is used
* Feat #3: Added implementation and tests for JSONReader not accepting specific escape sequence representing in strict mode
* Test #3: Simplify test cases by removing unnecessary array
* Feat #3: Improve error by including the illegal character
* Feat #5: JsonReader does not allow unespaced control flow characters in strict mode
* Test #5: Test unespaced control flow characters in strict mode
* Feat #4: Disallow espaced newline character in strict mode
* Test #4: Add tests for (dis)allowing newline character depensding on strictness
* Test #5: Test case for unescaped control char in non-strict mode
* Test #2: Simplify test cases
* Feat #13: Change leniency API to Strictness enum in JsonReader, Gson, and GsonBuilder
* Feat #15: Change JsonWriter API to also use Strictness
* Test #15: Test Strictness in JsonWriter API
* Doc #15: Add and update documentation for Strictness in JsonWriter API
* refactor #12: Fixed typos and empty catch brackets in tests
* refactor #12: Resolved importing wildcards, made some lines adhere to Google java style
* #5 Add test case for unescaped control characters
* Feat #5: add new lines to make JsonReader able to detect unescaped control characters (U+0000 through U+001F) and throw exceptions.
* Feat #5: add new lines to make JsonReader able to detect unescaped control characters (U+0000 through U+001F) and throw exceptions.
* Test #11: Added two tests for testing implementation of control character handling in strict mode and moved the implementation to nextQuotedValue
* Test #11: Added two tests for testing implementation of control character handling in strict mode and moved the implementation to nextQuotedValue
---------
Co-authored-by: LMC117 <2295699210@qq.com>
Co-authored-by: Marten Voorberg <martenvoorberg@gmail.com>
* Doc #17: Add and change javadoc of public methods
* Doc #17: Update JavaDoc in JsonReader and Strictness
* Doc #17: Update JavaDoc in Gson and GsonBuilder
* Test #34: Add tests for setting strictness through GsonBuilder
* Fix: Add Fix broken test
* Fix: Invalid JavaDoc in Gson.java
* Doc #17: update outdated javadoc
* #37: Resolve more PR feedback
* Fix#37: Resolve various PR comments
* Fix#37: Resolve various PR comments
* Refactor #35: Refactor JsonReader#peekKeyword to reduce the amount of strictness checks (#39)
* Doc #40: Update JavaDoc based on PR feedback
* Doc #40: Update old RFC in GsonBuilder documentation
* Doc #40: Fix formatting error in JavaDoc
* Doc #40: Add tests for setting strictness and lenient to JsonReaderTest
* Test #43: Changed tests to make use of assertThrows
* test #43: Changed tests to make use of assertThrows as per feedback
* Test #43: Update JsonWriterTest#testStrictnessNull to use assertThrows
* Test #43: Update JsonWriterTest#testStrictnessNull to use assertThrows
* test #43: Resolve PR recommendations
* Test #43: Mini change to TC
* Test #43: Mini change to TC
---------
Co-authored-by: Marten Voorberg <martenvoorberg@gmail.com>
* doc #46: Resolved comments in main PR
* Feat #45: Change Gson.fromJson and Gson.toJson to be strict when the provided writer/reader is strict
* Fix#45: Small type
* Update gson/src/test/java/com/google/gson/stream/JsonReaderTest.java
Co-authored-by: Marcono1234 <Marcono1234@users.noreply.github.com>
* Fix#45: Resolve various comments by Marcono1234
* Update gson/src/main/java/com/google/gson/GsonBuilder.java
Co-authored-by: Marcono1234 <Marcono1234@users.noreply.github.com>
* Fix#45: Resolve various comments by Marcono1234
* Fix#45: Resolve various comments by eamonmcmanus
* Strictness mode follow-up
* Update Troubleshooting.md and Gson default lenient mode documentation
* Always use GSON strictness when set.
* Rename Strictness.DEFAULT to Strictness.LEGACY_STRICT
* Update JavaDoc with new strictness functionality
* Replace default with legacy strict for JsonReader javadoc
* Add JSONReader test cases for U2028 and U2029
* Refactor JSONReader#peekKeyWord() based on @eamonmcmanus's suggestion
* Deprecate setLenient in favor of setStrictness
---------
Co-authored-by: Carl Peterson <unknown>
Co-authored-by: Gustaf Johansson <gustajoh@kth.se>
Co-authored-by: gustajoh <58432871+gustajoh@users.noreply.github.com>
Co-authored-by: LMC117 <2295699210@qq.com>
Co-authored-by: Marcono1234 <Marcono1234@users.noreply.github.com>
* Strictness follow-up (#2408)
* Strictness mode follow-up
- Remove mentions of `null` Gson strictness; this is an implementation detail
- Fix incorrect / outdated documentation
- Reduce links to RFC; if there is already a link to it in a previous sentence
don't link to it again
- Extend and update tests
- Minor punctuation changes in documentation for consistency
* Deprecate `setLenient` methods
* `strictness2` fixes & improvements (#2456)
* Adjust ProGuard default rules and shrinking tests (#2420)
* Adjust ProGuard default rules and shrinking tests
* Adjust comment
* Add shrinking test for class without no-args constructor; improve docs
* Improve Unsafe mention in Troubleshooting Guide
* Improve comment for `-if class *`
* Bump com.google.guava:guava from 32.0.1-jre to 32.1.1-jre (#2444)
Bumps [com.google.guava:guava](https://github.com/google/guava) from 32.0.1-jre to 32.1.1-jre.
- [Release notes](https://github.com/google/guava/releases)
- [Commits](https://github.com/google/guava/commits)
---
updated-dependencies:
- dependency-name: com.google.guava:guava
dependency-type: direct:production
update-type: version-update:semver-minor
...
Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
* Bump com.google.guava:guava-testlib from 32.0.1-jre to 32.1.1-jre (#2443)
Bumps [com.google.guava:guava-testlib](https://github.com/google/guava) from 32.0.1-jre to 32.1.1-jre.
- [Release notes](https://github.com/google/guava/releases)
- [Commits](https://github.com/google/guava/commits)
---
updated-dependencies:
- dependency-name: com.google.guava:guava-testlib
dependency-type: direct:development
update-type: version-update:semver-minor
...
Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
* Support non-generic type for `TypeToken.getParameterized` for legacy reasons (#2447)
This partially restores the behavior before a589ef2008,
except that back then for a non-generic type a bogus `TypeToken(ParameterizedType)`
was created, whereas now a `TypeToken(Class)` is created instead.
* Fixed Typo in GsonBuilder.java (#2449)
* Make date-formatting tests less fragile with regular expressions. (#2450)
* Make date-formatting tests less fragile with regular expressions.
This is not great. We should really ensure that formatted dates are the same
regardless of JDK version. There is code that attempts to do that but it is not
really effective. So for now we fudge around the differences by using regular
expressions to paper over the differences.
* Temporarily add test-debugging code.
* Another attempt at debugging a test failure.
* Fix pattern in assertion.
* Modification in test cases (#2454)
* Fixed Typo in GsonBuilder.java
* Suggestions on Test cases
* Modified test cases using assertThrows method (JUnit)
* Update gson/src/test/java/com/google/gson/JsonArrayAsListTest.java
Co-authored-by: Marcono1234 <Marcono1234@users.noreply.github.com>
* Update gson/src/test/java/com/google/gson/GsonTest.java
Co-authored-by: Marcono1234 <Marcono1234@users.noreply.github.com>
* Update gson/src/test/java/com/google/gson/JsonArrayAsListTest.java
Co-authored-by: Marcono1234 <Marcono1234@users.noreply.github.com>
* Update gson/src/test/java/com/google/gson/JsonStreamParserTest.java
Co-authored-by: Marcono1234 <Marcono1234@users.noreply.github.com>
* Update gson/src/test/java/com/google/gson/JsonStreamParserTest.java
Co-authored-by: Marcono1234 <Marcono1234@users.noreply.github.com>
* Update gson/src/test/java/com/google/gson/JsonStreamParserTest.java
Co-authored-by: Marcono1234 <Marcono1234@users.noreply.github.com>
* Update gson/src/test/java/com/google/gson/ToNumberPolicyTest.java
Co-authored-by: Marcono1234 <Marcono1234@users.noreply.github.com>
* Update gson/src/test/java/com/google/gson/TypeAdapterTest.java
Co-authored-by: Marcono1234 <Marcono1234@users.noreply.github.com>
* Update gson/src/test/java/com/google/gson/TypeAdapterTest.java
Co-authored-by: Marcono1234 <Marcono1234@users.noreply.github.com>
* Update gson/src/test/java/com/google/gson/ToNumberPolicyTest.java
Co-authored-by: Marcono1234 <Marcono1234@users.noreply.github.com>
* Update gson/src/test/java/com/google/gson/ToNumberPolicyTest.java
Co-authored-by: Marcono1234 <Marcono1234@users.noreply.github.com>
---------
Co-authored-by: Marcono1234 <Marcono1234@users.noreply.github.com>
* Minor follow-up changes
---------
Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: elevne <97422844+elevne@users.noreply.github.com>
Co-authored-by: Éamonn McManus <emcmanus@google.com>
Co-authored-by: Wonil <cwi5525@naver.com>
---------
Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: Marten <martenvoorberg@gmail.com>
Co-authored-by: Gustaf Johansson <gustajoh@kth.se>
Co-authored-by: gustajoh <58432871+gustajoh@users.noreply.github.com>
Co-authored-by: LMC117 <2295699210@qq.com>
Co-authored-by: Marcono1234 <Marcono1234@users.noreply.github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: elevne <97422844+elevne@users.noreply.github.com>
Co-authored-by: Wonil <cwi5525@naver.com>
This annotation indicates that return value of the annotated method does
not need to be used. If it is _not_ present on a non-void method, and if
Error Prone's `CheckReturnValue` is active, then calling the method
without using the result is an error. However, we are not enabling
`CheckReturnValue` by default here.
Also update some code that does ignore return values, so that the
returned value is used, if only by assigning it to an unused variable.
* FormattingStyle follow-up
* Add links to FormattingStyle
* Use Truth for FormattingStyleTest
* Reduce pull request scope to Javadoc and minor code changes
* Fix `OperatorPrecedence` warn in `JsonWriter#close`
* Fix `ReferenceEquality` warn in `LinkedTreeMap#replaceInParent`
* Fix `UnnecessaryParentheses` warn in `LinkedTreeMap#replaceInParent`
* Fix `ReferenceEquality` warn in `LinkedTreeMap#hasNext`
* Fix `ReferenceEquality` warn in `LinkedTreeMap#nextNode`
* Adds `error_prone_annotations` to the `pom.xml` of `gson`
* Fix `InlineMeSuggester` warns in `JsonParser`
* Fix `UnnecessaryParentheses` warns in `ConstructorConstructor#newDefaultImplementationConstructor`
* Fix `ThreadLocalUsage` warn in `Gson`
* Fix `JdkObsolete` warn in `GsonBuilder`
* Fix `ReferenceEquality` warn in `LazilyParsedNumber#equals`
* Fix `OperatorPrecedence` warn in `TreeTypeAdapter#create`
* Fix `OperatorPrecedence` warn in `ArrayTypeAdapter`
* Fix `UnnecessaryParentheses` warn in `TypeAdapters`
* Adds `-XepExcludedPaths` flag to ErrorProne plugin to exclude tests and proto path
* Fix `ClassNewInstance` warn in `InterceptorAdapter`
* Fix `ThreadLocalUsage` warn in `GraphAdapterBuilder`
* Fix `JdkObsolete` warn in `GraphAdapterBuilder`
* Revert "Adds `error_prone_annotations` to the `pom.xml` of `gson`"
This reverts commit 14af14dfa23b46a54f4855a70ccf2b0a2cdc3e3f.
* Revert "Fix `InlineMeSuggester` warns in `JsonParser`"
This reverts commit 095bfd517e06510e4cc9cc6b1aac58ad9bf3038a.
* Adds `@SuppressWarnings("ThreadLocalUsage")`
* Fix `OperatorPrecedence` in `JsonWriter`
* Revert "Fix `ReferenceEquality` warn in `LinkedTreeMap#nextNode`"
This reverts commit 387746c7f7e3d0943c8f80501f5d9c3710f4862e.
* Adds `@SuppressWarnings("ReferenceEquality")`
* Adds `guava-testlib` to the gson `pom.xml`
* `@SuppressWarnings("TruthSelfEquals")` removed to use `EqualsTester()`
* Add settings for kind of newline to use
* Fix amp in javadoc
* Fixing link in javadoc
* Doc: use JSON instead of Json
Co-authored-by: Marcono1234 <Marcono1234@users.noreply.github.com>
* PR Feedback: Objects.requireNonNull
Co-authored-by: Marcono1234 <Marcono1234@users.noreply.github.com>
* PR Feedback: $next-version$, don't hardcode
Co-authored-by: Marcono1234 <Marcono1234@users.noreply.github.com>
* s/testNewlineLF/testNewlineLf/
Co-authored-by: Marcono1234 <Marcono1234@users.noreply.github.com>
* Implement PR feedback
* Round two of review
* Restore copyright year, no reason to update
* Rename OS named enum values to CR and LF
* Add javadoc to NewlineStyle.getValue()
* Implement PR feedback, round 2
* Fix typo
Co-authored-by: Marcono1234 <Marcono1234@users.noreply.github.com>
* No need for line break
Co-authored-by: Marcono1234 <Marcono1234@users.noreply.github.com>
* Shorter, cleaner doc
Co-authored-by: Marcono1234 <Marcono1234@users.noreply.github.com>
* Using a FormattingStyle for pretty print
* Fix Junit4 and Truth after merge from master
* Implement review feedback
* Double backslash in message
---------
Co-authored-by: Marcono1234 <Marcono1234@users.noreply.github.com>
* Build on JDK 8 and 17 as well as 11.
* Remove JDK 8 for now.
`DefaultDateTypeAdapterTest` fails.
* Tweak javadoc to avoid warnings.
Mostly these are about using `<h3>` when the previous tag was `<h1>`,
and the like. This previous tag might be implicit (part of what javadoc
itself outputs rather than the HTML in doc comments).
Apparently JDK 11 puts method javadoc inside `<h2>` while JDK 11 puts it
inside `<h3>`. Or something like that. Anyway it doesn't appear to be
possible to use `<h3>` _or_ `<h4>` and please both.
* Fix JsonReader / JsonWriter documentation regarding top-level value
RFC 7159 allows any top-level value (not only arrays or objects) [0],
however when #773 added this functionality it appears the author forgot
to update the documentation of these classes.
[0] https://tools.ietf.org/html/rfc7159#appendix-A
> Changed the definition of "JSON text" so that it can be any JSON
> value, removing the constraint that it be an object or array.
* Fix missing space
Follow-up to comments on #2130, which introduced a new override which was not overridden by `JsonTreeWriter`. Also tweaks the doccomments for `float`, `double` and `Number` variants of `JsonWriter.value`.
Supplement to the fix for #1127.
* Add CodeQL GitHub code scanning workflow
* Only compile main sources for code scanning
* Move test .proto files to test sources
`annotations.proto` also seems to be only relevant for tests because the test
explicitly registers them as extensions. By default the Proto adapter does not
consider them.
* Address some code scanning findings
* Fix some more findings
* Added test which shows that lenient JsonWriter fails writing infinite primitive doubles, but does not fail writing boxed doubles, as stated in #1090.
* Fixed JsonWriter#value(double) to write infinite and NaN values when lenient, as JsonWriter#value(Number) does. (fixes#1090)
When calling value() with a Boolean overload resolution would choose value(boolean) which would throw an NPE on null. The other boxed types are all numbers which would resolve to value(Number) and behave correctly.
Add a jsonValue(String value) method that takes a raw JSON string that
can be used to write the string directly to the underlying writer
without modification.
The intended use case for this is when building JSON that contains a
pre-serialized JSON string as a value in an object or array.
TWEETS
run vm htmlSafe ms linear runtime %
Before app_process true 68.7 ============================== 100%
After app_process true 35.9 =============== 52%
READER_LONG
run vm htmlSafe ms linear runtime %
Before app_process true 439.0 ============================== 100%
After app_process true 74.5 ===== 17%
I'd prefer to not support multiple top-level values, but we support it in JsonReader and it's easier to be consistent. Kevin Hayen's patch pointed me in the right direction here, but I needed to do more work to cover some of the edge cases.
Fixes issue 397.
Add setSerializeNulls() to JsonWriter, so nulls can be skipped from serialization. This does not yet impact JsonElementWriter.
One change in behavior: if the only value is skipped, we now emit "null" rather than "".
Johannes Frohnmeyer
Marcono1234