Refactor CesiumUtility::Uri to use ada instead of uriparser

CMakeLists.txt

@@ -44,8 +44,8 @@ message(STATUS "VCPKG_OVERLAY_TRIPLETS ${VCPKG_OVERLAY_TRIPLETS}")
 # These packages are used in the public headers of Cesium libraries, so we need to distribute the headers and binaries
 # with the installation
 # Note that fmt is a public dependency of the vcpkg version of spdlog
-# STB and uriparser aren't technically part of the public interface, but they're used by the downstream Cesium for Unreal project
-set(PACKAGES_PUBLIC asyncplusplus expected-lite fmt glm rapidjson spdlog stb uriparser)
+# STB and ada-url aren't technically part of the public interface, but they're used by the downstream Cesium for Unreal project
+set(PACKAGES_PUBLIC asyncplusplus expected-lite fmt glm rapidjson spdlog stb ada-url uriparser)
 # These packages are used in the code and produce binaries, but are not part of the public interface.  Therefore we need
 # to distribute the binaries for linking, but not the headers, as downstream consumers don't need them
 # OpenSSL and abseil are both dependencies of s2geometry
@@ -257,6 +257,7 @@ find_package(tinyxml2 CONFIG REQUIRED)
 find_package(unofficial-sqlite3 CONFIG REQUIRED)
 find_package(uriparser CONFIG REQUIRED char wchar_t)
 find_package(WebP CONFIG REQUIRED)
+find_package(ada CONFIG REQUIRED)
 
 
 # Private Library (s2geometry)

Cesium3DTilesSelection/test/TestLayerJsonTerrainLoader.cpp

@@ -261,7 +261,8 @@ TEST_CASE("Test create layer json terrain loader") {
     CHECK(layers[0].version == "1.33.0");
     CHECK(
         layers[0].tileTemplateUrls.front() ==
-        "{z}/{x}/{y}.terrain?v={version}&extensions=octvertexnormals-metadata");
+        "%7Bz%7D/%7Bx%7D/"
+        "%7By%7D.terrain?v=%7Bversion%7D&extensions=octvertexnormals-metadata");
     CHECK(layers[0].loadedSubtrees.size() == 2);
     CHECK(layers[0].availabilityLevels == 10);
   }
@@ -290,7 +291,8 @@ TEST_CASE("Test create layer json terrain loader") {
     CHECK(layers[0].version == "1.0.0");
     CHECK(
         layers[0].tileTemplateUrls.front() ==
-        "{z}/{x}/{y}.terrain?v={version}&extensions=octvertexnormals");
+        "%7Bz%7D/%7Bx%7D/"
+        "%7By%7D.terrain?v=%7Bversion%7D&extensions=octvertexnormals");
     CHECK(layers[0].loadedSubtrees.empty());
     CHECK(layers[0].availabilityLevels == -1);
 
@@ -313,7 +315,7 @@ TEST_CASE("Test create layer json terrain loader") {
     auto parentJsonPath =
         testDataPath / "CesiumTerrainTileJson" / "Parent.tile.json";
     pMockedAssetAccessor->mockCompletedRequests.insert(
-        {"./Parent/layer.json", createMockAssetRequest(parentJsonPath)});
+        {"Parent/layer.json", createMockAssetRequest(parentJsonPath)});
 
     auto loaderFuture =
         LayerJsonTerrainLoader::createLoader(externals, {}, "layer.json", {});
@@ -411,8 +413,9 @@ TEST_CASE("Test create layer json terrain loader") {
     CHECK(layers[0].tileTemplateUrls.size() == 1);
     CHECK(
         layers[0].tileTemplateUrls[0] ==
-        "{z}/{x}/"
-        "{y}.terrain?v={version}&extensions=octvertexnormals-watermask");
+        "%7Bz%7D/%7Bx%7D/"
+        "%7By%7D.terrain?v=%7Bversion%7D&extensions=octvertexnormals-"
+        "watermask");
   }
 }
 

Cesium3DTilesSelection/test/data/AddTileset/tileset3/tileset3.json

@@ -17,7 +17,7 @@
     "geometricError": 0,
     "refine": "ADD",
     "content": {
-      "uri": "tileset3/ll.b3dm"
+      "uri": "ll.b3dm"
     }
   }
 }

CesiumUtility/CMakeLists.txt

@@ -46,5 +46,5 @@ target_link_libraries(
         zlib-ng::zlib-ng
         spdlog::spdlog
         glm::glm
-        uriparser::uriparser
+        ada::ada
 )

CesiumUtility/include/CesiumUtility/Uri.h

@@ -1,15 +1,107 @@
 #pragma once
 
+#include <ada.h>
+
 #include <functional>
+#include <memory>
+#include <optional>
 #include <string>
+#include <string_view>
 
 namespace CesiumUtility {
+
 /**
- * @brief A class for building and manipulating Uniform Resource Identifiers
+ * @brief A class for parsing and manipulating Uniform Resource Identifiers
  * (URIs).
+ *
+ * The URI parser supports the [WhatWG URL
+ * specification](https://url.spec.whatwg.org/). It also supports
+ * protocol-relative URIs such as `//example.com`, and opaque paths such as
+ * `a/b/c`.
  */
 class Uri final {
 public:
+  /**
+   * @brief Attempts to create a new Uri by parsing the given string. If the
+   * string fails to parse, \ref isValid will return false.
+   *
+   * @param uri A string containing the URI to attempt to parse.
+   */
+  Uri(const std::string& uri);
+  /**
+   * @brief Attempts to create a new Uri from a base URI and a relative URI. If
+   * the base URI is invalid or the relative URI string fails to parse, \ref
+   * isValid will return false.
+   *
+   * @param base The base URI that the relative URI is relative to.
+   * @param relative A string containing a relative URI to attempt to parse.
+   * @param useBaseQuery If true, the resulting URI will include the query
+   * parameters of both the base URI and the relative URI. If false, only the
+   * relative URI's query parameters will be used (if any).
+   */
+  Uri(const Uri& base, const std::string& relative, bool useBaseQuery = false);
+
+  /**
+   * @brief Copy constructor for Uri.
+   */
+  Uri(const Uri& uri);
+
+  /**
+   * @brief Returns a string representation of the entire URI including path and
+   * query parameters.
+   */
+  std::string toString() const;
+
+  /**
+   * @brief Returns true if this URI has been successfully parsed.
+   */
+  bool isValid() const;
+
+  /**
+   * @brief Equivalent to \ref isValid.
+   */
+  operator bool() const { return this->isValid(); }
+
+  /**
+   * @brief Obtains the value of the given key from the query string of the URI,
+   * if possible.
+   *
+   * If the URI can't be parsed, or the key doesn't exist in the
+   * query string, `std::nullopt` will be returned.
+   *
+   * @param key The key whose value will be obtained from the URI, if possible.
+   * @returns The value of the given key in the query string, or `std::nullopt`
+   * if not found.
+   */
+  const std::optional<std::string_view>
+  getQueryValue(const std::string& key) const;
+
+  /**
+   * @brief Sets the given key in the URI's query parameters to the given value.
+   * If the key doesn't exist already, it will be added to the query parameters.
+   * Otherwise, the previous value will be overwritten.
+   *
+   * @param key The key to be added to the query string.
+   * @param value The value to be added to the query string.
+   */
+  void setQueryValue(const std::string& key, const std::string& value);
+
+  /**
+   * @brief Gets the path portion of the URI. This will not include query
+   * parameters, if present.
+   *
+   * @return The path, or empty string if the URI could not be parsed.
+   */
+  const std::string_view getPath() const;
+
+  /**
+   * @brief Sets the path portion of a URI to a new value. The other portions of
+   * the URI are left unmodified, including any query parameters.
+   *
+   * @param path The new path portion of the URI.
+   */
+  void setPath(const std::string_view& path);
+
   /**
    * @brief Attempts to resolve a relative URI using a base URI.
    *
@@ -21,10 +113,11 @@ class Uri final {
    * @param relative The relative URI to be resolved against the base URI.
    * @param useBaseQuery If true, any query parameters of the base URI will be
    * retained in the resolved URI.
-   * @param assumeHttpsDefault If true, protocol-relative URIs (such as
-   * `//api.cesium.com`) will be assumed to be `https`. If false, they will be
-   * assumed to be `http`.
+   * @param assumeHttpsDefault This parameter is ignored and is only kept for
+   * API compatibility.
    * @returns The resolved URI.
+   *
+   * @deprecated Use the \ref Uri constructor instead.
    */
   static std::string resolve(
       const std::string& base,
@@ -40,6 +133,9 @@ class Uri final {
    * @param key The key to be added to the query string.
    * @param value The value to be added to the query string.
    * @returns The modified URI including the new query string parameter.
+   *
+   * @deprecated Create a \ref Uri instance and use \ref Uri::setQueryValue
+   * instead.
    */
   static std::string addQuery(
       const std::string& uri,
@@ -56,6 +152,9 @@ class Uri final {
    * @param key The key whose value will be obtained from the URI, if possible.
    * @returns The value of the given key in the query string, or an empty string
    * if not found.
+   *
+   * @deprecated Create a \ref Uri instance andthe member function \ref
+   * getQueryValue instead.
    */
   static std::string
   getQueryValue(const std::string& uri, const std::string& key);
@@ -193,6 +292,8 @@ class Uri final {
    *
    * @param uri The URI from which to get the path.
    * @return The path, or empty string if the URI could not be parsed.
+   *
+   * @deprecated Create a \ref Uri instance and use \ref Uri::getPath() instead.
    */
   static std::string getPath(const std::string& uri);
 
@@ -204,8 +305,16 @@ class Uri final {
    * @param newPath The new path portion of the URI.
    * @returns The new URI after setting the path. If the original URI cannot be
    * parsed, it is returned unmodified.
+   *
+   * @deprecated Create a \ref Uri instance and use \ref Uri::setPath(const
+   * std::string_view&) instead.
    */
   static std::string
   setPath(const std::string& uri, const std::string& newPath);
+
+private:
+  std::unique_ptr<ada::url_aggregator> url = nullptr;
+  std::unique_ptr<ada::url_search_params> params = nullptr;
+  bool hasScheme = false;
 };
 } // namespace CesiumUtility