The Android and iOS support introduced on #1011 is not really supported - the Tauri path API correctly resolves the cache directory on mobile, and we can access those directly using Rust code. This is a breaking change because we no longer uses the same directory to store the files - app_cache_dir returns a different locationpull/1383/head
Lucas Fernandes Nogueira
9 months ago
committed by
GitHub
parent
0d5e7e2892
commit
0c040bcc9a
@ -0,0 +1,5 @@
|
||||
---
|
||||
"store": patch:breaking
|
||||
---
|
||||
|
||||
Implement mobile support in Rust directly. This changes the store directories, invalidating all previously generated stores.
|
||||
@ -0,0 +1,55 @@
|
||||
<script>
|
||||
import { Store } from "@tauri-apps/plugin-store";
|
||||
import { onMount } from "svelte";
|
||||
|
||||
export let onMessage;
|
||||
|
||||
let key;
|
||||
let value;
|
||||
|
||||
const store = new Store("cache.json");
|
||||
let cache = {};
|
||||
|
||||
onMount(async () => {
|
||||
await store.load();
|
||||
const values = await store.entries();
|
||||
for (const [key, value] of values) {
|
||||
cache[key] = value;
|
||||
}
|
||||
cache = cache;
|
||||
});
|
||||
|
||||
function write(key, value) {
|
||||
store
|
||||
.set(key, value)
|
||||
.then(() => store.get(key))
|
||||
.then((v) => {
|
||||
cache[key] = v;
|
||||
cache = cache;
|
||||
})
|
||||
.then(() => store.save())
|
||||
.catch(onMessage);
|
||||
}
|
||||
</script>
|
||||
|
||||
<div class="flex flex-col childre:grow gap-1">
|
||||
<div class="flex flex-col flex-row-md gap-4">
|
||||
<div class="flex items-center gap-1">
|
||||
Key:
|
||||
<input class="grow input" bind:value={key} />
|
||||
</div>
|
||||
|
||||
<div class="flex items-center gap-1">
|
||||
Value:
|
||||
<input class="grow input" bind:value />
|
||||
</div>
|
||||
|
||||
<button class="btn" on:click={() => write(key, value)}> Write </button>
|
||||
</div>
|
||||
|
||||
<div>
|
||||
{#each Object.entries(cache) as [k, v]}
|
||||
<div>{k} = {v}</div>
|
||||
{/each}
|
||||
</div>
|
||||
</div>
|
||||
@ -1,2 +0,0 @@
|
||||
/build
|
||||
/.tauri
|
||||
@ -1,39 +0,0 @@
|
||||
plugins {
|
||||
id("com.android.library")
|
||||
id("org.jetbrains.kotlin.android")
|
||||
}
|
||||
|
||||
android {
|
||||
namespace = "app.tauri.store"
|
||||
compileSdk = 34
|
||||
|
||||
defaultConfig {
|
||||
minSdk = 24
|
||||
|
||||
testInstrumentationRunner = "androidx.test.runner.AndroidJUnitRunner"
|
||||
consumerProguardFiles("consumer-rules.pro")
|
||||
}
|
||||
|
||||
buildTypes {
|
||||
release {
|
||||
isMinifyEnabled = false
|
||||
proguardFiles(
|
||||
getDefaultProguardFile("proguard-android-optimize.txt"),
|
||||
"proguard-rules.pro"
|
||||
)
|
||||
}
|
||||
}
|
||||
compileOptions {
|
||||
sourceCompatibility = JavaVersion.VERSION_1_8
|
||||
targetCompatibility = JavaVersion.VERSION_1_8
|
||||
}
|
||||
kotlinOptions {
|
||||
jvmTarget = "1.8"
|
||||
}
|
||||
}
|
||||
|
||||
dependencies {
|
||||
implementation("androidx.core:core-ktx:1.9.0")
|
||||
implementation("com.fasterxml.jackson.core:jackson-databind:2.15.3")
|
||||
implementation(project(":tauri-android"))
|
||||
}
|
||||
@ -1,21 +0,0 @@
|
||||
# Add project specific ProGuard rules here.
|
||||
# You can control the set of applied configuration files using the
|
||||
# proguardFiles setting in build.gradle.
|
||||
#
|
||||
# For more details, see
|
||||
# http://developer.android.com/guide/developing/tools/proguard.html
|
||||
|
||||
# If your project uses WebView with JS, uncomment the following
|
||||
# and specify the fully qualified class name to the JavaScript interface
|
||||
# class:
|
||||
#-keepclassmembers class fqcn.of.javascript.interface.for.webview {
|
||||
# public *;
|
||||
#}
|
||||
|
||||
# Uncomment this to preserve the line number information for
|
||||
# debugging stack traces.
|
||||
#-keepattributes SourceFile,LineNumberTable
|
||||
|
||||
# If you keep the line number information, uncomment this to
|
||||
# hide the original source file name.
|
||||
#-renamesourcefileattribute SourceFile
|
||||
@ -1,2 +0,0 @@
|
||||
include ':tauri-android'
|
||||
project(':tauri-android').projectDir = new File('./.tauri/tauri-api')
|
||||
@ -1,3 +0,0 @@
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<manifest xmlns:android="http://schemas.android.com/apk/res/android">
|
||||
</manifest>
|
||||
@ -1,50 +0,0 @@
|
||||
// Copyright 2019-2023 Tauri Programme within The Commons Conservancy
|
||||
// SPDX-License-Identifier: Apache-2.0
|
||||
// SPDX-License-Identifier: MIT
|
||||
|
||||
package app.tauri.store
|
||||
|
||||
import android.app.Activity
|
||||
import app.tauri.annotation.Command
|
||||
import app.tauri.annotation.TauriPlugin
|
||||
import app.tauri.plugin.Invoke
|
||||
import app.tauri.plugin.Plugin
|
||||
import com.fasterxml.jackson.databind.JsonNode
|
||||
import com.fasterxml.jackson.databind.ObjectMapper
|
||||
import java.io.File
|
||||
|
||||
@TauriPlugin
|
||||
class StorePlugin(private val activity: Activity) : Plugin(activity) {
|
||||
@Command
|
||||
fun load(invoke: Invoke) {
|
||||
try {
|
||||
val path = invoke.parseArgs(String::class.java)
|
||||
val file = File(activity.applicationContext.getExternalFilesDir(null), path)
|
||||
|
||||
invoke.resolveObject(ObjectMapper().readTree(file))
|
||||
} catch (ex: Exception) {
|
||||
invoke.reject(ex.message)
|
||||
}
|
||||
}
|
||||
|
||||
@Command
|
||||
fun save(invoke: Invoke) {
|
||||
try {
|
||||
val args = invoke.parseArgs(JsonNode::class.java)
|
||||
val path = args.get("store").asText()
|
||||
val cache = args.get("cache")
|
||||
val file = File(activity.applicationContext.getExternalFilesDir(null), path)
|
||||
|
||||
if (!file.exists()) {
|
||||
file.parentFile?.mkdirs()
|
||||
file.createNewFile()
|
||||
}
|
||||
|
||||
file.writeText(cache.toString())
|
||||
|
||||
invoke.resolve()
|
||||
} catch (ex: Exception) {
|
||||
invoke.reject(ex.message)
|
||||
}
|
||||
}
|
||||
}
|
||||
@ -1,16 +0,0 @@
|
||||
{
|
||||
"object": {
|
||||
"pins": [
|
||||
{
|
||||
"package": "SwiftRs",
|
||||
"repositoryURL": "https://github.com/Brendonovich/swift-rs",
|
||||
"state": {
|
||||
"branch": null,
|
||||
"revision": "b5ed223fcdab165bc21219c1925dc1e77e2bef5e",
|
||||
"version": "1.0.6"
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
"version": 1
|
||||
}
|
||||
@ -1,34 +0,0 @@
|
||||
// swift-tools-version:5.3
|
||||
// Copyright 2019-2023 Tauri Programme within The Commons Conservancy
|
||||
// SPDX-License-Identifier: Apache-2.0
|
||||
// SPDX-License-Identifier: MIT
|
||||
|
||||
import PackageDescription
|
||||
|
||||
let package = Package(
|
||||
name: "tauri-plugin-store",
|
||||
platforms: [
|
||||
.macOS(.v10_13),
|
||||
.iOS(.v13),
|
||||
],
|
||||
products: [
|
||||
// Products define the executables and libraries a package produces, and make them visible to other packages.
|
||||
.library(
|
||||
name: "tauri-plugin-store",
|
||||
type: .static,
|
||||
targets: ["tauri-plugin-store"])
|
||||
],
|
||||
dependencies: [
|
||||
.package(name: "Tauri", path: "../.tauri/tauri-api")
|
||||
],
|
||||
targets: [
|
||||
// Targets are the basic building blocks of a package. A target can define a module or a test suite.
|
||||
// Targets can depend on other targets in this package, and on products in packages this package depends on.
|
||||
.target(
|
||||
name: "tauri-plugin-store",
|
||||
dependencies: [
|
||||
.byName(name: "Tauri")
|
||||
],
|
||||
path: "Sources")
|
||||
]
|
||||
)
|
||||
@ -1,217 +0,0 @@
|
||||
// Copyright 2019-2023 Tauri Programme within The Commons Conservancy
|
||||
// SPDX-License-Identifier: Apache-2.0
|
||||
// SPDX-License-Identifier: MIT
|
||||
|
||||
import Foundation
|
||||
|
||||
import SwiftRs
|
||||
import Tauri
|
||||
import UIKit
|
||||
import WebKit
|
||||
|
||||
|
||||
struct SaveStore: Codable {
|
||||
let store: String
|
||||
let cache: [String: JSON]
|
||||
}
|
||||
|
||||
class StorePlugin: Plugin {
|
||||
@objc public func save(_ invoke: Invoke) throws {
|
||||
do {
|
||||
let args = try invoke.parseArgs(SaveStore.self)
|
||||
let store = args.store
|
||||
let cache = args.cache
|
||||
let fileURL = getUrlFromPath(path: store, createDirs: true)
|
||||
|
||||
try JSONEncoder().encode(cache).write(to: fileURL)
|
||||
invoke.resolve()
|
||||
} catch {
|
||||
invoke.reject(error.localizedDescription)
|
||||
}
|
||||
}
|
||||
|
||||
@objc public func load(_ invoke: Invoke) throws {
|
||||
do {
|
||||
let path = try invoke.parseArgs(String.self)
|
||||
let fileURL = getUrlFromPath(path: path, createDirs: false)
|
||||
let data = try String(contentsOf: fileURL)
|
||||
let passData = dictionary(text: data)
|
||||
|
||||
invoke.resolve(passData)
|
||||
} catch {
|
||||
invoke.reject(error.localizedDescription)
|
||||
}
|
||||
}
|
||||
|
||||
func dictionary(text: String) -> [String: Any?] {
|
||||
if let data = text.data(using: .utf8) {
|
||||
do {
|
||||
return try JSONSerialization.jsonObject(with: data, options: []) as! [String: Any]
|
||||
} catch {
|
||||
fatalError(error.localizedDescription)
|
||||
}
|
||||
}
|
||||
|
||||
return [:]
|
||||
}
|
||||
|
||||
func getUrlFromPath(path: String, createDirs: Bool) -> URL {
|
||||
do {
|
||||
var url = try FileManager.default
|
||||
.url(
|
||||
for: .applicationSupportDirectory,
|
||||
in: .userDomainMask,
|
||||
appropriateFor: nil,
|
||||
create: true
|
||||
)
|
||||
let components = path.split(separator: "/").map { element in String(element) }
|
||||
|
||||
if components.count == 1 {
|
||||
return url.appendPath(path: path, isDirectory: false)
|
||||
}
|
||||
|
||||
for i in 0..<components.count {
|
||||
url = url.appendPath(path: components[i], isDirectory: true)
|
||||
}
|
||||
|
||||
if components.count > 1 && createDirs {
|
||||
try FileManager.default.createDirectory(at: url, withIntermediateDirectories: true)
|
||||
}
|
||||
|
||||
url = url.appendPath(path: components.last!, isDirectory: false)
|
||||
|
||||
return url
|
||||
} catch {
|
||||
fatalError(error.localizedDescription)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
@_cdecl("init_plugin_store")
|
||||
func initPlugin() -> Plugin {
|
||||
return StorePlugin()
|
||||
}
|
||||
|
||||
private extension URL {
|
||||
func appendPath(path: String, isDirectory: Bool) -> URL {
|
||||
if #available(iOS 16.0, *) {
|
||||
return self.appending(path: path, directoryHint: isDirectory ? .isDirectory : .notDirectory)
|
||||
} else {
|
||||
return self.appendingPathComponent(path, isDirectory: isDirectory)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
public enum JSON : Codable {
|
||||
case null
|
||||
case number(NSNumber)
|
||||
case string(String)
|
||||
case array([JSON])
|
||||
case bool(Bool)
|
||||
case dictionary([String : JSON])
|
||||
|
||||
public var value: Any? {
|
||||
switch self {
|
||||
case .null: return nil
|
||||
case .number(let number): return number
|
||||
case .string(let string): return string
|
||||
case .bool(let bool): return bool
|
||||
case .array(let array): return array.map { $0.value }
|
||||
case .dictionary(let dictionary): return dictionary.mapValues { $0.value }
|
||||
}
|
||||
}
|
||||
|
||||
public init?(_ value: Any?) {
|
||||
guard let value = value else {
|
||||
self = .null
|
||||
return
|
||||
}
|
||||
|
||||
if let bool = value as? Bool {
|
||||
self = .bool(bool)
|
||||
} else if let int = value as? Int {
|
||||
self = .number(NSNumber(value: int))
|
||||
} else if let double = value as? Double {
|
||||
self = .number(NSNumber(value: double))
|
||||
} else if let string = value as? String {
|
||||
self = .string(string)
|
||||
} else if let array = value as? [Any] {
|
||||
var mapped = [JSON]()
|
||||
for inner in array {
|
||||
guard let inner = JSON(inner) else {
|
||||
return nil
|
||||
}
|
||||
|
||||
mapped.append(inner)
|
||||
}
|
||||
|
||||
self = .array(mapped)
|
||||
} else if let dictionary = value as? [String : Any] {
|
||||
var mapped = [String : JSON]()
|
||||
for (key, inner) in dictionary {
|
||||
guard let inner = JSON(inner) else {
|
||||
return nil
|
||||
}
|
||||
|
||||
mapped[key] = inner
|
||||
}
|
||||
|
||||
self = .dictionary(mapped)
|
||||
} else {
|
||||
return nil
|
||||
}
|
||||
}
|
||||
|
||||
public init(from decoder: Decoder) throws {
|
||||
let container = try decoder.singleValueContainer()
|
||||
guard !container.decodeNil() else {
|
||||
self = .null
|
||||
return
|
||||
}
|
||||
|
||||
if let bool = try container.decodeIfMatched(Bool.self) {
|
||||
self = .bool(bool)
|
||||
} else if let int = try container.decodeIfMatched(Int.self) {
|
||||
self = .number(NSNumber(value: int))
|
||||
} else if let double = try container.decodeIfMatched(Double.self) {
|
||||
self = .number(NSNumber(value: double))
|
||||
} else if let string = try container.decodeIfMatched(String.self) {
|
||||
self = .string(string)
|
||||
} else if let array = try container.decodeIfMatched([JSON].self) {
|
||||
self = .array(array)
|
||||
} else if let dictionary = try container.decodeIfMatched([String : JSON].self) {
|
||||
self = .dictionary(dictionary)
|
||||
} else {
|
||||
throw DecodingError.typeMismatch(JSON.self, DecodingError.Context(codingPath: decoder.codingPath, debugDescription: "Unable to decode JSON as any of the possible types."))
|
||||
}
|
||||
}
|
||||
|
||||
public func encode(to encoder: Encoder) throws {
|
||||
var container = encoder.singleValueContainer()
|
||||
|
||||
switch self {
|
||||
case .null: try container.encodeNil()
|
||||
case .bool(let bool): try container.encode(bool)
|
||||
case .number(let number):
|
||||
if number.objCType.pointee == 0x64 /* 'd' */ {
|
||||
try container.encode(number.doubleValue)
|
||||
} else {
|
||||
try container.encode(number.intValue)
|
||||
}
|
||||
case .string(let string): try container.encode(string)
|
||||
case .array(let array): try container.encode(array)
|
||||
case .dictionary(let dictionary): try container.encode(dictionary)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
fileprivate extension SingleValueDecodingContainer {
|
||||
func decodeIfMatched<T : Decodable>(_ type: T.Type) throws -> T? {
|
||||
do {
|
||||
return try self.decode(T.self)
|
||||
} catch DecodingError.typeMismatch {
|
||||
return nil
|
||||
}
|
||||
}
|
||||
}
|
||||
@ -1,49 +0,0 @@
|
||||
// Copyright 2019-2023 Tauri Programme within The Commons Conservancy
|
||||
// SPDX-License-Identifier: Apache-2.0
|
||||
// SPDX-License-Identifier: MIT
|
||||
|
||||
use crate::Error;
|
||||
use crate::Runtime;
|
||||
use crate::Store;
|
||||
use std::fs::create_dir_all;
|
||||
use std::fs::read;
|
||||
use std::fs::File;
|
||||
use std::io::Write;
|
||||
use tauri::Manager;
|
||||
|
||||
#[cfg(desktop)]
|
||||
impl<R: Runtime> Store<R> {
|
||||
pub fn save(&self) -> Result<(), Error> {
|
||||
let app_dir = self
|
||||
.app
|
||||
.path()
|
||||
.app_data_dir()
|
||||
.expect("failed to resolve app dir");
|
||||
let store_path = app_dir.join(&self.path);
|
||||
|
||||
create_dir_all(store_path.parent().expect("invalid store path"))?;
|
||||
|
||||
let bytes = (self.serialize)(&self.cache).map_err(Error::Serialize)?;
|
||||
let mut f = File::create(&store_path)?;
|
||||
f.write_all(&bytes)?;
|
||||
|
||||
Ok(())
|
||||
}
|
||||
|
||||
/// Update the store from the on-disk state
|
||||
pub fn load(&mut self) -> Result<(), Error> {
|
||||
let app_dir = self
|
||||
.app
|
||||
.path()
|
||||
.app_data_dir()
|
||||
.expect("failed to resolve app dir");
|
||||
let store_path = app_dir.join(&self.path);
|
||||
|
||||
let bytes = read(store_path)?;
|
||||
|
||||
self.cache
|
||||
.extend((self.deserialize)(&bytes).map_err(Error::Deserialize)?);
|
||||
|
||||
Ok(())
|
||||
}
|
||||
}
|
||||
@ -1,53 +0,0 @@
|
||||
// Copyright 2019-2023 Tauri Programme within The Commons Conservancy
|
||||
// SPDX-License-Identifier: Apache-2.0
|
||||
// SPDX-License-Identifier: MIT
|
||||
|
||||
use tauri::Runtime;
|
||||
|
||||
use crate::error::Result;
|
||||
use crate::Store;
|
||||
use serde_json::Value;
|
||||
use std::collections::HashMap;
|
||||
|
||||
#[derive(Debug, serde::Serialize, serde::Deserialize)]
|
||||
#[serde(rename_all = "camelCase")]
|
||||
pub struct LoadStore {
|
||||
pub cache: HashMap<String, Value>,
|
||||
}
|
||||
|
||||
#[derive(Debug, serde::Serialize, serde::Deserialize)]
|
||||
#[serde(rename_all = "camelCase")]
|
||||
pub struct SaveStore {
|
||||
pub store: String,
|
||||
pub cache: HashMap<String, Value>,
|
||||
}
|
||||
|
||||
#[cfg(mobile)]
|
||||
impl<R: Runtime> Store<R> {
|
||||
pub fn save(&self) -> Result<()> {
|
||||
self.mobile_plugin_handle
|
||||
.as_ref()
|
||||
.ok_or_else(|| crate::error::Error::MobilePluginHandleUnInitialized)?
|
||||
.run_mobile_plugin(
|
||||
"save",
|
||||
SaveStore {
|
||||
store: self.path.to_string_lossy().to_string(),
|
||||
cache: self.cache.clone(),
|
||||
},
|
||||
)
|
||||
.map_err(Into::into)
|
||||
}
|
||||
|
||||
pub fn load(&mut self) -> Result<()> {
|
||||
let result: Value = self
|
||||
.mobile_plugin_handle
|
||||
.as_ref()
|
||||
.ok_or_else(|| crate::error::Error::MobilePluginHandleUnInitialized)?
|
||||
.run_mobile_plugin("load", self.path.to_string_lossy().to_string())?;
|
||||
|
||||
let map = serde_json::from_value::<HashMap<String, Value>>(result)?;
|
||||
self.cache.extend(map);
|
||||
|
||||
Ok(())
|
||||
}
|
||||
}
|
||||
Loading…
Reference in new issue