|
| 1 | +package io.sentry.android.core; |
| 2 | + |
| 3 | +import android.annotation.SuppressLint; |
| 4 | +import android.content.Context; |
| 5 | +import android.net.ConnectivityManager; |
| 6 | +import android.net.Network; |
| 7 | +import android.net.NetworkCapabilities; |
| 8 | +import android.os.Build; |
| 9 | +import androidx.annotation.NonNull; |
| 10 | +import androidx.annotation.RequiresApi; |
| 11 | +import io.sentry.Breadcrumb; |
| 12 | +import io.sentry.Hint; |
| 13 | +import io.sentry.IHub; |
| 14 | +import io.sentry.ILogger; |
| 15 | +import io.sentry.Integration; |
| 16 | +import io.sentry.SentryLevel; |
| 17 | +import io.sentry.SentryOptions; |
| 18 | +import io.sentry.android.core.internal.util.ConnectivityChecker; |
| 19 | +import io.sentry.util.Objects; |
| 20 | +import java.io.Closeable; |
| 21 | +import java.io.IOException; |
| 22 | +import org.jetbrains.annotations.NotNull; |
| 23 | +import org.jetbrains.annotations.Nullable; |
| 24 | +import org.jetbrains.annotations.TestOnly; |
| 25 | + |
| 26 | +public class NetworkBreadcrumbsIntegration implements Integration, Closeable { |
| 27 | + |
| 28 | + private final @NotNull Context context; |
| 29 | + |
| 30 | + private final @NotNull BuildInfoProvider buildInfoProvider; |
| 31 | + |
| 32 | + private final @NotNull ILogger logger; |
| 33 | + |
| 34 | + @TestOnly @Nullable NetworkBreadcrumbsNetworkCallback networkCallback; |
| 35 | + |
| 36 | + public NetworkBreadcrumbsIntegration( |
| 37 | + final @NotNull Context context, |
| 38 | + final @NotNull BuildInfoProvider buildInfoProvider, |
| 39 | + final @NotNull ILogger logger) { |
| 40 | + this.context = Objects.requireNonNull(context, "Context is required"); |
| 41 | + this.buildInfoProvider = |
| 42 | + Objects.requireNonNull(buildInfoProvider, "BuildInfoProvider is required"); |
| 43 | + this.logger = Objects.requireNonNull(logger, "ILogger is required"); |
| 44 | + } |
| 45 | + |
| 46 | + @SuppressLint("NewApi") |
| 47 | + @Override |
| 48 | + public void register(final @NotNull IHub hub, final @NotNull SentryOptions options) { |
| 49 | + Objects.requireNonNull(hub, "Hub is required"); |
| 50 | + SentryAndroidOptions androidOptions = |
| 51 | + Objects.requireNonNull( |
| 52 | + (options instanceof SentryAndroidOptions) ? (SentryAndroidOptions) options : null, |
| 53 | + "SentryAndroidOptions is required"); |
| 54 | + |
| 55 | + logger.log( |
| 56 | + SentryLevel.DEBUG, |
| 57 | + "NetworkBreadcrumbsIntegration enabled: %s", |
| 58 | + androidOptions.isEnableNetworkEventBreadcrumbs()); |
| 59 | + |
| 60 | + if (androidOptions.isEnableNetworkEventBreadcrumbs()) { |
| 61 | + |
| 62 | + // The specific error is logged in the ConnectivityChecker method |
| 63 | + if (buildInfoProvider.getSdkInfoVersion() < Build.VERSION_CODES.LOLLIPOP) { |
| 64 | + networkCallback = null; |
| 65 | + logger.log(SentryLevel.DEBUG, "NetworkBreadcrumbsIntegration requires Android 5+"); |
| 66 | + return; |
| 67 | + } |
| 68 | + |
| 69 | + networkCallback = new NetworkBreadcrumbsNetworkCallback(hub, buildInfoProvider); |
| 70 | + final boolean registered = |
| 71 | + ConnectivityChecker.registerNetworkCallback( |
| 72 | + context, logger, buildInfoProvider, networkCallback); |
| 73 | + |
| 74 | + // The specific error is logged in the ConnectivityChecker method |
| 75 | + if (!registered) { |
| 76 | + networkCallback = null; |
| 77 | + logger.log(SentryLevel.DEBUG, "NetworkBreadcrumbsIntegration not installed."); |
| 78 | + return; |
| 79 | + } |
| 80 | + logger.log(SentryLevel.DEBUG, "NetworkBreadcrumbsIntegration installed."); |
| 81 | + addIntegrationToSdkVersion(); |
| 82 | + } |
| 83 | + } |
| 84 | + |
| 85 | + @Override |
| 86 | + public void close() throws IOException { |
| 87 | + if (networkCallback != null) { |
| 88 | + ConnectivityChecker.unregisterNetworkCallback( |
| 89 | + context, logger, buildInfoProvider, networkCallback); |
| 90 | + logger.log(SentryLevel.DEBUG, "NetworkBreadcrumbsIntegration remove."); |
| 91 | + } |
| 92 | + networkCallback = null; |
| 93 | + } |
| 94 | + |
| 95 | + @SuppressLint("ObsoleteSdkInt") |
| 96 | + @RequiresApi(api = Build.VERSION_CODES.LOLLIPOP) |
| 97 | + static final class NetworkBreadcrumbsNetworkCallback extends ConnectivityManager.NetworkCallback { |
| 98 | + final @NotNull IHub hub; |
| 99 | + final @NotNull BuildInfoProvider buildInfoProvider; |
| 100 | + |
| 101 | + @Nullable Network currentNetwork = null; |
| 102 | + |
| 103 | + @Nullable NetworkCapabilities lastCapabilities = null; |
| 104 | + |
| 105 | + NetworkBreadcrumbsNetworkCallback( |
| 106 | + final @NotNull IHub hub, final @NotNull BuildInfoProvider buildInfoProvider) { |
| 107 | + this.hub = Objects.requireNonNull(hub, "Hub is required"); |
| 108 | + this.buildInfoProvider = |
| 109 | + Objects.requireNonNull(buildInfoProvider, "BuildInfoProvider is required"); |
| 110 | + } |
| 111 | + |
| 112 | + @Override |
| 113 | + public void onAvailable(final @NonNull Network network) { |
| 114 | + if (network.equals(currentNetwork)) { |
| 115 | + return; |
| 116 | + } |
| 117 | + final Breadcrumb breadcrumb = createBreadcrumb("networkAvailable"); |
| 118 | + hub.addBreadcrumb(breadcrumb); |
| 119 | + currentNetwork = network; |
| 120 | + lastCapabilities = null; |
| 121 | + } |
| 122 | + |
| 123 | + @Override |
| 124 | + public void onCapabilitiesChanged( |
| 125 | + final @NonNull Network network, final @NonNull NetworkCapabilities networkCapabilities) { |
| 126 | + if (!network.equals(currentNetwork)) { |
| 127 | + return; |
| 128 | + } |
| 129 | + final @Nullable NetworkBreadcrumbConnectionDetail connectionDetail = |
| 130 | + getNewConnectionDetails(lastCapabilities, networkCapabilities); |
| 131 | + if (connectionDetail == null) { |
| 132 | + return; |
| 133 | + } |
| 134 | + lastCapabilities = networkCapabilities; |
| 135 | + final Breadcrumb breadcrumb = createBreadcrumb("networkCapabilitiesChanged"); |
| 136 | + breadcrumb.setData("download_bandwidth", connectionDetail.downBandwidth); |
| 137 | + breadcrumb.setData("upload_bandwidth", connectionDetail.upBandwidth); |
| 138 | + breadcrumb.setData("vpn_active", connectionDetail.isVpn); |
| 139 | + breadcrumb.setData("network_type", connectionDetail.type); |
| 140 | + if (connectionDetail.signalStrength != 0) { |
| 141 | + breadcrumb.setData("signal_strength", connectionDetail.signalStrength); |
| 142 | + } |
| 143 | + Hint hint = new Hint(); |
| 144 | + hint.set("data", connectionDetail); |
| 145 | + hub.addBreadcrumb(breadcrumb, hint); |
| 146 | + } |
| 147 | + |
| 148 | + @Override |
| 149 | + public void onLost(final @NonNull Network network) { |
| 150 | + if (!network.equals(currentNetwork)) { |
| 151 | + return; |
| 152 | + } |
| 153 | + final Breadcrumb breadcrumb = createBreadcrumb("networkLost"); |
| 154 | + hub.addBreadcrumb(breadcrumb); |
| 155 | + currentNetwork = null; |
| 156 | + lastCapabilities = null; |
| 157 | + } |
| 158 | + |
| 159 | + private Breadcrumb createBreadcrumb(String action) { |
| 160 | + final Breadcrumb breadcrumb = new Breadcrumb(); |
| 161 | + breadcrumb.setType("system"); |
| 162 | + breadcrumb.setCategory("network.event"); |
| 163 | + breadcrumb.setData("action", action); |
| 164 | + breadcrumb.setLevel(SentryLevel.INFO); |
| 165 | + return breadcrumb; |
| 166 | + } |
| 167 | + |
| 168 | + private @Nullable NetworkBreadcrumbConnectionDetail getNewConnectionDetails( |
| 169 | + final @Nullable NetworkCapabilities oldCapabilities, |
| 170 | + final @NotNull NetworkCapabilities newCapabilities) { |
| 171 | + if (oldCapabilities == null) { |
| 172 | + return new NetworkBreadcrumbConnectionDetail(newCapabilities, buildInfoProvider); |
| 173 | + } |
| 174 | + NetworkBreadcrumbConnectionDetail oldConnectionDetails = |
| 175 | + new NetworkBreadcrumbConnectionDetail(oldCapabilities, buildInfoProvider); |
| 176 | + NetworkBreadcrumbConnectionDetail newConnectionDetails = |
| 177 | + new NetworkBreadcrumbConnectionDetail(newCapabilities, buildInfoProvider); |
| 178 | + |
| 179 | + // We compare the details and if they are similar we return null, so that we don't spam the |
| 180 | + // user with lots of breadcrumbs for e.g. an increase of signal strength of 1 point |
| 181 | + if (newConnectionDetails.isSimilar(oldConnectionDetails)) { |
| 182 | + return null; |
| 183 | + } |
| 184 | + return newConnectionDetails; |
| 185 | + } |
| 186 | + } |
| 187 | + |
| 188 | + static class NetworkBreadcrumbConnectionDetail { |
| 189 | + final int downBandwidth, upBandwidth, signalStrength; |
| 190 | + final boolean isVpn; |
| 191 | + final @NotNull String type; |
| 192 | + |
| 193 | + @SuppressLint({"NewApi", "ObsoleteSdkInt"}) |
| 194 | + @RequiresApi(api = Build.VERSION_CODES.LOLLIPOP) |
| 195 | + NetworkBreadcrumbConnectionDetail( |
| 196 | + final @NotNull NetworkCapabilities networkCapabilities, |
| 197 | + final @NotNull BuildInfoProvider buildInfoProvider) { |
| 198 | + Objects.requireNonNull(networkCapabilities, "NetworkCapabilities is required"); |
| 199 | + Objects.requireNonNull(buildInfoProvider, "BuildInfoProvider is required"); |
| 200 | + this.downBandwidth = networkCapabilities.getLinkDownstreamBandwidthKbps(); |
| 201 | + this.upBandwidth = networkCapabilities.getLinkUpstreamBandwidthKbps(); |
| 202 | + int strength = |
| 203 | + buildInfoProvider.getSdkInfoVersion() >= Build.VERSION_CODES.Q |
| 204 | + ? networkCapabilities.getSignalStrength() |
| 205 | + : 0; |
| 206 | + // If the system reports a signalStrength of Integer.MIN_VALUE, we adjust it to be 0 |
| 207 | + this.signalStrength = strength > -100 ? strength : 0; |
| 208 | + this.isVpn = networkCapabilities.hasTransport(NetworkCapabilities.TRANSPORT_VPN); |
| 209 | + String connectionType = |
| 210 | + ConnectivityChecker.getConnectionType(networkCapabilities, buildInfoProvider); |
| 211 | + this.type = connectionType != null ? connectionType : ""; |
| 212 | + } |
| 213 | + |
| 214 | + /** |
| 215 | + * Compares this connection detail to another one. |
| 216 | + * |
| 217 | + * @param other The other NetworkBreadcrumbConnectionDetail to compare |
| 218 | + * @return true if the details are similar enough, false otherwise |
| 219 | + */ |
| 220 | + boolean isSimilar(final @NotNull NetworkBreadcrumbConnectionDetail other) { |
| 221 | + return isVpn == other.isVpn |
| 222 | + && type.equals(other.type) |
| 223 | + && (-5 <= signalStrength - other.signalStrength |
| 224 | + && signalStrength - other.signalStrength <= 5) |
| 225 | + && (-1000 <= downBandwidth - other.downBandwidth |
| 226 | + && downBandwidth - other.downBandwidth <= 1000) |
| 227 | + && (-1000 <= upBandwidth - other.upBandwidth && upBandwidth - other.upBandwidth <= 1000); |
| 228 | + } |
| 229 | + } |
| 230 | +} |
0 commit comments