Skip to content

Commit f7273d4

Browse files
wu-huiwu-hui
committed
[realppl 9] realppl public api and integration tests
1 parent 0135d82 commit f7273d4

27 files changed

+1164
-148
lines changed

‎Firestore/Example/Firestore.xcodeproj/project.pbxproj‎

Lines changed: 60 additions & 39 deletions
Large diffs are not rendered by default.

‎Firestore/Example/Tests/Util/FSTIntegrationTestCase.mm‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -193,6 +193,8 @@ + (void)setUpDefaults {
193193
NSString *databaseId = [[NSProcessInfo processInfo] environment][@"TARGET_DATABASE_ID"];
194194
if (databaseId) {
195195
defaultDatabaseId = databaseId;
196+
} else {
197+
defaultDatabaseId = @"enterprise";
196198
}
197199

198200
// Check for a MobileHarness configuration, running against nightly or prod, which have live

‎Firestore/Source/API/FIRPipelineBridge+Internal.h‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@
2121
#include "Firestore/core/src/api/expressions.h"
2222
#include "Firestore/core/src/api/firestore.h"
2323
#include "Firestore/core/src/api/pipeline.h"
24+
#include "Firestore/core/src/api/pipeline_result_change.h"
2425
#include "Firestore/core/src/api/stages.h"
2526

2627
@class FIRFilter;
@@ -59,6 +60,12 @@ NS_ASSUME_NONNULL_BEGIN
5960

6061
@end
6162

63+
@interface __FIRPipelineResultChangeBridge (Internal)
64+
65+
- (id)initWithCppChange:(api::PipelineResultChange)change db:(std::shared_ptr<api::Firestore>)db;
66+
67+
@end
68+
6269
@interface FIRPipelineBridge (Internal)
6370

6471
- (std::shared_ptr<api::Pipeline>)cppPipelineWithReader:(FSTUserDataReader *)reader;

‎Firestore/Source/API/FIRPipelineBridge.mm‎

Lines changed: 183 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@
2323
#import "Firestore/Source/API/FIRDocumentReference+Internal.h"
2424
#import "Firestore/Source/API/FIRFieldPath+Internal.h"
2525
#import "Firestore/Source/API/FIRFirestore+Internal.h"
26+
#import "Firestore/Source/API/FIRListenerRegistration+Internal.h"
2627
#import "Firestore/Source/API/FIRPipelineBridge+Internal.h"
2728
#import "Firestore/Source/API/FSTUserDataReader.h"
2829
#import "Firestore/Source/API/FSTUserDataWriter.h"
@@ -37,8 +38,17 @@
3738
#include "Firestore/core/src/api/ordering.h"
3839
#include "Firestore/core/src/api/pipeline.h"
3940
#include "Firestore/core/src/api/pipeline_result.h"
41+
#include "Firestore/core/src/api/pipeline_result_change.h"
4042
#include "Firestore/core/src/api/pipeline_snapshot.h"
43+
#include "Firestore/core/src/api/query_listener_registration.h"
44+
#include "Firestore/core/src/api/realtime_pipeline.h"
45+
#include "Firestore/core/src/api/realtime_pipeline_snapshot.h"
46+
#include "Firestore/core/src/api/snapshot_metadata.h"
4147
#include "Firestore/core/src/api/stages.h"
48+
#include "Firestore/core/src/core/event_listener.h"
49+
#include "Firestore/core/src/core/firestore_client.h"
50+
#include "Firestore/core/src/core/listen_options.h"
51+
#include "Firestore/core/src/core/view_snapshot.h"
4252
#include "Firestore/core/src/util/error_apple.h"
4353
#include "Firestore/core/src/util/status.h"
4454
#include "Firestore/core/src/util/string_apple.h"
@@ -51,6 +61,7 @@
5161
using firebase::firestore::api::Constant;
5262
using firebase::firestore::api::DatabaseSource;
5363
using firebase::firestore::api::DistinctStage;
64+
using firebase::firestore::api::DocumentChange;
5465
using firebase::firestore::api::DocumentReference;
5566
using firebase::firestore::api::DocumentsSource;
5667
using firebase::firestore::api::Expr;
@@ -63,14 +74,21 @@
6374
using firebase::firestore::api::OffsetStage;
6475
using firebase::firestore::api::Ordering;
6576
using firebase::firestore::api::Pipeline;
77+
using firebase::firestore::api::PipelineResultChange;
78+
using firebase::firestore::api::QueryListenerRegistration;
79+
using firebase::firestore::api::RealtimePipeline;
80+
using firebase::firestore::api::RealtimePipelineSnapshot;
6681
using firebase::firestore::api::RemoveFieldsStage;
6782
using firebase::firestore::api::ReplaceWith;
6883
using firebase::firestore::api::Sample;
6984
using firebase::firestore::api::SelectStage;
85+
using firebase::firestore::api::SnapshotMetadata;
7086
using firebase::firestore::api::SortStage;
7187
using firebase::firestore::api::Union;
7288
using firebase::firestore::api::Unnest;
7389
using firebase::firestore::api::Where;
90+
using firebase::firestore::core::EventListener;
91+
using firebase::firestore::core::ViewSnapshot;
7492
using firebase::firestore::model::FieldPath;
7593
using firebase::firestore::nanopb::SharedMessage;
7694
using firebase::firestore::util::MakeCallback;
@@ -928,6 +946,48 @@ - (nullable id)get:(id)field
928946

929947
@end
930948

949+
@implementation __FIRPipelineResultChangeBridge {
950+
api::PipelineResultChange change_;
951+
std::shared_ptr<api::Firestore> db_;
952+
}
953+
954+
- (FIRDocumentChangeType)type {
955+
switch (change_.type()) {
956+
case PipelineResultChange::Type::Added:
957+
return FIRDocumentChangeTypeAdded;
958+
case PipelineResultChange::Type::Modified:
959+
return FIRDocumentChangeTypeModified;
960+
case PipelineResultChange::Type::Removed:
961+
return FIRDocumentChangeTypeRemoved;
962+
}
963+
964+
HARD_FAIL("Unknown PipelineResultChange::Type: %s", change_.type());
965+
}
966+
967+
- (__FIRPipelineResultBridge *)result {
968+
return [[__FIRPipelineResultBridge alloc] initWithCppResult:change_.result() db:db_];
969+
}
970+
971+
- (NSUInteger)oldIndex {
972+
return change_.old_index() == PipelineResultChange::npos ? NSNotFound : change_.old_index();
973+
}
974+
975+
- (NSUInteger)newIndex {
976+
return change_.new_index() == PipelineResultChange::npos ? NSNotFound : change_.new_index();
977+
}
978+
979+
- (id)initWithCppChange:(api::PipelineResultChange)change db:(std::shared_ptr<api::Firestore>)db {
980+
self = [super init];
981+
if (self) {
982+
change_ = std::move(change);
983+
db_ = std::move(db);
984+
}
985+
986+
return self;
987+
}
988+
989+
@end
990+
931991
@implementation FIRPipelineBridge {
932992
NSArray<FIRStageBridge *> *_stages;
933993
FIRFirestore *firestore;
@@ -965,4 +1025,127 @@ - (void)executeWithCompletion:(void (^)(__FIRPipelineSnapshotBridge *_Nullable r
9651025

9661026
@end
9671027

1028+
@interface __FIRRealtimePipelineSnapshotBridge ()
1029+
1030+
@property(nonatomic, strong, readwrite) NSArray<__FIRPipelineResultBridge *> *results;
1031+
1032+
@property(nonatomic, strong, readwrite) NSArray<__FIRPipelineResultChangeBridge *> *changes;
1033+
1034+
@end
1035+
1036+
@implementation __FIRRealtimePipelineSnapshotBridge {
1037+
absl::optional<api::RealtimePipelineSnapshot> snapshot_;
1038+
NSMutableArray<__FIRPipelineResultBridge *> *results_;
1039+
NSMutableArray<__FIRPipelineResultChangeBridge *> *changes_;
1040+
}
1041+
1042+
- (id)initWithCppSnapshot:(api::RealtimePipelineSnapshot)snapshot {
1043+
self = [super init];
1044+
if (self) {
1045+
snapshot_ = std::move(snapshot);
1046+
if (!snapshot_.has_value()) {
1047+
results_ = nil;
1048+
} else {
1049+
NSMutableArray<__FIRPipelineResultBridge *> *results = [NSMutableArray array];
1050+
for (auto &result : snapshot_.value().view_snapshot().documents()) {
1051+
[results addObject:[[__FIRPipelineResultBridge alloc]
1052+
initWithCppResult:api::PipelineResult(result)
1053+
db:snapshot_.value().firestore()]];
1054+
}
1055+
results_ = results;
1056+
1057+
NSMutableArray<__FIRPipelineResultChangeBridge *> *changes = [NSMutableArray array];
1058+
for (auto &change : snapshot_.value().CalculateResultChanges(false)) {
1059+
[changes addObject:[[__FIRPipelineResultChangeBridge alloc]
1060+
initWithCppChange:change
1061+
db:snapshot_.value().firestore()]];
1062+
}
1063+
changes_ = changes;
1064+
}
1065+
}
1066+
1067+
return self;
1068+
}
1069+
1070+
- (NSArray<__FIRPipelineResultBridge *> *)results {
1071+
return results_;
1072+
}
1073+
1074+
- (NSArray<__FIRPipelineResultChangeBridge *> *)changes {
1075+
return changes_;
1076+
}
1077+
1078+
@end
1079+
1080+
@implementation FIRRealtimePipelineBridge {
1081+
NSArray<FIRStageBridge *> *_stages;
1082+
FIRFirestore *firestore;
1083+
std::shared_ptr<api::RealtimePipeline> cpp_pipeline;
1084+
}
1085+
1086+
- (id)initWithStages:(NSArray<FIRStageBridge *> *)stages db:(FIRFirestore *)db {
1087+
_stages = stages;
1088+
firestore = db;
1089+
return [super init];
1090+
}
1091+
1092+
- (id<FIRListenerRegistration>)
1093+
addSnapshotListenerWithOptions:(FIRSnapshotListenOptions *)options
1094+
listener:
1095+
(void (^)(__FIRRealtimePipelineSnapshotBridge *_Nullable snapshot,
1096+
NSError *_Nullable error))listener {
1097+
std::shared_ptr<api::Firestore> wrapped_firestore = firestore.wrapped;
1098+
1099+
std::vector<std::shared_ptr<firebase::firestore::api::EvaluableStage>> cpp_stages;
1100+
for (FIRStageBridge *stage in _stages) {
1101+
auto evaluable_stage = std::dynamic_pointer_cast<api::EvaluableStage>(
1102+
[stage cppStageWithReader:firestore.dataReader]);
1103+
if (evaluable_stage) {
1104+
cpp_stages.push_back(evaluable_stage);
1105+
} else {
1106+
HARD_FAIL("Failed to convert cpp stage to EvaluableStage for RealtimePipeline");
1107+
}
1108+
}
1109+
1110+
cpp_pipeline = std::make_shared<RealtimePipeline>(
1111+
cpp_stages, std::make_unique<remote::Serializer>(wrapped_firestore->database_id()));
1112+
1113+
// Convert from ViewSnapshots to RealtimePipelineSnapshots.
1114+
auto view_listener = EventListener<ViewSnapshot>::Create(
1115+
[listener, wrapped_firestore](StatusOr<ViewSnapshot> maybe_snapshot) {
1116+
if (!maybe_snapshot.status().ok()) {
1117+
listener(nil, MakeNSError(maybe_snapshot.status()));
1118+
return;
1119+
}
1120+
1121+
ViewSnapshot snapshot = std::move(maybe_snapshot).ValueOrDie();
1122+
SnapshotMetadata metadata(snapshot.has_pending_writes(), snapshot.from_cache());
1123+
1124+
listener(
1125+
[[__FIRRealtimePipelineSnapshotBridge alloc]
1126+
initWithCppSnapshot:RealtimePipelineSnapshot(wrapped_firestore, std::move(snapshot),
1127+
std::move(metadata))],
1128+
nil);
1129+
});
1130+
1131+
// Call the view_listener on the user Executor.
1132+
auto async_listener = core::AsyncEventListener<ViewSnapshot>::Create(
1133+
wrapped_firestore->client()->user_executor(), std::move(view_listener));
1134+
1135+
std::shared_ptr<core::QueryListener> query_listener = wrapped_firestore->client()->ListenToQuery(
1136+
// TODO(pipeline): pass options properly
1137+
*cpp_pipeline, core::ListenOptions(), async_listener);
1138+
1139+
return [[FSTListenerRegistration alloc]
1140+
initWithRegistration:absl::make_unique<QueryListenerRegistration>(wrapped_firestore->client(),
1141+
std::move(async_listener),
1142+
std::move(query_listener))];
1143+
}
1144+
1145+
- (std::shared_ptr<api::RealtimePipeline>)cppPipelineWithReader:(FSTUserDataReader *)reader {
1146+
return cpp_pipeline;
1147+
}
1148+
1149+
@end
1150+
9681151
NS_ASSUME_NONNULL_END

‎Firestore/Source/Public/FirebaseFirestore/FIRPipelineBridge.h‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,9 @@
1818

1919
#import <Foundation/Foundation.h>
2020

21+
#import "FIRDocumentChange.h"
2122
#import "FIRDocumentSnapshot.h"
23+
#import "FIRSnapshotListenOptions.h"
2224

2325
@class FIRTimestamp;
2426
@class FIRVectorValue;
@@ -223,6 +225,22 @@ NS_SWIFT_NAME(__PipelineResultBridge)
223225

224226
@end
225227

228+
NS_SWIFT_SENDABLE
229+
NS_SWIFT_NAME(__PipelineResultChangeBridge)
230+
@interface __FIRPipelineResultChangeBridge : NSObject
231+
232+
/** The type of change that occurred (added, modified, or removed). */
233+
@property(nonatomic, readonly) FIRDocumentChangeType type;
234+
235+
/** The document affected by this change. */
236+
@property(nonatomic, strong, readonly) __FIRPipelineResultBridge *result;
237+
238+
@property(nonatomic, readonly) NSUInteger oldIndex;
239+
240+
@property(nonatomic, readonly) NSUInteger newIndex;
241+
242+
@end
243+
226244
NS_SWIFT_SENDABLE
227245
NS_SWIFT_NAME(__PipelineSnapshotBridge)
228246
@interface __FIRPipelineSnapshotBridge : NSObject
@@ -245,4 +263,30 @@ NS_SWIFT_NAME(PipelineBridge)
245263

246264
@end
247265

266+
NS_SWIFT_SENDABLE
267+
NS_SWIFT_NAME(__RealtimePipelineSnapshotBridge)
268+
@interface __FIRRealtimePipelineSnapshotBridge : NSObject
269+
270+
@property(nonatomic, strong, readonly) NSArray<__FIRPipelineResultBridge *> *results;
271+
272+
@property(nonatomic, strong, readonly) NSArray<__FIRPipelineResultChangeBridge *> *changes;
273+
274+
@end
275+
276+
NS_SWIFT_SENDABLE
277+
NS_SWIFT_NAME(RealtimePipelineBridge)
278+
@interface FIRRealtimePipelineBridge : NSObject
279+
280+
/** :nodoc: */
281+
- (id)initWithStages:(NSArray<FIRStageBridge *> *)stages db:(FIRFirestore *)db;
282+
283+
- (id<FIRListenerRegistration>)
284+
addSnapshotListenerWithOptions:(FIRSnapshotListenOptions *)options
285+
listener:
286+
(void (^)(__FIRRealtimePipelineSnapshotBridge *_Nullable snapshot,
287+
NSError *_Nullable error))listener
288+
NS_SWIFT_NAME(addSnapshotListener(options:listener:));
289+
290+
@end
291+
248292
NS_ASSUME_NONNULL_END

‎Firestore/Swift/Source/SwiftAPI/Firestore+Pipeline.swift‎

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,16 @@ import Foundation
2323

2424
@objc public extension Firestore {
2525
@available(iOS 13, tvOS 13, macOS 10.15, macCatalyst 13, watchOS 7, *)
26-
@nonobjc func pipeline() -> PipelineSource {
27-
return PipelineSource(self)
26+
@nonobjc func pipeline() -> PipelineSource<Pipeline> {
27+
return PipelineSource<Pipeline>(db: self) { stages, db in
28+
Pipeline(stages: stages, db: db)
29+
}
30+
}
31+
32+
@available(iOS 13, tvOS 13, macOS 10.15, macCatalyst 13, watchOS 7, *)
33+
@nonobjc func realtimePipeline() -> PipelineSource<RealtimePipeline> {
34+
return PipelineSource<RealtimePipeline>(db: self) { stages, db in
35+
RealtimePipeline(stages: stages, db: db)
36+
}
2837
}
2938
}

0 commit comments

Comments
 (0)