Merge branch 'hailey/shared-preferences' into hailey/decrement-badge

This commit is contained in:
Hailey
2024-07-01 18:40:25 -07:00
8 changed files with 297 additions and 104 deletions
@@ -16,22 +16,20 @@ class ExpoBlueskySharedPrefsModule : Module() {
override fun definition() = ModuleDefinition { override fun definition() = ModuleDefinition {
Name("ExpoBlueskySharedPrefs") Name("ExpoBlueskySharedPrefs")
AsyncFunction("setStringAsync") { key: String, value: String -> Function("setString") { key: String, value: String ->
return@AsyncFunction Preferences(getContext()).setValue(key, value) return@Function SharedPrefs(getContext()).setValue(key, value)
} }
AsyncFunction("setValueAsync") { key: String, value: JavaScriptValue, promise: Promise -> Function("setValue") { key: String, value: JavaScriptValue ->
val context = getContext() val context = getContext()
Log.d("ExpoBlueskySharedPrefs", "Setting value for key: $key")
try { try {
if (value.isNumber()) { if (value.isNumber()) {
Preferences(context).setValue(key, value.getFloat()) SharedPrefs(context).setValue(key, value.getFloat())
promise.resolve()
} else if (value.isBool()) { } else if (value.isBool()) {
Preferences(context).setValue(key, value.getBool()) SharedPrefs(context).setValue(key, value.getBool())
promise.resolve()
} else if (value.isNull() || value.isUndefined()) { } else if (value.isNull() || value.isUndefined()) {
Preferences(context).removeValue(key) SharedPrefs(context).removeValue(key)
promise.resolve()
} else { } else {
Log.d(NAME, "Unsupported type: ${value.kind()}") Log.d(NAME, "Unsupported type: ${value.kind()}")
promise.reject("UNSUPPORTED_TYPE_ERROR", "Attempted to set an unsupported type", null) promise.reject("UNSUPPORTED_TYPE_ERROR", "Attempted to set an unsupported type", null)
@@ -42,32 +40,32 @@ class ExpoBlueskySharedPrefsModule : Module() {
} }
} }
AsyncFunction("removeValueAsync") { key: String -> Function("removeValue") { key: String ->
return@AsyncFunction Preferences(getContext()).removeValue(key) return@Function SharedPrefs(getContext()).removeValue(key)
} }
AsyncFunction("getStringAsync") { key: String -> Function("getString") { key: String ->
return@AsyncFunction Preferences(getContext()).getString(key) return@Function SharedPrefs(getContext()).getString(key)
} }
AsyncFunction("getNumberAsync") { key: String -> Function("getNumber") { key: String ->
return@AsyncFunction Preferences(getContext()).getFloat(key) return@Function SharedPrefs(getContext()).getFloat(key)
} }
AsyncFunction("getBoolAsync") { key: String -> Function("getBool") { key: String ->
return@AsyncFunction Preferences(getContext()).getBoolean(key) return@Function SharedPrefs(getContext()).getBoolean(key)
} }
AsyncFunction("addToSetAsync") { key: String, value: String -> Function("addToSet") { key: String, value: String ->
return@AsyncFunction Preferences(getContext()).addToSet(key, value) return@Function SharedPrefs(getContext()).addToSet(key, value)
} }
AsyncFunction("removeFromSetAsync") { key: String, value: String -> Function("removeFromSet") { key: String, value: String ->
return@AsyncFunction Preferences(getContext()).removeFromSet(key, value) return@Function SharedPrefs(getContext()).removeFromSet(key, value)
} }
AsyncFunction("setContainsAsync") { key: String, value: String -> Function("setContains") { key: String, value: String ->
return@AsyncFunction Preferences(getContext()).setContains(key, value) return@Function SharedPrefs(getContext()).setContains(key, value)
} }
} }
} }
@@ -0,0 +1,193 @@
package expo.modules.blueskyswissarmy.sharedprefs
import android.content.Context
import android.content.SharedPreferences
import android.util.Log
val DEFAULTS = mapOf<String, Any>(
"playSoundChat" to true,
"playSoundFollow" to false,
"playSoundLike" to false,
"playSoundMention" to false,
"playSoundQuote" to false,
"playSoundReply" to false,
"playSoundRepost" to false,
"badgeCount" to 0,
)
const val NAME = "SharedPrefs"
class SharedPrefs(private val context: Context) {
companion object {
private var hasInitialized = false
private var instance: SharedPreferences? = null
fun getInstance(context: Context, info: String? = "(no info)"): SharedPreferences {
if (instance == null) {
Log.d(NAME, "No preferences instance found, creating one.")
instance = context.getSharedPreferences("xyz.blueskyweb.app", Context.MODE_PRIVATE)
}
val safeInstance = instance ?: throw Error("Preferences is null: $info")
if (!hasInitialized) {
Log.d(NAME, "Preferences instance has not been initialized yet.")
initialize(safeInstance)
hasInitialized = true
Log.d(NAME, "Preferences instance has been initialized.")
}
return safeInstance
}
private fun initialize(instance: SharedPreferences) {
instance
.edit()
.apply {
DEFAULTS.forEach { (key, value) ->
if (instance.contains(key)) {
return@forEach
}
when (value) {
is Boolean -> {
putBoolean(key, value)
}
is String -> {
putString(key, value)
}
is Array<*> -> {
putStringSet(key, value.map { it.toString() }.toSet())
}
is Map<*, *> -> {
putStringSet(key, value.map { it.toString() }.toSet())
}
}
}
}
.apply()
}
}
fun setValue(key: String, value: String) {
val safeInstance = getInstance(context)
safeInstance.edit().apply {
putString(key, value)
}.apply()
}
fun setValue(key: String, value: Float) {
val safeInstance = getInstance(context)
safeInstance.edit().apply {
putFloat(key, value)
}.apply()
}
fun setValue(key: String, value: Boolean) {
val safeInstance = getInstance(context)
safeInstance.edit().apply {
putBoolean(key, value)
}.apply()
}
fun setValue(key: String, value: Set<String>) {
val safeInstance = getInstance(context)
safeInstance.edit().apply {
putStringSet(key, value)
}.apply()
}
fun removeValue(key: String) {
val safeInstance = getInstance(context)
safeInstance.edit().apply {
remove(key)
}.apply()
}
fun getString(key: String): String? {
val safeInstance = getInstance(context)
return safeInstance.getString(key, null)
}
fun getFloat(key: String): Float? {
val safeInstance = getInstance(context)
if (!safeInstance.contains(key)) {
return null
}
return safeInstance.getFloat(key, 0.0f)
}
fun _setAnyValue(key: String, value: Any) {
val safeInstance = getInstance(context)
safeInstance.edit().apply {
when (value) {
is String -> putString(key, value)
is Float -> putFloat(key, value)
is Boolean -> putBoolean(key, value)
is Set<*> -> putStringSet(key, value.map { it.toString() }.toSet())
else -> throw Error("Unsupported type: ${value::class.java}")
}
}.apply()
}
fun getBoolean(key: String): Boolean? {
val safeInstance = getInstance(context)
if (!safeInstance.contains(key)) {
return null
}
Log.d(NAME, "Getting boolean for key: $key")
val res = safeInstance.getBoolean(key, false)
Log.d(NAME, "Got boolean for key: $key, value: $res")
return res
}
fun addToSet(key: String, value: String) {
val safeInstance = getInstance(context)
val set = safeInstance.getStringSet(key, setOf()) ?: setOf()
val newSet = set.toMutableSet().apply {
add(value)
}
safeInstance.edit().apply {
putStringSet(key, newSet)
}.apply()
}
fun removeFromSet(key: String, value: String) {
val safeInstance = getInstance(context)
val set = safeInstance.getStringSet(key, setOf()) ?: setOf()
val newSet = set.toMutableSet().apply {
remove(value)
}
safeInstance.edit().apply {
putStringSet(key, newSet)
}.apply()
}
fun setContains(key: String, value: String): Boolean {
val safeInstance = getInstance(context)
val set = safeInstance.getStringSet(key, setOf()) ?: setOf()
return set.contains(value)
}
fun hasValue(key: String): Boolean {
val safeInstance = getInstance(context)
return safeInstance.contains(key)
}
fun getValues(keys: Set<String>): Map<String, Any?> {
val safeInstance = getInstance(context)
return keys.associateWith { key ->
when (val value = safeInstance.all[key]) {
is String -> value
is Float -> value
is Boolean -> value
is Set<*> -> value
else -> null
}
}
}
}
@@ -15,45 +15,47 @@ public class ExpoBlueskySharedPrefsModule: Module {
public func definition() -> ModuleDefinition { public func definition() -> ModuleDefinition {
Name("ExpoBlueskySharedPrefs") Name("ExpoBlueskySharedPrefs")
AsyncFunction("setValueAsync") { (key: String, value: JavaScriptValue, promise: Promise) in // JavaScripValue causes a crash when trying to check `isString()`. Let's
if value.isString() { // explicitly define setString instead.
SharedPrefs.shared.setValue(key, value.getString()) Function("setString") { (key: String, value: String?) in
} else if value.isNumber() { SharedPrefs.shared.setValue(key, value)
}
Function("setValue") { (key: String, value: JavaScriptValue) in
if value.isNumber() {
SharedPrefs.shared.setValue(key, value.getDouble()) SharedPrefs.shared.setValue(key, value.getDouble())
} else if value.isBool() { } else if value.isBool() {
SharedPrefs.shared.setValue(key, value.getBool()) SharedPrefs.shared.setValue(key, value.getBool())
} else if value.isNull() || value.isUndefined() { } else if value.isNull() || value.isUndefined() {
SharedPrefs.shared.removeValue(key) SharedPrefs.shared.removeValue(key)
} else {
promise.reject("UNSUPPORTED_TYPE_ERROR", "Attempted to set an unsupported type")
} }
} }
AsyncFunction("removeValueAsync") { (key: String) in Function("removeValue") { (key: String) in
SharedPrefs.shared.removeValue(key) SharedPrefs.shared.removeValue(key)
} }
AsyncFunction("getStringAsync") { (key: String) in Function("getString") { (key: String) in
return SharedPrefs.shared.getString(key) return SharedPrefs.shared.getString(key)
} }
AsyncFunction("getBoolAsync") { (key: String) in Function("getBool") { (key: String) in
return SharedPrefs.shared.getBool(key) return SharedPrefs.shared.getBool(key)
} }
AsyncFunction("getNumberAsync") { (key: String) in Function("getNumber") { (key: String) in
return SharedPrefs.shared.getNumber(key) return SharedPrefs.shared.getNumber(key)
} }
AsyncFunction("addToSetAsync") { (key: String, value: String) in Function("addToSet") { (key: String, value: String) in
SharedPrefs.shared.addToSet(key, value) SharedPrefs.shared.addToSet(key, value)
} }
AsyncFunction("removeFromSetAsync") { (key: String, value: String) in Function("removeFromSet") { (key: String, value: String) in
SharedPrefs.shared.removeFromSet(key, value) SharedPrefs.shared.removeFromSet(key, value)
} }
AsyncFunction("setContainsAsync") { (key: String, value: String) in Function("setContains") { (key: String, value: String) in
return SharedPrefs.shared.setContains(key, value) return SharedPrefs.shared.setContains(key, value)
} }
} }
@@ -52,20 +52,20 @@ public class SharedPrefs {
} }
public func addToSet(_ key: String, _ value: String) { public func addToSet(_ key: String, _ value: String) {
var dict: [String:Bool]? var dict: [String: Bool]?
if var currDict = getDefaults(key)?.dictionary(forKey: key) as? [String:Bool] { if var currDict = getDefaults(key)?.dictionary(forKey: key) as? [String: Bool] {
currDict[value] = true currDict[value] = true
dict = currDict dict = currDict
} else { } else {
dict = [ dict = [
value : true value: true
] ]
} }
getDefaults(key)?.setValue(dict, forKey: key) getDefaults(key)?.setValue(dict, forKey: key)
} }
public func removeFromSet(_ key: String, _ value: String) { public func removeFromSet(_ key: String, _ value: String) {
guard var dict = getDefaults(key)?.dictionary(forKey: key) as? [String:Bool] else { guard var dict = getDefaults(key)?.dictionary(forKey: key) as? [String: Bool] else {
return return
} }
dict.removeValue(forKey: value) dict.removeValue(forKey: value)
@@ -73,7 +73,7 @@ public class SharedPrefs {
} }
public func setContains(_ key: String, _ value: String) -> Bool { public func setContains(_ key: String, _ value: String) -> Bool {
guard let dict = getDefaults(key)?.dictionary(forKey: key) as? [String:Bool] else { guard let dict = getDefaults(key)?.dictionary(forKey: key) as? [String: Bool] else {
return false return false
} }
return dict[value] == true return dict[value] == true
@@ -83,7 +83,7 @@ public class SharedPrefs {
return getDefaults(key)?.value(forKey: key) != nil return getDefaults(key)?.value(forKey: key) != nil
} }
public func getValues(_ keys: [String]) -> [String:Any?]? { public func getValues(_ keys: [String]) -> [String: Any?]? {
return getDefaults("keys:\(keys)")?.dictionaryWithValues(forKeys: keys) return getDefaults("keys:\(keys)")?.dictionaryWithValues(forKeys: keys)
} }
} }
@@ -1,44 +1,50 @@
import {Platform} from 'react-native'
import {requireNativeModule} from 'expo-modules-core' import {requireNativeModule} from 'expo-modules-core'
const NativeModule = requireNativeModule('ExpoBlueskySharedPrefs') const NativeModule = requireNativeModule('ExpoBlueskySharedPrefs')
export function setValueAsync( export function setValue(
key: string, key: string,
value: string | number | boolean | null | undefined, value: string | number | boolean | null | undefined,
): Promise<void> { ): void {
// A bug on Android causes `JavaScripValue.isString()` to cause a crash on some occasions, seemingly because of a // A bug on Android causes `JavaScripValue.isString()` to cause a crash on some occasions, seemingly because of a
// memory violation. Instead, we will use a specific function to set strings on this platform. // memory violation. Instead, we will use a specific function to set strings on this platform.
if (Platform.OS === 'android' && typeof value === 'string') { if (typeof value === 'string') {
return NativeModule.setStringAsync(key, value) return NativeModule.setString(key, value)
} }
return NativeModule.setValueAsync(key, value) return NativeModule.setValue(key, value)
} }
export function removeValueAsync(key: string): Promise<void> { export function removeValue(key: string): void {
return NativeModule.removeValueAsync(key) return NativeModule.removeValue(key)
} }
export function getStringAsync(key: string): Promise<string | null> { export function getString(key: string): string | undefined {
return NativeModule.getStringAsync(key) return nullToUndefined(NativeModule.getString(key))
} }
export function getNumberAsync(key: string): Promise<number | null> { export function getNumber(key: string): number | undefined {
return NativeModule.getNumberAsync(key) return nullToUndefined(NativeModule.getNumber(key))
} }
export function getBoolAsync(key: string): Promise<boolean | null> { export function getBool(key: string): boolean | undefined {
return NativeModule.getBoolAsync(key) return nullToUndefined(NativeModule.getBool(key))
} }
export function addToSetAsync(key: string, value: string): Promise<void> { export function addToSet(key: string, value: string): void {
return NativeModule.addToSetAsync(key, value) return NativeModule.addToSet(key, value)
} }
export function removeFromSetAsync(key: string, value: string): Promise<void> { export function removeFromSet(key: string, value: string): void {
return NativeModule.removeFromSetAsync(key, value) return NativeModule.removeFromSet(key, value)
} }
export function setContainsAsync(key: string, value: string): Promise<boolean> { export function setContains(key: string, value: string): boolean {
return NativeModule.setContainsAsync(key, value) return NativeModule.setContains(key, value)
}
// iOS returns `null` if a value does not exist, and Android returns `undefined. Normalize these here for JS types
function nullToUndefined(value: any) {
if (value === null) {
return undefined
}
} }
@@ -1,36 +1,36 @@
import {NotImplementedError} from '../NotImplemented' import {NotImplementedError} from '../NotImplemented'
export function setValueAsync( export function setValue(
key: string, key: string,
value: string | number | boolean | null | undefined, value: string | number | boolean | null | undefined,
): Promise<void> { ): void {
throw new NotImplementedError({key, value}) throw new NotImplementedError({key, value})
} }
export function removeValueAsync(key: string): Promise<void> { export function removeValue(key: string): void {
throw new NotImplementedError({key}) throw new NotImplementedError({key})
} }
export function getStringAsync(key: string): Promise<string | null> { export function getString(key: string): string | null {
throw new NotImplementedError({key}) throw new NotImplementedError({key})
} }
export function getNumberAsync(key: string): Promise<number | null> { export function getNumber(key: string): number | null {
throw new NotImplementedError({key}) throw new NotImplementedError({key})
} }
export function getBoolAsync(key: string): Promise<boolean | null> { export function getBool(key: string): boolean | null {
throw new NotImplementedError({key}) throw new NotImplementedError({key})
} }
export function addToSetAsync(key: string, value: string): Promise<void> { export function addToSet(key: string, value: string): void {
throw new NotImplementedError({key, value}) throw new NotImplementedError({key, value})
} }
export function removeFromSetAsync(key: string, value: string): Promise<void> { export function removeFromSet(key: string, value: string): void {
throw new NotImplementedError({key, value}) throw new NotImplementedError({key, value})
} }
export function setContainsAsync(key: string, value: string): Promise<boolean> { export function setContains(key: string, value: string): boolean {
throw new NotImplementedError({key, value}) throw new NotImplementedError({key, value})
} }
@@ -39,11 +39,10 @@ export function useStarterPackEntry() {
uri = createStarterPackLinkFromAndroidReferrer(res.installReferrer) uri = createStarterPackLinkFromAndroidReferrer(res.installReferrer)
} }
} else { } else {
const res = await SharedPrefs.getStringAsync('starterPackUri') const starterPackUri = SharedPrefs.getString('starterPackUri')
if (starterPackUri) {
if (res) { uri = httpStarterPackUriToAtUri(starterPackUri)
uri = httpStarterPackUriToAtUri(res) SharedPrefs.setValue('starterPackUri', null)
SharedPrefs.setValueAsync('starterPackUri', null)
} }
} }
@@ -25,10 +25,11 @@ export function SharedPreferencesTesterScreen() {
color="primary" color="primary"
size="xsmall" size="xsmall"
onPress={async () => { onPress={async () => {
await SharedPrefs.removeValueAsync('testerString') SharedPrefs.removeValue('testerString')
await SharedPrefs.setValueAsync('testerString', 'Hello') SharedPrefs.setValue('testerString', 'Hello')
const res = await SharedPrefs.getStringAsync('testerString') const str = SharedPrefs.getString('testerString')
setCurrentTestOutput(`${res}`) console.log(JSON.stringify(str))
setCurrentTestOutput(`${str}`)
}}> }}>
<ButtonText>Set String</ButtonText> <ButtonText>Set String</ButtonText>
</Button> </Button>
@@ -40,9 +41,9 @@ export function SharedPreferencesTesterScreen() {
color="primary" color="primary"
size="xsmall" size="xsmall"
onPress={async () => { onPress={async () => {
await SharedPrefs.removeValueAsync('testerString') SharedPrefs.removeValue('testerString')
const res = await SharedPrefs.getStringAsync('testerString') const str = SharedPrefs.getString('testerString')
setCurrentTestOutput(`${res}`) setCurrentTestOutput(`${str}`)
}}> }}>
<ButtonText>Remove String</ButtonText> <ButtonText>Remove String</ButtonText>
</Button> </Button>
@@ -54,10 +55,10 @@ export function SharedPreferencesTesterScreen() {
color="primary" color="primary"
size="xsmall" size="xsmall"
onPress={async () => { onPress={async () => {
await SharedPrefs.removeValueAsync('testerBool') SharedPrefs.removeValue('testerBool')
await SharedPrefs.setValueAsync('testerBool', true) SharedPrefs.setValue('testerBool', true)
const res = await SharedPrefs.getBoolAsync('testerBool') const bool = SharedPrefs.getBool('testerBool')
setCurrentTestOutput(`${res}`) setCurrentTestOutput(`${bool}`)
}}> }}>
<ButtonText>Set Bool</ButtonText> <ButtonText>Set Bool</ButtonText>
</Button> </Button>
@@ -69,10 +70,10 @@ export function SharedPreferencesTesterScreen() {
color="primary" color="primary"
size="xsmall" size="xsmall"
onPress={async () => { onPress={async () => {
await SharedPrefs.removeValueAsync('testerNumber') SharedPrefs.removeValue('testerNumber')
await SharedPrefs.setValueAsync('testerNumber', 123) SharedPrefs.setValue('testerNumber', 123)
const res = await SharedPrefs.getNumberAsync('testerNumber') const num = SharedPrefs.getNumber('testerNumber')
setCurrentTestOutput(`${res}`) setCurrentTestOutput(`${num}`)
}}> }}>
<ButtonText>Set Number</ButtonText> <ButtonText>Set Number</ButtonText>
</Button> </Button>
@@ -84,13 +85,10 @@ export function SharedPreferencesTesterScreen() {
color="primary" color="primary"
size="xsmall" size="xsmall"
onPress={async () => { onPress={async () => {
await SharedPrefs.removeFromSetAsync('testerSet', 'Hello!') SharedPrefs.removeFromSet('testerSet', 'Hello!')
await SharedPrefs.addToSetAsync('testerSet', 'Hello!') SharedPrefs.addToSet('testerSet', 'Hello!')
const res = await SharedPrefs.setContainsAsync( const contains = SharedPrefs.setContains('testerSet', 'Hello!')
'testerSet', setCurrentTestOutput(`${contains}`)
'Hello!',
)
setCurrentTestOutput(`${res}`)
}}> }}>
<ButtonText>Add to Set</ButtonText> <ButtonText>Add to Set</ButtonText>
</Button> </Button>
@@ -102,12 +100,9 @@ export function SharedPreferencesTesterScreen() {
color="primary" color="primary"
size="xsmall" size="xsmall"
onPress={async () => { onPress={async () => {
await SharedPrefs.removeFromSetAsync('testerSet', 'Hello!') SharedPrefs.removeFromSet('testerSet', 'Hello!')
const res = await SharedPrefs.setContainsAsync( const contains = SharedPrefs.setContains('testerSet', 'Hello!')
'testerSet', setCurrentTestOutput(`${contains}`)
'Hello!',
)
setCurrentTestOutput(`${res}`)
}}> }}>
<ButtonText>Remove from Set</ButtonText> <ButtonText>Remove from Set</ButtonText>
</Button> </Button>