Skip to content
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.

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

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

Merged
merged 17 commits into from
Dec 5, 2023
Merged
Show file tree
Hide file tree
Changes from 11 commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -187,10 +187,13 @@ private Date deserializeToDate(JsonReader in) throws IOException {
// Needs to be synchronized since JDK DateFormat classes are not thread-safe
synchronized (dateFormats) {
for (DateFormat dateFormat : dateFormats) {
TimeZone originalTimeZone = dateFormat.getTimeZone();
try {
return dateFormat.parse(s);
} catch (ParseException ignored) {
// OK: try the next format
} finally {
dateFormat.setTimeZone(originalTimeZone);
}
}
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@
import java.text.ParseException;
import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.TimeZone;

/**
* Adapter for java.sql.Date. Although this class appears stateless, it is not. DateFormat captures
Expand Down Expand Up @@ -59,15 +60,17 @@ public java.sql.Date read(JsonReader in) throws IOException {
return null;
}
String s = in.nextString();
try {
Date utilDate;
synchronized (this) {
utilDate = format.parse(s);
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
}
return new java.sql.Date(utilDate.getTime());
} catch (ParseException e) {
throw new JsonSyntaxException(
"Failed parsing '" + s + "' as SQL Date; at path " + in.getPreviousPath(), e);
}
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@
import java.text.ParseException;
import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.TimeZone;

/**
* Adapter for java.sql.Time. Although this class appears stateless, it is not. DateFormat captures
Expand Down Expand Up @@ -60,14 +61,17 @@ public Time read(JsonReader in) throws IOException {
return null;
}
String s = in.nextString();
try {
synchronized (this) {
synchronized (this) {
TimeZone originalTimeZone = format.getTimeZone(); // Save the original time zone
try {
Date date = format.parse(s);
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
}
} catch (ParseException e) {
throw new JsonSyntaxException(
"Failed parsing '" + s + "' as SQL Time; at path " + in.getPreviousPath(), e);
}
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,11 @@

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

import com.google.gson.Gson;
import com.google.gson.GsonBuilder;
import com.google.gson.TypeAdapter;
import com.google.gson.TypeAdapterFactory;
import com.google.gson.internal.bind.DefaultDateTypeAdapter.DateType;
Expand Down Expand Up @@ -223,6 +225,36 @@ public void testUnexpectedToken() throws Exception {
}
}

@Test
public void testGsonDateFormat() {
TimeZone originalTimeZone = TimeZone.getDefault();
// Set the default timezone to UTC
TimeZone.setDefault(TimeZone.getTimeZone("UTC"));
eamonnmcmanus marked this conversation as resolved.
Show resolved Hide resolved
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);
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);
// Assert that the deserialized date's time is correct
assertThat(deserializedDate.getTime()).isEqualTo(new Date(28800000).getTime());

// 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
Date expectedDate = new Date(28800000); // This represents the original date in UTC
String expectedJson = gson.toJson(expectedDate);
assertThat(jsonAfterDeserialization).isEqualTo(expectedJson);
Copy link
Collaborator

Choose a reason for hiding this comment

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

Please hardcode the expected JSON string here:

Suggested change
Date expectedDate = new Date(28800000); // This represents the original date in UTC
String expectedJson = gson.toJson(expectedDate);
assertThat(jsonAfterDeserialization).isEqualTo(expectedJson);
assertThat(jsonAfterDeserialization).isEqualTo("\"1970-01-01 08:00 UTC\"");

Otherwise your current code would fail to detect the bug (if you reverted your setTimeZone fix) because both gson.toJson(deserializedDate) and gson.toJson(expectedDate) would use PST as time zone, and would therefore both be wrong. But because both are wrong in the same way, the test would erroneously pass as successful.

} finally {
TimeZone.setDefault(originalTimeZone);
}
}

private static TypeAdapter<Date> dateAdapter(TypeAdapterFactory adapterFactory) {
TypeAdapter<Date> adapter = adapterFactory.create(new Gson(), TypeToken.get(Date.class));
assertThat(adapter).isNotNull();
Expand Down