#include #include #include #include #include using namespace mbgl; TEST(DefaultFileSource, TEST_REQUIRES_SERVER(CacheResponse)) { util::RunLoop loop; DefaultFileSource fs(":memory:", "."); const Resource resource { Resource::Unknown, "http://127.0.0.1:3000/cache" }; Response response; std::unique_ptr req1; std::unique_ptr req2; req1 = fs.request(resource, [&](Response res) { req1.reset(); EXPECT_EQ(nullptr, res.error); ASSERT_TRUE(res.data.get()); EXPECT_EQ("Response 1", *res.data); EXPECT_TRUE(bool(res.expires)); EXPECT_FALSE(res.mustRevalidate); EXPECT_FALSE(bool(res.modified)); EXPECT_FALSE(bool(res.etag)); response = res; // Now test that we get the same values as in the previous request. If we'd go to the server // again, we'd get different values. req2 = fs.request(resource, [&](Response res2) { req2.reset(); EXPECT_EQ(response.error, res2.error); ASSERT_TRUE(res2.data.get()); EXPECT_EQ(*response.data, *res2.data); EXPECT_EQ(response.expires, res2.expires); EXPECT_EQ(response.mustRevalidate, res2.mustRevalidate); EXPECT_EQ(response.modified, res2.modified); EXPECT_EQ(response.etag, res2.etag); loop.stop(); }); }); loop.run(); } TEST(DefaultFileSource, TEST_REQUIRES_SERVER(CacheRevalidateSame)) { util::RunLoop loop; DefaultFileSource fs(":memory:", "."); const Resource revalidateSame { Resource::Unknown, "http://127.0.0.1:3000/revalidate-same" }; std::unique_ptr req1; std::unique_ptr req2; bool gotResponse = false; // First request causes the response to get cached. req1 = fs.request(revalidateSame, [&](Response res) { req1.reset(); EXPECT_EQ(nullptr, res.error); EXPECT_FALSE(res.notModified); ASSERT_TRUE(res.data.get()); EXPECT_EQ("Response", *res.data); EXPECT_FALSE(bool(res.expires)); EXPECT_TRUE(res.mustRevalidate); EXPECT_FALSE(bool(res.modified)); EXPECT_EQ("snowfall", *res.etag); // The first response is stored in the cache, but it has 'must-revalidate' set. This means // it can't return the cached response right away and we must wait for the revalidation // request to complete. We can distinguish the cached response from the revalided response // because the latter has an expiration date, while the cached response doesn't. req2 = fs.request(revalidateSame, [&](Response res2) { if (!gotResponse) { // Even though we could find the response in the database, we send a revalidation // request and get a 304 response. Since we haven't sent a reply yet, we're forcing // notModified to be false so that implementations can continue to use the // notModified flag to skip parsing new data. gotResponse = true; EXPECT_EQ(nullptr, res2.error); EXPECT_FALSE(res2.notModified); ASSERT_TRUE(res2.data.get()); EXPECT_EQ("Response", *res2.data); EXPECT_TRUE(bool(res2.expires)); EXPECT_TRUE(res2.mustRevalidate); EXPECT_FALSE(bool(res2.modified)); EXPECT_EQ("snowfall", *res2.etag); } else { // The test server sends a Cache-Control header with a max-age of 1 second. This // means that our OnlineFileSource implementation will request the tile again after // 1 second. This time, our request already had a prior response, so we don't need // to send the data again, and instead can actually forward the notModified flag. req2.reset(); EXPECT_EQ(nullptr, res2.error); EXPECT_TRUE(res2.notModified); EXPECT_FALSE(res2.data.get()); EXPECT_TRUE(bool(res2.expires)); EXPECT_TRUE(res2.mustRevalidate); EXPECT_FALSE(bool(res2.modified)); EXPECT_EQ("snowfall", *res2.etag); loop.stop(); } }); }); loop.run(); } TEST(DefaultFileSource, TEST_REQUIRES_SERVER(CacheRevalidateModified)) { util::RunLoop loop; DefaultFileSource fs(":memory:", "."); const Resource revalidateModified{ Resource::Unknown, "http://127.0.0.1:3000/revalidate-modified" }; std::unique_ptr req1; std::unique_ptr req2; bool gotResponse = false; // First request causes the response to get cached. req1 = fs.request(revalidateModified, [&](Response res) { req1.reset(); EXPECT_EQ(nullptr, res.error); EXPECT_FALSE(res.notModified); ASSERT_TRUE(res.data.get()); EXPECT_EQ("Response", *res.data); EXPECT_FALSE(bool(res.expires)); EXPECT_TRUE(res.mustRevalidate); EXPECT_EQ(Timestamp{ Seconds(1420070400) }, *res.modified); EXPECT_FALSE(res.etag); // The first response is stored in the cache, but it has 'must-revalidate' set. This means // it can't return the cached response right away and we must wait for the revalidation // request to complete. We can distinguish the cached response from the revalided response // because the latter has an expiration date, while the cached response doesn't. req2 = fs.request(revalidateModified, [&, res](Response res2) { if (!gotResponse) { // Even though we could find the response in the database, we send a revalidation // request and get a 304 response. Since we haven't sent a reply yet, we're forcing // notModified to be false so that implementations can continue to use the // notModified flag to skip parsing new data. gotResponse = true; EXPECT_EQ(nullptr, res2.error); EXPECT_FALSE(res2.notModified); ASSERT_TRUE(res2.data.get()); EXPECT_EQ("Response", *res2.data); EXPECT_TRUE(bool(res2.expires)); EXPECT_TRUE(res2.mustRevalidate); EXPECT_EQ(Timestamp{ Seconds(1420070400) }, *res2.modified); EXPECT_FALSE(res2.etag); } else { // The test server sends a Cache-Control header with a max-age of 1 second. This // means that our OnlineFileSource implementation will request the tile again after // 1 second. This time, our request already had a prior response, so we don't need // to send the data again, and instead can actually forward the notModified flag. req2.reset(); EXPECT_EQ(nullptr, res2.error); EXPECT_TRUE(res2.notModified); EXPECT_FALSE(res2.data.get()); EXPECT_TRUE(bool(res2.expires)); EXPECT_TRUE(res2.mustRevalidate); EXPECT_EQ(Timestamp{ Seconds(1420070400) }, *res2.modified); EXPECT_FALSE(res2.etag); loop.stop(); } }); }); loop.run(); } TEST(DefaultFileSource, TEST_REQUIRES_SERVER(CacheRevalidateEtag)) { util::RunLoop loop; DefaultFileSource fs(":memory:", "."); const Resource revalidateEtag { Resource::Unknown, "http://127.0.0.1:3000/revalidate-etag" }; std::unique_ptr req1; std::unique_ptr req2; // First request causes the response to get cached. req1 = fs.request(revalidateEtag, [&](Response res) { req1.reset(); EXPECT_EQ(nullptr, res.error); ASSERT_TRUE(res.data.get()); EXPECT_EQ("Response 1", *res.data); EXPECT_FALSE(bool(res.expires)); EXPECT_TRUE(res.mustRevalidate); EXPECT_FALSE(bool(res.modified)); EXPECT_EQ("response-1", *res.etag); // Second request does not return the cached response, since it had Cache-Control: must-revalidate set. req2 = fs.request(revalidateEtag, [&, res](Response res2) { req2.reset(); EXPECT_EQ(nullptr, res2.error); ASSERT_TRUE(res2.data.get()); EXPECT_NE(res.data, res2.data); EXPECT_EQ("Response 2", *res2.data); EXPECT_FALSE(bool(res2.expires)); EXPECT_TRUE(res2.mustRevalidate); EXPECT_FALSE(bool(res2.modified)); EXPECT_EQ("response-2", *res2.etag); loop.stop(); }); }); loop.run(); } // Test for https://github.com/mapbox/mapbox-gl-native/issue/1369 // // A request for http://example.com is made. This triggers a cache get. While the cache get is // pending, the request is canceled. This removes it from pending. Then, still while the cache get // is pending, a second request is made for the same resource. This adds an entry back to pending // and queues another cache request, even though the first one is still pending. Now both cache // requests resolve to misses, resulting in two HTTP requests for the same resource. The first one // will notify as expected, the second one will have bound a DefaultFileRequest* in the lambda that // gets invalidated by the first notify's pending.erase, and when it gets notified, the crash // occurs. TEST(DefaultFileSource, TEST_REQUIRES_SERVER(HTTPIssue1369)) { util::RunLoop loop; DefaultFileSource fs(":memory:", "."); const Resource resource { Resource::Unknown, "http://127.0.0.1:3000/test" }; auto req = fs.request(resource, [&](Response) { ADD_FAILURE() << "Callback should not be called"; }); req.reset(); req = fs.request(resource, [&](Response res) { req.reset(); EXPECT_EQ(nullptr, res.error); ASSERT_TRUE(res.data.get()); EXPECT_EQ("Hello World!", *res.data); EXPECT_FALSE(bool(res.expires)); EXPECT_FALSE(res.mustRevalidate); EXPECT_FALSE(bool(res.modified)); EXPECT_FALSE(bool(res.etag)); loop.stop(); }); loop.run(); } TEST(DefaultFileSource, OptionalNonExpired) { util::RunLoop loop; DefaultFileSource fs(":memory:", "."); const Resource optionalResource { Resource::Unknown, "http://127.0.0.1:3000/test", {}, Resource::Optional }; using namespace std::chrono_literals; Response response; response.data = std::make_shared("Cached value"); response.expires = util::now() + 1h; fs.put(optionalResource, response); std::unique_ptr req; req = fs.request(optionalResource, [&](Response res) { req.reset(); EXPECT_EQ(nullptr, res.error); ASSERT_TRUE(res.data.get()); EXPECT_EQ("Cached value", *res.data); ASSERT_TRUE(bool(res.expires)); EXPECT_EQ(*response.expires, *res.expires); EXPECT_FALSE(res.mustRevalidate); EXPECT_FALSE(bool(res.modified)); EXPECT_FALSE(bool(res.etag)); loop.stop(); }); loop.run(); } TEST(DefaultFileSource, OptionalExpired) { util::RunLoop loop; DefaultFileSource fs(":memory:", "."); const Resource optionalResource { Resource::Unknown, "http://127.0.0.1:3000/test", {}, Resource::Optional }; using namespace std::chrono_literals; Response response; response.data = std::make_shared("Cached value"); response.expires = util::now() - 1h; fs.put(optionalResource, response); std::unique_ptr req; req = fs.request(optionalResource, [&](Response res) { req.reset(); EXPECT_EQ(nullptr, res.error); ASSERT_TRUE(res.data.get()); EXPECT_EQ("Cached value", *res.data); ASSERT_TRUE(bool(res.expires)); EXPECT_EQ(*response.expires, *res.expires); EXPECT_FALSE(res.mustRevalidate); EXPECT_FALSE(bool(res.modified)); EXPECT_FALSE(bool(res.etag)); loop.stop(); }); loop.run(); } TEST(DefaultFileSource, GetBaseURLAndAccessTokenWhilePaused) { util::RunLoop loop; DefaultFileSource fs(":memory:", "."); fs.pause(); auto baseURL = "http://url"; auto accessToken = "access_token"; fs.setAPIBaseURL(baseURL); fs.setAccessToken(accessToken); EXPECT_EQ(fs.getAPIBaseURL(), baseURL); EXPECT_EQ(fs.getAccessToken(), accessToken); } TEST(DefaultFileSource, OptionalNotFound) { util::RunLoop loop; DefaultFileSource fs(":memory:", "."); const Resource optionalResource { Resource::Unknown, "http://127.0.0.1:3000/test", {}, Resource::Optional }; using namespace std::chrono_literals; std::unique_ptr req; req = fs.request(optionalResource, [&](Response res) { req.reset(); ASSERT_TRUE(res.error.get()); EXPECT_EQ(Response::Error::Reason::NotFound, res.error->reason); EXPECT_EQ("Not found in offline database", res.error->message); EXPECT_FALSE(res.data); EXPECT_FALSE(bool(res.expires)); EXPECT_FALSE(res.mustRevalidate); EXPECT_FALSE(bool(res.modified)); EXPECT_FALSE(bool(res.etag)); loop.stop(); }); loop.run(); } // Test that we can make a request with etag data that doesn't first try to load // from cache like a regular request TEST(DefaultFileSource, TEST_REQUIRES_SERVER(NoCacheRefreshEtagNotModified)) { util::RunLoop loop; DefaultFileSource fs(":memory:", "."); Resource resource { Resource::Unknown, "http://127.0.0.1:3000/revalidate-same" }; resource.priorEtag.emplace("snowfall"); using namespace std::chrono_literals; // Put a fake value into the cache to make sure we're not retrieving anything from the cache. Response response; response.data = std::make_shared("Cached value"); response.expires = util::now() + 1h; fs.put(resource, response); std::unique_ptr req; req = fs.request(resource, [&](Response res) { req.reset(); EXPECT_EQ(nullptr, res.error); EXPECT_TRUE(res.notModified); EXPECT_FALSE(res.data.get()); ASSERT_TRUE(bool(res.expires)); EXPECT_LT(util::now(), *res.expires); EXPECT_TRUE(res.mustRevalidate); EXPECT_FALSE(bool(res.modified)); ASSERT_TRUE(bool(res.etag)); EXPECT_EQ("snowfall", *res.etag); loop.stop(); }); loop.run(); } // Test that we can make a request with etag data that doesn't first try to load // from cache like a regular request TEST(DefaultFileSource, TEST_REQUIRES_SERVER(NoCacheRefreshEtagModified)) { util::RunLoop loop; DefaultFileSource fs(":memory:", "."); Resource resource { Resource::Unknown, "http://127.0.0.1:3000/revalidate-same" }; resource.priorEtag.emplace("sunshine"); using namespace std::chrono_literals; // Put a fake value into the cache to make sure we're not retrieving anything from the cache. Response response; response.data = std::make_shared("Cached value"); response.expires = util::now() + 1h; fs.put(resource, response); std::unique_ptr req; req = fs.request(resource, [&](Response res) { req.reset(); EXPECT_EQ(nullptr, res.error); EXPECT_FALSE(res.notModified); ASSERT_TRUE(res.data.get()); EXPECT_EQ("Response", *res.data); EXPECT_FALSE(bool(res.expires)); EXPECT_TRUE(res.mustRevalidate); EXPECT_FALSE(bool(res.modified)); ASSERT_TRUE(bool(res.etag)); EXPECT_EQ("snowfall", *res.etag); loop.stop(); }); loop.run(); } // Test that we can make a request that doesn't first try to load // from cache like a regular request. TEST(DefaultFileSource, TEST_REQUIRES_SERVER(NoCacheFull)) { util::RunLoop loop; DefaultFileSource fs(":memory:", "."); Resource resource { Resource::Unknown, "http://127.0.0.1:3000/revalidate-same" }; // Setting any prior field results in skipping the cache. resource.priorExpires.emplace(Seconds(0)); using namespace std::chrono_literals; // Put a fake value into the cache to make sure we're not retrieving anything from the cache. Response response; response.data = std::make_shared("Cached value"); response.expires = util::now() + 1h; fs.put(resource, response); std::unique_ptr req; req = fs.request(resource, [&](Response res) { req.reset(); EXPECT_EQ(nullptr, res.error); EXPECT_FALSE(res.notModified); ASSERT_TRUE(res.data.get()); EXPECT_EQ("Response", *res.data); EXPECT_FALSE(bool(res.expires)); EXPECT_TRUE(res.mustRevalidate); EXPECT_FALSE(bool(res.modified)); ASSERT_TRUE(bool(res.etag)); EXPECT_EQ("snowfall", *res.etag); loop.stop(); }); loop.run(); } // Test that we can make a request with a Modified field that doesn't first try to load // from cache like a regular request TEST(DefaultFileSource, TEST_REQUIRES_SERVER(NoCacheRefreshModifiedNotModified)) { util::RunLoop loop; DefaultFileSource fs(":memory:", "."); Resource resource { Resource::Unknown, "http://127.0.0.1:3000/revalidate-modified" }; resource.priorModified.emplace(Seconds(1420070400)); // January 1, 2015 using namespace std::chrono_literals; // Put a fake value into the cache to make sure we're not retrieving anything from the cache. Response response; response.data = std::make_shared("Cached value"); response.expires = util::now() + 1h; fs.put(resource, response); std::unique_ptr req; req = fs.request(resource, [&](Response res) { req.reset(); EXPECT_EQ(nullptr, res.error); EXPECT_TRUE(res.notModified); EXPECT_FALSE(res.data.get()); ASSERT_TRUE(bool(res.expires)); EXPECT_LT(util::now(), *res.expires); EXPECT_TRUE(res.mustRevalidate); ASSERT_TRUE(bool(res.modified)); EXPECT_EQ(Timestamp{ Seconds(1420070400) }, *res.modified); EXPECT_FALSE(bool(res.etag)); loop.stop(); }); loop.run(); } // Test that we can make a request with a Modified field that doesn't first try to load // from cache like a regular request TEST(DefaultFileSource, TEST_REQUIRES_SERVER(NoCacheRefreshModifiedModified)) { util::RunLoop loop; DefaultFileSource fs(":memory:", "."); Resource resource { Resource::Unknown, "http://127.0.0.1:3000/revalidate-modified" }; resource.priorModified.emplace(Seconds(1417392000)); // December 1, 2014 using namespace std::chrono_literals; // Put a fake value into the cache to make sure we're not retrieving anything from the cache. Response response; response.data = std::make_shared("Cached value"); response.expires = util::now() + 1h; fs.put(resource, response); std::unique_ptr req; req = fs.request(resource, [&](Response res) { req.reset(); EXPECT_EQ(nullptr, res.error); EXPECT_FALSE(res.notModified); ASSERT_TRUE(res.data.get()); EXPECT_EQ("Response", *res.data); EXPECT_FALSE(bool(res.expires)); EXPECT_TRUE(res.mustRevalidate); EXPECT_EQ(Timestamp{ Seconds(1420070400) }, *res.modified); EXPECT_FALSE(res.etag); loop.stop(); }); loop.run(); } TEST(DefaultFileSource, TEST_REQUIRES_SERVER(SetResourceTransform)) { util::RunLoop loop; DefaultFileSource fs(":memory:", "."); // Translates the URL "localhost://test to http://127.0.0.1:3000/test Actor transform(loop, [](Resource::Kind, const std::string&& url) -> std::string { if (url == "localhost://test") { return "http://127.0.0.1:3000/test"; } else { return std::move(url); } }); fs.setResourceTransform(transform.self()); const Resource resource1 { Resource::Unknown, "localhost://test" }; std::unique_ptr req; req = fs.request(resource1, [&](Response res) { req.reset(); EXPECT_EQ(nullptr, res.error); ASSERT_TRUE(res.data.get()); EXPECT_EQ("Hello World!", *res.data); EXPECT_FALSE(bool(res.expires)); EXPECT_FALSE(res.mustRevalidate); EXPECT_FALSE(bool(res.modified)); EXPECT_FALSE(bool(res.etag)); loop.stop(); }); loop.run(); fs.setResourceTransform({}); const Resource resource2 { Resource::Unknown, "http://127.0.0.1:3000/test" }; req = fs.request(resource2, [&](Response res) { req.reset(); EXPECT_EQ(nullptr, res.error); ASSERT_TRUE(res.data.get()); EXPECT_EQ("Hello World!", *res.data); EXPECT_FALSE(bool(res.expires)); EXPECT_FALSE(res.mustRevalidate); EXPECT_FALSE(bool(res.modified)); EXPECT_FALSE(bool(res.etag)); loop.stop(); }); loop.run(); }