Skip to content

Fix DateFormat time zone is not restored and add Test. #2549

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 17 commits into from
Dec 5, 2023
Merged

Fix DateFormat time zone is not restored and add Test. #2549

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
46942b6
Fix DateFormat time zone is not restored and add Test.
Nov 20, 2023
6ad06f9
delete the test and make sure mvn clean test -X can be SUCCESS
Nov 22, 2023
fb8c463
delete the test and make sure mvn clean test -X can be SUCCESS
Nov 22, 2023
fb850a5
add test
Nov 22, 2023
7928fe4
restore the DateFormat time zone in SqlDateTypeAdapter and SqlTimeTyp…
Nov 22, 2023
3da89da
Merge branch 'main' into main
Carpe-Wang Nov 22, 2023
db4ff5e
Adjust the code according to the code review feedback.
Nov 22, 2023
7b8e91a
Adjust the code according to the code review feedback.
Nov 23, 2023
1687fb1
Adjust the code according to the code review feedback.
Nov 25, 2023
23bbbca
Adjust the Test
Nov 25, 2023
3b7c7d0
fix Werror error
Nov 25, 2023
a8a13e7
Adjust the DefaultDateTypeAdapterTest according to the code review fe…
Nov 26, 2023
49f0caf
Merge branch 'main' into main
Carpe-Wang Nov 28, 2023
edc10e1
Merge branch 'main' into main
Carpe-Wang Nov 29, 2023
72cc078
Merge branch 'main' into main
Carpe-Wang Dec 2, 2023
d3767a8
Merge branch 'main' into main
Carpe-Wang Dec 5, 2023
972900a
Merge branch 'main' into main
Carpe-Wang Dec 5, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions gson/src/main/java/com/google/gson/internal/sql/SqlDateTypeAdapter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,17 +60,18 @@ public java.sql.Date read(JsonReader in) throws IOException {
return null;
}
String s = in.nextString();
TimeZone originalTimeZone = format.getTimeZone(); // Save the original time zone
Copy link
Collaborator

@Marcono1234 Marcono1234 Nov 24, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please move this and the setTimeZone call inside the synchronized (this) { ... } block. Type adapters must be thread-safe and with the current implementation there could be a race condition.

Or rewrite this so that the synchronized block covers the try; I guess that should be fine as well, e.g.:

    synchronized (this) {
      TimeZone originalTimeZone = format.getTimeZone(); // Save the original time zone
      try {
        Date utilDate = format.parse(s);
        return new java.sql.Date(utilDate.getTime());
      } catch (ParseException e) {
        throw new JsonSyntaxException("Failed parsing '" + s + "' as SQL Date; at path " + in.getPreviousPath(), e);
      } finally {
        format.setTimeZone(originalTimeZone); // Restore the original time zone after parsing
      }
    }

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is my mistake; I did not carefully read the code review you provided at the beginning.

try {
Date utilDate;
synchronized (this) {
TimeZone originalTimeZone = format.getTimeZone(); // Save the original time zone
utilDate = format.parse(s);
format.setTimeZone(originalTimeZone); // Restore the original time zone after parsing
}
return new java.sql.Date(utilDate.getTime());
} catch (ParseException e) {
throw new JsonSyntaxException(
"Failed parsing '" + s + "' as SQL Date; at path " + in.getPreviousPath(), e);
} finally {
format.setTimeZone(originalTimeZone); // Restore the original time zone after parsing
}
}

Expand Down
5 changes: 3 additions & 2 deletions gson/src/main/java/com/google/gson/internal/sql/SqlTimeTypeAdapter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,16 +61,17 @@ public Time read(JsonReader in) throws IOException {
return null;
}
String s = in.nextString();
TimeZone originalTimeZone = format.getTimeZone(); // Save the original time zone
Copy link
Collaborator

@Marcono1234 Marcono1234 Nov 24, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same as #2549 (comment)

try {
synchronized (this) {
TimeZone originalTimeZone = format.getTimeZone(); // Save the original time zone
Date date = format.parse(s);
format.setTimeZone(originalTimeZone); // Restore the original time zone
return new Time(date.getTime());
}
} catch (ParseException e) {
throw new JsonSyntaxException(
"Failed parsing '" + s + "' as SQL Time; at path " + in.getPreviousPath(), e);
} finally {
format.setTimeZone(originalTimeZone); // Restore the original time zone
}
}

Expand Down
31 changes: 18 additions & 13 deletions gson/src/test/java/com/google/gson/internal/bind/DefaultDateTypeAdapterTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@

import static com.google.common.truth.Truth.assertThat;
import static com.google.common.truth.Truth.assertWithMessage;
import static org.junit.Assert.assertEquals;
import static junit.framework.TestCase.assertEquals;
import static org.junit.Assert.fail;

import com.google.gson.Gson;
Expand Down Expand Up @@ -227,23 +227,28 @@ public void testUnexpectedToken() throws Exception {

@Test
public void testGsonDateFormat() {
TimeZone originalTimeZone = TimeZone.getDefault();
// Set the default timezone to UTC
TimeZone.setDefault(TimeZone.getTimeZone("UTC"));
Gson gson = new GsonBuilder().setDateFormat("yyyy-MM-dd HH:mm z").create();
Date originalDate = new Date(0);
try {
Gson gson = new GsonBuilder().setDateFormat("yyyy-MM-dd HH:mm z").create();
Date originalDate = new Date(0);

// Serialize the date object
String json = gson.toJson(originalDate);
assertEquals("\"1970-01-01 00:00 UTC\"", json);
// Serialize the date object
String json = gson.toJson(originalDate);
assertEquals("\"1970-01-01 00:00 UTC\"", json);
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please use Truth for assertions here:

Suggested change
assertEquals("\"1970-01-01 00:00 UTC\"", json);
assertThat(json).isEqualTo("\"1970-01-01 00:00 UTC\"");


// Deserialize a date string with the PST timezone
Date deserializedDate = gson.fromJson("\"1970-01-01 00:00 PST\"", Date.class);
// Deserialize a date string with the PST timezone
Date deserializedDate = gson.fromJson("\"1970-01-01 00:00 PST\"", Date.class);

// Serialize the deserialized date object again
String jsonAfterDeserialization = gson.toJson(deserializedDate);
// The expectation is that the date, after deserialization, when serialized again should still
// be in the UTC timezone
assertEquals("\"1970-01-01 08:00 UTC\"", jsonAfterDeserialization);
// Serialize the deserialized date object again
String jsonAfterDeserialization = gson.toJson(deserializedDate);
// The expectation is that the date, after deserialization, when serialized again should still
// be in the UTC timezone
assertEquals("\"1970-01-01 08:00 UTC\"", jsonAfterDeserialization);
} finally {
TimeZone.setDefault(originalTimeZone);
}
}

private static TypeAdapter<Date> dateAdapter(TypeAdapterFactory adapterFactory) {
Expand Down