Added ability to block uploads on networks with "Low Data Mode" enabled #2345
Conversation
kmusco-foreflight
force-pushed
the
block-uploads-on-constrained-networks
branch
from
d84928c to
09fc6ec
Compare
There was a problem hiding this comment.
Thank you for the contribution @kmusco-foreflight 🙏
And for providing the use case. It makes sense to have this constraint on data uploads.
I’ve left a few comments regarding naming to help improve readability.
Additionally, I’ll change the base branch to include telemetry for this change so we can monitor it going forward.
|
|
||
| init(minBatteryLevel: Float = Constants.minBatteryLevel) { | ||
| /// Blocks uploads on networks with "Low Data Mode" enabled when set to `false`. Defaults to `true`. | ||
| let allowsConstrainedNetworkAccess: Bool |
There was a problem hiding this comment.
suggestion: This naming references the urlsessionconfiguration API and it seems not used in the logic below which can lead to confusion.
Can you rename the parameters around the API used (NWPath.isConstrained)?
Here it can be isNetworkAccessConstrained with the opposite value of it.
There was a problem hiding this comment.
The same for case allowsConstrainedNetworkAccessFalse. It could be case constrainedNetworkAccess
There was a problem hiding this comment.
I applied your naming suggestions 👍
simaoseica-dd
changed the base branch from
develop
to
simaoseica/RUM-10424/add-new-data-upload-blocker
|
@kmusco-foreflight |
Co-authored-by: Simao <[email protected]>
Co-authored-by: Simao <[email protected]>
@Valpertui Thank you for the follow up! I applied your suggestions |
3 participants
What and why?
This PR allows us to configure the SDK to block uploads when connected to a network with "Low Data Mode" enabled.
Why?
A large number of our users rely on satellite internet with plans that charge based on data consumption. There are also scenarios where the connection has limited bandwidth and we only want to allow critical services to make network requests.
How?
This PR adds a
constrainedNetworkAccessEnabledparameter that can be passed toDatadog.init(). This name was chosen to match URLSession's allowsConstrainedNetworkAccess property which specifies if "Low Data Mode" is enabled. The property defaults totrueto maintain the current behavior and will disable uploads when set tofalse.The SDK is already tracking whether or not the network is constrained in NWPathMonitorPublisher with the
isConstrainedproperty, and has a mechanism for blocking uploads with DataUploadConditions.blockersForUpload(). This PR updatesblockersForUpload()to block uploads ifisConstrainedistrueand theallowsConstrainedNetworkAccessparameter isfalse.Review checklist
make api-surface)