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 5 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 @@ -62,7 +63,9 @@ public java.sql.Date read(JsonReader in) throws IOException {
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
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 try-finally here as well, to be safe (in case time zone was already changed despite an exception being thrown):

Suggested change
TimeZone originalTimeZone = format.getTimeZone(); // Save the original time zone
utilDate = format.parse(s);
format.setTimeZone(originalTimeZone); // Restore the original time zone after parsing
TimeZone originalTimeZone = format.getTimeZone(); // Save the original time zone
try {
utilDate = format.parse(s);
} finally {
format.setTimeZone(originalTimeZone); // Restore the original time zone after parsing
}

(you might to have to reformat the code above)

}
return new java.sql.Date(utilDate.getTime());
} catch (ParseException 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 @@ -62,7 +63,9 @@ public Time read(JsonReader in) throws IOException {
String s = in.nextString();
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
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 try-finally here as well:

Suggested change
TimeZone originalTimeZone = format.getTimeZone(); // Save the original time zone
Date date = format.parse(s);
format.setTimeZone(originalTimeZone); // Restore the original time zone
TimeZone originalTimeZone = format.getTimeZone(); // Save the original time zone
try {
date = format.parse(s);
} finally {
format.setTimeZone(originalTimeZone); // Restore the original time zone after parsing
}

(you might to have to reformat the code above)

return new Time(date.getTime());
}
} catch (ParseException 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 org.junit.Assert.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,27 @@ public void testUnexpectedToken() throws Exception {
}
}

@Test
public void testGsonDateFormat() {
// Set the default timezone to UTC
TimeZone.setDefault(TimeZone.getTimeZone("UTC"));
eamonnmcmanus marked this conversation as resolved.
Show resolved Hide resolved
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);

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

Choose a reason for hiding this comment

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

Maybe add an assertion here that the date was parsed correctly, I assume it would be this:

Suggested change
Date deserializedDate = gson.fromJson("\"1970-01-01 00:00 PST\"", Date.class);
Date deserializedDate = gson.fromJson("\"1970-01-01 00:00 PST\"", Date.class);
assertThat(deserializedDate).isEqualTo(new Date(28800000));


// Serialize the deserialized date object again
String jsonAfterDeserialization = gson.toJson(deserializedDate);
Copy link
Collaborator

Choose a reason for hiding this comment

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

Maybe this should rather call toJson(originalDate); otherwise if deserializedDate is incorrect due to a bug we would get confusing failures here.

Copy link

Choose a reason for hiding this comment

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

Hyt

// 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);
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 instead of the JUnit methods here; that will leads to better failure messages and makes the assertion easier to read:

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

}

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