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
109 lines
4.1 KiB
Objective-C
109 lines
4.1 KiB
Objective-C
/*
|
|
* 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 <memory>
|
|
#include <set>
|
|
#include <string>
|
|
|
|
#import "Firestore/Source/Local/FSTPersistence.h"
|
|
#include "Firestore/core/src/firebase/firestore/core/database_info.h"
|
|
#include "Firestore/core/src/firebase/firestore/local/leveldb_transaction.h"
|
|
#include "leveldb/db.h"
|
|
|
|
@class FSTLocalSerializer;
|
|
|
|
NS_ASSUME_NONNULL_BEGIN
|
|
|
|
/** A LevelDB-backed instance of FSTPersistence. */
|
|
// TODO(mikelehen): Rename to FSTLevelDBPersistence.
|
|
@interface FSTLevelDB : NSObject <FSTPersistence, FSTTransactional>
|
|
|
|
/**
|
|
* Initializes the LevelDB in the given directory. Note that all expensive startup work including
|
|
* opening any database files is deferred until -[FSTPersistence start] is called.
|
|
*/
|
|
- (instancetype)initWithDirectory:(NSString *)directory
|
|
serializer:(FSTLocalSerializer *)serializer NS_DESIGNATED_INITIALIZER;
|
|
|
|
- (instancetype)init __attribute__((unavailable("Use -initWithDirectory: instead.")));
|
|
|
|
/** Finds a suitable directory to serve as the root of all Firestore local storage. */
|
|
+ (NSString *)documentsDirectory;
|
|
|
|
/**
|
|
* Computes a unique storage directory for the given identifying components of local storage.
|
|
*
|
|
* @param databaseInfo The identifying information for the local storage instance.
|
|
* @param documentsDirectory The root document directory relative to which the storage directory
|
|
* will be created. Usually just +[FSTLevelDB documentsDir].
|
|
* @return A storage directory unique to the instance identified by databaseInfo.
|
|
*/
|
|
+ (NSString *)storageDirectoryForDatabaseInfo:
|
|
(const firebase::firestore::core::DatabaseInfo &)databaseInfo
|
|
documentsDirectory:(NSString *)documentsDirectory;
|
|
|
|
/**
|
|
* Starts LevelDB-backed persistent storage by opening the database files, creating the DB if it
|
|
* does not exist.
|
|
*
|
|
* The leveldb directory is created relative to the appropriate document storage directory for the
|
|
* platform: NSDocumentDirectory on iOS or $HOME/.firestore on macOS.
|
|
*/
|
|
- (BOOL)start:(NSError **)error;
|
|
|
|
// What follows is the Objective-C++ extension to the API.
|
|
/**
|
|
* @return A standard set of read options
|
|
*/
|
|
+ (const leveldb::ReadOptions)standardReadOptions;
|
|
|
|
/**
|
|
* Creates an NSError based on the given status if the status is not ok.
|
|
*
|
|
* @param status The status of the preceding LevelDB operation.
|
|
* @param description A printf-style format string describing what kind of failure happened if
|
|
* @a status is not ok. Additional parameters are substituted into the placeholders in this
|
|
* format string.
|
|
*
|
|
* @return An NSError with its localizedDescription composed from the description format and its
|
|
* localizedFailureReason composed from any error message embedded in @a status.
|
|
*/
|
|
+ (nullable NSError *)errorWithStatus:(leveldb::Status)status
|
|
description:(NSString *)description, ... NS_FORMAT_FUNCTION(2, 3);
|
|
|
|
/**
|
|
* Converts the given @a status to an NSString describing the status condition, suitable for
|
|
* logging or inclusion in an NSError.
|
|
*
|
|
* @param status The status of the preceding LevelDB operation.
|
|
*
|
|
* @return An NSString describing the status (even if the status was ok).
|
|
*/
|
|
+ (NSString *)descriptionOfStatus:(leveldb::Status)status;
|
|
|
|
/** The native db pointer, allocated during start. */
|
|
@property(nonatomic, assign, readonly) leveldb::DB *ptr;
|
|
|
|
@property(nonatomic, readonly) firebase::firestore::local::LevelDbTransaction *currentTransaction;
|
|
|
|
@property(nonatomic, readonly) const std::set<std::string> &users;
|
|
|
|
@end
|
|
|
|
NS_ASSUME_NONNULL_END
|