From 382dd0c8d9e48379c57429a06f4df1605d441d37 Mon Sep 17 00:00:00 2001 From: rsgowman Date: Fri, 29 Jun 2018 16:36:20 -0400 Subject: Initial (incomplete) implementation of f:f::core::Query (#1471) --- .../src/firebase/firestore/core/CMakeLists.txt | 2 + .../core/src/firebase/firestore/core/query.cc | 61 ++++++++++++++++++++ Firestore/core/src/firebase/firestore/core/query.h | 67 ++++++++++++++++++++++ .../test/firebase/firestore/core/CMakeLists.txt | 1 + .../test/firebase/firestore/core/query_test.cc | 57 ++++++++++++++++++ .../test/firebase/firestore/testutil/testutil.h | 2 +- 6 files changed, 189 insertions(+), 1 deletion(-) create mode 100644 Firestore/core/src/firebase/firestore/core/query.cc create mode 100644 Firestore/core/src/firebase/firestore/core/query.h create mode 100644 Firestore/core/test/firebase/firestore/core/query_test.cc (limited to 'Firestore/core') diff --git a/Firestore/core/src/firebase/firestore/core/CMakeLists.txt b/Firestore/core/src/firebase/firestore/core/CMakeLists.txt index cf3cafe..1aab09a 100644 --- a/Firestore/core/src/firebase/firestore/core/CMakeLists.txt +++ b/Firestore/core/src/firebase/firestore/core/CMakeLists.txt @@ -19,6 +19,8 @@ cc_library( database_info.h target_id_generator.cc target_id_generator.h + query.cc + query.h DEPENDS absl_strings firebase_firestore_model diff --git a/Firestore/core/src/firebase/firestore/core/query.cc b/Firestore/core/src/firebase/firestore/core/query.cc new file mode 100644 index 0000000..ad0f7a3 --- /dev/null +++ b/Firestore/core/src/firebase/firestore/core/query.cc @@ -0,0 +1,61 @@ +/* + * Copyright 2018 Google + * + * 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 "Firestore/core/src/firebase/firestore/core/query.h" + +#include "Firestore/core/src/firebase/firestore/model/document_key.h" +#include "Firestore/core/src/firebase/firestore/model/resource_path.h" + +namespace firebase { +namespace firestore { +namespace core { + +using model::Document; +using model::DocumentKey; +using model::ResourcePath; + +bool Query::Matches(const Document& doc) const { + return MatchesPath(doc) && MatchesOrderBy(doc) && MatchesFilters(doc) && + MatchesBounds(doc); +} + +bool Query::MatchesPath(const Document& doc) const { + ResourcePath doc_path = doc.key().path(); + if (DocumentKey::IsDocumentKey(path_)) { + return path_ == doc_path; + } else { + return path_.IsPrefixOf(doc_path) && path_.size() == doc_path.size() - 1; + } +} + +bool Query::MatchesFilters(const Document&) const { + // TODO(rsgowman): Implement this correctly. + return true; +} + +bool Query::MatchesOrderBy(const Document&) const { + // TODO(rsgowman): Implement this correctly. + return true; +} + +bool Query::MatchesBounds(const Document&) const { + // TODO(rsgowman): Implement this correctly. + return true; +} + +} // namespace core +} // namespace firestore +} // namespace firebase diff --git a/Firestore/core/src/firebase/firestore/core/query.h b/Firestore/core/src/firebase/firestore/core/query.h new file mode 100644 index 0000000..84d645d --- /dev/null +++ b/Firestore/core/src/firebase/firestore/core/query.h @@ -0,0 +1,67 @@ +/* + * Copyright 2018 Google + * + * 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. + */ + +#ifndef FIRESTORE_CORE_SRC_FIREBASE_FIRESTORE_CORE_QUERY_H_ +#define FIRESTORE_CORE_SRC_FIREBASE_FIRESTORE_CORE_QUERY_H_ + +#include + +#include "Firestore/core/src/firebase/firestore/model/document.h" +#include "Firestore/core/src/firebase/firestore/model/resource_path.h" + +namespace firebase { +namespace firestore { +namespace core { + +/** Represents the internal structure of a Firestore Query. */ +class Query { + public: + /** + * Creates and returns a new Query. + * + * @param path The path to the collection to be queried over. + * @return A new instance of Query. + */ + static Query AtPath(model::ResourcePath path) { + return Query(std::move(path)); + } + + /** Initializes a query with all of its components directly. */ + explicit Query(model::ResourcePath path /* TODO(rsgowman): other params */) + : path_(std::move(path)) { + } + + const model::ResourcePath& path() const { + return path_; + } + + /** Returns true if the document matches the constraints of this query. */ + bool Matches(const model::Document& doc) const; + + private: + bool MatchesPath(const model::Document& doc) const; + bool MatchesFilters(const model::Document& doc) const; + bool MatchesOrderBy(const model::Document& doc) const; + bool MatchesBounds(const model::Document& doc) const; + + const model::ResourcePath path_; +}; + +} // namespace core +} // namespace firestore +} // namespace firebase + +#endif // FIRESTORE_CORE_SRC_FIREBASE_FIRESTORE_CORE_QUERY_H_ diff --git a/Firestore/core/test/firebase/firestore/core/CMakeLists.txt b/Firestore/core/test/firebase/firestore/core/CMakeLists.txt index 5b4c55a..7b14aa1 100644 --- a/Firestore/core/test/firebase/firestore/core/CMakeLists.txt +++ b/Firestore/core/test/firebase/firestore/core/CMakeLists.txt @@ -17,6 +17,7 @@ cc_test( SOURCES database_info_test.cc target_id_generator_test.cc + query_test.cc DEPENDS firebase_firestore_core ) diff --git a/Firestore/core/test/firebase/firestore/core/query_test.cc b/Firestore/core/test/firebase/firestore/core/query_test.cc new file mode 100644 index 0000000..3ac22a9 --- /dev/null +++ b/Firestore/core/test/firebase/firestore/core/query_test.cc @@ -0,0 +1,57 @@ +/* + * Copyright 2018 Google + * + * 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 "Firestore/core/src/firebase/firestore/core/query.h" + +#include "Firestore/core/src/firebase/firestore/model/document.h" +#include "Firestore/core/src/firebase/firestore/model/resource_path.h" +#include "Firestore/core/test/firebase/firestore/testutil/testutil.h" +#include "gtest/gtest.h" + +namespace firebase { +namespace firestore { +namespace core { + +using model::Document; +using testutil::Doc; + +TEST(QueryTest, MatchesBasedOnDocumentKey) { + Document doc1 = Doc("rooms/eros/messages/1"); + Document doc2 = Doc("rooms/eros/messages/2"); + Document doc3 = Doc("rooms/other/messages/1"); + + Query query = Query::AtPath({"rooms", "eros", "messages", "1"}); + EXPECT_TRUE(query.Matches(doc1)); + EXPECT_FALSE(query.Matches(doc2)); + EXPECT_FALSE(query.Matches(doc3)); +} + +TEST(QueryTest, MatchesShallowAncestorQuery) { + Document doc1 = Doc("rooms/eros/messages/1"); + Document doc1_meta = Doc("rooms/eros/messages/1/meta/1"); + Document doc2 = Doc("rooms/eros/messages/2"); + Document doc3 = Doc("rooms/other/messages/1"); + + Query query = Query::AtPath({"rooms", "eros", "messages"}); + EXPECT_TRUE(query.Matches(doc1)); + EXPECT_FALSE(query.Matches(doc1_meta)); + EXPECT_TRUE(query.Matches(doc2)); + EXPECT_FALSE(query.Matches(doc3)); +} + +} // namespace core +} // namespace firestore +} // namespace firebase diff --git a/Firestore/core/test/firebase/firestore/testutil/testutil.h b/Firestore/core/test/firebase/firestore/testutil/testutil.h index 9a875f4..c470250 100644 --- a/Firestore/core/test/firebase/firestore/testutil/testutil.h +++ b/Firestore/core/test/firebase/firestore/testutil/testutil.h @@ -59,7 +59,7 @@ inline model::SnapshotVersion Version(int64_t version) { return model::SnapshotVersion{Timestamp::FromTimePoint(timepoint)}; } -inline model::Document Doc(absl::string_view key, int64_t version) { +inline model::Document Doc(absl::string_view key, int64_t version = 0) { return model::Document{model::FieldValue::ObjectValueFromMap({}), Key(key), Version(version), /* has_local_mutations= */ false}; -- cgit v1.2.3