couchbase 3.0.0.alpha.1-universal-darwin-19 → 3.0.0.beta.1-universal-darwin-19

data/ext/couchbase/timeout_defaults.hxx

@@ -0,0 +1,41 @@
+/* -*- Mode: C++; tab-width: 4; c-basic-offset: 4; indent-tabs-mode: nil -*- */
+/*
+ *     Copyright 2020 Couchbase, Inc.
+ *
+ *   Licensed under the Apache License, Version 2.0 (the "License");
+ *   you may not use this file except in compliance with the License.
+ *   You may obtain a copy of the License at
+ *
+ *       http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *   Unless required by applicable law or agreed to in writing, software
+ *   distributed under the License is distributed on an "AS IS" BASIS,
+ *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *   See the License for the specific language governing permissions and
+ *   limitations under the License.
+ */
+
+#pragma once
+
+#include <chrono>
+
+namespace couchbase::timeout_defaults
+{
+constexpr std::chrono::milliseconds bootstrap_timeout{ 10'000 };
+
+constexpr std::chrono::milliseconds connect_timeout{ 10'000 };
+constexpr std::chrono::milliseconds key_value_timeout{ 2'500 };
+constexpr std::chrono::milliseconds key_value_durable_timeout{ 10'000 };
+constexpr std::chrono::milliseconds view_timeout{ 75'000 };
+constexpr std::chrono::milliseconds query_timeout{ 75'000 };
+constexpr std::chrono::milliseconds analytics_timeout{ 75'000 };
+constexpr std::chrono::milliseconds search_timeout{ 75'000 };
+constexpr std::chrono::milliseconds management_timeout{ 75'000 };
+
+constexpr std::chrono::milliseconds dns_srv_timeout{ 500 };
+constexpr std::chrono::milliseconds tcp_keep_alive_interval{ 60'000 };
+constexpr std::chrono::milliseconds config_poll_interval{ 2'500 };
+constexpr std::chrono::milliseconds config_poll_floor{ 50'000 };
+constexpr std::chrono::milliseconds config_idle_redial_timeout{ 5 * 60'000 };
+constexpr std::chrono::milliseconds idle_http_connection_timeout{ 4'500 };
+} // namespace couchbase::timeout_defaults

data/ext/couchbase/utils/byteswap.hxx

@@ -22,7 +22,6 @@ namespace couchbase::utils
 static inline std::uint64_t
 byte_swap_64(std::uint64_t val)
 {
-    ;
     std::uint64_t ret = 0U;
     for (std::size_t i = 0; i < sizeof(std::uint64_t); ++i) {
         ret <<= 8U;
@@ -31,4 +30,4 @@ byte_swap_64(std::uint64_t val)
     }
     return ret;
 }
-} // namespace couchbase::utils
+} // namespace couchbase::utils

data/ext/couchbase/utils/connection_string.hxx

@@ -0,0 +1,370 @@
+/* -*- Mode: C++; tab-width: 4; c-basic-offset: 4; indent-tabs-mode: nil -*- */
+/*
+ *     Copyright 2020 Couchbase, Inc.
+ *
+ *   Licensed under the Apache License, Version 2.0 (the "License");
+ *   you may not use this file except in compliance with the License.
+ *   You may obtain a copy of the License at
+ *
+ *       http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *   Unless required by applicable law or agreed to in writing, software
+ *   distributed under the License is distributed on an "AS IS" BASIS,
+ *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *   See the License for the specific language governing permissions and
+ *   limitations under the License.
+ */
+
+#pragma once
+
+#include <string>
+
+#include <tao/json/external/pegtl.hpp>
+#include <tao/json/external/pegtl/contrib/uri.hpp>
+
+#include <cluster_options.hxx>
+
+namespace couchbase::utils
+{
+
+struct connection_string {
+    enum class bootstrap_mode {
+        unspecified,
+        gcccp,
+        http,
+    };
+
+    enum class address_type {
+        ipv4,
+        ipv6,
+        dns,
+    };
+
+    struct node {
+        std::string address;
+        std::uint16_t port;
+        address_type type;
+        bootstrap_mode mode{ bootstrap_mode::unspecified };
+    };
+
+    std::string scheme{};
+    bool tls{ false };
+    std::map<std::string, std::string> params{};
+    cluster_options options{};
+
+    std::vector<node> bootstrap_nodes{};
+
+    std::optional<std::string> default_bucket_name{};
+    bootstrap_mode default_mode{ bootstrap_mode::unspecified };
+    std::uint16_t default_port{ 0 };
+
+    std::optional<std::string> error{};
+};
+
+namespace priv
+{
+using namespace tao::json::pegtl;
+
+struct bucket_name : seq<uri::segment_nz> {
+};
+using param_key = star<sor<abnf::ALPHA, abnf::DIGIT, one<'_'>>>;
+using param_value = star<sor<minus<uri::pchar, one<'=', '&', '?'>>, one<'/'>>>;
+struct param : seq<param_key, one<'='>, param_value> {
+};
+
+using sub_delims = minus<uri::sub_delims, one<',', '='>>; // host and mode separators
+struct reg_name : star<sor<uri::unreserved, uri::pct_encoded, sub_delims>> {
+};
+struct host : sor<uri::IP_literal, uri::IPv4address, reg_name> {
+};
+
+struct mode : sor<istring<'c', 'c', 'c', 'p'>, istring<'g', 'c', 'c', 'c', 'p'>, istring<'h', 't', 't', 'p'>, istring<'m', 'c', 'd'>> {
+};
+using node = seq<host, opt<uri::colon, uri::port>, opt<one<'='>, mode>>;
+
+using opt_bucket_name = opt_must<one<'/'>, bucket_name>;
+using opt_params = opt_must<one<'?'>, list_must<param, one<'&'>>>;
+using opt_nodes = seq<list_must<node, one<',', ';'>>, opt_bucket_name>;
+
+using grammar = must<seq<uri::scheme, one<':'>, uri::dslash, opt_nodes, opt_params, eof>>;
+
+template<typename Rule>
+struct action {
+};
+
+template<>
+struct action<uri::scheme> {
+    template<typename ActionInput>
+    static void apply(const ActionInput& in, connection_string& cs, connection_string::node& /* cur_node */)
+    {
+        cs.scheme = in.string();
+        if (cs.scheme == "couchbase") {
+            cs.default_port = 11210;
+            cs.default_mode = connection_string::bootstrap_mode::gcccp;
+            cs.tls = false;
+        } else if (cs.scheme == "couchbases") {
+            cs.default_port = 11207;
+            cs.default_mode = connection_string::bootstrap_mode::gcccp;
+            cs.tls = true;
+        } else if (cs.scheme == "http") {
+            cs.default_port = 8091;
+            cs.default_mode = connection_string::bootstrap_mode::http;
+            cs.tls = false;
+        } else if (cs.scheme == "https") {
+            cs.default_port = 18091;
+            cs.default_mode = connection_string::bootstrap_mode::http;
+            cs.tls = true;
+        }
+    }
+};
+
+template<>
+struct action<param> {
+    template<typename ActionInput>
+    static void apply(const ActionInput& in, connection_string& cs, connection_string::node& /* cur_node */)
+    {
+        const auto& pair = in.string();
+        auto eq = pair.find('=');
+        std::string key = pair.substr(0, eq);
+        cs.params[key] = (eq == std::string::npos) ? "" : pair.substr(eq + 1);
+    }
+};
+
+template<>
+struct action<reg_name> {
+    template<typename ActionInput>
+    static void apply(const ActionInput& in, connection_string& /* cs */, connection_string::node& cur_node)
+    {
+        cur_node.type = connection_string::address_type::dns;
+        cur_node.address = in.string_view();
+    }
+};
+
+template<>
+struct action<uri::IPv4address> {
+    template<typename ActionInput>
+    static void apply(const ActionInput& in, connection_string& /* cs */, connection_string::node& cur_node)
+    {
+        cur_node.type = connection_string::address_type::ipv4;
+        cur_node.address = in.string_view();
+    }
+};
+
+template<>
+struct action<uri::IPv6address> {
+    template<typename ActionInput>
+    static void apply(const ActionInput& in, connection_string& /* cs */, connection_string::node& cur_node)
+    {
+        cur_node.type = connection_string::address_type::ipv6;
+        cur_node.address = in.string_view();
+    }
+};
+
+template<>
+struct action<node> {
+    template<typename ActionInput>
+    static void apply(const ActionInput& /* in */, connection_string& cs, connection_string::node& cur_node)
+    {
+        cs.bootstrap_nodes.push_back(cur_node);
+        cur_node = {};
+    }
+};
+
+template<>
+struct action<uri::port> {
+    template<typename ActionInput>
+    static void apply(const ActionInput& in, connection_string& /* cs */, connection_string::node& cur_node)
+    {
+        cur_node.port = static_cast<std::uint16_t>(std::stoul(in.string()));
+    }
+};
+
+template<>
+struct action<mode> {
+    template<typename ActionInput>
+    static void apply(const ActionInput& in, connection_string& /* cs */, connection_string::node& cur_node)
+    {
+        std::string mode = in.string();
+        std::transform(mode.begin(), mode.end(), mode.begin(), [](unsigned char c) { return std::tolower(c); });
+        if (mode == "mcd" || mode == "gcccp" || mode == "cccp") {
+            cur_node.mode = connection_string::bootstrap_mode::gcccp;
+        } else if (mode == "http") {
+            cur_node.mode = connection_string::bootstrap_mode::http;
+        }
+    }
+};
+
+template<>
+struct action<bucket_name> {
+    template<typename ActionInput>
+    static void apply(const ActionInput& in, connection_string& cs, connection_string::node& /* cur_node */)
+    {
+        cs.default_bucket_name = in.string();
+    }
+};
+} // namespace priv
+
+static void
+extract_options(connection_string& connstr)
+{
+    connstr.options.enable_tls = connstr.tls;
+    if (connstr.bootstrap_nodes.size() != 1 || connstr.bootstrap_nodes[0].type != connection_string::address_type::dns) {
+        connstr.options.enable_dns_srv = false;
+    }
+    for (const auto& param : connstr.params) {
+        try {
+            if (param.first == "kv_connect_timeout") {
+                /**
+                 * Number of seconds the client should wait while attempting to connect to a node’s KV service via a socket.  Initial
+                 * connection, reconnecting, node added, etc.
+                 */
+                connstr.options.connect_timeout = std::chrono::milliseconds(std::stoull(param.second));
+            } else if (param.first == "kv_timeout") {
+                /**
+                 * Number of milliseconds to wait before timing out a KV operation by the client.
+                 */
+                connstr.options.key_value_timeout = std::chrono::milliseconds(std::stoull(param.second));
+            } else if (param.first == "kv_durable_timeout") {
+                /**
+                 * Number of milliseconds to wait before timing out a KV operation that is either using synchronous durability or
+                 * observe-based durability.
+                 */
+                connstr.options.key_value_durable_timeout = std::chrono::milliseconds(std::stoull(param.second));
+            } else if (param.first == "view_timeout") {
+                /**
+                 * Number of seconds to wait before timing out a View request  by the client..
+                 */
+                connstr.options.view_timeout = std::chrono::milliseconds(std::stoull(param.second));
+            } else if (param.first == "query_timeout") {
+                /**
+                 * Number of seconds to wait before timing out a Query or N1QL request by the client.
+                 */
+                connstr.options.query_timeout = std::chrono::milliseconds(std::stoull(param.second));
+            } else if (param.first == "analytics_timeout") {
+                /**
+                 * Number of seconds to wait before timing out an Analytics request by the client.
+                 */
+                connstr.options.analytics_timeout = std::chrono::milliseconds(std::stoull(param.second));
+            } else if (param.first == "search_timeout") {
+                /**
+                 * Number of seconds to wait before timing out a Search request by the client.
+                 */
+                connstr.options.search_timeout = std::chrono::milliseconds(std::stoull(param.second));
+            } else if (param.first == "management_timeout") {
+                /**
+                 * Number of seconds to wait before timing out a Management API request by the client.
+                 */
+                connstr.options.management_timeout = std::chrono::milliseconds(std::stoull(param.second));
+            } else if (param.first == "trust_certificate") {
+                connstr.options.trust_certificate = param.second;
+            } else if (param.first == "enable_mutation_tokens") {
+                /**
+                 * Request mutation tokens at connection negotiation time. Turning this off will save 16 bytes per operation response.
+                 */
+                if (param.second == "true" || param.second == "yes" || param.second == "on") {
+                    connstr.options.enable_mutation_tokens = true;
+                } else if (param.second == "false" || param.second == "no" || param.second == "off") {
+                    connstr.options.enable_mutation_tokens = false;
+                }
+            } else if (param.first == "enable_tcp_keep_alive") {
+                /**
+                 * Gets or sets a value indicating whether enable TCP keep-alive.
+                 */
+                if (param.second == "true" || param.second == "yes" || param.second == "on") {
+                    connstr.options.enable_tcp_keep_alive = true;
+                } else if (param.second == "false" || param.second == "no" || param.second == "off") {
+                    connstr.options.enable_tcp_keep_alive = false;
+                }
+            } else if (param.first == "tcp_keep_alive_interval") {
+                /**
+                 * Specifies the timeout, in milliseconds, with no activity until the first keep-alive packet is sent. This applies to all
+                 * services, but is advisory: if the underlying platform does not support this on all connections, it will be applied only
+                 * on those it can be.
+                 */
+                connstr.options.tcp_keep_alive_interval = std::chrono::milliseconds(std::stoull(param.second));
+            } else if (param.first == "force_ipv4") {
+                /**
+                 * Sets the SDK configuration to do IPv4 Name Resolution
+                 */
+                if (param.second == "true" || param.second == "yes" || param.second == "on") {
+                    connstr.options.force_ipv4 = true;
+                } else if (param.second == "false" || param.second == "no" || param.second == "off") {
+                    connstr.options.force_ipv4 = false;
+                }
+            } else if (param.first == "config_poll_interval") {
+                connstr.options.config_poll_interval = std::chrono::milliseconds(std::stoull(param.second));
+            } else if (param.first == "config_poll_floor") {
+                connstr.options.config_poll_floor = std::chrono::milliseconds(std::stoull(param.second));
+            } else if (param.first == "max_http_connections") {
+                /**
+                 * The maximum number of HTTP connections allowed on a per-host and per-port basis.  0 indicates an unlimited number of
+                 * connections are permitted.
+                 */
+                connstr.options.max_http_connections = std::stoul(param.second);
+            } else if (param.first == "idle_http_connection_timeout") {
+                /**
+                 * The period of time an HTTP connection can be idle before it is forcefully disconnected.
+                 */
+                connstr.options.idle_http_connection_timeout = std::chrono::milliseconds(std::stoull(param.second));
+            } else if (param.first == "enable_dns_srv") {
+                if (connstr.bootstrap_nodes.size() == 1) {
+                    if (param.second == "true" || param.second == "yes" || param.second == "on") {
+                        connstr.options.enable_dns_srv = true;
+                    } else if (param.second == "false" || param.second == "no" || param.second == "off") {
+                        connstr.options.enable_dns_srv = false;
+                    }
+                } else {
+                    spdlog::warn(
+                      R"(parameter "{}" require single entry in bootstrap nodes list of the connection string, ignoring (value "{}"))",
+                      param.first,
+                      param.second);
+                }
+            } else if (param.first == "network") {
+                connstr.options.network = param.second; /* current known values are "auto", "default" and "external" */
+            } else {
+                spdlog::warn(R"(unknown parameter "{}" in connection string (value "{}"))", param.first, param.second);
+            }
+        } catch (std::invalid_argument& ex1) {
+            spdlog::warn(R"(unable to parse "{}" parameter in connection string (value "{}" cannot be converted): {})",
+                         param.first,
+                         param.second,
+                         ex1.what());
+        } catch (std::out_of_range& ex2) {
+            spdlog::warn(R"(unable to parse "{}" parameter in connection string (value "{}" is out of range): {})",
+                         param.first,
+                         param.second,
+                         ex2.what());
+        }
+    }
+}
+
+static connection_string
+parse_connection_string(const std::string& input)
+{
+    connection_string res;
+
+    if (input.empty()) {
+        res.error = "failed to parse connection string: empty input";
+        return res;
+    }
+
+    auto in = tao::json::pegtl::memory_input(input, __FUNCTION__);
+    try {
+        connection_string::node node{};
+        tao::json::pegtl::parse<priv::grammar, priv::action>(in, res, node);
+    } catch (tao::json::pegtl::parse_error& e) {
+        for (const auto& position : e.positions) {
+            if (position.source == __FUNCTION__) {
+                res.error = fmt::format(
+                  "failed to parse connection string (column: {}, trailer: \"{}\")", position.byte_in_line, input.substr(position.byte));
+                break;
+            }
+        }
+        if (!res.error) {
+            res.error = e.what();
+        }
+    }
+    extract_options(res);
+    return res;
+}
+} // namespace couchbase::utils

data/ext/couchbase/utils/url_codec.hxx

@@ -0,0 +1,225 @@
+#pragma once
+
+namespace couchbase::utils::string_codec
+{
+template<typename Ti, typename To>
+bool
+url_decode(Ti first, Ti last, To out, size_t& nout)
+{
+    for (; first != last && *first != '\0'; ++first) {
+        if (*first == '%') {
+            char nextbuf[3] = { 0 };
+            size_t jj = 0;
+            first++;
+            nextbuf[0] = *first;
+            for (; first != last && jj < 2; ++jj) {
+                nextbuf[jj] = *first;
+                if (jj != 1) {
+                    first++;
+                }
+            }
+            if (jj != 2) {
+                return false;
+            }
+
+            unsigned octet = 0;
+            if (sscanf(nextbuf, "%2X", &octet) != 1) {
+                return false;
+            }
+
+            *out = static_cast<char>(octet);
+        } else {
+            *out = *first;
+        }
+
+        out++;
+        nout++;
+    }
+    return true;
+}
+
+inline bool
+url_decode(const char* input, char* output)
+{
+    const char* endp = input + strlen(input);
+    size_t nout = 0;
+    if (url_decode(input, endp, output, nout)) {
+        output[nout] = '\0';
+        return true;
+    }
+    return false;
+}
+
+inline bool
+url_decode(char* in_out)
+{
+    return url_decode(in_out, in_out);
+}
+
+inline bool
+url_decode(std::string& s)
+{
+    size_t n = 0;
+    if (url_decode(s.begin(), s.end(), s.begin(), n)) {
+        s.resize(n);
+        return true;
+    }
+    return false;
+}
+
+namespace priv
+{
+inline bool
+is_legal_uri_char(char c)
+{
+    auto uc = static_cast<unsigned char>(c);
+    if ((isalpha(uc) != 0) || (isdigit(uc) != 0)) {
+        return true;
+    }
+    switch (uc) {
+        case '-':
+        case '_':
+        case '.':
+        case '~':
+        case '!':
+        case '*':
+        case '\'':
+        case '(':
+        case ')':
+        case ';':
+        case ':':
+        case '@':
+        case '&':
+        case '=':
+        case '+':
+        case '$':
+        case ',':
+        case '/':
+        case '?':
+        case '#':
+        case '[':
+        case ']':
+            return true;
+        default:
+            break;
+    }
+    return false;
+}
+
+template<typename T>
+inline bool
+is_already_escape(T first, T last)
+{
+    first++; // ignore '%'
+    size_t jj;
+    for (jj = 0; first != last && jj < 2; ++jj, ++first) {
+        if (!isxdigit(*first)) {
+            return false;
+        }
+    }
+    return jj == 2;
+}
+} // namespace priv
+
+template<typename Ti, typename To>
+bool
+url_encode(Ti first, Ti last, To& o, bool check_encoded = true)
+{
+    // If re-encoding detection is enabled, this flag indicates not to
+    // re-encode
+    bool skip_encoding = false;
+
+    for (; first != last; ++first) {
+        if (!skip_encoding && check_encoded) {
+            if (*first == '%') {
+                skip_encoding = priv::is_already_escape(first, last);
+            } else if (*first == '+') {
+                skip_encoding = true;
+            }
+        }
+        if (skip_encoding || priv::is_legal_uri_char(*first)) {
+            if (skip_encoding && *first != '%' && !priv::is_legal_uri_char(*first)) {
+                return false;
+            }
+
+            o.insert(o.end(), first, first + 1);
+        } else {
+            unsigned int c = static_cast<unsigned char>(*first);
+            size_t numbytes = 0;
+
+            if ((c & 0x80) == 0) { /* ASCII character */
+                numbytes = 1;
+            } else if ((c & 0xE0) == 0xC0) { /* 110x xxxx */
+                numbytes = 2;
+            } else if ((c & 0xF0) == 0xE0) { /* 1110 xxxx */
+                numbytes = 3;
+            } else if ((c & 0xF8) == 0xF0) { /* 1111 0xxx */
+                numbytes = 4;
+            } else {
+                return false;
+            }
+
+            do {
+                char buf[4];
+                sprintf(buf, "%%%02X", static_cast<unsigned char>(*first));
+                o.insert(o.end(), &buf[0], &buf[0] + 3);
+            } while (--numbytes && ++first != last);
+        }
+    }
+    return true;
+}
+
+template<typename Tin, typename Tout>
+bool
+url_encode(const Tin& in, Tout& out)
+{
+    return url_encode(in.begin(), in.end(), out);
+}
+
+/* See: https://url.spec.whatwg.org/#urlencoded-serializing: */
+/*
+ * 0x2A
+ * 0x2D
+ * 0x2E
+ * 0x30 to 0x39
+ * 0x41 to 0x5A
+ * 0x5F
+ * 0x61 to 0x7A
+ *  Append a code point whose value is byte to output.
+ * Otherwise
+ *  Append byte, percent encoded, to output.
+ */
+template<typename Ti, typename To>
+void
+form_encode(Ti first, Ti last, To& out)
+{
+    for (; first != last; ++first) {
+        auto c = static_cast<unsigned char>(*first);
+        if (isalnum(c)) {
+            out.insert(out.end(), first, first + 1);
+            continue;
+        }
+        if (c == ' ') {
+            char tmp = '+';
+            out.insert(out.end(), &tmp, &tmp + 1);
+        } else if ((c == 0x2A || c == 0x2D || c == 0x2E) || (c >= 0x30 && c <= 0x39) || (c >= 0x41 && c <= 0x5A) || (c == 0x5F) ||
+                   (c >= 0x60 && c <= 0x7A)) {
+            out.insert(out.end(), static_cast<char>(c));
+        } else {
+            char buf[3] = { 0 };
+            out.insert(out.end(), '%');
+            sprintf(buf, "%02X", c);
+            out.insert(out.end(), &buf[0], &buf[0] + 2);
+        }
+    }
+}
+
+std::string
+form_encode(const std::string& src)
+{
+    std::string dst;
+    form_encode(src.begin(), src.end(), dst);
+    return dst;
+}
+
+} // namespace couchbase::utils::string_codec