mirror of
https://github.com/firebase/firebase-ios-sdk
synced 2026-11-10 22:45:59 +05:45
Greg Soltis
16a5210b3c
* Switch to reference delegates for garbage collection (#1410) * Bump sequence number on resume token refresh * Style * Fix comment formatting * Add FSTReferenceDelegate definition and documentation * Add methods to return nil for delegates, wire up inMemoryPins * Add hook for removing a reference * Start work on reference delegates * Fix up tests to support adding documents at a sequence number * Implement removing references * Remove from target when dropped from local view * Fix warning * Add hooks for removal from mutation queue * Add hooks for limbo document updates * Style * Drop commented-out code * Fixup after merging master * Start importing delegate implementations * Memory LRU tests pass * Make memory lru work, start fixing up lru tests. All with hidden sequence numbers * Most LRU tests passing w/ memory * Big LRU test passes w/ memory * Leveldb LRU tests pass * All passing except local store tests * All tests pass * Fix localstore tests * Revert removeQueryData change * Remove collectGarbage calls * Remove NoOp GC * More cleanup * Refactor FSTHelpers * Cleanup and commenting * Comments and cleanup * Comments * Drop nullable for reference delegates, and old persistence method on spec tests * Fix missing sequence bump, remove unneeded targetID * Style * Drop commented-out code * Satisfy the linters and copyrighters, etc. * Drop more commented-out code * Fix import -> include, NSUInteger -> int * Start work on test comments * FSTDocumentKey -> DocumentKey * Sample of LRU test refactor (#1424) * Sample of test refactor * Drop errant 'struct' keyword * More test refactoring * Make gc a member variable too * Tests refactored to use member variables * Assign delegates procedurally, rather than passing in a block * Fix up FSTLevelDB a little * listens -> listenTargets * Rename GCEnabled * remove isSentinel * reword comment * Add case for non-eager GC to test * Style * Cleaning the lint trap * Clean up LRU tests (#1433) * Add copious helpers and some docs to lru tests * Style * Method name refactor, add comment * Drop FSTGarbageCollector and FSTEagerGarbageCollector (#1440) * Drop FSTGarbageCollector and FSTEagerGarbageCollector * Drop unused containsKey from FSTLevelDBMutationQueue * Style * Include sequence number in FSTQueryData hash and isEqual (#1568) * Include sequence number in FSTQueryData hash and isEqual methods * Style * Switch to util::Hash * Fix preserving query cache metadata (#1569) * Add failing test * Move the restart tests to the leveldb test suite * Style * Add new persistence test helper * Fix test failure * Review feedback * Style
100 lines
3.8 KiB
Objective-C
100 lines
3.8 KiB
Objective-C
/*
|
|
* 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.
|
|
*/
|
|
|
|
#import <Foundation/Foundation.h>
|
|
|
|
#import "Firestore/Source/Core/FSTTypes.h"
|
|
#import "Firestore/Source/Local/FSTQueryData.h"
|
|
#include "Firestore/core/src/firebase/firestore/model/document_key.h"
|
|
|
|
@protocol FSTQueryCache;
|
|
|
|
@class FSTLRUGarbageCollector;
|
|
|
|
extern const FSTListenSequenceNumber kFSTListenSequenceNumberInvalid;
|
|
|
|
/**
|
|
* Persistence layers intending to use LRU Garbage collection should implement this protocol. This
|
|
* protocol defines the operations that the LRU garbage collector needs from the persistence layer.
|
|
*/
|
|
@protocol FSTLRUDelegate
|
|
|
|
/**
|
|
* Enumerates all the targets that the delegate is aware of. This is typically all of the targets in
|
|
* an FSTQueryCache.
|
|
*/
|
|
- (void)enumerateTargetsUsingBlock:(void (^)(FSTQueryData *queryData, BOOL *stop))block;
|
|
|
|
/**
|
|
* Enumerates all of the outstanding mutations.
|
|
*/
|
|
- (void)enumerateMutationsUsingBlock:(void (^)(const firebase::firestore::model::DocumentKey &key,
|
|
FSTListenSequenceNumber sequenceNumber,
|
|
BOOL *stop))block;
|
|
|
|
/**
|
|
* Removes all unreferenced documents from the cache that have a sequence number less than or equal
|
|
* to the given sequence number. Returns the number of documents removed.
|
|
*/
|
|
- (int)removeOrphanedDocumentsThroughSequenceNumber:(FSTListenSequenceNumber)sequenceNumber;
|
|
|
|
/**
|
|
* Removes all targets that are not currently being listened to and have a sequence number less than
|
|
* or equal to the given sequence number. Returns the number of targets removed.
|
|
*/
|
|
- (int)removeTargetsThroughSequenceNumber:(FSTListenSequenceNumber)sequenceNumber
|
|
liveQueries:(NSDictionary<NSNumber *, FSTQueryData *> *)liveQueries;
|
|
|
|
/** Access to the underlying LRU Garbage collector instance. */
|
|
@property(strong, nonatomic, readonly) FSTLRUGarbageCollector *gc;
|
|
|
|
@end
|
|
|
|
/**
|
|
* FSTLRUGarbageCollector defines the LRU algorithm used to clean up old documents and targets. It
|
|
* is persistence-agnostic, as long as proper delegate is provided.
|
|
*/
|
|
@interface FSTLRUGarbageCollector : NSObject
|
|
|
|
- (instancetype)initWithQueryCache:(id<FSTQueryCache>)queryCache
|
|
delegate:(id<FSTLRUDelegate>)delegate;
|
|
|
|
/**
|
|
* Given a target percentile, return the number of queries that make up that percentage of the
|
|
* queries that are cached. For instance, if 20 queries are cached, and the percentile is 40, the
|
|
* result will be 8.
|
|
*/
|
|
- (int)queryCountForPercentile:(NSUInteger)percentile;
|
|
|
|
/**
|
|
* Given a number of queries n, return the nth sequence number in the cache.
|
|
*/
|
|
- (FSTListenSequenceNumber)sequenceNumberForQueryCount:(NSUInteger)queryCount;
|
|
|
|
/**
|
|
* Removes queries that are not currently live (as indicated by presence in the liveQueries map) and
|
|
* have a sequence number less than or equal to the given sequence number.
|
|
*/
|
|
- (int)removeQueriesUpThroughSequenceNumber:(FSTListenSequenceNumber)sequenceNumber
|
|
liveQueries:(NSDictionary<NSNumber *, FSTQueryData *> *)liveQueries;
|
|
|
|
/**
|
|
* Removes all unreferenced documents from the cache that have a sequence number less than or equal
|
|
* to the given sequence number. Returns the number of documents removed.
|
|
*/
|
|
- (int)removeOrphanedDocumentsThroughSequenceNumber:(FSTListenSequenceNumber)sequenceNumber;
|
|
|
|
@end |