couchbase 3.4.2 → 3.4.3

data/ext/couchbase/core/impl/internal_search_error_context.hxx

@@ -0,0 +1,61 @@
+/* -*- Mode: C++; tab-width: 4; c-basic-offset: 4; indent-tabs-mode: nil -*- */
+/*
+ *   Copyright 2023-Present 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 "core/operations/document_search.hxx"
+
+#include <couchbase/search_result.hxx>
+
+namespace couchbase
+{
+class internal_search_error_context
+{
+  public:
+    explicit internal_search_error_context(core::operations::search_response& resp);
+    internal_search_error_context(internal_search_error_context&& other) noexcept;
+    internal_search_error_context& operator=(internal_search_error_context&& other) noexcept;
+    internal_search_error_context(const internal_search_error_context& other) = delete;
+    internal_search_error_context& operator=(const internal_search_error_context& other) = delete;
+
+    [[nodiscard]] auto ec() const -> std::error_code;
+    [[nodiscard]] auto last_dispatched_to() const -> const std::optional<std::string>&;
+    [[nodiscard]] auto last_dispatched_from() const -> const std::optional<std::string>&;
+    [[nodiscard]] auto retry_attempts() const -> std::size_t;
+    [[nodiscard]] auto retry_reasons() const -> const std::set<retry_reason>&;
+    [[nodiscard]] auto retried_because_of(retry_reason reason) const -> bool;
+
+    [[nodiscard]] auto index_name() const -> const std::string&;
+    [[nodiscard]] auto client_context_id() const -> const std::string&;
+    [[nodiscard]] auto query() const -> const std::string&;
+    [[nodiscard]] auto parameters() const -> const std::optional<std::string>&;
+    [[nodiscard]] auto method() const -> const std::string&;
+    [[nodiscard]] auto path() const -> const std::string&;
+    [[nodiscard]] auto http_status() const -> std::uint32_t;
+    [[nodiscard]] auto http_body() const -> const std::string&;
+    [[nodiscard]] auto hostname() const -> const std::string&;
+    [[nodiscard]] auto port() const -> std::uint16_t;
+    [[nodiscard]] auto error() const -> const std::string&;
+    [[nodiscard]] auto status() const -> const std::string&;
+
+  private:
+    core::error_context::search ctx_;
+    std::string status_{};
+    std::string error_{};
+};
+
+} // namespace couchbase

data/ext/couchbase/core/impl/internal_search_meta_data.cxx

@@ -0,0 +1,60 @@
+/* -*- Mode: C++; tab-width: 4; c-basic-offset: 4; indent-tabs-mode: nil -*- */
+/*
+ *   Copyright 2023-Present 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.
+ */
+
+#include "internal_search_meta_data.hxx"
+
+namespace couchbase
+{
+static couchbase::search_metrics
+map_metrics(const core::operations::search_response::search_metrics& metrics)
+{
+    return {
+        metrics.took,
+        metrics.total_rows,
+        metrics.success_partition_count,
+        metrics.error_partition_count,
+        metrics.success_partition_count + metrics.error_partition_count,
+        metrics.max_score,
+    };
+}
+
+internal_search_meta_data::internal_search_meta_data(const core::operations::search_response::search_meta_data& meta)
+  : client_context_id_{ meta.client_context_id }
+  , metrics_{ map_metrics(meta.metrics) }
+  , errors_{ meta.errors }
+{
+}
+
+auto
+internal_search_meta_data::client_context_id() const -> const std::string&
+{
+    return client_context_id_;
+}
+
+auto
+internal_search_meta_data::errors() const -> const std::map<std::string, std::string>&
+{
+    return errors_;
+}
+
+auto
+internal_search_meta_data::metrics() const -> const couchbase::search_metrics&
+{
+    return metrics_;
+}
+
+} // namespace couchbase

data/ext/couchbase/core/impl/internal_search_meta_data.hxx

@@ -0,0 +1,41 @@
+/* -*- Mode: C++; tab-width: 4; c-basic-offset: 4; indent-tabs-mode: nil -*- */
+/*
+ *   Copyright 2023-Present 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 "core/operations/document_search.hxx"
+
+#include <couchbase/search_meta_data.hxx>
+
+namespace couchbase
+{
+class internal_search_meta_data
+{
+  public:
+    explicit internal_search_meta_data(const core::operations::search_response::search_meta_data& meta);
+
+    [[nodiscard]] auto client_context_id() const -> const std::string&;
+    [[nodiscard]] auto errors() const -> const std::map<std::string, std::string>&;
+    [[nodiscard]] auto metrics() const -> const couchbase::search_metrics&;
+
+  private:
+    std::string client_context_id_{};
+    couchbase::search_metrics metrics_{};
+    std::map<std::string, std::string> errors_{};
+};
+
+} // namespace couchbase

data/ext/couchbase/core/impl/internal_search_result.cxx

@@ -0,0 +1,84 @@
+/* -*- Mode: C++; tab-width: 4; c-basic-offset: 4; indent-tabs-mode: nil -*- */
+/*
+ *   Copyright 2023-Present 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.
+ */
+
+#include "internal_search_result.hxx"
+
+#include "couchbase/date_range_facet_result.hxx"
+#include "internal_date_range_facet_result.hxx"
+#include "internal_numeric_range_facet_result.hxx"
+#include "internal_search_meta_data.hxx"
+#include "internal_search_row.hxx"
+#include "internal_search_row_location.hxx"
+#include "internal_search_row_locations.hxx"
+#include "internal_term_facet_result.hxx"
+
+namespace couchbase
+{
+static std::vector<couchbase::search_row>
+map_rows(const std::vector<core::operations::search_response::search_row>& rows)
+{
+    std::vector<couchbase::search_row> result{};
+    result.reserve(rows.size());
+    for (const auto& row : rows) {
+        result.emplace_back(couchbase::search_row{ internal_search_row{ row } });
+    }
+    return result;
+}
+
+static std::map<std::string, std::shared_ptr<search_facet_result>>
+map_facets(std::vector<core::operations::search_response::search_facet> facets)
+{
+    std::map<std::string, std::shared_ptr<search_facet_result>> result;
+
+    for (const auto& facet : facets) {
+        if (!facet.date_ranges.empty()) {
+            result.try_emplace(facet.name, std::make_shared<date_range_facet_result>(internal_date_range_facet_result{ facet }));
+        } else if (!facet.numeric_ranges.empty()) {
+            result.try_emplace(facet.name, std::make_shared<numeric_range_facet_result>(internal_numeric_range_facet_result{ facet }));
+        } else if (!facet.terms.empty()) {
+            result.try_emplace(facet.name, std::make_shared<term_facet_result>(internal_term_facet_result{ facet }));
+        }
+    }
+
+    return result;
+}
+
+internal_search_result::internal_search_result(const core::operations::search_response& response)
+  : meta_data_{ internal_search_meta_data{ response.meta } }
+  , facets_{ map_facets(response.facets) }
+  , rows_{ map_rows(response.rows) }
+{
+}
+
+auto
+internal_search_result::meta_data() const -> const search_meta_data&
+{
+    return meta_data_;
+}
+
+auto
+internal_search_result::rows() const -> const std::vector<search_row>&
+{
+    return rows_;
+}
+
+auto
+internal_search_result::facets() const -> const std::map<std::string, std::shared_ptr<search_facet_result>>&
+{
+    return facets_;
+}
+} // namespace couchbase

data/ext/couchbase/core/impl/internal_search_result.hxx

@@ -0,0 +1,43 @@
+/* -*- Mode: C++; tab-width: 4; c-basic-offset: 4; indent-tabs-mode: nil -*- */
+/*
+ *   Copyright 2023-Present 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 "core/operations/document_search.hxx"
+
+#include <couchbase/search_result.hxx>
+
+namespace couchbase
+{
+class internal_search_result
+{
+  public:
+    explicit internal_search_result(const core::operations::search_response& response);
+
+    [[nodiscard]] auto meta_data() const -> const search_meta_data&;
+
+    [[nodiscard]] auto rows() const -> const std::vector<search_row>&;
+
+    [[nodiscard]] auto facets() const -> const std::map<std::string, std::shared_ptr<search_facet_result>>&;
+
+  private:
+    search_meta_data meta_data_;
+    std::map<std::string, std::shared_ptr<search_facet_result>> facets_;
+    std::vector<search_row> rows_;
+};
+
+} // namespace couchbase

data/ext/couchbase/core/impl/internal_search_row.cxx

@@ -0,0 +1,82 @@
+/* -*- Mode: C++; tab-width: 4; c-basic-offset: 4; indent-tabs-mode: nil -*- */
+/*
+ *   Copyright 2023-Present 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.
+ */
+
+#include "internal_search_row.hxx"
+
+#include "internal_search_row_location.hxx"
+#include "internal_search_row_locations.hxx"
+
+#include "core/utils/binary.hxx"
+
+#include <utility>
+
+namespace couchbase
+{
+
+internal_search_row::internal_search_row(core::operations::search_response::search_row row)
+  : row_{ std::move(row) }
+  , fields_{ core::utils::to_binary(row_.fields) }
+  , explanation_{ core::utils::to_binary(row_.explanation) }
+  , fragments_{ row_.fragments }
+{
+    if (!row_.locations.empty()) {
+        locations_.emplace(internal_search_row_locations{ row_.locations });
+    }
+}
+
+auto
+internal_search_row::index() const -> const std::string&
+{
+    return row_.index;
+}
+
+auto
+internal_search_row::id() const -> const std::string&
+{
+    return row_.id;
+}
+
+auto
+internal_search_row::score() const -> double
+{
+    return row_.score;
+}
+
+auto
+internal_search_row::fields() const -> const codec::binary&
+{
+    return fields_;
+}
+
+auto
+internal_search_row::explanation() const -> const codec::binary&
+{
+    return explanation_;
+}
+
+auto
+internal_search_row::fragments() const -> const std::map<std::string, std::vector<std::string>>&
+{
+    return fragments_;
+}
+
+auto
+internal_search_row::locations() const -> const std::optional<search_row_locations>&
+{
+    return locations_;
+}
+} // namespace couchbase

data/ext/couchbase/core/impl/internal_search_row.hxx

@@ -0,0 +1,56 @@
+/* -*- Mode: C++; tab-width: 4; c-basic-offset: 4; indent-tabs-mode: nil -*- */
+/*
+ *   Copyright 2023-Present 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 "core/operations/document_search.hxx"
+
+#include <couchbase/codec/encoded_value.hxx>
+#include <couchbase/search_row_locations.hxx>
+
+namespace couchbase
+{
+class internal_search_row
+{
+  public:
+    explicit internal_search_row(core::operations::search_response::search_row row);
+
+    [[nodiscard]] auto index() const -> const std::string&;
+
+    [[nodiscard]] auto id() const -> const std::string&;
+
+    [[nodiscard]] auto score() const -> double;
+
+    [[nodiscard]] auto fields() const -> const codec::binary&;
+
+    [[nodiscard]] auto explanation() const -> const codec::binary&;
+
+    [[nodiscard]] auto fragments() const -> const std::map<std::string, std::vector<std::string>>&;
+
+    [[nodiscard]] auto locations() const -> const std::optional<search_row_locations>&;
+
+  private:
+    core::operations::search_response::search_row row_;
+
+    // TODO(sergey): eliminate or defer copying of these fields
+    codec::binary fields_;
+    codec::binary explanation_;
+    std::map<std::string, std::vector<std::string>> fragments_;
+    std::optional<search_row_locations> locations_{};
+};
+
+} // namespace couchbase

data/ext/couchbase/core/impl/internal_search_row_location.hxx

@@ -0,0 +1,32 @@
+/* -*- Mode: C++; tab-width: 4; c-basic-offset: 4; indent-tabs-mode: nil -*- */
+/*
+ *   Copyright 2023-Present 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 "core/operations/document_search.hxx"
+
+#include <couchbase/search_row_location.hxx>
+
+namespace couchbase
+{
+class internal_search_row_location
+{
+  public:
+    core::operations::search_response::search_location location;
+};
+
+} // namespace couchbase

data/ext/couchbase/core/impl/internal_search_row_locations.cxx

@@ -0,0 +1,137 @@
+/* -*- Mode: C++; tab-width: 4; c-basic-offset: 4; indent-tabs-mode: nil -*- */
+/*
+ *   Copyright 2023-Present 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.
+ */
+
+#include "internal_search_row_locations.hxx"
+
+#include "internal_search_row_location.hxx"
+
+namespace couchbase
+{
+
+internal_search_row_locations::internal_search_row_locations(
+  const std::vector<core::operations::search_response::search_location>& locations)
+{
+    for (const auto& location : locations) {
+        locations_[location.field][location.term].emplace_back(internal_search_row_location{ location });
+    }
+}
+
+auto
+internal_search_row_locations::get(const std::string& field) const -> std::vector<search_row_location>
+{
+    const auto& locations_for_field = locations_.find(field);
+
+    if (locations_for_field == locations_.end()) {
+        return {};
+    }
+
+    std::vector<search_row_location> result;
+    for (const auto& [term, locations] : locations_for_field->second) {
+        result.reserve(result.size() + locations.size());
+        for (const auto& location : locations) {
+            result.emplace_back(location);
+        }
+    }
+
+    return result;
+}
+
+auto
+internal_search_row_locations::get(const std::string& field, const std::string& term) const -> std::vector<search_row_location>
+{
+    const auto& locations_for_field = locations_.find(field);
+
+    if (locations_for_field == locations_.end()) {
+        return {};
+    }
+
+    const auto& locations_for_term = locations_for_field->second.find(term);
+    if (locations_for_term == locations_for_field->second.end()) {
+        return {};
+    }
+
+    std::vector<search_row_location> result;
+    result.reserve(locations_for_term->second.size());
+    for (const auto& location : locations_for_term->second) {
+        result.emplace_back(location);
+    }
+    return result;
+}
+
+auto
+internal_search_row_locations::get_all() const -> std::vector<search_row_location>
+{
+    std::vector<search_row_location> result;
+
+    for (const auto& [field, locations_by_field] : locations_) {
+        for (const auto& [term, locations] : locations_by_field) {
+            result.reserve(result.size() + locations.size());
+            for (const auto& location : locations) {
+                result.emplace_back(location);
+            }
+        }
+    }
+
+    return result;
+}
+
+auto
+internal_search_row_locations::fields() const -> std::vector<std::string>
+{
+    std::vector<std::string> result;
+
+    result.reserve(locations_.size());
+    for (const auto& [field, _] : locations_) {
+        result.emplace_back(field);
+    }
+
+    return result;
+}
+
+auto
+internal_search_row_locations::terms() const -> std::set<std::string>
+{
+    std::set<std::string> result;
+
+    for (const auto& [field, locations_by_term] : locations_) {
+        for (const auto& [term, _] : locations_by_term) {
+            result.insert(term);
+        }
+    }
+
+    return result;
+}
+
+auto
+internal_search_row_locations::terms_for(const std::string& field) const -> std::vector<std::string>
+{
+    const auto& locations_for_field = locations_.find(field);
+
+    if (locations_for_field == locations_.end()) {
+        return {};
+    }
+
+    std::vector<std::string> result;
+
+    result.reserve(locations_for_field->second.size());
+    for (const auto& [term, _] : locations_for_field->second) {
+        result.emplace_back(term);
+    }
+
+    return result;
+}
+} // namespace couchbase

data/ext/couchbase/core/impl/internal_search_row_locations.hxx

@@ -0,0 +1,45 @@
+/* -*- Mode: C++; tab-width: 4; c-basic-offset: 4; indent-tabs-mode: nil -*- */
+/*
+ *   Copyright 2023-Present 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 "core/operations/document_search.hxx"
+
+#include <couchbase/search_row_location.hxx>
+
+namespace couchbase
+{
+class internal_search_row_location;
+
+class internal_search_row_locations
+{
+  public:
+    explicit internal_search_row_locations(const std::vector<core::operations::search_response::search_location>& locations);
+
+    [[nodiscard]] auto get(const std::string& field) const -> std::vector<search_row_location>;
+    [[nodiscard]] auto get(const std::string& field, const std::string& term) const -> std::vector<search_row_location>;
+    [[nodiscard]] auto get_all() const -> std::vector<search_row_location>;
+    [[nodiscard]] auto fields() const -> std::vector<std::string>;
+    [[nodiscard]] auto terms() const -> std::set<std::string>;
+    [[nodiscard]] auto terms_for(const std::string& field) const -> std::vector<std::string>;
+
+  private:
+    // field -> term -> location
+    std::map<std::string, std::map<std::string, std::vector<internal_search_row_location>>> locations_;
+};
+
+} // namespace couchbase