feat: add `Webview::cookies` and `Webview::cookies_for_url()` #12665

charrondev · 2025-02-09T19:26:07Z

Closes

[feat] Get secure and http only cookies #11330

Related

Relevant discussion How to use the new wry API `WebView::cookies` and `WebView::cookies_for_url` in a tauri project? #11655
Relevant merge into Wry feat: add WebView::cookies and WebView::cookies_for_url wry#1394

Related issues not fully handled by this PR:

Changes

Added Webview::cookies_for_url() and tauri::Cookie

Implementation notes

I'm open to any requested changes here, but here's how I've gone about this:

Expose cookie::Cookie as a re-export from tauri_runtime::Cookie and tauri::Cookie. Notably I did not re-export the wry::Cookie which is a re-export of cookie::Cookie since tauri_runtime does not have a dependency on wry.
Add cookies_for_url() on the webview dispatcher and add an implementation for wry. I used WebviewDispatcher::reparent as my template for a dispatch the takes a parameter and returns a result.
I chose not to expose wry::webview::cookies() as it seemed to have an implementation note that it didn't work on Android at the moment.

Notes from my testing

Notably the wry support seems to only work when a site served over http (which is what I need it for). In my manual testing there doesn't seem to be a clear story for cookies on the tauri:// protocol (and there probably shouldn't be?). In any case by linking this PR into my own project I am able to extract the cookies from content served over http/https.

github-actions · 2025-02-09T22:23:24Z

Package Changes Through `b53ebb2`

There are 8 changes which include tauri with minor, tauri-runtime with minor, tauri-runtime-wry with minor, tauri-utils with patch, tauri-cli with minor, @tauri-apps/cli with minor, @tauri-apps/api with minor, tauri-bundler with patch

Planned Package Versions

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

package	current	next
@tauri-apps/api	2.3.0	2.4.0
tauri-utils	2.2.0	2.2.1
tauri-bundler	2.2.4	2.2.5
tauri-runtime	2.4.0	2.5.0
tauri-runtime-wry	2.4.1	2.5.0
tauri-codegen	2.0.5	2.0.6
tauri-macros	2.0.5	2.0.6
tauri-plugin	2.0.5	2.0.6
tauri-build	2.0.6	2.0.7
tauri	2.3.1	2.4.0
@tauri-apps/cli	2.3.1	2.4.0
tauri-cli	2.3.1	2.4.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

FabianLars

thank you!!

I chose not to expose wry::webview::cookies() as it seemed to have an implementation note that it didn't work on Android at the moment.

It would be fine to do the same in tauri as well (having this function return an empty vec with a platform-specific note)

FabianLars · 2025-02-09T22:28:11Z

crates/tauri/src/webview/mod.rs

    Ok(())
  }

+  /// Returns all cookies for a specified URL including HTTP-only and secure cookies.


Can you add a note about the scheme requirements here? imo quite important

I've added a note. This actually seems more of a bug/runtime limitation than anything. I would imagine this is because the tauri:// protocol behaves like the the file:// protocol in browsers and doesn't actually expose a functional cookie store.

charrondev · 2025-02-09T23:52:26Z

I've added the relevant note and the cookies() function.

I've also gone in and fixed up my fustfmt and clippy issues.

charrondev · 2025-02-10T23:03:57Z

As I'm testing this more deeply, I'm finding some concerning going. Fetching cookies is occasionally hanging the entire process. I will try to dig in some more.

charrondev · 2025-02-11T07:01:56Z

So after testing a bit more I've narrowed down the source of the hangs. It seems to happen in the MacOS implemenation specifically getting caught up in wry's wait_for_blocking_operation().

https://github.com/tauri-apps/wry/blob/cf181943444bca172d969615471997e48e10b611/src/wkwebview/mod.rs#L1057-L1077

I've gone and made a PR over on wry to resolve it tauri-apps/wry#1486

Bubbet · 2025-02-26T05:02:18Z

Where are you meant to use this? I've tried using the pr in a on_page_load event and inside a command and in both circumstances it just gets hung or something and never actually returns the cookies. The process doesn't lock up but its like it waiting forever. Edit: I'm also on windows.

AlloryDante · 2025-03-11T07:08:38Z

Where are you meant to use this? I've tried using the pr in a on_page_load event and inside a command and in both circumstances it just gets hung or something and never actually returns the cookies. The process doesn't lock up but its like it waiting forever.

I get the same hunging when I do it on windows....

lucasfernog · 2025-03-15T12:14:29Z

the issue on Windows is similar to window creation, which must be done on a separate thread because we need to wait for an async operation on the webview side. see tauri-apps/wry#583
i've updated the docs to mention this behavior

AlloryDante · 2025-03-15T12:21:30Z

the issue on Windows is similar to window creation, which must be done on a separate thread because we need to wait for an async operation on the webview side. see tauri-apps/wry#583 i've updated the docs to mention this behavior

Got it. Thank you for the docs and for the example file.

lucasfernog · 2025-03-15T13:15:12Z

the only gotcha here is that we're re-exporting the cookie crate which is on 0.18 meaning we can't update it to 0.19 for instance without it being flagged as a breaking change, i'll at least update our toml for this

crates/tauri-runtime/Cargo.toml

FabianLars · 2025-03-15T14:05:25Z

alternatively we could do the same we do in with_webview and document that this may change between minor versions. Seeing the crate's activity we probably don't have to worry about new 0.x versions in the near future.

AlloryDante · 2025-03-15T14:29:43Z

Finally we will have a way to get the cookies for the websites. If wry allows maybe in the future it would be nice to also have a set cookie method. I know for a fact that I am gonna use it...

Thank you so much for adding support for this @lucasfernog . I know it doesnt seem much but for my use case I am heavly dependant on cookie access and I was actually deciding if it would be better to switch to electron and you added this nice PR.

lucasfernog · 2025-03-15T14:47:10Z

thanks to @charrondev for bringing the bindings here and @amrbashir for working on the wry implementations

The issue was introduced in cedb24d (tauri-apps#12665). As the `.cookies()` docs state, the command should be async.

Remove the cookies code from it. Firtly, they are not necessary: "Hello, world!" should be simple. Secondly, it's broken on Windows: `.cookies()` hangs. The cookies stuff was introduced recently, in cedb24d (tauri-apps#12665). This supersedes tauri-apps#12992.

Remove the cookies code from it. Firtly, they are not necessary: "Hello, world!" should be simple. Secondly, it's broken on Windows: `.cookies()` hangs. The cookies stuff was introduced recently, in cedb24d (tauri-apps#12665). This commit reverts the changes to the example. This supersedes tauri-apps#12992.

Remove the cookies code from it. Firtly, they are not necessary: "Hello, world!" should be simple. Secondly, it's broken on Windows: `.cookies()` hangs. The cookies stuff was introduced recently, in cedb24d (#12665). This commit reverts the changes to the example. This supersedes #12992.

charrondev requested a review from a team as a code owner February 9, 2025 19:26

Add support for fetching cookies by url

bccd107

charrondev force-pushed the feat/cookies-for-url branch from e2ca406 to bccd107 Compare February 9, 2025 19:32

FabianLars reviewed Feb 9, 2025

View reviewed changes

Add support for fetching all cookies

fdbefdd

charrondev requested a review from FabianLars February 10, 2025 15:26

charrondev mentioned this pull request Feb 11, 2025

fix(macos): fix race condition in wkwebview implementation of cookie fetching tauri-apps/wry#1486

Merged

lucasfernog changed the title ~~feat: add tauri::Webview::cookies_by_url() and tauri::Cookie~~ feat: add Webview::cookies and Webview::cookies_for_url() Mar 15, 2025

github-project-automation bot added this to Roadmap Mar 15, 2025

github-project-automation bot moved this to 📬Proposal in Roadmap Mar 15, 2025

lucasfernog added 2 commits March 15, 2025 08:47

add missing getters, update change file

dc50f2c

update docs for windows deadlock

fa1db55

fix mobile build

47c95da

lucasfernog reviewed Mar 15, 2025

View reviewed changes

crates/tauri-runtime/Cargo.toml Outdated Show resolved Hide resolved

Update crates/tauri-runtime/Cargo.toml

b53ebb2

lucasfernog previously approved these changes Mar 15, 2025

View reviewed changes

add docs for stability [skip ci]

3a0aee3

lucasfernog dismissed their stale review via 3a0aee3 March 15, 2025 15:32

lucasfernog merged commit cedb24d into tauri-apps:dev Mar 15, 2025
3 checks passed

github-project-automation bot moved this from 📬Proposal to 🔎 In audit in Roadmap Mar 15, 2025

AlloryDante mentioned this pull request Mar 15, 2025

[feature] Implement WebView::set_cookie tauri-apps/wry#1511

Closed

github-actions bot mentioned this pull request Mar 15, 2025

Apply Version Updates From Current Changes #12856

Merged

WofWca added a commit to WofWca/tauri that referenced this pull request Mar 15, 2025

chore: fix helloworld example hang on Windows

237d986

The issue was introduced in cedb24d (tauri-apps#12665). As the `.cookies()` docs state, the command should be async.

WofWca mentioned this pull request Mar 15, 2025

chore: fix helloworld example hang on Windows #12992

Closed

WofWca mentioned this pull request Mar 16, 2025

chore: examples: fix & simplify helloworld #12995

Merged

WSH032 mentioned this pull request Jun 23, 2025

feat: add WebView::set_cookie and WebView::delete_cookie #13661

Merged

This was referenced Aug 17, 2025

[feat] Get secure and http only cookies #11330

Closed

[feat] Add a CookieManager to the WebView #5823

Open

Vija02 mentioned this pull request Aug 23, 2025

[App] Allow remote access without direct IP Vija02/TheOpenPresenter#32

Open

Uh oh!

feat: add Webview::cookies and Webview::cookies_for_url() #12665

feat: add Webview::cookies and Webview::cookies_for_url() #12665

Uh oh!

Conversation

charrondev commented Feb 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changes

Implementation notes

Notes from my testing

Uh oh!

github-actions bot commented Feb 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Package Changes Through b53ebb2

Uh oh!

FabianLars left a comment

Choose a reason for hiding this comment

Uh oh!

FabianLars Feb 9, 2025

Choose a reason for hiding this comment

Uh oh!

charrondev Feb 9, 2025

Choose a reason for hiding this comment

Uh oh!

charrondev commented Feb 9, 2025

Uh oh!

charrondev commented Feb 10, 2025

Uh oh!

charrondev commented Feb 11, 2025

Uh oh!

Bubbet commented Feb 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

AlloryDante commented Mar 11, 2025

Uh oh!

lucasfernog commented Mar 15, 2025

Uh oh!

AlloryDante commented Mar 15, 2025

Uh oh!

lucasfernog commented Mar 15, 2025

Uh oh!

Uh oh!

FabianLars commented Mar 15, 2025

Uh oh!

AlloryDante commented Mar 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

lucasfernog commented Mar 15, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

feat: add `Webview::cookies` and `Webview::cookies_for_url()` #12665

feat: add `Webview::cookies` and `Webview::cookies_for_url()` #12665

charrondev commented Feb 9, 2025 •

edited

Loading

github-actions bot commented Feb 9, 2025 •

edited

Loading

Package Changes Through `b53ebb2`

Bubbet commented Feb 26, 2025 •

edited

Loading

AlloryDante commented Mar 15, 2025 •

edited

Loading