refactor(store)!: more reworks #1860

Legend-Master · 2024-10-02T10:02:56Z

Follow up of #1550

Changes:

Disallow calling create_store when there're still active stores with the same path alive
Save and cancel pending auto save on drop
Use absolute path as store's key, fix [store] Absolute vs. relative paths to the same store file are cached separately #984

New features:

Add getStore/get_store share stores across js and rust side
Add default (de)serialize functions settings
Allow js to use pre-stored (de)serialize functions
Add back lazy store (implemented in js)

Default changes:

Share store to resource table by default
Enable auto save with 100ms debounce time by default
Use pretty json by default, close Store json file can be save format beautify style? #1690

github-actions · 2024-10-02T10:15:18Z

Package Changes Through `8e71393`

There are 10 changes which include dialog with patch, dialog-js with patch, positioner with patch, positioner-js with patch, http with patch, http-js with patch, shell with patch, shell-js with patch, store-js with minor, store with minor

Planned Package Versions

The following package releases are the planned based on the context of changes in this pull request.

package	current	next
api-example	2.0.2	2.0.3
api-example-js	2.0.0	2.0.1
dialog	2.0.1	2.0.2
dialog-js	2.0.0	2.0.1
http	2.0.1	2.0.2
http-js	2.0.0	2.0.1
positioner	2.0.1	2.0.2
positioner-js	2.0.0	2.0.1
shell	2.0.1	2.0.2
shell-js	2.0.0	2.0.1
store	2.0.1	2.1.0
store-js	2.0.0	2.1.0

Add another change file through the GitHub UI by following this link.

Read about change files or the docs at github.com/jbolda/covector

lucasfernog · 2024-10-02T10:16:12Z

can't we automatically share the store? like always make it available in the same collection, so a call from another language would pick it up anyway?

Legend-Master · 2024-10-02T10:21:29Z

Yeah I was thinking about it, but that means you'll need to always preserve that store, sometimes you might just want to read the data from it and forget about it, maybe share/preserve it by default, and add a close function or something

Legend-Master · 2024-10-02T10:23:02Z

I need to take a break, this thing is haunting me right now 😂

Legend-Master · 2024-10-03T02:59:34Z

Note: don't merge it yet, I didn't have the time to test and write the docs yet, got some other things to handle, might be able get back on this tomorrow or something like that

This reverts commit 7ffd769.

Legend-Master · 2024-10-17T03:44:25Z

To be honest, I still find create to be very confusing, I don't think anyone will expect it to mean open an empty store in the rust side without loading from disk while load gets the opened store or create a new store but also loads it

lucasfernog · 2024-10-17T10:19:43Z

To be honest, I still find create to be very confusing, I don't think anyone will expect it to mean open an empty store in the rust side without loading from disk while load gets the opened store or create a new store but also loads it

I've removed the create function from the Rust side, maybe we do the same on the JS side too. I'll push this change for you to take a look.

This reverts commit 4a29fc8.

lucasfernog · 2024-10-17T10:39:33Z

@amrbashir i wanted to use the Resource class close() method instead of creating a dedicated one but I can't because we're using the AppHandle resource table and not the Webview one.. should the resources plugin allow me to configure which table i'm referring to? or fallback to other tables?

amrbashir · 2024-10-17T10:46:40Z

I was thinking something similar but Idk if the auditors will approve, maybe if we allow only closing resources from the same webview, or the same window or the app handle, It should be fine then.

amrbashir · 2024-10-17T10:47:28Z

I.e. webview can't close resources from other webviews.

lucasfernog · 2024-10-17T10:57:58Z

yeah so fallback to the parent window or AppHandle, that should be good

lucasfernog · 2024-10-17T10:59:32Z

usually you shouldn't even know the RID if you can't also close the resource.. otherwise users can use a wrapper ID instead

This reverts commit 70a1830.

lucasfernog · 2024-10-17T11:01:05Z

all good for us to merge and release this? @amrbashir and @Legend-Master
no more breaking changes pls :D

Legend-Master · 2024-10-17T11:10:07Z

Except for close doesn't actually work right now, looks good to me

lucasfernog · 2024-10-17T11:10:26Z

we'll fix on the tauri side

this changes the resource plugin close() API to fallback to the parent window and AppHandle resource tables, letting the JS to delete global resources. The need for this was brought up on tauri-apps/plugins-workspace#1860 (comment) the store plugin stores the resources in the AppHandle, and we want the existing close() API to work on global resources otherwise every consumer needs their own resource close commands

…11398) this changes the resource plugin close() API to fallback to the parent window and AppHandle resource tables, letting the JS to delete global resources. The need for this was brought up on tauri-apps/plugins-workspace#1860 (comment) the store plugin stores the resources in the AppHandle, and we want the existing close() API to work on global resources otherwise every consumer needs their own resource close commands

Reference: tauri-apps/plugins-workspace#1860

* refactor(store): more reworks * Enable auto save by default * Store to resource table by default * Remove share store * Clean up * Add close store * Add store function * Add lazy store * Add init to lazy store * refresh cache in example * Add get-or-create-store * Revert "Add get-or-create-store" This reverts commit 7ffd769. * try get first * Docs * Use absolute path for store * more docs * Allow js to use pre-stored (de)serialize functions * Fix js get and close store * Show case how to use pretty json * Update readme * Use store instead of `store_builder` in example * Build * Fix example * More docs for StoreBuilder::build * Add default (de)serialize fn * Use pretty json by default * Use `undefined` for empty value in get * Change files * Differentiate json null from no value for events * Add create or existing * Build * Rename inner store's inset method to set * Update readme * Apply suggestions from code review * Use close instead * Update breaking changes * Return result in resolve_store_path * Change to close_resource and take &self * Clean up * Apply suggestions from code review Co-authored-by: Amr Bashir <amr.bashir2015@gmail.com> * Remove unused pub(crate) * Update change file * Expose resolve_store_path * Remove with_store * Remove StoreInner from pub and expose is_empty * Fix wrong jsdoc param * Update readme * rename createOrExistingStore to createOrLoad * make api consistent with the JS implementation, add examples * fmt * reintroduce "get existing store" behavior for create_or_load * rename createOrLoad to newOrExisting * keep store lock throughout whole new_or_existing_inner * Remove load * Missed if load * Don't make StoreState public * Remove R: Runtime from Builder * rename newOrExisting to load, load to reload * update docs * rename missing reload fn * rename builder fn to build() * fix default permission * Fix description and create_new logic * Clippy * Update docs * Update docs * remove create_store command * remove close_store command since we extend from Resource * Revert "remove close_store command since we extend from Resource" This reverts commit 4a29fc8. * Reapply "remove close_store command since we extend from Resource" This reverts commit 70a1830. --------- Co-authored-by: Amr Bashir <amr.bashir2015@gmail.com> Co-authored-by: Lucas Nogueira <lucas@tauri.app>

refactor(store): more reworks

9811756

Legend-Master requested a review from a team as a code owner October 2, 2024 10:02

Enable auto save by default

35b439f

Legend-Master changed the title ~~refactor(store): more reworks~~ refactor(store)!: more reworks Oct 2, 2024

Legend-Master marked this pull request as draft October 2, 2024 15:18

Legend-Master added 7 commits October 3, 2024 09:33

Store to resource table by default

ea9c101

Remove share store

98d4fc4

Clean up

8975d10

Merge remote-tracking branch 'upstream/v2' into store-rework-2

e0bbc6d

Add close store

4cb9d8d

Add store function

6cdaa31

Add lazy store

79bc8d0

Legend-Master marked this pull request as ready for review October 3, 2024 02:52

Legend-Master added 2 commits October 3, 2024 11:48

Add init to lazy store

bbd34b1

refresh cache in example

17d910b

Legend-Master linked an issue Oct 3, 2024 that may be closed by this pull request

tauri-plugin-store: typescript mismatch for attribute autoSave #1865

Closed

Legend-Master and others added 6 commits October 3, 2024 13:34

Add get-or-create-store

7ffd769

Revert "Add get-or-create-store"

3acf66e

This reverts commit 7ffd769.

try get first

42c5a1c

Merge branch 'v2' into store-rework-2

4f17adc

Docs

45b2af4

Use absolute path for store

d22de02

Legend-Master linked an issue Oct 3, 2024 that may be closed by this pull request

[store] Absolute vs. relative paths to the same store file are cached separately #984

Closed

Legend-Master added 2 commits October 3, 2024 16:22

more docs

a3bef84

Allow js to use pre-stored (de)serialize functions

718f5dc

Legend-Master and others added 2 commits October 17, 2024 11:31

Merge branch 'v2' into store-rework-2

0d1b78a

Clippy

bf5a191

amrbashir previously approved these changes Oct 17, 2024

View reviewed changes

Update docs

9751296

Legend-Master dismissed amrbashir’s stale review via 9751296 October 17, 2024 03:58

Update docs

5181d2b

lucasfernog added 3 commits October 17, 2024 07:24

remove create_store command

09cce55

remove close_store command since we extend from Resource

4a29fc8

Revert "remove close_store command since we extend from Resource"

70a1830

This reverts commit 4a29fc8.

Reapply "remove close_store command since we extend from Resource"

8e71393

This reverts commit 70a1830.

amrbashir approved these changes Oct 17, 2024

View reviewed changes

lucasfernog approved these changes Oct 17, 2024

View reviewed changes

Legend-Master merged commit 8c67d44 into tauri-apps:v2 Oct 17, 2024
18 checks passed

lucasfernog mentioned this pull request Oct 17, 2024

feat(core): fallback to Window and AppHandle resource table on close tauri-apps/tauri#11398

Merged

github-actions bot mentioned this pull request Oct 16, 2024

Publish New Versions (v2) #1909

Merged

Legend-Master added a commit to tauri-apps/tauri-docs that referenced this pull request Oct 21, 2024

Update store plugin's docs to match the new rework

b4eb468

Reference: tauri-apps/plugins-workspace#1860

Legend-Master mentioned this pull request Oct 21, 2024

Update store plugin's docs to match the new rework tauri-apps/tauri-docs#2888

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor(store)!: more reworks #1860

refactor(store)!: more reworks #1860

Legend-Master commented Oct 2, 2024 •

edited

Loading

github-actions bot commented Oct 2, 2024 •

edited

Loading

lucasfernog commented Oct 2, 2024

Legend-Master commented Oct 2, 2024

Legend-Master commented Oct 2, 2024

Legend-Master commented Oct 3, 2024 •

edited

Loading

Legend-Master commented Oct 17, 2024

lucasfernog commented Oct 17, 2024

lucasfernog commented Oct 17, 2024

amrbashir commented Oct 17, 2024

amrbashir commented Oct 17, 2024

lucasfernog commented Oct 17, 2024

lucasfernog commented Oct 17, 2024 •

edited

Loading

lucasfernog commented Oct 17, 2024

Legend-Master commented Oct 17, 2024

lucasfernog commented Oct 17, 2024

refactor(store)!: more reworks #1860

refactor(store)!: more reworks #1860

Conversation

Legend-Master commented Oct 2, 2024 • edited Loading

github-actions bot commented Oct 2, 2024 • edited Loading

Package Changes Through 8e71393

lucasfernog commented Oct 2, 2024

Legend-Master commented Oct 2, 2024

Legend-Master commented Oct 2, 2024

Legend-Master commented Oct 3, 2024 • edited Loading

Legend-Master commented Oct 17, 2024

lucasfernog commented Oct 17, 2024

lucasfernog commented Oct 17, 2024

amrbashir commented Oct 17, 2024

amrbashir commented Oct 17, 2024

lucasfernog commented Oct 17, 2024

lucasfernog commented Oct 17, 2024 • edited Loading

lucasfernog commented Oct 17, 2024

Legend-Master commented Oct 17, 2024

lucasfernog commented Oct 17, 2024

Legend-Master commented Oct 2, 2024 •

edited

Loading

github-actions bot commented Oct 2, 2024 •

edited

Loading

Package Changes Through `8e71393`

Legend-Master commented Oct 3, 2024 •

edited

Loading

lucasfernog commented Oct 17, 2024 •

edited

Loading