[Tauri v2] Deep link | Tauri Apps | Page 1

ocean condor Dec 2, 2024, 3:38 PM

#

I kinda made a deep link work on macos, even though it never worked with code from docs, and was very tricky to make it work. I am stucked on linux version. Not sure why clear tauri project works fine, but if copied code to migrated from v1 project it just doesnt work.

The main problem is that i register a schema

  "plugins": {
    "deep-link": {
      "desktop": {
        "schemes": ["test"]
      }
    }
  },

then checking in a js, await isRegistered('test') which returns true.
lib.rs has all setuped as in docs

 tauri::Builder::default()
        .plugin(tauri_plugin_single_instance::init(|app, argv, _cwd| {
            let _ = app.get_webview_window("main")
                .expect("no main window")
                .set_focus();

          println!("a new app instance was opened with {argv:?} and the deep link event was already triggered");
        }))
        .plugin(tauri_plugin_deep_link::init())
        .plugin(tauri_plugin_global_shortcut::Builder::new().build())
        .plugin(tauri_plugin_http::init())
        .plugin(tauri_plugin_fs::init())
        .plugin(tauri_plugin_os::init())
        .plugin(tauri_plugin_dialog::init())
        .plugin(tauri_plugin_process::init())
        .plugin(tauri_plugin_shell::init())
        .setup(|app| {
            #[cfg(any(windows, target_os = "linux"))]
            {
                use tauri_plugin_deep_link::DeepLinkExt;
                app.deep_link().register_all()?;
            }

            Ok(())            
        })
        .plugin(tauri_plugin_websocket::init())

and it just returns error when i am trying to do a xdg-open test://something in terminal gio: test://something: The specified location is not supported all the time.
When i do same code but in clear project it works fine. It is Ubuntu 24.
I even try to build a deb package and install, then it will open an app, but url will have only path to app which was opened, and it never fires onOpenUrl nor other listeners.

slate garden Dec 4, 2024, 12:35 AM

#

any updates on this? im working through it too. you said in a clear project it works fine?

#

i got it to get past the ``` The specified location is not supported

#

but now its just saying that

xdg-open myapp://url
error: unexpected argument 'myapp://url' found

#

and its not triggering in the js either?

await onOpenUrl((urls) => {
  console.log('deep link:', urls);
});

nothing

#

i have this

tauri = tauri
        .plugin(tauri_plugin_deep_link::init())
        .plugin(tauri_plugin_process::init())
        .setup(move |app| {
            #[cfg(any(windows, target_os = "linux"))]
            {
                println!("register deep links");
                use tauri_plugin_deep_link::DeepLinkExt;
                app.deep_link().register_all()?;
            }

            app.deep_link().on_open_url(|event| {
                println!("deep link URLs: {:?}", event.urls());
            });

slate garden Dec 4, 2024, 1:05 AM

#

so its like running the xdg-open myapp://url just runs the app and gives the whole myapp://url to my cli... ? the js is registered says true but the js and rust are not triggered when i run the xdg-open

slate garden Dec 4, 2024, 1:52 AM

#

ok so reading the docs again i found that the deep links are passed as cli arguments. so i had parse them better so my cli didnt complain. now the deep links are going in but stil have 2 problems. 1. its opening a new app. 2. even when the app is closed its not triggering the js or the rust deep link println!

slate garden Dec 4, 2024, 6:33 AM

#

ok so on mac it seams to be working better. its triggering the js onOpenUrl

ocean condor Dec 4, 2024, 8:20 AM

#

No progress, still stuck as linux doesnt register a scheme 😦

azure tapir Dec 4, 2024, 10:43 AM

#

slate garden ok so reading the docs again i found that the deep links are passed as cli argum...

Isn't 1) also in the docs? This is just how deep links work on windows and linux. You can use the single-instance plugin for this (if you enable its deep-link feature onOpenUrl should also work).

#

Is also expected, and should be documented in the onOpenUrl inline docs. You'll need to call getCurrent to get the scheme that started the app

azure tapir Dec 4, 2024, 10:45 AM

#

ocean condor No progress, still stuck as linux doesnt register a scheme 😦

can you check that the file path in ~/.local/share/applications/yourapp.desktop makes sense?

ocean condor Dec 4, 2024, 2:27 PM

#

It looks like i get through this issue.
I have no idea why its working correctly on clear app and not working on my.
Solution that i found :

Run app once with yarn tauri dev -> this will register a deep link i suppose (if i try to run xdg-open test://something its not working saying gio: test://something: The specified location is not supported)
Stop the app dev proccess
Start yarn tauri dev again. Now its registered.

I spend around 4 days to find the problem with this, just bc on clear app it works right away without restarting...

ocean condor Dec 4, 2024, 2:31 PM

#

azure tapir can you check that the file path in `~/.local/share/applications/yourapp.desktop...

File has a lot of registered schemes, is this okay?

MimeType=x-scheme-handler/test;x-scheme-handler/test;x-scheme-handler/test;x-scheme-handler/test;x-scheme-handler/test;x-scheme-handler/test;x-scheme-handler/test;x-scheme-handler/test;x-scheme-handler/test;x-scheme-handler/test;x-scheme-handler/test;x-scheme-handler/test;x-scheme-handler/test;x-scheme-handler/test;x-scheme-handler/test;x-scheme-handler/test;x-scheme-handler/test;x-scheme-handler/test;x-scheme-handler/test;x-scheme-handler/test;x-scheme-handler/test;x-scheme-handler/test;x-scheme-handler/test;x-scheme-handler/test;x-scheme-handler/test;x-scheme-handler/test;x-scheme-handler/test;x-scheme-handler/test;x-scheme-handler/test;x-scheme-handler/test;x-scheme-handler/test;x-scheme-handler/test;x-scheme-handler/test;x-scheme-handler/test;x-scheme-handler/test;x-scheme-handler/test;x-scheme-handler/test;x-scheme-handler/test;x-scheme-handler/test;x-scheme-handler/test;x-scheme-handler/test;x-scheme-handler/test;x-scheme-handler/test;x-scheme-handler/test;x-scheme-handler/test;x-scheme-handler/test;x-scheme-handler/test;x-scheme-handler/test;x-scheme-handler/test;x-scheme-handler/test;x-scheme-handler/test;x-scheme-handler/test;x-scheme-handler/test;x-scheme-handler/test;x-scheme-handler/test;x-scheme-handler/test;x-scheme-handler/test;x-scheme-handler/test;x-scheme-handler/test;x-scheme-handler/test;x-scheme-handler/test;x-scheme-handler/test;

azure tapir Dec 4, 2024, 2:58 PM

#

ocean condor File has a lot of registered schemes, is this okay? ``` MimeType=x-scheme-handle...

it's not nice but it shouldn't cause any real issues. you may still wanna wrap that register() call in a is_registered() condition.

ocean condor Dec 4, 2024, 3:21 PM

#

And i just checked, for dev version it works okay and
listen<string[]>('deep-link://new-url', event => {}) is being called, but for production app, it looks like none of the listeners i can put on is never called nor rust listeners too.

#

await onOpenUrl(url => {
  debugger
  console.log(url)
})
or
listen<string[]>('deep-link://new-url', event => {})

never fires, even though deep link is working fine.

azure tapir Dec 4, 2024, 3:35 PM

#

is the app already running when you call the link, or does the link also open the app itself?

#

asking because of #1313167432319242361 message

slate garden Dec 4, 2024, 7:50 PM

#

azure tapir Isn't 1) also in the docs? This is just how deep links work on windows and linux...

i didnt mention it but i am using the single instance plugin

 let mut tauri = tauri::Builder::default();

    #[cfg(desktop)]
    {
         tauri = tauri.plugin(tauri_plugin_single_instance::init(|_app, argv, _cwd| {
          println!("a new app instance was opened with {argv:?} and the deep link event was already triggered");
          // when defining deep link schemes at runtime, you must also check `argv` here
        }));
    }
    tauri = tauri
        .plugin(tauri_plugin_deep_link::init())
        .plugin(tauri_plugin_process::init())
        .setup(move |app| {
            #[cfg(any(windows, target_os = "linux"))]
            {
                println!("register deep links");
                use tauri_plugin_deep_link::DeepLinkExt;
                app.deep_link().register_all()?;
            }

            app.deep_link().on_open_url(|event| {
                println!("deep link URLs: {:?}", event.urls());
            });

i just opens a new instance on linux.

#

it works on mac when the app is already running.

ocean condor Dec 4, 2024, 9:21 PM

#

azure tapir is the app already running when you call the link, or does the link also open th...

Yes it’s already running.
I checked the file it looks good, it has a correct deep link schema, and single instance callback is being called, but not other listener

azure tapir Dec 4, 2024, 10:03 PM

#

ocean condor Yes it’s already running. I checked the file it looks good, it has a correct de...

did you enable the deep-link feature flag on the single-instance dependency in cargo.toml?

azure tapir Dec 4, 2024, 10:05 PM

#

slate garden i didnt mention it but i am using the single instance plugin ``` let mut tauri ...

hmm that's weird, so the single instance plugin isn't working. Does it work if you simply start the app again yourself by double clicking on the app or whatever?

it works on mac when the app is already running.
mac works so vastly different that it's completely irrelevant here

slate garden Dec 4, 2024, 10:52 PM

#

azure tapir hmm that's weird, so the single instance plugin isn't working. Does it work if y...

yeah single instance plugin not working on linux.
if i start the app manually and then do an xdg-open myapp://url
it just tries to open a new version. even after i start the app again.
another thing that makes me think the single instance is messed up is that when the app is closed and i do an xdg-open it opens the app but it doesnot print the ``` tauri = tauri.plugin(tauri_plugin_single_instance::init(|_app, argv, _cwd| {
println!("a new app instance was opened with {argv:?} and the deep link event was already triggered");

    }));```

azure tapir Dec 4, 2024, 10:54 PM

#

another thing that makes me think the single instance is messed up is that when the app is closed and i do an xdg-open it opens the app but it doesnot print the
that part at least is how it's supposed to work. The single-instance callback is only supposed to run if secondary instances are opened (and killed)

slate garden Dec 4, 2024, 10:54 PM

#

ok that part makes sense

#

to see if the link is coming in when the app is closed i think i need to use that getCurrent to get the scheme that started the app.

#

but the confusing part now is still why the single instance is not working.

#

and whatabout when the app is closed and the xdg-open fires should the ``` app.deep_link().on_open_url(|event| {
println!("deep link URLs: {:?}", event.urls());
});

ocean condor Dec 5, 2024, 9:06 AM

#

azure tapir did you enable the deep-link feature flag on the single-instance dependency in c...

i did all by the docs. And this is how it looks like

[build-dependencies]
tauri-build = { version = "2", features = [] }

[dependencies]
tauri = { version = "2", features = [ "protocol-asset", "image-png", "tray-icon"] }
serde = { version = "1.0", features = ["derive"] }
serde_json = "1.0"
tauri-plugin-websocket = "2"
tauri-plugin-deep-link = "2.0.2"
tokio = "1.36.0"
open = "5.1.3"
tauri-plugin-shell = "2"
tauri-plugin-process = "2"
tauri-plugin-dialog = "2.0.4"
tauri-plugin-os = "2"
tauri-plugin-fs = "2"
tauri-plugin-http = "2.0.4"

[target."cfg(any(target_os = \"macos\", windows, target_os = \"linux\"))".dependencies]
tauri-plugin-single-instance = { version = "2.0.2", features = ["deep-link"] }

#

and for lib.rs

    tauri::Builder::default()
        .plugin(tauri_plugin_single_instance::init(|app, argv, _cwd| {
            let _ = app.get_webview_window("main")
                .expect("no main window")
                .set_focus();

          println!("a new app instance was opened with {argv:?} and the deep link event was already triggered");
        }))
        .plugin(tauri_plugin_deep_link::init())
        .plugin(tauri_plugin_http::init())
        .plugin(tauri_plugin_fs::init())
        .plugin(tauri_plugin_os::init())
        .plugin(tauri_plugin_dialog::init())
        .plugin(tauri_plugin_process::init())
        .plugin(tauri_plugin_shell::init())
        .setup(|app| {
            #[cfg(any(windows, target_os = "linux"))]
            {
                use tauri_plugin_deep_link::DeepLinkExt;
                app.deep_link().register_all()?;
            }

            Ok(())            
        })

#

And again, on totally clean app with cargo.toml

[package]
name = "test"
version = "0.1.0"
description = "A Tauri App"
authors = ["you"]
edition = "2021"

# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

[lib]
# The `_lib` suffix may seem redundant but it is necessary
# to make the lib name unique and wouldn't conflict with the bin name.
# This seems to be only an issue on Windows, see https://github.com/rust-lang/cargo/issues/8519
name = "test_lib"
crate-type = ["staticlib", "cdylib", "rlib"]

[build-dependencies]
tauri-build = { version = "2", features = [] }

[dependencies]
tauri = { version = "2", features = [] }
tauri-plugin-shell = "2"
serde = { version = "1", features = ["derive"] }
serde_json = "1"
tauri-plugin-deep-link = "2"

[target."cfg(any(target_os = \"macos\", windows, target_os = \"linux\"))".dependencies]
tauri-plugin-single-instance = { version = "2.0.0", features = ["deep-link"] }

#

and lib.rs

use tauri::Manager;

// Learn more about Tauri commands at https://tauri.app/develop/calling-rust/
#[tauri::command]
fn greet(name: &str) -> String {
    format!("Hello, {}! You've been greeted from Rust!", name)
}

#[cfg_attr(mobile, tauri::mobile_entry_point)]
pub fn run() {
    tauri::Builder::default()
        .plugin(tauri_plugin_single_instance::init(|app, argv, _cwd| {
             let _ = app.get_webview_window("main")
                .expect("no main window")
                .set_focus();
          println!("a new app instance was opened with {argv:?} and the deep link event was already triggered");
          // when defining deep link schemes at runtime, you must also check `argv` here
        }))
        .plugin(tauri_plugin_deep_link::init())
        .plugin(tauri_plugin_shell::init())
        .setup(|app| {
            #[cfg(any(windows, target_os = "linux"))]
            {
            use tauri_plugin_deep_link::DeepLinkExt;
               let _= app.deep_link().register_all()?;
            }

            Ok(())
        })
        .invoke_handler(tauri::generate_handler![greet])
        .run(tauri::generate_context!())
        .expect("error while running tauri application");
}

#

it works totally fine and onOpenUrl works just fine

azure tapir Dec 5, 2024, 9:22 AM

#

slate garden and whatabout when the app is closed and the xdg-open fires should the ``` app...

no

azure tapir Dec 5, 2024, 9:23 AM

#

ocean condor i did all by the docs. And this is how it looks like ``` [build-dependencies] ta...

is your non-working project public by any chance?

ocean condor Dec 5, 2024, 9:23 AM

#

Unfortunatelly not...

#

Could it be that migration cli from v1-v2 make some changes that broke functionality?

azure tapir Dec 5, 2024, 9:40 AM

#

never say never but i don't see what could cause this.

#

can you also share your tauri.conf.json file? (you can remove the app name and identifier and whatever to keep it private)

ocean condor Dec 5, 2024, 9:57 AM

#

Sure

{
  "$schema": "https://schema.tauri.app/config/2",
  "build": {
    "beforeDevCommand": "yarn dev",
    "beforeBuildCommand": "yarn build",
    "frontendDist": "../dist",
    "devUrl": "http://localhost:1420"
  },
  "bundle": {
    "active": true,
    "targets": "all",
    "resources": {
      "../service/.env.development": "./",
      "../service/.env.staging": "./",
      "../service/.env": "./"
    },
    "icon": ["icons/32x32.png", "icons/128x128.png", "icons/[email protected]", "icons/icon.icns", "icons/icon.ico"]
  },
  "productName": "Test",
  "mainBinaryName": "Test",
  "version": "../package.json",
  "identifier": "ui.test.desktop",
  "plugins": {
    "deep-link": {
      "desktop": {
        "schemes": ["something"]
      }
    }
  },
  "app": {
    "windows": [
      {
        "fullscreen": false,
        "resizable": true,
        "title": "Test",
        "width": 1440,
        "height": 900,
        "minHeight": 460,
        "minWidth": 600
      }
    ],
    "withGlobalTauri": false,
    "security": {
      "assetProtocol": {
        "scope": ["$CACHE/test/**"],
        "enable": true
      },
      "csp": "style-src 'unsafe-inline' 'self'; default-src 'self'; img-src 'self' data: https: asset: http://asset.localhost; connect-src ipc: http://ipc.localhost https://plausible.io/api/event"
    }
  }
}

this is main one

#

and this is linux.conf.json

{
  "bundle": {
    "resources": {
      "../service/test": "./",
      "../service/testt": "./",
      "../service/testtt": "./",
      "../service/testttt": "./",
      "../pkgScripts/lin/test.service": "./"
    },
    "linux": {
      "deb": {
        "files": {
          "../control/postinst": "../pkgScripts/lin/postinst",
          "../control/postrm": "../pkgScripts/lin/postrem"
        },
        "depends": ["net-tools", "iw", "resolvconf"]
      }
    }
  }
}

azure tapir Dec 5, 2024, 10:01 AM

#

hmm that all looks fine

#

was the issue the same for tauri dev vs appimage vs deb vs rpm (or whatever subset of those you tested)?

ocean condor Dec 5, 2024, 10:04 AM

#

i am using only deb bc we need to include postinstall and preinstall scripts

#

with tauri dev issue was that it didnt even register a scheme on a first run, i always need to stop it and run again to register it.

#

after i build it. it register schema correctly and shows app, but no callback is called :/

#

so now i am kinda trying to brut force it, by making a clear repo and copying thing there from our code and see when it breaks 😄

#

Another thing that for example for macos, even though docs says that it should work fine with single instance plugin or without, it actually always opened second instance if i started my app with yarn tauri dev and i have all same code in lib.rs. And it never called onOpenUrl thats why i found this work around for listen('deep-link://new-url) which kinda works okay.
So i am a little suspicious about that migration, bc as i tried to search other people dont really have this problem.

ocean condor Dec 6, 2024, 9:46 AM

#

@azure tapir could the reason why its not working being a properties productName or mainBinaryName ? When i want to use some user friendly name like "Something Test" its not working. If i change it to "something-test" it works ...

ocean condor Dec 6, 2024, 1:43 PM

#

PS. after i build it, it calls onOpenUrl all the time over and over again and never stops

azure tapir Dec 9, 2024, 8:26 PM

#

ocean condor Another thing that for example for macos, even though docs says that it should w...

In a built app the single instance plugin is not needed (and does not trigger) on macOS. As a workaround for development however you can use it.

azure tapir Dec 9, 2024, 8:27 PM

#

ocean condor <@195491839741132800> could the reason why its not working being a properties `p...

That could be, yeah. I'm on vacation starting wednesday morning and i don't think i'll can look into this tomorrow. Would you mind opening a github issue for this?

ocean condor Dec 11, 2024, 9:10 AM

#

Sure 👍

#[Tauri v2] Deep link