Migrate Hive box To IsolatedHive box

Signed-off-by: dab246 <tdvu@linagora.com>
This commit is contained in:
dab246
2025-06-27 23:44:35 +07:00
committed by Dat H. Pham
parent 000a2e3985
commit 8d83650f33
28 changed files with 964 additions and 334 deletions
@@ -14,84 +14,170 @@ abstract class HiveCacheClient<T> {
Future<Uint8List?> _getEncryptionKey() => HiveCacheConfig.instance.getEncryptionKey();
Future<IsolatedBox<T>> openBox() async {
Future<IsolatedBox<T>> openIsolatedBox() async {
if (IsolatedHive.isBoxOpen(tableName)) {
return IsolatedHive.box<T>(tableName);
} else {
return IsolatedHive.openBox<T>(tableName);
}
}
Future<IsolatedBox<T>> openBoxEncryption() async {
final encryptionKey = await _getEncryptionKey();
if (IsolatedHive.isBoxOpen(tableName)) {
return IsolatedHive.box<T>(tableName);
} else {
return IsolatedHive.openBox<T>(tableName,
if (encryption) {
final encryptionKey = await _getEncryptionKey();
return IsolatedHive.openBox<T>(
tableName,
encryptionCipher:
encryptionKey != null ? HiveAesCipher(encryptionKey) : null);
encryptionKey != null ? HiveAesCipher(encryptionKey) : null,
);
} else {
return IsolatedHive.openBox<T>(tableName);
}
}
}
Future<void> insertItem(String key, T newObject) {
log('$runtimeType::insertItem:encryption: $encryption - key = $key');
Future<Box<T>> openBox() async {
if (Hive.isBoxOpen(tableName)) {
return Hive.box<T>(tableName);
} else {
if (encryption) {
final encryptionKey = await _getEncryptionKey();
return Hive.openBox<T>(
tableName,
encryptionCipher:
encryptionKey != null ? HiveAesCipher(encryptionKey) : null,
);
} else {
return Hive.openBox<T>(tableName);
}
}
}
Future<void> insertItem(
String key,
T newObject, {
bool isolated = true,
}) {
log('$runtimeType::insertItem:encryption: $encryption - key = $key - isolated');
return Future.sync(() async {
final boxItem = encryption ? await openBoxEncryption() : await openBox();
return boxItem.put(key, newObject);
if (isolated) {
final boxItem = await openIsolatedBox();
return boxItem.put(key, newObject);
} else {
final boxItem = await openBox();
return boxItem.put(key, newObject);
}
}).catchError((error) {
throw error;
});
}
Future<void> insertMultipleItem(Map<String, T> mapObject) {
Future<void> insertMultipleItem(
Map<String, T> mapObject, {
bool isolated = true,
}) {
return Future.sync(() async {
final boxItem = encryption ? await openBoxEncryption() : await openBox();
return boxItem.putAll(mapObject);
if (isolated) {
final boxItem = await openIsolatedBox();
return boxItem.putAll(mapObject);
} else {
final boxItem = await openBox();
return boxItem.putAll(mapObject);
}
}).catchError((error) {
throw error;
});
}
Future<T?> getItem(String key) {
Future<T?> getItem(
String key, {
bool isolated = true,
}) {
return Future.sync(() async {
final boxItem = encryption
? await openBoxEncryption()
: await openBox();
return boxItem.get(key);
if (isolated) {
final boxItem = await openIsolatedBox();
return boxItem.get(key);
} else {
final boxItem = await openBox();
return boxItem.get(key);
}
}).catchError((error) {
throw error;
});
}
Future<List<T>> getAll() {
Future<List<T>> getAll({bool isolated = true}) {
return Future.sync(() async {
final boxItem = encryption ? await openBoxEncryption() : await openBox();
final items = await boxItem.values;
Iterable<T> items;
if (isolated) {
final boxItem = await openIsolatedBox();
items = await boxItem.values;
} else {
final boxItem = await openBox();
items = boxItem.values;
}
log('$runtimeType::getAll: Length of items is ${items.length}');
return items.toList();
}).catchError((error) {
throw error;
});
}
Future<List<T>> getListByNestedKey(String nestedKey) {
Future<Map<String, T>> getMapItems({bool isolated = true}) {
return Future.sync(() async {
final boxItem = encryption ? await openBoxEncryption() : await openBox();
final mapItems = await boxItem.toMap();
late Map<dynamic, T> mapItems;
if (isolated) {
final boxItem = await openIsolatedBox();
mapItems = await boxItem.toMap();
} else {
final boxItem = await openBox();
mapItems = boxItem.toMap();
}
log('$runtimeType::getMapItems: Length of mapItems is ${mapItems.length}');
return mapItems.map((key, value) => MapEntry(key.toString(), value));
}).catchError((error) {
throw error;
});
}
Future<List<T>> getListByNestedKey(
String nestedKey, {
bool isolated = true,
}) {
return Future.sync(() async {
late Map<dynamic, T> mapItems;
if (isolated) {
final boxItem = await openIsolatedBox();
mapItems = await boxItem.toMap();
} else {
final boxItem = await openBox();
mapItems = boxItem.toMap();
}
final listItem = mapItems
.where((key, value) => _matchedNestedKey(key, nestedKey))
.values
.toList();
log('$runtimeType::getListByNestedKey:listItem: ${listItem.length}');
log('$runtimeType::getListByNestedKey: Length of listItem is ${listItem.length}');
return listItem;
}).catchError((error) {
throw error;
});
}
Future<List<T>> getValuesByListKey(List<String> listKeys) {
Future<List<T>> getValuesByListKey(
List<String> listKeys, {
bool isolated = true,
}) {
return Future.sync(() async {
final boxItem = encryption ? await openBoxEncryption() : await openBox();
final mapItems = await boxItem.toMap();
late Map<dynamic, T> mapItems;
if (isolated) {
final boxItem = await openIsolatedBox();
mapItems = await boxItem.toMap();
} else {
final boxItem = await openBox();
mapItems = boxItem.toMap();
}
return mapItems
.where((key, value) => listKeys.contains(key))
.values
@@ -107,88 +193,149 @@ abstract class HiveCacheClient<T> {
return decodedKey.contains(decodedNestedKey);
}
Future<void> updateItem(String key, T newObject) {
Future<void> updateItem(
String key,
T newObject, {
bool isolated = true,
}) {
return Future.sync(() async {
final boxItem = encryption ? await openBoxEncryption() : await openBox();
return boxItem.put(key, newObject);
if (isolated) {
final boxItem = await openIsolatedBox();
return boxItem.put(key, newObject);
} else {
final boxItem = await openBox();
return boxItem.put(key, newObject);
}
}).catchError((error) {
throw error;
});
}
Future<void> updateMultipleItem(Map<String, T> mapObject) {
Future<void> updateMultipleItem(
Map<String, T> mapObject, {
bool isolated = true,
}) {
return Future.sync(() async {
final boxItem = encryption ? await openBoxEncryption() : await openBox();
return boxItem.putAll(mapObject);
if (isolated) {
final boxItem = await openIsolatedBox();
return boxItem.putAll(mapObject);
} else {
final boxItem = await openBox();
return boxItem.putAll(mapObject);
}
}).catchError((error) {
throw error;
});
}
Future<void> deleteItem(String key) {
Future<void> deleteItem(
String key, {
bool isolated = true,
}) {
return Future.sync(() async {
final boxItem = encryption ? await openBoxEncryption() : await openBox();
return boxItem.delete(key);
if (isolated) {
final boxItem = await openIsolatedBox();
return boxItem.delete(key);
} else {
final boxItem = await openBox();
return boxItem.delete(key);
}
}).catchError((error) {
throw error;
});
}
Future<void> deleteMultipleItem(List<String> listKey) {
Future<void> deleteMultipleItem(
List<String> listKey, {
bool isolated = true,
}) {
return Future.sync(() async {
final boxItem = encryption
? await openBoxEncryption()
: await openBox();
return boxItem.deleteAll(listKey);
if (isolated) {
final boxItem = await openIsolatedBox();
return boxItem.deleteAll(listKey);
} else {
final boxItem = await openBox();
return boxItem.deleteAll(listKey);
}
}).catchError((error) {
throw error;
});
}
Future<bool> isExistItem(String key) {
Future<bool> isExistItem(
String key, {
bool isolated = true,
}) {
return Future.sync(() async {
final boxItem = encryption
? await openBoxEncryption()
: await openBox();
return boxItem.containsKey(key);
if (isolated) {
final boxItem = await openIsolatedBox();
return boxItem.containsKey(key);
} else {
final boxItem = await openBox();
return boxItem.containsKey(key);
}
}).catchError((error) {
throw error;
});
}
Future<void> deleteBox() {
return IsolatedHive.deleteBoxFromDisk(tableName);
}
Future<void> clearAllData() {
return Future.sync(() async {
final boxItem = encryption
? await openBoxEncryption()
: await openBox();
return boxItem.clear();
}).catchError((error) {
throw error;
});
}
Future<void> clearAllDataContainKey(String nestedKey) {
return Future.sync(() async {
final boxItem = encryption ? await openBoxEncryption() : await openBox();
final mapItems = await boxItem.toMap();
final listKeys = mapItems
.where((key, value) => _matchedNestedKey(key, nestedKey))
.keys;
log('$runtimeType::clearAllDataContainKey:listKeys: ${listKeys.length}');
return boxItem.deleteAll(listKeys);
}).catchError((error) {
throw error;
});
}
Future<void> closeBox() async {
if (IsolatedHive.isBoxOpen(tableName)) {
await IsolatedHive.box<T>(tableName).close();
Future<void> deleteBox({bool isolated = true}) {
if (isolated) {
return IsolatedHive.deleteBoxFromDisk(tableName);
} else {
return Hive.deleteBoxFromDisk(tableName);
}
return Future.value();
}
}
Future<void> clearAllData({bool isolated = true}) {
return Future.sync(() async {
if (isolated) {
final boxItem = await openIsolatedBox();
return boxItem.clear();
} else {
final boxItem = await openBox();
return boxItem.clear();
}
}).catchError((error) {
throw error;
});
}
Future<void> clearAllDataContainKey(
String nestedKey, {
bool isolated = true,
}) {
return Future.sync(() async {
if (isolated) {
final boxItem = await openIsolatedBox();
final mapItems = await boxItem.toMap();
final listKeys = mapItems
.where((key, value) => _matchedNestedKey(key, nestedKey))
.keys;
log('$runtimeType::clearAllDataContainKey: Length of keys is ${listKeys.length}');
return boxItem.deleteAll(listKeys);
} else {
final boxItem = await openBox();
final listKeys = boxItem.toMap()
.where((key, value) => _matchedNestedKey(key, nestedKey))
.keys;
log('$runtimeType::clearAllDataContainKey: Length of keys is ${listKeys.length}');
return boxItem.deleteAll(listKeys);
}
}).catchError((error) {
throw error;
});
}
Future<void> closeBox({bool isolated = true}) async {
if (isolated) {
if (IsolatedHive.isBoxOpen(tableName)) {
await IsolatedHive.box<T>(tableName).close();
}
} else {
if (Hive.isBoxOpen(tableName)) {
await Hive.box<T>(tableName).close();
}
}
}
}
@@ -51,12 +51,15 @@ class HiveCacheConfig {
static HiveCacheConfig get instance => _instance;
Future<void> setUp({String? cachePath}) async {
await initializeDatabase(databasePath: cachePath);
_registerAdapter();
Future<void> setUp({String? cachePath, bool isolated = true}) async {
await initializeDatabase(databasePath: cachePath, isolated: isolated);
_registerAdapter(isolated: isolated);
}
Future<void> initializeDatabase({String? databasePath}) async {
Future<void> initializeDatabase({
String? databasePath,
bool isolated = true,
}) async {
if (databasePath == null && PlatformInfo.isMobile) {
Directory directory = await path_provider.getApplicationDocumentsDirectory();
databasePath = directory.path;
@@ -64,10 +67,14 @@ class HiveCacheConfig {
if (databasePath == null) return;
await IsolatedHive.init(
databasePath,
isolateNameServer: const FcmIsolateNameServer(),
);
if (isolated) {
await IsolatedHive.init(
databasePath,
isolateNameServer: const FcmIsolateNameServer(),
);
} else {
Hive.init(databasePath);
}
}
Future<void> onUpgradeDatabase(CachingManager cachingManager) async {
@@ -123,96 +130,130 @@ class HiveCacheConfig {
}
}
void _registerAdapter() {
void _registerAdapter({bool isolated = true}) {
registerCacheAdapter<MailboxCache>(
MailboxCacheAdapter(),
CachingConstants.MAILBOX_CACHE_IDENTIFY
CachingConstants.MAILBOX_CACHE_IDENTIFY,
isolated: isolated,
);
registerCacheAdapter<MailboxRightsCache>(
MailboxRightsCacheAdapter(),
CachingConstants.MAILBOX_RIGHTS_CACHE_IDENTIFY
CachingConstants.MAILBOX_RIGHTS_CACHE_IDENTIFY,
isolated: isolated,
);
registerCacheAdapter<StateCache>(
StateCacheAdapter(),
CachingConstants.STATE_CACHE_IDENTIFY
CachingConstants.STATE_CACHE_IDENTIFY,
isolated: isolated,
);
registerCacheAdapter<StateType>(
StateTypeAdapter(),
CachingConstants.STATE_TYPE_IDENTIFY
CachingConstants.STATE_TYPE_IDENTIFY,
isolated: isolated,
);
registerCacheAdapter<EmailAddressHiveCache>(
EmailAddressHiveCacheAdapter(),
CachingConstants.EMAIL_ADDRESS_HIVE_CACHE_IDENTIFY
CachingConstants.EMAIL_ADDRESS_HIVE_CACHE_IDENTIFY,
isolated: isolated,
);
registerCacheAdapter<EmailCache>(
EmailCacheAdapter(),
CachingConstants.EMAIL_CACHE_IDENTIFY
CachingConstants.EMAIL_CACHE_IDENTIFY,
isolated: isolated,
);
registerCacheAdapter<RecentSearchCache>(
RecentSearchCacheAdapter(),
CachingConstants.RECENT_SEARCH_HIVE_CACHE_IDENTIFY
CachingConstants.RECENT_SEARCH_HIVE_CACHE_IDENTIFY,
isolated: isolated,
);
registerCacheAdapter<TokenOidcCache>(
TokenOidcCacheAdapter(),
CachingConstants.TOKEN_OIDC_HIVE_CACHE_IDENTIFY
CachingConstants.TOKEN_OIDC_HIVE_CACHE_IDENTIFY,
isolated: isolated,
);
registerCacheAdapter<AccountCache>(
AccountCacheAdapter(),
CachingConstants.ACCOUNT_HIVE_CACHE_IDENTIFY
CachingConstants.ACCOUNT_HIVE_CACHE_IDENTIFY,
isolated: isolated,
);
registerCacheAdapter<EncryptionKeyCache>(
EncryptionKeyCacheAdapter(),
CachingConstants.ENCRYPTION_KEY_HIVE_CACHE_IDENTIFY
CachingConstants.ENCRYPTION_KEY_HIVE_CACHE_IDENTIFY,
isolated: isolated,
);
registerCacheAdapter<AuthenticationInfoCache>(
AuthenticationInfoCacheAdapter(),
CachingConstants.AUTHENTICATION_INFO_HIVE_CACHE_IDENTIFY
CachingConstants.AUTHENTICATION_INFO_HIVE_CACHE_IDENTIFY,
isolated: isolated,
);
registerCacheAdapter<RecentLoginUrlCache>(
RecentLoginUrlCacheAdapter(),
CachingConstants.RECENT_LOGIN_URL_HIVE_CACHE_IDENTITY
CachingConstants.RECENT_LOGIN_URL_HIVE_CACHE_IDENTITY,
isolated: isolated,
);
registerCacheAdapter<RecentLoginUsernameCache>(
RecentLoginUsernameCacheAdapter(),
CachingConstants.RECENT_LOGIN_USERNAME_HIVE_CACHE_IDENTITY
CachingConstants.RECENT_LOGIN_USERNAME_HIVE_CACHE_IDENTITY,
isolated: isolated,
);
registerCacheAdapter<FirebaseRegistrationCache>(
FirebaseRegistrationCacheAdapter(),
CachingConstants.FIREBASE_REGISTRATION_HIVE_CACHE_IDENTITY
CachingConstants.FIREBASE_REGISTRATION_HIVE_CACHE_IDENTITY,
isolated: isolated,
);
registerCacheAdapter<AttachmentHiveCache>(
AttachmentHiveCacheAdapter(),
CachingConstants.ATTACHMENT_HIVE_CACHE_ID
CachingConstants.ATTACHMENT_HIVE_CACHE_ID,
isolated: isolated,
);
registerCacheAdapter<EmailHeaderHiveCache>(
EmailHeaderHiveCacheAdapter(),
CachingConstants.EMAIL_HEADER_HIVE_CACHE_ID
CachingConstants.EMAIL_HEADER_HIVE_CACHE_ID,
isolated: isolated,
);
registerCacheAdapter<DetailedEmailHiveCache>(
DetailedEmailHiveCacheAdapter(),
CachingConstants.DETAILED_EMAIL_HIVE_CACHE_ID
CachingConstants.DETAILED_EMAIL_HIVE_CACHE_ID,
isolated: isolated,
);
registerCacheAdapter<SendingEmailHiveCache>(
SendingEmailHiveCacheAdapter(),
CachingConstants.SENDING_EMAIL_HIVE_CACHE_ID
CachingConstants.SENDING_EMAIL_HIVE_CACHE_ID,
isolated: isolated,
);
registerCacheAdapter<SessionHiveObj>(
SessionHiveObjAdapter(),
CachingConstants.SESSION_HIVE_CACHE_ID
CachingConstants.SESSION_HIVE_CACHE_ID,
isolated: isolated,
);
registerCacheAdapter<OidcConfigurationCache>(
OidcConfigurationCacheAdapter(),
CachingConstants.OIDC_CONFIGURATION_CACHE_ID,
isolated: isolated,
);
}
void registerCacheAdapter<T>(TypeAdapter<T> typeAdapter, int typeId) {
if (!IsolatedHive.isAdapterRegistered(typeId)) {
IsolatedHive.registerAdapter<T>(typeAdapter);
void registerCacheAdapter<T>(
TypeAdapter<T> typeAdapter,
int typeId, {
bool isolated = true,
}) {
if (isolated) {
if (!IsolatedHive.isAdapterRegistered(typeId)) {
IsolatedHive.registerAdapter<T>(typeAdapter);
}
} else {
if (!Hive.isAdapterRegistered(typeId)) {
Hive.registerAdapter<T>(typeAdapter);
}
}
}
Future<void> closeHive() async {
return await IsolatedHive.close();
Future<void> closeHive({bool isolated = true}) async {
if (isolated) {
await IsolatedHive.close();
} else {
await Hive.close();
}
}
}