Sentry fails to serialize Locale

[marek-klima]

Integration

sentry

Java Version

17

Version

6.4.3

Steps to Reproduce

Running a code that tries to encode object of type Locale never ends. It probably stays inside JsonReflectionObjectSerializer (here) because object.getClass().getDeclaredFields() returns long list.

There were recent fixes for enums (#2220).

import io.sentry.JsonObjectWriter;
import io.sentry.NoOpLogger;
import java.io.IOException;
import java.io.StringWriter;
import java.util.HashMap;
import java.util.Locale;

public class StartSentry {
    public static void main(String[] args) {
        JsonObjectWriter writer = new JsonObjectWriter(new StringWriter(), 10);
        HashMap<String, Locale> map = new HashMap<>();
        map.put("one", Locale.GERMAN);
        try {
            writer.value(
                    NoOpLogger.getInstance(),
                    map
            );
        } catch (IOException e) {
            System.out.println("IO exception " + e);
        }
    }
}

The same happens on newest version 6.5.0.

Expected Result

Locale is correctly serialized

Actual Result

Potential Out of Memory exception

[philipphofmann]

@marek-klima, did this work on any of the previous versions? If yes, which version was the last one it still worked?

[marek-klima]

@marek-klima, did this work on any of the previous versions?

Unfortunately I'm now aware of any older version where this would work correctly.

[romtsn]

Hmm, do you really want to serialize the entire Locale object? I guess our serializer is not designed to serialize large deeply-nested object hierarchies.. On the other hand it should in theory function the same way Gson reflection serializer works.

[marek-klima]

Right, there is no need to serialize the entire Locale object - it should be serialized to something like de_de in the given example. Also, this issue is affecting any large deeply-nested object, not only Locale.

[romtsn]

Yeah we definitely need to investigate it, that's for sure

[adinauer]

I'll take a look

[adinauer]

We could skip static fields when going through the fields but in this case it would lead to an empty object being serialized for Locale. We could fall back to toString() in that case as a generic solution. WDYT?