Skip to content

Vendor JSON Writer/Reader: Gpu #1673

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
denrase merged 5 commits into from
Aug 26, 2021
+269 −37
Merged

Vendor JSON Writer/Reader: Gpu #1673

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
39139ab
move unknwn getter/setter requirement to own interface
denrase Aug 5, 2021
8eda7f6
mark interface as public
denrase Aug 5, 2021
ecc145e
generate api dump
denrase Aug 5, 2021
1938a35
add gpu serialization
denrase Aug 23, 2021
fc041d9
Merge branch 'feat/vendor-json-writer-reader' into feat/vendor-json-w…
denrase Aug 26, 2021
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
24 changes: 23 additions & 1 deletion sentry/api/sentry.api
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1634,7 +1634,7 @@ public final class io/sentry/protocol/Device$JsonKeys {
public fun <init> ()V
}

public final class io/sentry/protocol/Gpu : io/sentry/IUnknownPropertiesConsumer {
public final class io/sentry/protocol/Gpu : io/sentry/IUnknownPropertiesConsumer, io/sentry/JsonSerializable, io/sentry/JsonUnknown {
public static final field TYPE Ljava/lang/String;
public fun <init> ()V
public fun acceptUnknownProperties (Ljava/util/Map;)V
Expand All @@ -1643,21 +1643,43 @@ public final class io/sentry/protocol/Gpu : io/sentry/IUnknownPropertiesConsumer
public fun getMemorySize ()Ljava/lang/Integer;
public fun getName ()Ljava/lang/String;
public fun getNpotSupport ()Ljava/lang/String;
public fun getUnknown ()Ljava/util/Map;
public fun getVendorId ()Ljava/lang/Integer;
public fun getVendorName ()Ljava/lang/String;
public fun getVersion ()Ljava/lang/String;
public fun isMultiThreadedRendering ()Ljava/lang/Boolean;
public fun serialize (Lio/sentry/JsonObjectWriter;Lio/sentry/ILogger;)V
public fun setApiType (Ljava/lang/String;)V
public fun setId (Ljava/lang/Integer;)V
public fun setMemorySize (Ljava/lang/Integer;)V
public fun setMultiThreadedRendering (Ljava/lang/Boolean;)V
public fun setName (Ljava/lang/String;)V
public fun setNpotSupport (Ljava/lang/String;)V
public fun setUnknown (Ljava/util/Map;)V
public fun setVendorId (Ljava/lang/Integer;)V
public fun setVendorName (Ljava/lang/String;)V
public fun setVersion (Ljava/lang/String;)V
}

public final class io/sentry/protocol/Gpu$Deserializer : io/sentry/JsonDeserializer {
public fun <init> ()V
public fun deserialize (Lio/sentry/JsonObjectReader;Lio/sentry/ILogger;)Lio/sentry/protocol/Gpu;
public synthetic fun deserialize (Lio/sentry/JsonObjectReader;Lio/sentry/ILogger;)Ljava/lang/Object;
}

public final class io/sentry/protocol/Gpu$JsonKeys {
public static final field API_TYPE Ljava/lang/String;
public static final field ID Ljava/lang/String;
public static final field MEMORY_SIZE Ljava/lang/String;
public static final field MULTI_THREADED_RENDERING Ljava/lang/String;
public static final field NAME Ljava/lang/String;
public static final field NPOT_SUPPORT Ljava/lang/String;
public static final field VENDOR_ID Ljava/lang/String;
public static final field VENDOR_NAME Ljava/lang/String;
public static final field VERSION Ljava/lang/String;
public fun <init> ()V
}

public final class io/sentry/protocol/MeasurementValue {
public fun <init> (F)V
}
Expand Down
131 changes: 124 additions & 7 deletions sentry/src/main/java/io/sentry/protocol/Gpu.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,21 @@
package io.sentry.protocol;

import io.sentry.ILogger;
import io.sentry.IUnknownPropertiesConsumer;
import io.sentry.JsonDeserializer;
import io.sentry.JsonObjectReader;
import io.sentry.JsonObjectWriter;
import io.sentry.JsonSerializable;
import io.sentry.JsonUnknown;
import io.sentry.util.CollectionUtils;
import java.io.IOException;
import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;
import org.jetbrains.annotations.ApiStatus;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import org.jetbrains.annotations.TestOnly;

public final class Gpu implements IUnknownPropertiesConsumer {
public final class Gpu implements IUnknownPropertiesConsumer, JsonUnknown, JsonSerializable {
public static final String TYPE = "gpu";

/** The name of the graphics device. */
Expand Down Expand Up @@ -125,15 +131,126 @@ public void setNpotSupport(final @Nullable String npotSupport) {
this.npotSupport = npotSupport;
}

@TestOnly
@ApiStatus.Internal
@Override
public void acceptUnknownProperties(final @NotNull Map<String, Object> unknown) {
this.unknown = new ConcurrentHashMap<>(unknown);
}

// region JsonSerializable

public static final class JsonKeys {
public static final String NAME = "name";
public static final String ID = "id";
public static final String VENDOR_ID = "vendor_id";
public static final String VENDOR_NAME = "vendor_name";
public static final String MEMORY_SIZE = "memory_size";
public static final String API_TYPE = "api_type";
public static final String MULTI_THREADED_RENDERING = "multi_threaded_rendering";
public static final String VERSION = "version";
public static final String NPOT_SUPPORT = "npot_support";
}

@Override
public void serialize(@NotNull JsonObjectWriter writer, @NotNull ILogger logger)
throws IOException {
writer.beginObject();
if (name != null) {
writer.name(JsonKeys.NAME).value(name);
}
if (id != null) {
writer.name(JsonKeys.ID).value(id);
}
if (vendorId != null) {
writer.name(JsonKeys.VENDOR_ID).value(vendorId);
}
if (vendorName != null) {
writer.name(JsonKeys.VENDOR_NAME).value(vendorName);
}
if (memorySize != null) {
writer.name(JsonKeys.MEMORY_SIZE).value(memorySize);
}
if (apiType != null) {
writer.name(JsonKeys.API_TYPE).value(apiType);
}
if (multiThreadedRendering != null) {
writer.name(JsonKeys.MULTI_THREADED_RENDERING).value(multiThreadedRendering);
}
if (version != null) {
writer.name(JsonKeys.VERSION).value(version);
}
if (npotSupport != null) {
writer.name(JsonKeys.NPOT_SUPPORT).value(npotSupport);
}
if (unknown != null) {
for (String key : unknown.keySet()) {
Object value = unknown.get(key);
writer.name(key);
writer.value(logger, value);
}
}
writer.endObject();
}

@Nullable
Map<String, Object> getUnknown() {
@Override
public Map<String, Object> getUnknown() {
return unknown;
}

@ApiStatus.Internal
@Override
public void acceptUnknownProperties(final @NotNull Map<String, Object> unknown) {
this.unknown = new ConcurrentHashMap<>(unknown);
public void setUnknown(@Nullable Map<String, Object> unknown) {
this.unknown = unknown;
}

public static final class Deserializer implements JsonDeserializer<Gpu> {
@Override
public @NotNull Gpu deserialize(@NotNull JsonObjectReader reader, @NotNull ILogger logger)
throws Exception {
reader.beginObject();
Gpu gpu = new Gpu();
Map<String, Object> unknown = null;
do {
final String nextName = reader.nextName();
switch (nextName) {
case JsonKeys.NAME:
gpu.name = reader.nextStringOrNull();
break;
case JsonKeys.ID:
gpu.id = reader.nextIntegerOrNull();
break;
case JsonKeys.VENDOR_ID:
gpu.vendorId = reader.nextIntegerOrNull();
break;
case JsonKeys.VENDOR_NAME:
gpu.vendorName = reader.nextStringOrNull();
break;
case JsonKeys.MEMORY_SIZE:
gpu.memorySize = reader.nextIntegerOrNull();
break;
case JsonKeys.API_TYPE:
gpu.apiType = reader.nextStringOrNull();
break;
case JsonKeys.MULTI_THREADED_RENDERING:
gpu.multiThreadedRendering = reader.nextBooleanOrNull();
break;
case JsonKeys.VERSION:
gpu.version = reader.nextStringOrNull();
break;
case JsonKeys.NPOT_SUPPORT:
gpu.npotSupport = reader.nextStringOrNull();
break;
default:
if (unknown == null) {
unknown = new ConcurrentHashMap<>();
}
reader.nextUnknown(logger, unknown, nextName);
break;
}
} while (reader.hasNext());
gpu.setUnknown(unknown);
reader.endObject();
return gpu;
}
}
}
69 changes: 40 additions & 29 deletions sentry/src/test/java/io/sentry/JsonUnknownSerializationTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import com.nhaarman.mockitokotlin2.whenever
import io.sentry.protocol.App
import io.sentry.protocol.Browser
import io.sentry.protocol.Device
import io.sentry.protocol.Gpu
import io.sentry.protocol.OperatingSystem
import io.sentry.protocol.SentryId
import io.sentry.protocol.SentryRuntime
Expand All @@ -26,26 +27,12 @@ class JsonUnknownSerializationTest {
val eventId = SentryId("c2fb8fee2e2b49758bcb67cda0f713c7")
return givenJsonUnknown(UserFeedback(eventId))
}

fun getApp(): App {
return givenJsonUnknown(App())
}

fun getDevice(): Device {
return givenJsonUnknown(Device())
}

fun getBrowser(): Browser {
return givenJsonUnknown(Browser())
}

fun getOperatingSystem(): OperatingSystem {
return givenJsonUnknown(OperatingSystem())
}

fun getSentryRuntime(): SentryRuntime {
return givenJsonUnknown(SentryRuntime())
}
fun getApp() = givenJsonUnknown(App())
fun getBrowser() = givenJsonUnknown(Browser())
fun getDevice() = givenJsonUnknown(Device())
fun getGpu() = givenJsonUnknown(Gpu())
fun getOperatingSystem() = givenJsonUnknown(OperatingSystem())
fun getSentryRuntime() = givenJsonUnknown(SentryRuntime())

private fun <T : JsonUnknown> givenJsonUnknown(jsonUnknown: T): T {
return jsonUnknown.apply {
Expand Down Expand Up @@ -108,12 +95,23 @@ class JsonUnknownSerializationTest {
verify(writer).value(logger, "fixture-value")
}

// Browser

@Test
fun `serializing unknown calls json object writer for device`() {
fun `serializing and deserialize browser`() {
val sut = fixture.getBrowser()

val serialized = serialize(sut)
val deserialized = deserialize(serialized, Browser.Deserializer())

assertEquals(sut.unknown, deserialized.unknown)
}

@Test
fun `serializing unknown calls json object writer for browser`() {
val writer: JsonObjectWriter = mock()
whenever(writer.name(any())).thenReturn(writer)
val logger: ILogger = mock()
val sut = fixture.getDevice()
val sut = fixture.getBrowser()

sut.serialize(writer, logger)

Expand All @@ -133,23 +131,36 @@ class JsonUnknownSerializationTest {
assertEquals(sut.unknown, deserialized.unknown)
}

// Browser
@Test
fun `serializing unknown calls json object writer for device`() {
val writer: JsonObjectWriter = mock()
whenever(writer.name(any())).thenReturn(writer)
val logger: ILogger = mock()
val sut = fixture.getDevice()

sut.serialize(writer, logger)

verify(writer).name("fixture-key")
verify(writer).value(logger, "fixture-value")
}

// GPU

@Test
fun `serializing and deserialize browser`() {
val sut = fixture.getBrowser()
fun `serializing and deserialize gpu`() {
val sut = fixture.getGpu()

val serialized = serialize(sut)
val deserialized = deserialize(serialized, Browser.Deserializer())
val deserialized = deserialize(serialized, Gpu.Deserializer())

assertEquals(sut.unknown, deserialized.unknown)
}

@Test
fun `serializing unknown calls json object writer for browser`() {
fun `serializing unknown calls json object writer for gpu`() {
val writer: JsonObjectWriter = mock()
val logger: ILogger = mock()
val sut = fixture.getBrowser()
val sut = fixture.getGpu()

sut.serialize(writer, logger)

Expand Down
71 changes: 71 additions & 0 deletions sentry/src/test/java/io/sentry/protocol/GpuTests.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
package io.sentry.protocol

import com.nhaarman.mockitokotlin2.mock
import io.sentry.FileFromResources
import io.sentry.ILogger
import io.sentry.JsonObjectReader
import io.sentry.JsonObjectWriter
import io.sentry.JsonSerializable
import java.io.StringReader
import java.io.StringWriter
import kotlin.test.assertEquals
import org.junit.Test

class GpuSerializationTest {

private class Fixture {
var logger: ILogger = mock()

fun getSut() = Gpu().apply {
name = "d623a6b5-e1ab-4402-931b-c06f5a43a5ae"
id = -596576280
vendorId = 1874778041
vendorName = "d732cf76-07dc-48e2-8920-96d6bfc2439d"
memorySize = -1484004451
apiType = "95dfc8bc-88ae-4d66-b85f-6c88ad45b80f"
isMultiThreadedRendering = true
version = "3f3f73c3-83a2-423a-8a6f-bb3de0d4a6ae"
npotSupport = "e06b074a-463c-45de-a959-cbabd461d99d"
}
}
private val fixture = Fixture()

@Test
fun serialize() {
val expected = sanitizedFile("gson/gpu.json")
val actual = serializeToString(fixture.getSut())
assertEquals(expected, actual)
}

@Test
fun deserialize() {
val expectedJson = sanitizedFile("gson/gpu.json")
val actual = deserializeBrowser(expectedJson)
val actualJson = serializeToString(actual)
assertEquals(expectedJson, actualJson)
}

// Helper

private fun sanitizedFile(path: String): String {
return FileFromResources.invoke(path)
.replace(Regex("[\n\r]"), "")
.replace(" ", "")
}

private fun serializeToString(jsonSerializable: JsonSerializable): String {
return this.serializeToString { wrt -> jsonSerializable.serialize(wrt, fixture.logger) }
}

private fun serializeToString(serialize: (JsonObjectWriter) -> Unit): String {
val wrt = StringWriter()
val jsonWrt = JsonObjectWriter(wrt)
serialize(jsonWrt)
return wrt.toString()
}

private fun deserializeBrowser(json: String): Gpu {
val reader = JsonObjectReader(StringReader(json))
return Gpu.Deserializer().deserialize(reader, fixture.logger)
}
}
Loading