Add Initial PMTiles support (#2882)

Co-authored-by: Bart Louwers <bart.louwers@gmail.com>

test/storage/http_file_source.test.cpp

@@ -37,6 +37,27 @@ TEST(HTTPFileSource, TEST_REQUIRES_SERVER(HTTP200)) {
     loop.run();
 }
 
+TEST(HTTPFileSource, TEST_REQUIRES_SERVER(HTTP206)) {
+    util::RunLoop loop;
+    HTTPFileSource fs(ResourceOptions::Default(), ClientOptions());
+
+    Resource resource(Resource::Unknown, "http://127.0.0.1:3000/test");
+    resource.dataRange = std::make_pair<uint64_t, uint64_t>(3, 8);
+
+    auto req = fs.request(resource, [&](Response res) {
+        EXPECT_EQ(nullptr, res.error);
+        ASSERT_TRUE(res.data.get());
+        EXPECT_EQ("lo Wor", *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(HTTPFileSource, TEST_REQUIRES_SERVER(HTTP404)) {
     util::RunLoop loop;
     HTTPFileSource fs(ResourceOptions::Default(), ClientOptions());

test/storage/local_file_source.test.cpp

@@ -5,6 +5,7 @@
 #include <mbgl/util/run_loop.hpp>
 
 #include <climits>
+#include <cstdint>
 #include <gtest/gtest.h>
 
 #if defined(WIN32)
@@ -25,7 +26,7 @@ std::string toAbsoluteURL(const std::string& fileName) {
 #else
     char* cwd = getcwd(buff, PATH_MAX + 1);
 #endif
-    std::string url = {"file://" + std::string(cwd) + "/test/fixtures/storage/assets/" + fileName};
+    std::string url = {mbgl::util::FILE_PROTOCOL + std::string(cwd) + "/test/fixtures/storage/assets/" + fileName};
     assert(url.size() <= PATH_MAX);
     return url;
 }
@@ -76,6 +77,25 @@ TEST(LocalFileSource, NonEmptyFile) {
     loop.run();
 }
 
+TEST(LocalFileSource, PartialFile) {
+    util::RunLoop loop;
+
+    LocalFileSource fs(ResourceOptions::Default(), ClientOptions());
+
+    Resource resource(Resource::Unknown, toAbsoluteURL("nonempty"));
+    resource.dataRange = std::make_pair<uint64_t, uint64_t>(4, 12);
+
+    std::unique_ptr<AsyncRequest> req = fs.request(resource, [&](Response res) {
+        req.reset();
+        EXPECT_EQ(nullptr, res.error);
+        ASSERT_TRUE(res.data.get());
+        EXPECT_EQ("ent is he", *res.data);
+        loop.stop();
+    });
+
+    loop.run();
+}
+
 TEST(LocalFileSource, NonExistentFile) {
     util::RunLoop loop;
 

test/storage/pmtiles_file_source.test.cpp

@@ -0,0 +1,105 @@
+#include <mbgl/storage/pmtiles_file_source.hpp>
+#include <mbgl/storage/resource.hpp>
+#include <mbgl/storage/resource_options.hpp>
+#include <mbgl/util/platform.hpp>
+#include <mbgl/util/run_loop.hpp>
+
+#include <filesystem>
+
+#include <climits>
+#include <gtest/gtest.h>
+
+namespace {
+
+std::string toAbsoluteURL(const std::string &fileName) {
+    auto path = std::filesystem::current_path() / "test/fixtures/storage/pmtiles" / fileName;
+    return std::string(mbgl::util::PMTILES_PROTOCOL) + std::string(mbgl::util::FILE_PROTOCOL) + path.string();
+}
+
+} // namespace
+
+using namespace mbgl;
+
+TEST(PMTilesFileSource, AcceptsURL) {
+    PMTilesFileSource pmtiles(ResourceOptions::Default(), ClientOptions());
+    EXPECT_TRUE(pmtiles.canRequest(Resource::style("pmtiles:///test")));
+    EXPECT_FALSE(pmtiles.canRequest(Resource::style("pmtile://test")));
+    EXPECT_FALSE(pmtiles.canRequest(Resource::style("pmtiles:")));
+    EXPECT_FALSE(pmtiles.canRequest(Resource::style("")));
+}
+
+// Nonexistent pmtiles file raises error
+TEST(PMTilesFileSource, NonExistentFile) {
+    util::RunLoop loop;
+
+    PMTilesFileSource pmtiles(ResourceOptions::Default(), ClientOptions());
+
+    std::unique_ptr<AsyncRequest> req = pmtiles.request(
+        {Resource::Unknown, toAbsoluteURL("does_not_exist")}, [&](Response res) {
+            req.reset();
+            ASSERT_NE(nullptr, res.error);
+            EXPECT_EQ(Response::Error::Reason::NotFound, res.error->reason);
+            EXPECT_NE((res.error->message).find("path not found"), std::string::npos);
+            ASSERT_FALSE(res.data.get());
+            loop.stop();
+        });
+
+    loop.run();
+}
+
+// Existing pmtiles file default request returns TileJSON
+TEST(PMTilesFileSource, TileJSON) {
+    util::RunLoop loop;
+
+    PMTilesFileSource pmtiles(ResourceOptions::Default(), ClientOptions());
+
+    std::unique_ptr<AsyncRequest> req = pmtiles.request(
+        {Resource::Unknown, toAbsoluteURL("geography-class-png.pmtiles")}, [&](Response res) {
+            req.reset();
+            EXPECT_EQ(nullptr, res.error);
+            ASSERT_TRUE(res.data.get());
+            // basic test that TileJSON included a tile URL
+            EXPECT_NE((*res.data).find("geography-class-png.pmtiles"), std::string::npos);
+            loop.stop();
+        });
+
+    loop.run();
+}
+
+// Existing tiles return tile data
+TEST(PMTilesFileSource, Tile) {
+    util::RunLoop loop;
+
+    PMTilesFileSource pmtiles(ResourceOptions::Default(), ClientOptions());
+
+    std::unique_ptr<AsyncRequest> req = pmtiles.request(
+        Resource::tile(toAbsoluteURL("geography-class-png.pmtiles"), 1.0, 0, 0, 0, Tileset::Scheme::XYZ),
+        [&](Response res) {
+            req.reset();
+            EXPECT_EQ(nullptr, res.error);
+            ASSERT_TRUE(res.data.get());
+            ASSERT_EQ(res.noContent, false);
+            loop.stop();
+        });
+
+    loop.run();
+}
+
+// Nonexistent tiles do not raise errors, they simply return no content
+TEST(PMTilesFileSource, NonExistentTile) {
+    util::RunLoop loop;
+
+    PMTilesFileSource pmtiles(ResourceOptions::Default(), ClientOptions());
+
+    std::unique_ptr<AsyncRequest> req = pmtiles.request(
+        Resource::tile(toAbsoluteURL("geography-class-png.pmtiles"), 1.0, 0, 0, 4, Tileset::Scheme::XYZ),
+        [&](Response res) {
+            req.reset();
+            EXPECT_EQ(nullptr, res.error);
+            ASSERT_FALSE(res.data.get());
+            ASSERT_EQ(res.noContent, true);
+            loop.stop();
+        });
+
+    loop.run();
+}

test/storage/server.js

@@ -15,6 +15,7 @@ var app = express();
 app.disable('etag');
 
 app.get('/test', function (req, res) {
+    var content = 'Hello World!';
     if (req.query.modified) {
         res.setHeader('Last-Modified', (new Date(req.query.modified * 1000)).toUTCString());
     }
@@ -27,7 +28,12 @@ app.get('/test', function (req, res) {
     if (req.query.cachecontrol) {
         res.setHeader('Cache-Control', req.query.cachecontrol);
     }
-    res.send('Hello World!');
+    if (req.range()) {
+        const [ range ] = req.range();
+        content = content.substring(range.start, range.end + 1);
+        res.status(206);
+    }
+    res.send(content);
 });
 
 app.get('/stale/*', function() {