[core] Introduce Source::setMinimumTileUpdateInterval API #16416

pozdnyakov · 2020-04-20T11:41:14Z

The Source::setMinimumTileUpdateInterval(Duration) method sets the minimum tile update interval, which is used to throttle the tile update network requests.

The corresponding Source::getMinimumTileUpdateInterval() getter is added too.

Default minimum tile update interval value is Duration::zero().

Tag https://github.com/mapbox/mapbox-gl-native-team/issues/335

alexshalamov

lgtm

alexshalamov · 2020-04-20T14:56:17Z

/cc @asheemmamoowala do you think that property would be useful for gl-js as well?

asheemmamoowala · 2020-04-20T15:48:48Z

@asheemmamoowala do you think that property would be useful for gl-js as well?

@pozdnyakov Is there any documentation around what this method is supposed to do? Tracking for parity at mapbox/mapbox-gl-js#9603, but I don't see any use case for it in GL-JS as yet.

Introduce `Resource::minimumUpdateInterval` and consider it in the online file source. The `minimumUpdateInterval` is used to throttle the requests, which were initiated due to resource expiration.

The `Source::setMinimumTileUpdateInterval()` method sets the minimum tile update interval, which is used to throttle the tile update network requests. Default value is `Duration::zero()`.

pozdnyakov · 2020-04-20T16:22:10Z

@pozdnyakov Is there any documentation around what this method is supposed to do?

Just in this pr description, and the inline comments in source.hpp.. However, it's quite simple: it makes sure the update tile network request does not happen more often than the given duration (even if the server-provided expiration date supposes more frequent tile updates)

tmpsantos · 2020-04-21T19:45:16Z

test/storage/online_file_source.test.cpp

+    std::unique_ptr<AsyncRequest> req = fs->request(resource, [&](Response) {
+        auto wait = util::now() - start;
+        EXPECT_GE(wait, resource.minimumUpdateInterval);
+        EXPECT_LT(wait, resource.minimumUpdateInterval + Milliseconds(10));


1: [ RUN ] OnlineFileSource.RespectMinimumUpdateInterval
1: ../test/storage/online_file_source.test.cpp:232: Failure
1: Expected: (wait) < (resource.minimumUpdateInterval + Milliseconds(10)), actual: 8-byte object <02-00 00-00 00-00 00-00> vs 8-byte object <80-60 33-3C 00-00 00-00>

This one here is flaking.

chloekraw · 2020-04-22T06:56:58Z

include/mbgl/style/source.hpp

@@ -76,6 +79,14 @@ class Source : public mbgl::util::noncopyable {
    void setPrefetchZoomDelta(optional<uint8_t> delta) noexcept;
    optional<uint8_t> getPrefetchZoomDelta() const noexcept;

+    // If the given source supports loading tiles from a server,
+    // sets the minimum tile update interval, which is used to
+    // throttle the tile update network requests.


nit: "suppress" might be a better word here, if we're preventing the update network requests from happening entirely. "throttle" sounds like the request is still made but we're slowing them down.

In our requests are still made but less frequently, is "suppress" still a better word?

Hmm, so my thinking is, update network requests that are more frequent than the minimumTileUpdateInterval are suppressed (i.e., not made at all) -- is that accurate?

yeah, we can put it that way, I'll update this comment in #16422

chloekraw · 2020-04-22T07:12:15Z

@pozdnyakov a few follow-up questions:

can Source::setMinimumTileUpdateInterval(Duration) be safely called at any time?
once a TTL override is set, can the same API call be used to change the override? For example, if a device were on low power mode, you might want to slow down a source's refresh rate even further.

cc @mapbox/maps-android @knov to cut tickets for platform bindings. For now, it's only a high priority on Android.

cc @asheemmamoowala

pozdnyakov · 2020-04-22T08:26:38Z

can Source::setMinimumTileUpdateInterval(Duration) be safely called at any time?

yeah

once a TTL override is set, can the same API call be used to change the override? For example, if a device were on low power mode, you might want to slow down a source's refresh rate even further.

absolutely, the resulting network request interval is always = max(TTL, minimuTileUpdateInterval /* set by the introduced API*/)

chloekraw · 2020-04-23T06:35:32Z

thanks for the clarification @pozdnyakov!

pozdnyakov self-assigned this Apr 20, 2020

pozdnyakov requested review from tmpsantos and alexshalamov April 20, 2020 11:41

pozdnyakov force-pushed the mikhail_source_min_tile_update_interval branch from fc67f52 to ad7313d Compare April 20, 2020 13:02

pozdnyakov added the needs changelog Indicates PR needs a changelog entry prior to merging. label Apr 20, 2020

pozdnyakov marked this pull request as ready for review April 20, 2020 13:48

alexshalamov approved these changes Apr 20, 2020

View reviewed changes

asheemmamoowala mentioned this pull request Apr 20, 2020

Port Source::setMinimumTileUpdateInterval API mapbox/mapbox-gl-js#9603

Open

pozdnyakov added 9 commits April 20, 2020 19:06

[core] Introduce Resource::minimumUpdateInterval

d4435d9

Introduce `Resource::minimumUpdateInterval` and consider it in the online file source. The `minimumUpdateInterval` is used to throttle the requests, which were initiated due to resource expiration.

Add OnlineFileSource.RespectMinimumUpdateInterval unit test

4b4f3a4

[core] Introduce Tile::setMinimumUpdateInterval()

3134f95

[core] Introduce Source::setMinimumTileUpdateInterval API

802f1cd

The `Source::setMinimumTileUpdateInterval()` method sets the minimum tile update interval, which is used to throttle the tile update network requests. Default value is `Duration::zero()`.

[core] TilePyramid::update accepts source impl

c933975

[core] Tile pyramid passes minimum update interval to tiles

fa547fc

Add Source.SourceMinimumUpdateInterval unit test

80b8c8f

Add Map.SourceMinimumUpdateIntervalOverride unit test

8e6c01a

Add change log entry

0c4cbaa

pozdnyakov force-pushed the mikhail_source_min_tile_update_interval branch from ad7313d to 0c4cbaa Compare April 20, 2020 16:11

pozdnyakov removed the needs changelog Indicates PR needs a changelog entry prior to merging. label Apr 20, 2020

tmpsantos approved these changes Apr 20, 2020

View reviewed changes

pozdnyakov merged commit f513dc9 into master Apr 20, 2020

pozdnyakov deleted the mikhail_source_min_tile_update_interval branch April 20, 2020 18:54

tmpsantos reviewed Apr 21, 2020

View reviewed changes

chloekraw reviewed Apr 22, 2020

View reviewed changes

pozdnyakov added a commit that referenced this pull request Apr 22, 2020

#16416 follow-up

69ca9d2

pozdnyakov added a commit that referenced this pull request Apr 22, 2020

#16416 follow-up

b4fa87b

pozdnyakov added a commit that referenced this pull request Apr 22, 2020

#16416 follow-up

784d569

pozdnyakov added a commit that referenced this pull request Apr 22, 2020

#16416 follow-up

f01e2f4

Chaoba mentioned this pull request Apr 28, 2020

Integration of Source::set/isVolatile and Source::setMinimumTileUpdateInterval mapbox/mapbox-gl-native-android#351

Closed

chloekraw mentioned this pull request Apr 30, 2020

Update changelog mapbox/mapbox-gl-native-android#359

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[core] Introduce Source::setMinimumTileUpdateInterval API #16416

[core] Introduce Source::setMinimumTileUpdateInterval API #16416

pozdnyakov commented Apr 20, 2020

alexshalamov left a comment

alexshalamov commented Apr 20, 2020

asheemmamoowala commented Apr 20, 2020

pozdnyakov commented Apr 20, 2020

tmpsantos Apr 21, 2020

chloekraw Apr 22, 2020 •

edited

Loading

pozdnyakov Apr 22, 2020

chloekraw Apr 22, 2020

pozdnyakov Apr 22, 2020

chloekraw commented Apr 22, 2020

pozdnyakov commented Apr 22, 2020

chloekraw commented Apr 23, 2020

[core] Introduce Source::setMinimumTileUpdateInterval API #16416

[core] Introduce Source::setMinimumTileUpdateInterval API #16416

Conversation

pozdnyakov commented Apr 20, 2020

alexshalamov left a comment

Choose a reason for hiding this comment

alexshalamov commented Apr 20, 2020

asheemmamoowala commented Apr 20, 2020

pozdnyakov commented Apr 20, 2020

tmpsantos Apr 21, 2020

Choose a reason for hiding this comment

chloekraw Apr 22, 2020 • edited Loading

Choose a reason for hiding this comment

pozdnyakov Apr 22, 2020

Choose a reason for hiding this comment

chloekraw Apr 22, 2020

Choose a reason for hiding this comment

pozdnyakov Apr 22, 2020

Choose a reason for hiding this comment

chloekraw commented Apr 22, 2020

pozdnyakov commented Apr 22, 2020

chloekraw commented Apr 23, 2020

chloekraw Apr 22, 2020 •

edited

Loading