InsanusMokrassar/tgbotapi
1
0
Fork 0
mirror of https://github.com/InsanusMokrassar/TelegramBotAPI.git synced 2025-09-03 23:29:33 +00:00
Code Releases Activity

add special error type for device and secure sorages

Browse Source
This commit is contained in:
InsanusMokrassar
2025-05-25 13:33:15 +06:00
parent 172f49fa6b
commit c13a0d3193
3 changed files with 57 additions and 29 deletions
Download Patch File Download Diff File Expand all files Collapse all files

38
tgbotapi.webapps/src/jsMain/kotlin/dev/inmo/tgbotapi/webapps/storage/DeviceStorage.kt
View File

@@ -16,7 +16,7 @@ external interface DeviceStorage {
* @param value The value to store.
* @param callback A callback function that is called when the operation is complete. The first argument is an error object, if any, and the second argument is a boolean indicating whether the operation was successful.
*/
fun setItem(key: String, value: String, callback: (Throwable?, Boolean?) -> Unit): DeviceStorage
fun setItem(key: String, value: String, callback: (DeviceStorageErrorMessage?, Boolean?) -> Unit): DeviceStorage
/**
* Retrieves the value associated with a key.
@@ -24,7 +24,7 @@ external interface DeviceStorage {
* @param key The key to retrieve the value for.
* @param callback A callback function that is called when the operation is complete. The first argument is an error object, if any, and the second argument is the value associated with the key, or null if the key is not found.
*/
fun getItem(key: String, callback: (Throwable?, String?) -> Unit): DeviceStorage
fun getItem(key: String, callback: (DeviceStorageErrorMessage?, String?) -> Unit): DeviceStorage
/**
* Removes the key-value pair associated with a key.
@@ -32,16 +32,30 @@ external interface DeviceStorage {
* @param key The key to remove.
* @param callback A callback function that is called when the operation is complete. The first argument is an error object, if any, and the second argument is a boolean indicating whether the operation was successful.
*/
fun removeItem(key: String, callback: (Throwable?, Boolean?) -> Unit): DeviceStorage
fun removeItem(key: String, callback: (DeviceStorageErrorMessage?, Boolean?) -> Unit): DeviceStorage
/**
* Clears all key-value pairs from the storage.
*
* @param callback A callback function that is called when the operation is complete. The first argument is an error object, if any, and the second argument is a boolean indicating whether the operation was successful.
*/
fun clear(callback: (Throwable?, Boolean?) -> Unit): DeviceStorage
fun clear(callback: (DeviceStorageErrorMessage?, Boolean?) -> Unit): DeviceStorage
}
/**
* This value class represent strongly-typed errors of [DeviceStorage] operations and required to separate it with string
* args
*/
value class DeviceStorageErrorMessage(val text: String) {
internal fun deviceStorageError() = DeviceStorageError(text)
}
/**
* This class will be used in [setWithResult] and other extensions for [DeviceStorage] to represent special error happen
* in operations of [DeviceStorage]
*/
class DeviceStorageError(message: String) : IllegalStateException(message)
/**
* Stores a key-value pair. This function uses a [CompletableDeferred] to handle the asynchronous callback and returns a [Result] object.
*
@@ -56,7 +70,7 @@ suspend fun DeviceStorage.setWithResult(key: String, value: String): Result<Bool
if (error == null) {
deferred.complete(Result.success(result ?: false))
} else {
deferred.complete(Result.failure(error))
deferred.complete(Result.failure(error.deviceStorageError()))
}
}
@@ -76,7 +90,7 @@ suspend fun DeviceStorage.getWithResult(key: String): Result<String?> {
if (error == null) {
deferred.complete(Result.success(result))
} else {
deferred.complete(Result.failure(error))
deferred.complete(Result.failure(error.deviceStorageError()))
}
}
@@ -96,7 +110,7 @@ suspend fun DeviceStorage.removeWithResult(key: String): Result<Boolean> {
if (error == null) {
deferred.complete(Result.success(result ?: false))
} else {
deferred.complete(Result.failure(error))
deferred.complete(Result.failure(error.deviceStorageError()))
}
}
@@ -115,7 +129,7 @@ suspend fun DeviceStorage.clearWithResult(): Result<Boolean> {
if (error == null) {
deferred.complete(Result.success(result ?: false))
} else {
deferred.complete(Result.failure(error))
deferred.complete(Result.failure(error.deviceStorageError()))
}
}
@@ -128,7 +142,7 @@ suspend fun DeviceStorage.clearWithResult(): Result<Boolean> {
* @param key The key to store the value under.
* @param value The value to store.
* @return Boolean indicating whether the operation was successful.
* @throws Throwable If an error occurs during the operation.
* @throws DeviceStorageError If an error occurs during the operation.
*/
suspend fun DeviceStorage.setItem(key: String, value: String): Boolean {
return setWithResult(key, value).getOrThrow()
@@ -139,7 +153,7 @@ suspend fun DeviceStorage.setItem(key: String, value: String): Boolean {
*
* @param key The key to retrieve the value for.
* @return The value associated with the key, or null if the key is not found.
* @throws Throwable If an error occurs during the operation.
* @throws IllegalStateException If an error occurs during the operation.
*/
suspend fun DeviceStorage.getItem(key: String): String? {
return getWithResult(key).getOrThrow()
@@ -150,7 +164,7 @@ suspend fun DeviceStorage.getItem(key: String): String? {
*
* @param key The key to remove.
* @return Boolean indicating whether the operation was successful.
* @throws Throwable If an error occurs during the operation.
* @throws DeviceStorageError If an error occurs during the operation.
*/
suspend fun DeviceStorage.removeItem(key: String): Boolean {
return removeWithResult(key).getOrThrow()
@@ -160,7 +174,7 @@ suspend fun DeviceStorage.removeItem(key: String): Boolean {
* Clears all key-value pairs from the storage. This function suspends until the result is available and returns the result directly or throws an exception if an error occurred.
*
* @return Boolean indicating whether the operation was successful.
* @throws Throwable If an error occurs during the operation.
* @throws DeviceStorageError If an error occurs during the operation.
*/
suspend fun DeviceStorage.clear(): Boolean {
return clearWithResult().getOrThrow()

46
tgbotapi.webapps/src/jsMain/kotlin/dev/inmo/tgbotapi/webapps/storage/SecureStorage.kt
View File

@@ -27,7 +27,7 @@ external class SecureStorage {
* The first argument is an error object, if any, and the second argument is a boolean
* indicating whether the operation was successful.
*/
fun setItem(key: String, value: String, callback: (error: Throwable?, isSuccessful: Boolean) -> Unit)
fun setItem(key: String, value: String, callback: (error: SecureStorageErrorMessage?, isSuccessful: Boolean) -> Unit)
/**
* Retrieves the value associated with a key from secure storage.
@@ -38,7 +38,7 @@ external class SecureStorage {
* associated with the key, or null if the key is not found, and the third argument
* indicates whether the value can be restored.
*/
fun getItem(key: String, callback: (error: Throwable?, value: String?, canBeRestored: Boolean?) -> Unit)
fun getItem(key: String, callback: (error: SecureStorageErrorMessage?, value: String?, canBeRestored: Boolean?) -> Unit)
/**
* Restores the value associated with a key in secure storage. This is useful if the
@@ -51,7 +51,7 @@ external class SecureStorage {
* The first argument is an error object, if any, and the second argument is the restored
* value, or null if the key is not found or cannot be restored.
*/
fun restoreItem(key: String, callback: (error: Throwable?, value: String?) -> Unit)
fun restoreItem(key: String, callback: (error: SecureStorageErrorMessage?, value: String?) -> Unit)
/**
* Removes the key-value pair associated with a key from secure storage.
@@ -61,7 +61,7 @@ external class SecureStorage {
* The first argument is an error object, if any, and the second argument is a boolean
* indicating whether the operation was successful.
*/
fun removeItem(key: String, callback: (error: Throwable?, isSuccessful: Boolean) -> Unit)
fun removeItem(key: String, callback: (error: SecureStorageErrorMessage?, isSuccessful: Boolean) -> Unit)
/**
* Clears all key-value pairs from the secure storage.
@@ -70,9 +70,23 @@ external class SecureStorage {
* The first argument is an error object, if any, and the second argument is a boolean
* indicating whether the operation was successful.
*/
fun clear(callback: (error: Throwable?, isSuccessful: Boolean) -> Unit)
fun clear(callback: (error: SecureStorageErrorMessage?, isSuccessful: Boolean) -> Unit)
}
/**
* This value class represent strongly-typed errors of [DeviceStorage] operations and required to separate it with string
* args
*/
value class SecureStorageErrorMessage(val text: String) {
internal fun secureStorageError() = SecureStorageError(text)
}
/**
* This class will be used in [setWithResult] and other extensions for [DeviceStorage] to represent special error happen
* in operations of [DeviceStorage]
*/
class SecureStorageError(message: String) : IllegalStateException(message)
/**
* Stores a key-value pair in secure storage using a [CompletableDeferred] and returns a [Result].
*
@@ -86,7 +100,7 @@ suspend fun SecureStorage.setWithResult(key: String, value: String): Result<Bool
if (error == null) {
deferred.complete(Result.success(isSuccessful))
} else {
deferred.complete(Result.failure(error))
deferred.complete(Result.failure(error.secureStorageError()))
}
}
return deferred.await()
@@ -100,13 +114,13 @@ suspend fun SecureStorage.setWithResult(key: String, value: String): Result<Bool
*
* @param key The key to retrieve the value for.
* @return A [Result] object containing the retrieved value (which can be null if the key is not found)
* or a [Throwable] representing the error that occurred.
* or a [SecureStorageError] representing the error that occurred.
*/
suspend fun SecureStorage.getWithResult(key: String): Result<Either<String?, Boolean>> {
val deferred = CompletableDeferred<Result<Either<String?, Boolean>>>()
getItem(key) { error, value, canBeRestored ->
when {
error != null -> deferred.complete(Result.failure(error))
error != null -> deferred.complete(Result.failure(error.secureStorageError()))
value != null -> deferred.complete(Result.success(value.either()))
else -> deferred.complete(Result.success((canBeRestored == true).either()))
}
@@ -126,7 +140,7 @@ suspend fun SecureStorage.restoreWithResult(key: String): Result<String?> {
if (error == null) {
deferred.complete(Result.success(value))
} else {
deferred.complete(Result.failure(error))
deferred.complete(Result.failure(error.secureStorageError()))
}
}
return deferred.await()
@@ -144,7 +158,7 @@ suspend fun SecureStorage.removeWithResult(key: String): Result<Boolean> {
if (error == null) {
deferred.complete(Result.success(isSuccessful))
} else {
deferred.complete(Result.failure(error))
deferred.complete(Result.failure(error.secureStorageError()))
}
}
return deferred.await()
@@ -161,7 +175,7 @@ suspend fun SecureStorage.clearWithResult(): Result<Boolean> {
if (error == null) {
deferred.complete(Result.success(isSuccessful))
} else {
deferred.complete(Result.failure(error))
deferred.complete(Result.failure(error.secureStorageError()))
}
}
return deferred.await()
@@ -174,7 +188,7 @@ suspend fun SecureStorage.clearWithResult(): Result<Boolean> {
* @param key The key to store the value under.
* @param value The value to store.
* @return True if the operation was successful.
* @throws Throwable If an error occurs during the operation.
* @throws SecureStorageError If an error occurs during the operation.
*/
suspend fun SecureStorage.setItem(key: String, value: String): Boolean {
return setWithResult(key, value).getOrThrow()
@@ -185,7 +199,7 @@ suspend fun SecureStorage.setItem(key: String, value: String): Boolean {
*
* @param key The key to retrieve the value for.
* @param callback A callback function that is called when the operation is complete.
* The first argument is an error object (a [Throwable] if an error occurred, or null otherwise),
* The first argument is an error object (a [SecureStorageError] if an error occurred, or null otherwise),
* the second argument is the retrieved value (a [String] or null if the key is not found),
* and the third argument is a boolean indicating whether the value can be restored
* (useful if the value was previously removed and might be restorable).
@@ -201,7 +215,7 @@ suspend fun SecureStorage.getItem(key: String): Either<String?, Boolean> {
*
* @param key The key to restore the value for.
* @return The restored value, or null if the key is not found or cannot be restored.
* @throws Throwable If an error occurs during the operation.
* @throws SecureStorageError If an error occurs during the operation.
*/
suspend fun SecureStorage.restoreItem(key: String): String? {
return restoreWithResult(key).getOrThrow()
@@ -213,7 +227,7 @@ suspend fun SecureStorage.restoreItem(key: String): String? {
*
* @param key The key to remove.
* @return True if the operation was successful.
* @throws Throwable If an error occurs during the operation.
* @throws SecureStorageError If an error occurs during the operation.
*/
suspend fun SecureStorage.removeItem(key: String): Boolean {
return removeWithResult(key).getOrThrow()
@@ -224,7 +238,7 @@ suspend fun SecureStorage.removeItem(key: String): Boolean {
* directly and throws an exception if an error occurs.
*
* @return True if the operation was successful.
* @throws Throwable If an error occurs during the operation.
* @throws SecureStorageError If an error occurs during the operation.
*/
suspend fun SecureStorage.clear(): Boolean {
return clearWithResult().getOrThrow()