couchbase 3.0.0.alpha.2-universal-darwin-19 → 3.0.0-universal-darwin-19

data/ext/couchbase/operations/document_search.hxx

@@ -0,0 +1,360 @@
+/* -*- 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 <tao/json.hpp>
+
+#include <version.hxx>
+
+namespace couchbase::operations
+{
+struct search_response {
+    struct search_metrics {
+        std::chrono::nanoseconds took;
+        std::uint64_t total_rows;
+        double max_score;
+        std::uint64_t success_partition_count;
+        std::uint64_t error_partition_count;
+    };
+
+    struct search_meta_data {
+        std::string client_context_id;
+        search_metrics metrics;
+        std::map<std::string, std::string> errors;
+    };
+
+    struct search_location {
+        std::string field;
+        std::string term;
+        std::uint64_t position;
+        std::uint64_t start_offset;
+        std::uint64_t end_offset;
+        std::optional<std::vector<std::uint64_t>> array_positions{};
+    };
+
+    struct search_row {
+        std::string index;
+        std::string id;
+        double score;
+        std::vector<search_location> locations{};
+        std::map<std::string, std::vector<std::string>> fragments{};
+        std::string fields{};
+        std::string explanation{};
+    };
+
+    struct search_facet {
+        struct term_facet {
+            std::string term{};
+            std::uint64_t count{};
+        };
+
+        struct date_range_facet {
+            std::string name{};
+            std::uint64_t count{};
+            std::optional<std::string> start{};
+            std::optional<std::string> end{};
+        };
+
+        struct numeric_range_facet {
+            std::string name{};
+            std::uint64_t count{};
+            std::variant<std::monostate, std::uint64_t, double> min{};
+            std::variant<std::monostate, std::uint64_t, double> max{};
+        };
+
+        std::string name;
+        std::string field;
+        std::uint64_t total;
+        std::uint64_t missing;
+        std::uint64_t other;
+        std::vector<term_facet> terms{};
+        std::vector<date_range_facet> date_ranges{};
+        std::vector<numeric_range_facet> numeric_ranges{};
+    };
+
+    std::error_code ec;
+    std::string status{};
+    search_meta_data meta_data{};
+    std::string error{};
+    std::vector<search_row> rows{};
+    std::vector<search_facet> facets{};
+};
+
+struct search_request {
+    using response_type = search_response;
+    using encoded_request_type = io::http_request;
+    using encoded_response_type = io::http_response;
+
+    static const inline service_type type = service_type::search;
+
+    std::string client_context_id{ uuid::to_string(uuid::random()) };
+    std::chrono::milliseconds timeout{ timeout_defaults::management_timeout };
+
+    std::string index_name;
+    tao::json::value query;
+
+    std::optional<std::uint32_t> limit{};
+    std::optional<std::uint32_t> skip{};
+    bool explain{ false };
+
+    enum class highlight_style_type { html, ansi };
+    std::optional<highlight_style_type> highlight_style{};
+    std::vector<std::string> highlight_fields{};
+    std::vector<std::string> fields{};
+
+    enum class scan_consistency_type { not_bounded };
+    std::optional<scan_consistency_type> scan_consistency{};
+    std::vector<mutation_token> mutation_state{};
+
+    std::vector<std::string> sort_specs{};
+
+    std::map<std::string, std::string> facets{};
+
+    std::map<std::string, tao::json::value> raw{};
+
+    void encode_to(encoded_request_type& encoded)
+    {
+        tao::json::value body{
+            { "query", query },
+            { "explain", explain },
+            { "ctl", { { "timeout", timeout.count() } } },
+        };
+        if (limit) {
+            body["size"] = *limit;
+        }
+        if (skip) {
+            body["from"] = *skip;
+        }
+        if (highlight_style || !highlight_fields.empty()) {
+            tao::json::value highlight;
+            if (highlight_style) {
+                switch (*highlight_style) {
+                    case highlight_style_type::html:
+                        highlight["style"] = "html";
+                        break;
+                    case highlight_style_type::ansi:
+                        highlight["style"] = "ansi";
+                        break;
+                }
+            }
+            if (!highlight_fields.empty()) {
+                highlight["fields"] = highlight_fields;
+            }
+            body["highlight"] = highlight;
+        }
+        if (!fields.empty()) {
+            body["fields"] = fields;
+        }
+        if (!sort_specs.empty()) {
+            body["sort"] = tao::json::empty_array;
+            for (const auto& spec : sort_specs) {
+                body["sort"].get_array().push_back(tao::json::from_string(spec));
+            }
+        }
+        if (!facets.empty()) {
+            body["facets"] = tao::json::empty_object;
+            for (const auto& facet : facets) {
+                body["facets"][facet.first] = tao::json::from_string(facet.second);
+            }
+        }
+        if (!mutation_state.empty()) {
+            tao::json::value scan_vectors = tao::json::empty_object;
+            for (const auto& token : mutation_state) {
+                auto key = fmt::format("{}/{}", token.partition_id, token.partition_uuid);
+                auto* old_val = scan_vectors.find(key);
+                if (old_val == nullptr || (old_val->is_integer() && old_val->get_unsigned() < token.sequence_number)) {
+                    scan_vectors[key] = token.sequence_number;
+                }
+            }
+            body["ctl"]["consistency"] = tao::json::value{
+                { "level", "at_plus" },
+                { "vectors", { { index_name, scan_vectors } } },
+            };
+        }
+
+        encoded.type = type;
+        encoded.headers["content-type"] = "application/json";
+        encoded.method = "POST";
+        encoded.path = fmt::format("/api/index/{}/query", index_name);
+        encoded.body = tao::json::to_string(body);
+    }
+};
+
+search_response
+make_response(std::error_code ec, search_request& request, search_request::encoded_response_type encoded)
+{
+    search_response response{ ec };
+    response.meta_data.client_context_id = request.client_context_id;
+    if (!ec) {
+        if (encoded.status_code == 200) {
+            auto payload = tao::json::from_string(encoded.body);
+            response.meta_data.metrics.took = std::chrono::nanoseconds(payload.at("took").get_unsigned());
+            response.meta_data.metrics.max_score = payload.at("max_score").as<double>();
+            response.meta_data.metrics.total_rows = payload.at("total_hits").get_unsigned();
+            auto status_prop = payload.at("status");
+            if (status_prop.is_string()) {
+                response.status = status_prop.get_string();
+                if (response.status == "ok") {
+                    return response;
+                }
+            } else if (status_prop.is_object()) {
+                response.meta_data.metrics.error_partition_count = status_prop.at("failed").get_unsigned();
+                response.meta_data.metrics.success_partition_count = status_prop.at("successful").get_unsigned();
+                const auto* errors = status_prop.find("errors");
+                if (errors != nullptr && errors->is_object()) {
+                    for (const auto& error : errors->get_object()) {
+                        response.meta_data.errors.emplace(error.first, error.second.get_string());
+                    }
+                }
+            } else {
+                response.ec = std::make_error_code(error::common_errc::internal_server_failure);
+                return response;
+            }
+            const auto* rows = payload.find("hits");
+            if (rows != nullptr && rows->is_array()) {
+                for (const auto& entry : rows->get_array()) {
+                    search_response::search_row row{};
+                    row.index = entry.at("index").get_string();
+                    row.id = entry.at("id").get_string();
+                    row.score = entry.at("score").as<double>();
+                    const auto* locations = entry.find("locations");
+                    if (locations != nullptr && locations->is_object()) {
+                        for (const auto& field : locations->get_object()) {
+                            for (const auto& term : field.second.get_object()) {
+                                for (const auto& loc : term.second.get_array()) {
+                                    search_response::search_location location{};
+                                    location.field = field.first;
+                                    location.term = term.first;
+                                    location.position = loc.at("pos").get_unsigned();
+                                    location.start_offset = loc.at("start").get_unsigned();
+                                    location.end_offset = loc.at("end").get_unsigned();
+                                    const auto* ap = loc.find("array_positions");
+                                    if (ap != nullptr && ap->is_array()) {
+                                        location.array_positions.emplace(ap->as<std::vector<std::uint64_t>>());
+                                    }
+                                    row.locations.emplace_back(location);
+                                }
+                            }
+                        }
+                    }
+                    const auto* fragments_map = entry.find("fragments");
+                    if (fragments_map != nullptr && fragments_map->is_object()) {
+                        for (const auto& field : fragments_map->get_object()) {
+                            row.fragments.emplace(field.first, field.second.as<std::vector<std::string>>());
+                        }
+                    }
+                    const auto* fields = entry.find("fields");
+                    if (fields != nullptr && fields->is_object()) {
+                        row.fields = tao::json::to_string(*fields);
+                    }
+                    const auto* explanation = entry.find("explanation");
+                    if (explanation != nullptr && explanation->is_object()) {
+                        row.explanation = tao::json::to_string(*explanation);
+                    }
+                    response.rows.emplace_back(row);
+                }
+            }
+            const auto* facets = payload.find("facets");
+            if (facets != nullptr && facets->is_object()) {
+                for (const auto& entry : facets->get_object()) {
+                    search_response::search_facet facet;
+                    facet.name = entry.first;
+                    facet.field = entry.second.at("field").get_string();
+                    facet.total = entry.second.at("total").get_unsigned();
+                    facet.missing = entry.second.at("missing").get_unsigned();
+                    facet.other = entry.second.at("other").get_unsigned();
+
+                    const auto& date_ranges = entry.second.find("date_ranges");
+                    if (date_ranges != nullptr && date_ranges->is_array()) {
+                        for (const auto& date_range : date_ranges->get_array()) {
+                            search_response::search_facet::date_range_facet drf;
+                            drf.name = date_range.at("name").get_string();
+                            drf.count = date_range.at("count").get_unsigned();
+                            const auto* start = date_range.find("start");
+                            if (start != nullptr && start->is_string()) {
+                                drf.start = start->get_string();
+                            }
+                            const auto* end = date_range.find("end");
+                            if (end != nullptr && end->is_string()) {
+                                drf.end = end->get_string();
+                            }
+                            facet.date_ranges.emplace_back(drf);
+                        }
+                    }
+
+                    const auto& numeric_ranges = entry.second.find("numeric_ranges");
+                    if (numeric_ranges != nullptr && numeric_ranges->is_array()) {
+                        for (const auto& numeric_range : numeric_ranges->get_array()) {
+                            search_response::search_facet::numeric_range_facet nrf;
+                            nrf.name = numeric_range.at("name").get_string();
+                            nrf.count = numeric_range.at("count").get_unsigned();
+                            const auto* min = numeric_range.find("min");
+                            if (min != nullptr) {
+                                if (min->is_double()) {
+                                    nrf.min = min->as<double>();
+                                } else if (min->is_integer()) {
+                                    nrf.min = min->get_unsigned();
+                                }
+                            }
+                            const auto* max = numeric_range.find("max");
+                            if (max != nullptr) {
+                                if (max->is_double()) {
+                                    nrf.max = max->as<double>();
+                                } else if (max->is_integer()) {
+                                    nrf.max = max->get_unsigned();
+                                }
+                            }
+                            facet.numeric_ranges.emplace_back(nrf);
+                        }
+                    }
+
+                    const auto& terms = entry.second.find("terms");
+                    if (terms != nullptr && terms->is_array()) {
+                        for (const auto& term : terms->get_array()) {
+                            search_response::search_facet::term_facet tf;
+                            tf.term = term.at("term").get_string();
+                            tf.count = term.at("count").get_unsigned();
+                            facet.terms.emplace_back(tf);
+                        }
+                    }
+
+                    response.facets.emplace_back(facet);
+                }
+            }
+            return response;
+        }
+        if (encoded.status_code == 400) {
+            auto payload = tao::json::from_string(encoded.body);
+            response.status = payload.at("status").get_string();
+            response.error = payload.at("error").get_string();
+            if (response.error.find("index not found") != std::string::npos) {
+                response.ec = std::make_error_code(error::common_errc::index_not_found);
+                return response;
+            }
+            if (response.error.find("no planPIndexes for indexName") != std::string::npos ||
+                response.error.find("pindex_consistency mismatched partition") != std::string::npos) {
+                response.ec = std::make_error_code(error::search_errc::index_not_ready);
+                return response;
+            }
+        }
+        response.ec = std::make_error_code(error::common_errc::internal_server_failure);
+    }
+    return response;
+}
+
+} // namespace couchbase::operations

data/ext/couchbase/operations/document_touch.hxx

@@ -19,12 +19,14 @@
 
 #include <document_id.hxx>
 #include <protocol/cmd_touch.hxx>
+#include <io/retry_context.hxx>
 
 namespace couchbase::operations
 {
 
 struct touch_response {
     document_id id;
+    std::uint32_t opaque;
     std::error_code ec{};
     std::uint64_t cas{};
 };
@@ -36,21 +38,26 @@ struct touch_request {
     document_id id;
     std::uint16_t partition{};
     std::uint32_t opaque{};
-    std::uint32_t expiration{};
+    std::uint32_t expiry{};
+    std::chrono::milliseconds timeout{ timeout_defaults::key_value_timeout };
+    io::retry_context<io::retry_strategy::best_effort> retries{ false };
 
     void encode_to(encoded_request_type& encoded)
     {
         encoded.opaque(opaque);
         encoded.partition(partition);
         encoded.body().id(id);
-        encoded.body().expiration(expiration);
+        encoded.body().expiry(expiry);
     }
 };
 
 touch_response
 make_response(std::error_code ec, touch_request& request, touch_request::encoded_response_type encoded)
 {
-    touch_response response{ request.id, ec };
+    touch_response response{ request.id, encoded.opaque(), ec };
+    if (ec && response.opaque == 0) {
+        response.opaque = request.opaque;
+    }
     if (!ec) {
         response.cas = encoded.cas();
     }

data/ext/couchbase/operations/document_unlock.hxx

@@ -19,12 +19,14 @@
 
 #include <document_id.hxx>
 #include <protocol/cmd_unlock.hxx>
+#include <io/retry_context.hxx>
 
 namespace couchbase::operations
 {
 
 struct unlock_response {
     document_id id;
+    std::uint32_t opaque;
     std::error_code ec{};
     std::uint64_t cas{};
 };
@@ -37,6 +39,8 @@ struct unlock_request {
     uint16_t partition{};
     uint32_t opaque{};
     uint64_t cas{};
+    std::chrono::milliseconds timeout{ timeout_defaults::key_value_timeout };
+    io::retry_context<io::retry_strategy::best_effort> retries{ false };
 
     void encode_to(encoded_request_type& encoded)
     {
@@ -50,7 +54,10 @@ struct unlock_request {
 unlock_response
 make_response(std::error_code ec, unlock_request& request, unlock_request::encoded_response_type encoded)
 {
-    unlock_response response{ request.id, ec };
+    unlock_response response{ request.id, encoded.opaque(), ec };
+    if (ec && response.opaque == 0) {
+        response.opaque = request.opaque;
+    }
     if (!ec) {
         response.cas = encoded.cas();
     }

data/ext/couchbase/operations/document_upsert.hxx

@@ -20,12 +20,14 @@
 #include <document_id.hxx>
 #include <protocol/cmd_upsert.hxx>
 #include <protocol/durability_level.hxx>
+#include <io/retry_context.hxx>
 
 namespace couchbase::operations
 {
 
 struct upsert_response {
     document_id id;
+    std::uint32_t opaque;
     std::error_code ec{};
     std::uint64_t cas{};
     mutation_token token{};
@@ -40,16 +42,18 @@ struct upsert_request {
     uint16_t partition{};
     uint32_t opaque{};
     uint32_t flags{ 0 };
-    uint32_t expiration{ 0 };
+    uint32_t expiry{ 0 };
     protocol::durability_level durability_level{ protocol::durability_level::none };
     std::optional<std::uint16_t> durability_timeout{};
+    std::chrono::milliseconds timeout{ timeout_defaults::key_value_timeout };
+    io::retry_context<io::retry_strategy::best_effort> retries{ false };
 
     void encode_to(encoded_request_type& encoded)
     {
         encoded.opaque(opaque);
         encoded.partition(partition);
         encoded.body().id(id);
-        encoded.body().expiration(expiration);
+        encoded.body().expiry(expiry);
         encoded.body().flags(flags);
         encoded.body().content(value);
         if (durability_level != protocol::durability_level::none) {
@@ -61,7 +65,10 @@ struct upsert_request {
 upsert_response
 make_response(std::error_code ec, upsert_request& request, upsert_request::encoded_response_type encoded)
 {
-    upsert_response response{ request.id, ec };
+    upsert_response response{ request.id, encoded.opaque(), ec };
+    if (ec && response.opaque == 0) {
+        response.opaque = request.opaque;
+    }
     if (!ec) {
         response.cas = encoded.cas();
         response.token = encoded.body().token();