|
| 1 | +package io.sentry.rrweb; |
| 2 | + |
| 3 | +import io.sentry.ILogger; |
| 4 | +import io.sentry.JsonDeserializer; |
| 5 | +import io.sentry.JsonSerializable; |
| 6 | +import io.sentry.JsonUnknown; |
| 7 | +import io.sentry.ObjectReader; |
| 8 | +import io.sentry.ObjectWriter; |
| 9 | +import io.sentry.SentryOptions; |
| 10 | +import io.sentry.SentryReplayOptions; |
| 11 | +import io.sentry.protocol.SdkVersion; |
| 12 | +import io.sentry.util.CollectionUtils; |
| 13 | +import io.sentry.vendor.gson.stream.JsonToken; |
| 14 | +import java.io.IOException; |
| 15 | +import java.util.HashMap; |
| 16 | +import java.util.Map; |
| 17 | +import java.util.concurrent.ConcurrentHashMap; |
| 18 | +import org.jetbrains.annotations.NotNull; |
| 19 | +import org.jetbrains.annotations.Nullable; |
| 20 | + |
| 21 | +public final class RRWebOptionsEvent extends RRWebEvent implements JsonSerializable, JsonUnknown { |
| 22 | + public static final String EVENT_TAG = "options"; |
| 23 | + |
| 24 | + private @NotNull String tag; |
| 25 | + // keeping this untyped so hybrids can easily set what they want |
| 26 | + private @NotNull Map<String, Object> optionsPayload = new HashMap<>(); |
| 27 | + // to support unknown json attributes with nesting, we have to have unknown map for each of the |
| 28 | + // nested object in json: { ..., "data": { ..., "payload": { ... } } } |
| 29 | + private @Nullable Map<String, Object> unknown; |
| 30 | + private @Nullable Map<String, Object> dataUnknown; |
| 31 | + |
| 32 | + public RRWebOptionsEvent() { |
| 33 | + super(RRWebEventType.Custom); |
| 34 | + tag = EVENT_TAG; |
| 35 | + } |
| 36 | + |
| 37 | + public RRWebOptionsEvent(final @NotNull SentryOptions options) { |
| 38 | + this(); |
| 39 | + final SdkVersion sdkVersion = options.getSdkVersion(); |
| 40 | + if (sdkVersion != null) { |
| 41 | + optionsPayload.put("nativeSdkName", sdkVersion.getName()); |
| 42 | + optionsPayload.put("nativeSdkVersion", sdkVersion.getVersion()); |
| 43 | + } |
| 44 | + final @NotNull SentryReplayOptions replayOptions = options.getExperimental().getSessionReplay(); |
| 45 | + optionsPayload.put("errorSampleRate", replayOptions.getOnErrorSampleRate()); |
| 46 | + optionsPayload.put("sessionSampleRate", replayOptions.getSessionSampleRate()); |
| 47 | + optionsPayload.put( |
| 48 | + "maskAllImages", |
| 49 | + replayOptions.getMaskViewClasses().contains(SentryReplayOptions.IMAGE_VIEW_CLASS_NAME)); |
| 50 | + optionsPayload.put( |
| 51 | + "maskAllText", |
| 52 | + replayOptions.getMaskViewClasses().contains(SentryReplayOptions.TEXT_VIEW_CLASS_NAME)); |
| 53 | + optionsPayload.put("quality", replayOptions.getQuality().serializedName()); |
| 54 | + optionsPayload.put( |
| 55 | + "maskedViewClasses", CollectionUtils.joinToString(replayOptions.getMaskViewClasses(), ",")); |
| 56 | + optionsPayload.put( |
| 57 | + "unmaskedViewClasses", |
| 58 | + CollectionUtils.joinToString(replayOptions.getUnmaskViewClasses(), ",")); |
| 59 | + } |
| 60 | + |
| 61 | + @NotNull |
| 62 | + public String getTag() { |
| 63 | + return tag; |
| 64 | + } |
| 65 | + |
| 66 | + public void setTag(final @NotNull String tag) { |
| 67 | + this.tag = tag; |
| 68 | + } |
| 69 | + |
| 70 | + public @NotNull Map<String, Object> getOptionsPayload() { |
| 71 | + return optionsPayload; |
| 72 | + } |
| 73 | + |
| 74 | + public void setOptionsPayload(final @NotNull Map<String, Object> optionsPayload) { |
| 75 | + this.optionsPayload = optionsPayload; |
| 76 | + } |
| 77 | + |
| 78 | + public @Nullable Map<String, Object> getDataUnknown() { |
| 79 | + return dataUnknown; |
| 80 | + } |
| 81 | + |
| 82 | + public void setDataUnknown(final @Nullable Map<String, Object> dataUnknown) { |
| 83 | + this.dataUnknown = dataUnknown; |
| 84 | + } |
| 85 | + |
| 86 | + @Override |
| 87 | + public @Nullable Map<String, Object> getUnknown() { |
| 88 | + return unknown; |
| 89 | + } |
| 90 | + |
| 91 | + @Override |
| 92 | + public void setUnknown(final @Nullable Map<String, Object> unknown) { |
| 93 | + this.unknown = unknown; |
| 94 | + } |
| 95 | + |
| 96 | + // region json |
| 97 | + public static final class JsonKeys { |
| 98 | + public static final String DATA = "data"; |
| 99 | + public static final String PAYLOAD = "payload"; |
| 100 | + } |
| 101 | + |
| 102 | + @Override |
| 103 | + public void serialize(@NotNull ObjectWriter writer, @NotNull ILogger logger) throws IOException { |
| 104 | + writer.beginObject(); |
| 105 | + new RRWebEvent.Serializer().serialize(this, writer, logger); |
| 106 | + writer.name(JsonKeys.DATA); |
| 107 | + serializeData(writer, logger); |
| 108 | + if (unknown != null) { |
| 109 | + for (final String key : unknown.keySet()) { |
| 110 | + final Object value = unknown.get(key); |
| 111 | + writer.name(key); |
| 112 | + writer.value(logger, value); |
| 113 | + } |
| 114 | + } |
| 115 | + writer.endObject(); |
| 116 | + } |
| 117 | + |
| 118 | + private void serializeData(final @NotNull ObjectWriter writer, final @NotNull ILogger logger) |
| 119 | + throws IOException { |
| 120 | + writer.beginObject(); |
| 121 | + writer.name(RRWebEvent.JsonKeys.TAG).value(tag); |
| 122 | + writer.name(JsonKeys.PAYLOAD); |
| 123 | + serializePayload(writer, logger); |
| 124 | + if (dataUnknown != null) { |
| 125 | + for (String key : dataUnknown.keySet()) { |
| 126 | + Object value = dataUnknown.get(key); |
| 127 | + writer.name(key); |
| 128 | + writer.value(logger, value); |
| 129 | + } |
| 130 | + } |
| 131 | + writer.endObject(); |
| 132 | + } |
| 133 | + |
| 134 | + private void serializePayload(final @NotNull ObjectWriter writer, final @NotNull ILogger logger) |
| 135 | + throws IOException { |
| 136 | + writer.beginObject(); |
| 137 | + if (optionsPayload != null) { |
| 138 | + for (final String key : optionsPayload.keySet()) { |
| 139 | + final Object value = optionsPayload.get(key); |
| 140 | + writer.name(key); |
| 141 | + writer.value(logger, value); |
| 142 | + } |
| 143 | + } |
| 144 | + writer.endObject(); |
| 145 | + } |
| 146 | + |
| 147 | + public static final class Deserializer implements JsonDeserializer<RRWebOptionsEvent> { |
| 148 | + |
| 149 | + @Override |
| 150 | + public @NotNull RRWebOptionsEvent deserialize( |
| 151 | + @NotNull ObjectReader reader, @NotNull ILogger logger) throws Exception { |
| 152 | + reader.beginObject(); |
| 153 | + @Nullable Map<String, Object> unknown = null; |
| 154 | + |
| 155 | + final RRWebOptionsEvent event = new RRWebOptionsEvent(); |
| 156 | + final RRWebEvent.Deserializer baseEventDeserializer = new RRWebEvent.Deserializer(); |
| 157 | + |
| 158 | + while (reader.peek() == JsonToken.NAME) { |
| 159 | + final String nextName = reader.nextName(); |
| 160 | + switch (nextName) { |
| 161 | + case JsonKeys.DATA: |
| 162 | + deserializeData(event, reader, logger); |
| 163 | + break; |
| 164 | + default: |
| 165 | + if (!baseEventDeserializer.deserializeValue(event, nextName, reader, logger)) { |
| 166 | + if (unknown == null) { |
| 167 | + unknown = new HashMap<>(); |
| 168 | + } |
| 169 | + reader.nextUnknown(logger, unknown, nextName); |
| 170 | + } |
| 171 | + break; |
| 172 | + } |
| 173 | + } |
| 174 | + |
| 175 | + event.setUnknown(unknown); |
| 176 | + reader.endObject(); |
| 177 | + return event; |
| 178 | + } |
| 179 | + |
| 180 | + private void deserializeData( |
| 181 | + final @NotNull RRWebOptionsEvent event, |
| 182 | + final @NotNull ObjectReader reader, |
| 183 | + final @NotNull ILogger logger) |
| 184 | + throws Exception { |
| 185 | + @Nullable Map<String, Object> dataUnknown = null; |
| 186 | + |
| 187 | + reader.beginObject(); |
| 188 | + while (reader.peek() == JsonToken.NAME) { |
| 189 | + final String nextName = reader.nextName(); |
| 190 | + switch (nextName) { |
| 191 | + case RRWebEvent.JsonKeys.TAG: |
| 192 | + final String tag = reader.nextStringOrNull(); |
| 193 | + event.tag = tag == null ? "" : tag; |
| 194 | + break; |
| 195 | + case JsonKeys.PAYLOAD: |
| 196 | + deserializePayload(event, reader, logger); |
| 197 | + break; |
| 198 | + default: |
| 199 | + if (dataUnknown == null) { |
| 200 | + dataUnknown = new ConcurrentHashMap<>(); |
| 201 | + } |
| 202 | + reader.nextUnknown(logger, dataUnknown, nextName); |
| 203 | + } |
| 204 | + } |
| 205 | + event.setDataUnknown(dataUnknown); |
| 206 | + reader.endObject(); |
| 207 | + } |
| 208 | + |
| 209 | + @SuppressWarnings("unchecked") |
| 210 | + private void deserializePayload( |
| 211 | + final @NotNull RRWebOptionsEvent event, |
| 212 | + final @NotNull ObjectReader reader, |
| 213 | + final @NotNull ILogger logger) |
| 214 | + throws Exception { |
| 215 | + @Nullable Map<String, Object> optionsPayload = null; |
| 216 | + |
| 217 | + reader.beginObject(); |
| 218 | + while (reader.peek() == JsonToken.NAME) { |
| 219 | + final String nextName = reader.nextName(); |
| 220 | + if (optionsPayload == null) { |
| 221 | + optionsPayload = new HashMap<>(); |
| 222 | + } |
| 223 | + reader.nextUnknown(logger, optionsPayload, nextName); |
| 224 | + } |
| 225 | + if (optionsPayload != null) { |
| 226 | + event.setOptionsPayload(optionsPayload); |
| 227 | + } |
| 228 | + reader.endObject(); |
| 229 | + } |
| 230 | + } |
| 231 | + // endregion json |
| 232 | +} |
0 commit comments