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) --- .../Example/Firestore.xcodeproj/project.pbxproj | 100 +-------------------- .../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 +- 7 files changed, 193 insertions(+), 97 deletions(-) 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 diff --git a/Firestore/Example/Firestore.xcodeproj/project.pbxproj b/Firestore/Example/Firestore.xcodeproj/project.pbxproj index 954dbb0..d15e590 100644 --- a/Firestore/Example/Firestore.xcodeproj/project.pbxproj +++ b/Firestore/Example/Firestore.xcodeproj/project.pbxproj @@ -165,6 +165,7 @@ 6EDD3B4820BF247500C33877 /* UIKit.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 6003F591195388D20070C39A /* UIKit.framework */; }; 6EDD3B4920BF247500C33877 /* XCTest.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 6003F5AF195388D20070C39A /* XCTest.framework */; }; 6EDD3B6020BF25AE00C33877 /* FSTFuzzTestsPrincipal.mm in Sources */ = {isa = PBXBuildFile; fileRef = 6EDD3B5E20BF24D000C33877 /* FSTFuzzTestsPrincipal.mm */; }; + 6F3CAC76D918D6B0917EDF92 /* query_test.cc in Sources */ = {isa = PBXBuildFile; fileRef = B9C261C26C5D311E1E3C0CB9 /* query_test.cc */; }; 71719F9F1E33DC2100824A3D /* LaunchScreen.storyboard in Resources */ = {isa = PBXBuildFile; fileRef = 71719F9D1E33DC2100824A3D /* LaunchScreen.storyboard */; }; 7346E61D20325C6900FD6CEF /* FSTDispatchQueueTests.mm in Sources */ = {isa = PBXBuildFile; fileRef = 7346E61C20325C6900FD6CEF /* FSTDispatchQueueTests.mm */; }; 73866AA12082B0A5009BB4FF /* FIRArrayTransformTests.mm in Sources */ = {isa = PBXBuildFile; fileRef = 73866A9F2082B069009BB4FF /* FIRArrayTransformTests.mm */; }; @@ -496,6 +497,7 @@ B6FB4689208F9B9100554BA2 /* executor_libdispatch_test.mm */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.objcpp; path = executor_libdispatch_test.mm; sourceTree = ""; }; B6FB468A208F9B9100554BA2 /* executor_test.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = executor_test.h; sourceTree = ""; }; B79CA87A1A01FC5329031C9B /* Pods_Firestore_FuzzTests_iOS.framework */ = {isa = PBXFileReference; explicitFileType = wrapper.framework; includeInIndex = 0; path = Pods_Firestore_FuzzTests_iOS.framework; sourceTree = BUILT_PRODUCTS_DIR; }; + B9C261C26C5D311E1E3C0CB9 /* query_test.cc */ = {isa = PBXFileReference; includeInIndex = 1; path = query_test.cc; sourceTree = ""; }; BB92EB03E3F92485023F64ED /* Pods_Firestore_Example_iOS_Firestore_SwiftTests_iOS.framework */ = {isa = PBXFileReference; explicitFileType = wrapper.framework; includeInIndex = 0; path = Pods_Firestore_Example_iOS_Firestore_SwiftTests_iOS.framework; sourceTree = BUILT_PRODUCTS_DIR; }; D3CC3DC5338DCAF43A211155 /* README.md */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = net.daringfireball.markdown; name = README.md; path = ../README.md; sourceTree = ""; }; DE03B2E91F2149D600A30B9C /* Firestore_IntegrationTests_iOS.xctest */ = {isa = PBXFileReference; explicitFileType = wrapper.cfbundle; includeInIndex = 0; path = Firestore_IntegrationTests_iOS.xctest; sourceTree = BUILT_PRODUCTS_DIR; }; @@ -958,6 +960,7 @@ isa = PBXGroup; children = ( AB38D92E20235D22000A432D /* database_info_test.cc */, + B9C261C26C5D311E1E3C0CB9 /* query_test.cc */, AB380CF82019382300D97691 /* target_id_generator_test.cc */, ); path = core; @@ -1183,7 +1186,6 @@ 54C9EDEE2040E16300A969CD /* Frameworks */, 54C9EDEF2040E16300A969CD /* Resources */, EA424838F4A5DD7B337F57AB /* [CP] Embed Pods Frameworks */, - 6BD54D799442CEB09349B73E /* [CP] Copy Pods Resources */, ); buildRules = ( ); @@ -1204,7 +1206,6 @@ 6003F587195388D20070C39A /* Frameworks */, 6003F588195388D20070C39A /* Resources */, 1EE692C7509A98D7EB03CA51 /* [CP] Embed Pods Frameworks */, - A4BCE623F5E4C28728E5F17A /* [CP] Copy Pods Resources */, ); buildRules = ( ); @@ -1224,7 +1225,6 @@ 6003F5AB195388D20070C39A /* Frameworks */, 6003F5AC195388D20070C39A /* Resources */, 329C25E418360CEF62F6CB2B /* [CP] Embed Pods Frameworks */, - 263508FF7FD6CA4D6C3E685D /* [CP] Copy Pods Resources */, ); buildRules = ( ); @@ -1245,7 +1245,6 @@ 6EDD3B4520BF247500C33877 /* Frameworks */, 6EDD3B4A20BF247500C33877 /* Resources */, 6EDD3B5720BF247500C33877 /* [CP] Embed Pods Frameworks */, - F5DFA8B0274B042DC1B00837 /* [CP] Copy Pods Resources */, ); buildRules = ( ); @@ -1266,7 +1265,6 @@ DE03B2D31F2149D600A30B9C /* Frameworks */, DE03B2D81F2149D600A30B9C /* Resources */, B7923D95031DB0DA112AAE9B /* [CP] Embed Pods Frameworks */, - 5B2A669EEE88DF2205316429 /* [CP] Copy Pods Resources */, ); buildRules = ( ); @@ -1287,7 +1285,6 @@ DE0761E11F2FE611003233AF /* Frameworks */, DE0761E21F2FE611003233AF /* Resources */, 04404E0DCBB886A40E3C7175 /* [CP] Embed Pods Frameworks */, - 138396D16F5128E073E667C6 /* [CP] Copy Pods Resources */, ); buildRules = ( ); @@ -1459,21 +1456,6 @@ shellScript = "\"${SRCROOT}/Pods/Target Support Files/Pods-Firestore_Example_iOS-SwiftBuildTest/Pods-Firestore_Example_iOS-SwiftBuildTest-frameworks.sh\"\n"; showEnvVarsInLog = 0; }; - 138396D16F5128E073E667C6 /* [CP] Copy Pods Resources */ = { - isa = PBXShellScriptBuildPhase; - buildActionMask = 2147483647; - files = ( - ); - inputPaths = ( - ); - name = "[CP] Copy Pods Resources"; - outputPaths = ( - ); - runOnlyForDeploymentPostprocessing = 0; - shellPath = /bin/sh; - shellScript = "\"${SRCROOT}/Pods/Target Support Files/Pods-Firestore_Example_iOS-SwiftBuildTest/Pods-Firestore_Example_iOS-SwiftBuildTest-resources.sh\"\n"; - showEnvVarsInLog = 0; - }; 1EE692C7509A98D7EB03CA51 /* [CP] Embed Pods Frameworks */ = { isa = PBXShellScriptBuildPhase; buildActionMask = 2147483647; @@ -1510,21 +1492,6 @@ shellScript = "\"${SRCROOT}/Pods/Target Support Files/Pods-Firestore_Example_iOS/Pods-Firestore_Example_iOS-frameworks.sh\"\n"; showEnvVarsInLog = 0; }; - 263508FF7FD6CA4D6C3E685D /* [CP] Copy Pods Resources */ = { - isa = PBXShellScriptBuildPhase; - buildActionMask = 2147483647; - files = ( - ); - inputPaths = ( - ); - name = "[CP] Copy Pods Resources"; - outputPaths = ( - ); - runOnlyForDeploymentPostprocessing = 0; - shellPath = /bin/sh; - shellScript = "\"${SRCROOT}/Pods/Target Support Files/Pods-Firestore_Tests_iOS/Pods-Firestore_Tests_iOS-resources.sh\"\n"; - showEnvVarsInLog = 0; - }; 329C25E418360CEF62F6CB2B /* [CP] Embed Pods Frameworks */ = { isa = PBXShellScriptBuildPhase; buildActionMask = 2147483647; @@ -1567,36 +1534,6 @@ shellScript = "diff \"${PODS_PODFILE_DIR_PATH}/Podfile.lock\" \"${PODS_ROOT}/Manifest.lock\" > /dev/null\nif [ $? != 0 ] ; then\n # print error to STDERR\n echo \"error: The sandbox is not in sync with the Podfile.lock. Run 'pod install' or update your CocoaPods installation.\" >&2\n exit 1\nfi\n# This output is used by Xcode 'outputs' to avoid re-running this script phase.\necho \"SUCCESS\" > \"${SCRIPT_OUTPUT_FILE_0}\"\n"; showEnvVarsInLog = 0; }; - 5B2A669EEE88DF2205316429 /* [CP] Copy Pods Resources */ = { - isa = PBXShellScriptBuildPhase; - buildActionMask = 2147483647; - files = ( - ); - inputPaths = ( - ); - name = "[CP] Copy Pods Resources"; - outputPaths = ( - ); - runOnlyForDeploymentPostprocessing = 0; - shellPath = /bin/sh; - shellScript = "\"${SRCROOT}/Pods/Target Support Files/Pods-Firestore_IntegrationTests_iOS/Pods-Firestore_IntegrationTests_iOS-resources.sh\"\n"; - showEnvVarsInLog = 0; - }; - 6BD54D799442CEB09349B73E /* [CP] Copy Pods Resources */ = { - isa = PBXShellScriptBuildPhase; - buildActionMask = 2147483647; - files = ( - ); - inputPaths = ( - ); - name = "[CP] Copy Pods Resources"; - outputPaths = ( - ); - runOnlyForDeploymentPostprocessing = 0; - shellPath = /bin/sh; - shellScript = "\"${SRCROOT}/Pods/Target Support Files/Pods-Firestore_Example_iOS-Firestore_SwiftTests_iOS/Pods-Firestore_Example_iOS-Firestore_SwiftTests_iOS-resources.sh\"\n"; - showEnvVarsInLog = 0; - }; 6EDD3AD420BF247500C33877 /* [CP] Check Pods Manifest.lock */ = { isa = PBXShellScriptBuildPhase; buildActionMask = 2147483647; @@ -1669,21 +1606,6 @@ shellScript = "diff \"${PODS_PODFILE_DIR_PATH}/Podfile.lock\" \"${PODS_ROOT}/Manifest.lock\" > /dev/null\nif [ $? != 0 ] ; then\n # print error to STDERR\n echo \"error: The sandbox is not in sync with the Podfile.lock. Run 'pod install' or update your CocoaPods installation.\" >&2\n exit 1\nfi\n# This output is used by Xcode 'outputs' to avoid re-running this script phase.\necho \"SUCCESS\" > \"${SCRIPT_OUTPUT_FILE_0}\"\n"; showEnvVarsInLog = 0; }; - A4BCE623F5E4C28728E5F17A /* [CP] Copy Pods Resources */ = { - isa = PBXShellScriptBuildPhase; - buildActionMask = 2147483647; - files = ( - ); - inputPaths = ( - ); - name = "[CP] Copy Pods Resources"; - outputPaths = ( - ); - runOnlyForDeploymentPostprocessing = 0; - shellPath = /bin/sh; - shellScript = "\"${SRCROOT}/Pods/Target Support Files/Pods-Firestore_Example_iOS/Pods-Firestore_Example_iOS-resources.sh\"\n"; - showEnvVarsInLog = 0; - }; A827A009A65B69DC1B80EAD4 /* [CP] Check Pods Manifest.lock */ = { isa = PBXShellScriptBuildPhase; buildActionMask = 2147483647; @@ -1774,21 +1696,6 @@ shellScript = "\"${SRCROOT}/Pods/Target Support Files/Pods-Firestore_Example_iOS-Firestore_SwiftTests_iOS/Pods-Firestore_Example_iOS-Firestore_SwiftTests_iOS-frameworks.sh\"\n"; showEnvVarsInLog = 0; }; - F5DFA8B0274B042DC1B00837 /* [CP] Copy Pods Resources */ = { - isa = PBXShellScriptBuildPhase; - buildActionMask = 2147483647; - files = ( - ); - inputPaths = ( - ); - name = "[CP] Copy Pods Resources"; - outputPaths = ( - ); - runOnlyForDeploymentPostprocessing = 0; - shellPath = /bin/sh; - shellScript = "\"${SRCROOT}/Pods/Target Support Files/Pods-Firestore_FuzzTests_iOS/Pods-Firestore_FuzzTests_iOS-resources.sh\"\n"; - showEnvVarsInLog = 0; - }; /* End PBXShellScriptBuildPhase section */ /* Begin PBXSourcesBuildPhase section */ @@ -1920,6 +1827,7 @@ 5A080105CCBFDB6BF3F3772D /* path_test.cc in Sources */, 549CCA5920A36E1F00BCEB75 /* precondition_test.cc in Sources */, 618BBEAB20B89AAC00B5BCE7 /* query.pb.cc in Sources */, + 6F3CAC76D918D6B0917EDF92 /* query_test.cc in Sources */, B686F2B22025000D0028D6BE /* resource_path_test.cc in Sources */, 54740A571FC914BA00713A1A /* secure_random_test.cc in Sources */, 61F72C5620BC48FD001A68CB /* serializer_test.cc in Sources */, 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