1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
|
/*
* Copyright 2017 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.
*/
#import <Foundation/Foundation.h>
#include <map>
#include <set>
#include <unordered_map>
#include <unordered_set>
#import "Firestore/Source/Core/FSTTypes.h"
#import "Firestore/Source/Model/FSTDocumentDictionary.h"
#include "Firestore/core/src/firebase/firestore/model/document_key.h"
#include "Firestore/core/src/firebase/firestore/model/document_key_set.h"
#include "Firestore/core/src/firebase/firestore/model/snapshot_version.h"
@class FSTDocument;
@class FSTExistenceFilter;
@class FSTMaybeDocument;
@class FSTWatchChange;
@class FSTQueryData;
@class FSTDocumentWatchChange;
@class FSTWatchTargetChange;
@class FSTExistenceFilterWatchChange;
NS_ASSUME_NONNULL_BEGIN
/**
* Interface implemented by RemoteStore to expose target metadata to the FSTWatchChangeAggregator.
*/
@protocol FSTTargetMetadataProvider
/**
* Returns the set of remote document keys for the given target ID as of the last raised snapshot.
*/
- (firebase::firestore::model::DocumentKeySet)remoteKeysForTarget:(FSTBoxedTargetID *)targetID;
/**
* Returns the FSTQueryData for an active target ID or 'null' if this query has become inactive
*/
- (nullable FSTQueryData *)queryDataForTarget:(FSTBoxedTargetID *)targetID;
@end
#pragma mark - FSTTargetChange
/**
* An FSTTargetChange specifies the set of changes for a specific target as part of an
* FSTRemoteEvent. These changes track which documents are added, modified or emoved, as well as the
* target's resume token and whether the target is marked CURRENT.
*
* The actual changes *to* documents are not part of the FSTTargetChange since documents may be part
* of multiple targets.
*/
@interface FSTTargetChange : NSObject
/**
* Creates a new target change with the given SnapshotVersion.
*/
- (instancetype)initWithResumeToken:(NSData *)resumeToken
current:(BOOL)current
addedDocuments:(firebase::firestore::model::DocumentKeySet)addedDocuments
modifiedDocuments:(firebase::firestore::model::DocumentKeySet)modifiedDocuments
removedDocuments:(firebase::firestore::model::DocumentKeySet)removedDocuments
NS_DESIGNATED_INITIALIZER;
- (instancetype)init NS_UNAVAILABLE;
/**
* An opaque, server-assigned token that allows watching a query to be resumed after
* disconnecting without retransmitting all the data that matches the query. The resume token
* essentially identifies a point in time from which the server should resume sending results.
*/
@property(nonatomic, strong, readonly) NSData *resumeToken;
/**
* The "current" (synced) status of this target. Note that "current" has special meaning in the RPC
* protocol that implies that a target is both up-to-date and consistent with the rest of the watch
* stream.
*/
@property(nonatomic, assign, readonly) BOOL current;
/**
* The set of documents that were newly assigned to this target as part of this remote event.
*/
- (const firebase::firestore::model::DocumentKeySet &)addedDocuments;
/**
* The set of documents that were already assigned to this target but received an update during this
* remote event.
*/
- (const firebase::firestore::model::DocumentKeySet &)modifiedDocuments;
/**
* The set of documents that were removed from this target as part of this remote event.
*/
- (const firebase::firestore::model::DocumentKeySet &)removedDocuments;
@end
#pragma mark - FSTRemoteEvent
/**
* An event from the RemoteStore. It is split into targetChanges (changes to the state or the set
* of documents in our watched targets) and documentUpdates (changes to the actual documents).
*/
@interface FSTRemoteEvent : NSObject
- (instancetype)
initWithSnapshotVersion:(firebase::firestore::model::SnapshotVersion)snapshotVersion
targetChanges:(std::unordered_map<FSTTargetID, FSTTargetChange *>)targetChanges
targetMismatches:(std::unordered_set<FSTTargetID>)targetMismatches
documentUpdates:
(std::unordered_map<firebase::firestore::model::DocumentKey,
FSTMaybeDocument *,
firebase::firestore::model::DocumentKeyHash>)documentUpdates
limboDocuments:(firebase::firestore::model::DocumentKeySet)limboDocuments;
/** The snapshot version this event brings us up to. */
- (const firebase::firestore::model::SnapshotVersion &)snapshotVersion;
/**
* A set of which document updates are due only to limbo resolution targets.
*/
- (const firebase::firestore::model::DocumentKeySet &)limboDocumentChanges;
/** A map from target to changes to the target. See TargetChange. */
- (const std::unordered_map<FSTTargetID, FSTTargetChange *> &)targetChanges;
/**
* A set of targets that is known to be inconsistent. Listens for these targets should be
* re-established without resume tokens.
*/
- (const std::unordered_set<FSTTargetID> &)targetMismatches;
/**
* A set of which documents have changed or been deleted, along with the doc's new values (if not
* deleted).
*/
- (const std::unordered_map<firebase::firestore::model::DocumentKey,
FSTMaybeDocument *,
firebase::firestore::model::DocumentKeyHash> &)documentUpdates;
@end
#pragma mark - FSTWatchChangeAggregator
/**
* A helper class to accumulate watch changes into a FSTRemoteEvent and other target
* information.
*/
@interface FSTWatchChangeAggregator : NSObject
- (instancetype)initWithTargetMetadataProvider:(id<FSTTargetMetadataProvider>)targetMetadataProvider
NS_DESIGNATED_INITIALIZER;
- (instancetype)init NS_UNAVAILABLE;
/** Processes and adds the FSTDocumentWatchChange to the current set of changes. */
- (void)handleDocumentChange:(FSTDocumentWatchChange *)documentChange;
/** Processes and adds the WatchTargetChange to the current set of changes. */
- (void)handleTargetChange:(FSTWatchTargetChange *)targetChange;
/** Removes the in-memory state for the provided target. */
- (void)removeTarget:(FSTTargetID)targetID;
/**
* Handles existence filters and synthesizes deletes for filter mismatches. Targets that are
* invalidated by filter mismatches are added to `targetMismatches`.
*/
- (void)handleExistenceFilter:(FSTExistenceFilterWatchChange *)existenceFilter;
/**
* Increment the number of acks needed from watch before we can consider the server to be 'in-sync'
* with the client's active targets.
*/
- (void)recordTargetRequest:(FSTBoxedTargetID *)targetID;
/**
* Converts the current state into a remote event with the snapshot version taken from the
* initializer.
*/
- (FSTRemoteEvent *)remoteEventAtSnapshotVersion:
(const firebase::firestore::model::SnapshotVersion &)snapshotVersion;
@end
NS_ASSUME_NONNULL_END
|
