From 9bbd9aba3a8cebf7191ae5b28c8cf16acf39987e Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Konstantin=20K=C3=A4fer?= <mail@kkaefer.com>
Date: Thu, 15 Oct 2015 23:02:11 +0200
Subject: [PATCH] [core] set a timer and auto-refresh requests when they expire

When we get a request with an explicit expiration time, we're now starting a timer, and will trigger a refresh once the data expires. This gives requesters a chance to update their data.
---
 src/mbgl/storage/default_file_source.cpp      | 35 ++++++++++++++++--
 src/mbgl/storage/default_file_source_impl.hpp |  1 +
 test/storage/http_timeout.cpp                 | 37 +++++++++++++++++++
 test/test.gypi                                |  1 +
 4 files changed, 71 insertions(+), 3 deletions(-)
 create mode 100644 test/storage/http_timeout.cpp

diff --git a/src/mbgl/storage/default_file_source.cpp b/src/mbgl/storage/default_file_source.cpp
index 71c42f622..5d698fc0f 100644
--- a/src/mbgl/storage/default_file_source.cpp
+++ b/src/mbgl/storage/default_file_source.cpp
@@ -11,6 +11,7 @@
 #include <mbgl/util/thread.hpp>
 #include <mbgl/util/mapbox.hpp>
 #include <mbgl/util/exception.hpp>
+#include <mbgl/util/chrono.hpp>
 
 #pragma GCC diagnostic push
 #pragma GCC diagnostic ignored "-Wshadow"
@@ -159,19 +160,26 @@ void DefaultFileSource::Impl::startCacheRequest(DefaultFileRequest* request) {
         request->cacheRequest = nullptr;
         if (response) {
             response->stale = response->isExpired();
-
-            // Notify in all cases; requestors can decide whether they want to use stale responses.
-            notify(request, response, FileCache::Hint::No);
         }
 
         if (!response || response->stale) {
             // No response or stale cache. Run the real request.
             startRealRequest(request, response);
         }
+
+        if (response) {
+            // Notify in all cases; requestors can decide whether they want to use stale responses.
+            notify(request, response, FileCache::Hint::No);
+        }
     });
 }
 
 void DefaultFileSource::Impl::startRealRequest(DefaultFileRequest* request, std::shared_ptr<const Response> response) {
+    // Cancel the timer if we have one.
+    if (request->timerRequest) {
+        request->timerRequest->stop();
+    }
+
     auto callback = [request, this] (std::shared_ptr<const Response> res, FileCache::Hint hint) {
         request->realRequest = nullptr;
         notify(request, res, hint);
@@ -225,6 +233,27 @@ void DefaultFileSource::Impl::notify(DefaultFileRequest* request, std::shared_pt
         // Store response in database
         cache->put(request->resource, response, hint);
     }
+
+    // Set timer for requests that have a known expiry times. Expiry times of 0 are technically
+    // expiring immediately, but we can't continually request.
+    if (!request->realRequest && response->expires > 0) {
+        const int64_t now = std::chrono::duration_cast<std::chrono::seconds>(
+                                    SystemClock::now().time_since_epoch()).count();
+        const int64_t timeout = response->expires - now;
+
+        if (timeout <= 0) {
+            update(request);
+        } else {
+            if (!request->timerRequest) {
+                request->timerRequest = std::make_unique<uv::timer>(util::RunLoop::getLoop());
+            }
+
+            // timeout is in seconds, but the timer takes milliseconds.
+            request->timerRequest->start(1000 * timeout, 0, [this, request] {
+                update(request);
+            });
+        }
+    }
 }
 
 }
diff --git a/src/mbgl/storage/default_file_source_impl.hpp b/src/mbgl/storage/default_file_source_impl.hpp
index 980eedc11..387c6ce66 100644
--- a/src/mbgl/storage/default_file_source_impl.hpp
+++ b/src/mbgl/storage/default_file_source_impl.hpp
@@ -19,6 +19,7 @@ struct DefaultFileRequest {
 
     std::unique_ptr<WorkRequest> cacheRequest;
     RequestBase* realRequest = nullptr;
+    std::unique_ptr<uv::timer> timerRequest;
 
     inline DefaultFileRequest(const Resource& resource_)
         : resource(resource_) {}
diff --git a/test/storage/http_timeout.cpp b/test/storage/http_timeout.cpp
new file mode 100644
index 000000000..71553677b
--- /dev/null
+++ b/test/storage/http_timeout.cpp
@@ -0,0 +1,37 @@
+#include "storage.hpp"
+
+#include <uv.h>
+
+#include <mbgl/storage/default_file_source.hpp>
+#include <mbgl/storage/network_status.hpp>
+
+
+TEST_F(Storage, HTTPTimeout) {
+    SCOPED_TEST(HTTPTimeout)
+
+    using namespace mbgl;
+
+    DefaultFileSource fs(nullptr);
+
+    int counter = 0;
+
+    const Resource resource { Resource::Unknown, "http://127.0.0.1:3000/test?cachecontrol=max-age=1" };
+    Request* req = fs.request(resource, uv_default_loop(), [&](const Response &res) {
+        counter++;
+        EXPECT_EQ(Response::Successful, res.status);
+        EXPECT_EQ(false, res.stale);
+        EXPECT_EQ("Hello World!", res.data);
+        EXPECT_LT(0, res.expires);
+        EXPECT_EQ(0, res.modified);
+        EXPECT_EQ("", res.etag);
+        EXPECT_EQ("", res.message);
+        if (counter == 4) {
+            fs.cancel(req);
+            HTTPTimeout.finish();
+        }
+    });
+
+    uv_run(uv_default_loop(), UV_RUN_DEFAULT);
+
+    EXPECT_EQ(4, counter);
+}
diff --git a/test/test.gypi b/test/test.gypi
index b581053d8..3631c14ef 100644
--- a/test/test.gypi
+++ b/test/test.gypi
@@ -85,6 +85,7 @@
         'storage/http_load.cpp',
         'storage/http_other_loop.cpp',
         'storage/http_reading.cpp',
+        'storage/http_timeout.cpp',
 
         'style/glyph_store.cpp',
         'style/pending_resources.cpp',