KAN-51: add isolated Tauri macOS app scaffold
This commit is contained in:
Generated
+4509
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,29 @@
|
||||
[package]
|
||||
name = "kanbangit-native"
|
||||
version = "0.1.0"
|
||||
description = "KanbanGit native application"
|
||||
edition = "2021"
|
||||
publish = false
|
||||
|
||||
[lib]
|
||||
name = "kanbangit_native"
|
||||
crate-type = ["staticlib", "cdylib", "rlib"]
|
||||
|
||||
[build-dependencies]
|
||||
tauri-build = { version = "2", features = [] }
|
||||
|
||||
[dependencies]
|
||||
tauri = { version = "2", features = [] }
|
||||
|
||||
[dev-dependencies]
|
||||
tauri = { version = "2", features = ["test"] }
|
||||
serde_json = "1"
|
||||
|
||||
[features]
|
||||
smoke-test = []
|
||||
custom-protocol = ["tauri/custom-protocol"]
|
||||
|
||||
[[test]]
|
||||
name = "macos_smoke"
|
||||
harness = false
|
||||
required-features = ["smoke-test"]
|
||||
@@ -0,0 +1,3 @@
|
||||
fn main() {
|
||||
tauri_build::build();
|
||||
}
|
||||
Binary file not shown.
Binary file not shown.
|
After Width: | Height: | Size: 5.9 KiB |
@@ -0,0 +1,214 @@
|
||||
use tauri::{
|
||||
webview::{NewWindowResponse, PageLoadEvent},
|
||||
AppHandle, Manager, Url, WebviewUrl, WebviewWindowBuilder, WindowEvent,
|
||||
};
|
||||
|
||||
const SERVER_URL: &str = "https://kanbangit.de/";
|
||||
|
||||
fn allows_server_navigation(server: &Url, destination: &Url) -> bool {
|
||||
destination.scheme() == "https"
|
||||
&& destination.origin() == server.origin()
|
||||
&& destination.username().is_empty()
|
||||
&& destination.password().is_none()
|
||||
}
|
||||
|
||||
fn allows_launcher_navigation(destination: &Url) -> bool {
|
||||
destination.scheme() == "tauri"
|
||||
&& destination.host_str() == Some("localhost")
|
||||
&& destination.port().is_none()
|
||||
&& destination.username().is_empty()
|
||||
&& destination.password().is_none()
|
||||
}
|
||||
|
||||
fn show_launcher(app: &AppHandle) {
|
||||
if let Some(window) = app.get_webview_window("launcher") {
|
||||
let _ = window.show();
|
||||
let _ = window.set_focus();
|
||||
}
|
||||
}
|
||||
|
||||
fn open_workspace(app: &AppHandle) -> tauri::Result<()> {
|
||||
if let Some(window) = app.get_webview_window("workspace") {
|
||||
window.show()?;
|
||||
window.set_focus()?;
|
||||
return Ok(());
|
||||
}
|
||||
|
||||
let server = Url::parse(SERVER_URL).expect("The built-in server URL must be valid");
|
||||
let window = WebviewWindowBuilder::new(app, "workspace", WebviewUrl::External(server.clone()))
|
||||
.title("KanbanGit")
|
||||
.inner_size(1280.0, 850.0)
|
||||
.min_inner_size(375.0, 600.0)
|
||||
.center()
|
||||
.on_navigation(move |destination| allows_server_navigation(&server, destination))
|
||||
.on_new_window(|_, _| NewWindowResponse::Deny)
|
||||
.on_page_load(|window, payload| {
|
||||
if payload.event() == PageLoadEvent::Finished {
|
||||
if let Some(launcher) = window.app_handle().get_webview_window("launcher") {
|
||||
let _ = launcher.hide();
|
||||
}
|
||||
#[cfg(debug_assertions)]
|
||||
eprintln!(
|
||||
"KanbanGit workspace page loaded: {}",
|
||||
payload.url().origin().ascii_serialization()
|
||||
);
|
||||
}
|
||||
})
|
||||
.build()?;
|
||||
|
||||
let handle = app.clone();
|
||||
window.on_window_event(move |event| {
|
||||
if matches!(event, WindowEvent::Destroyed) {
|
||||
show_launcher(&handle);
|
||||
}
|
||||
});
|
||||
Ok(())
|
||||
}
|
||||
|
||||
pub fn context<R: tauri::Runtime>() -> tauri::Context<R> {
|
||||
tauri::generate_context!()
|
||||
}
|
||||
|
||||
pub fn builder() -> tauri::Builder<tauri::Wry> {
|
||||
tauri::Builder::default().setup(|app| {
|
||||
let handle = app.handle().clone();
|
||||
WebviewWindowBuilder::new(app, "launcher", WebviewUrl::App("index.html".into()))
|
||||
.title("KanbanGit")
|
||||
.inner_size(560.0, 520.0)
|
||||
.min_inner_size(375.0, 480.0)
|
||||
.center()
|
||||
.on_navigation(move |destination| {
|
||||
if allows_launcher_navigation(destination) {
|
||||
return true;
|
||||
}
|
||||
if destination.as_str() == SERVER_URL {
|
||||
let handle = handle.clone();
|
||||
// Defer window creation until the navigation callback has returned.
|
||||
let _ = handle.clone().run_on_main_thread(move || {
|
||||
if let Err(error) = open_workspace(&handle) {
|
||||
eprintln!("Could not open the workspace: {error}");
|
||||
show_launcher(&handle);
|
||||
}
|
||||
});
|
||||
}
|
||||
false
|
||||
})
|
||||
.on_new_window(|_, _| NewWindowResponse::Deny)
|
||||
.build()?;
|
||||
Ok(())
|
||||
})
|
||||
}
|
||||
|
||||
#[cfg_attr(mobile, tauri::mobile_entry_point)]
|
||||
pub fn run() {
|
||||
builder().run(context()).expect("Could not start KanbanGit");
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
|
||||
#[test]
|
||||
fn server_allows_application_routes_on_the_same_https_origin() {
|
||||
let server = Url::parse(SERVER_URL).unwrap();
|
||||
for path in [
|
||||
"/",
|
||||
"/login",
|
||||
"/two-factor-challenge",
|
||||
"/projects/1?ticket=51#details",
|
||||
] {
|
||||
assert!(allows_server_navigation(
|
||||
&server,
|
||||
&server.join(path).unwrap()
|
||||
));
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn server_rejects_origin_changes_downgrades_credentials_and_local_content() {
|
||||
let server = Url::parse(SERVER_URL).unwrap();
|
||||
for destination in [
|
||||
"http://kanbangit.de/",
|
||||
"https://kanbangit.de:444/",
|
||||
"https://kanbangit.de.example.com/",
|
||||
"https://example.com/",
|
||||
"https://user:password@kanbangit.de/",
|
||||
"https://user@kanbangit.de/",
|
||||
"tauri://localhost/index.html",
|
||||
"file:///etc/passwd",
|
||||
"data:text/html,hello",
|
||||
"javascript:alert(1)",
|
||||
] {
|
||||
assert!(
|
||||
!allows_server_navigation(&server, &Url::parse(destination).unwrap()),
|
||||
"{destination}"
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn launcher_only_loads_bundled_pages() {
|
||||
assert!(allows_launcher_navigation(
|
||||
&Url::parse("tauri://localhost/index.html").unwrap()
|
||||
));
|
||||
for destination in [
|
||||
SERVER_URL,
|
||||
"https://localhost/",
|
||||
"http://localhost:1420/",
|
||||
"tauri://other/index.html",
|
||||
"tauri://user@localhost/index.html",
|
||||
] {
|
||||
assert!(!allows_launcher_navigation(
|
||||
&Url::parse(destination).unwrap()
|
||||
));
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn remote_pages_cannot_invoke_native_window_webview_or_path_commands() {
|
||||
let app = tauri::test::mock_builder().build(context()).unwrap();
|
||||
let window = WebviewWindowBuilder::new(
|
||||
&app,
|
||||
"workspace",
|
||||
WebviewUrl::External(Url::parse(SERVER_URL).unwrap()),
|
||||
)
|
||||
.build()
|
||||
.unwrap();
|
||||
|
||||
for command in [
|
||||
"plugin:window|close",
|
||||
"plugin:webview|create_webview_window",
|
||||
"plugin:path|resolve_directory",
|
||||
] {
|
||||
let response = tauri::test::get_ipc_response(
|
||||
&window,
|
||||
tauri::webview::InvokeRequest {
|
||||
cmd: command.into(),
|
||||
callback: tauri::ipc::CallbackFn(0),
|
||||
error: tauri::ipc::CallbackFn(1),
|
||||
url: Url::parse(SERVER_URL).unwrap(),
|
||||
body: tauri::ipc::InvokeBody::default(),
|
||||
headers: Default::default(),
|
||||
invoke_key: tauri::test::INVOKE_KEY.into(),
|
||||
},
|
||||
);
|
||||
let error = response.expect_err("Remote native commands must be rejected");
|
||||
assert!(error.as_str().unwrap().contains("not allowed"), "{error}");
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn packaged_app_exposes_no_native_capabilities_or_global_api() {
|
||||
let config: serde_json::Value =
|
||||
serde_json::from_str(include_str!("../tauri.conf.json")).unwrap();
|
||||
assert_eq!(config["app"]["withGlobalTauri"], false);
|
||||
assert_eq!(
|
||||
config["app"]["security"]["capabilities"],
|
||||
serde_json::json!([])
|
||||
);
|
||||
let capabilities = std::path::Path::new(env!("CARGO_MANIFEST_DIR")).join("capabilities");
|
||||
assert!(
|
||||
!capabilities.exists() || std::fs::read_dir(capabilities).unwrap().next().is_none()
|
||||
);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,5 @@
|
||||
#![cfg_attr(not(debug_assertions), windows_subsystem = "windows")]
|
||||
|
||||
fn main() {
|
||||
kanbangit_native::run();
|
||||
}
|
||||
@@ -0,0 +1,25 @@
|
||||
{
|
||||
"$schema": "https://schema.tauri.app/config/2",
|
||||
"productName": "KanbanGit",
|
||||
"version": "0.1.0",
|
||||
"identifier": "de.kanbangit.desktop",
|
||||
"build": {
|
||||
"frontendDist": "../ui"
|
||||
},
|
||||
"app": {
|
||||
"windows": [],
|
||||
"withGlobalTauri": false,
|
||||
"security": {
|
||||
"csp": "default-src 'self'; script-src 'self'; style-src 'self'; img-src 'self'; connect-src 'none'; object-src 'none'; base-uri 'none'; form-action 'none'; frame-src 'none'",
|
||||
"capabilities": []
|
||||
}
|
||||
},
|
||||
"bundle": {
|
||||
"active": true,
|
||||
"targets": ["app"],
|
||||
"icon": ["icons/icon.png", "icons/icon.icns"],
|
||||
"macOS": {
|
||||
"minimumSystemVersion": "11.0"
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,107 @@
|
||||
#[cfg(target_os = "macos")]
|
||||
fn main() {
|
||||
use std::sync::{
|
||||
atomic::{AtomicBool, Ordering},
|
||||
Arc,
|
||||
};
|
||||
use tauri::{webview::PageLoadEvent, Manager};
|
||||
|
||||
let complete = Arc::new(AtomicBool::new(false));
|
||||
let passed = Arc::new(AtomicBool::new(false));
|
||||
let navigation_complete = complete.clone();
|
||||
let navigation_passed = passed.clone();
|
||||
let plugin = tauri::plugin::Builder::<tauri::Wry>::new("macos-smoke")
|
||||
.js_init_script("window.__nativeSmokeErrors = []; window.addEventListener('error', event => window.__nativeSmokeErrors.push(event.message || event.target.src), true);")
|
||||
.on_page_load(|webview, payload| {
|
||||
if payload.event() != PageLoadEvent::Finished {
|
||||
return;
|
||||
}
|
||||
if webview.label() == "launcher" {
|
||||
webview.eval(r#"
|
||||
(async () => {
|
||||
for (let attempt = 0; attempt < 100; attempt++) {
|
||||
if (document.querySelector('.open-workspace')?.textContent === 'Open workspace') break;
|
||||
await new Promise(resolve => setTimeout(resolve, 100));
|
||||
}
|
||||
const link = document.querySelector('.open-workspace');
|
||||
const appearance = document.querySelector('#appearance');
|
||||
const translated = link?.textContent === 'Open workspace';
|
||||
appearance.value = 'dark';
|
||||
appearance.dispatchEvent(new Event('change'));
|
||||
const dark = getComputedStyle(document.documentElement).backgroundColor === 'rgb(15, 23, 42)';
|
||||
appearance.value = 'light';
|
||||
appearance.dispatchEvent(new Event('change'));
|
||||
const light = getComputedStyle(document.documentElement).backgroundColor === 'rgb(247, 249, 251)';
|
||||
appearance.value = 'system';
|
||||
appearance.dispatchEvent(new Event('change'));
|
||||
if (translated && dark && light) {
|
||||
link.click();
|
||||
} else {
|
||||
location.href = 'tauri://localhost/__native_smoke_result?passed=false&stage=launcher&translated=' + translated + '&dark=' + dark + '&light=' + light + '&background=' + encodeURIComponent(getComputedStyle(document.documentElement).backgroundColor) + '&label=' + encodeURIComponent(link?.textContent) + '&errors=' + encodeURIComponent(JSON.stringify(window.__nativeSmokeErrors));
|
||||
}
|
||||
})();
|
||||
"#).unwrap();
|
||||
} else if webview.label() == "workspace" {
|
||||
webview.eval(r#"
|
||||
(async () => {
|
||||
for (let attempt = 0; attempt < 100; attempt++) {
|
||||
if (document.querySelector('#app')?.innerText.trim().length > 100) break;
|
||||
await new Promise(resolve => setTimeout(resolve, 100));
|
||||
}
|
||||
const root = document.querySelector('#app');
|
||||
const rendered = root?.innerText.trim().length > 100 && root.getBoundingClientRect().height > 0;
|
||||
let denied = true;
|
||||
for (const cmd of ['plugin:path|resolve_directory', 'plugin:window|get_all_windows']) {
|
||||
try {
|
||||
await window.__TAURI_INTERNALS__.invoke(cmd);
|
||||
denied = false;
|
||||
} catch (error) {
|
||||
denied = denied && String(error).includes('not allowed');
|
||||
}
|
||||
}
|
||||
const noGlobalApi = typeof window.__TAURI__ === 'undefined';
|
||||
const report = new URL('/__native_smoke_result', location.origin);
|
||||
report.searchParams.set('passed', String(rendered && denied && noGlobalApi));
|
||||
report.searchParams.set('rendered', String(rendered));
|
||||
report.searchParams.set('nativeDenied', String(denied));
|
||||
report.searchParams.set('globalAbsent', String(noGlobalApi));
|
||||
location.href = report.href;
|
||||
})();
|
||||
"#).unwrap();
|
||||
}
|
||||
})
|
||||
.on_navigation(move |webview, url| {
|
||||
if url.path() != "/__native_smoke_result" {
|
||||
return true;
|
||||
}
|
||||
let success = url.query_pairs().any(|(key, value)| key == "passed" && value == "true");
|
||||
println!("macOS WebView smoke test: {}", url.query().unwrap_or_default());
|
||||
navigation_passed.store(success, Ordering::SeqCst);
|
||||
navigation_complete.store(true, Ordering::SeqCst);
|
||||
webview.app_handle().exit(if success { 0 } else { 1 });
|
||||
false
|
||||
})
|
||||
.build();
|
||||
let app = kanbangit_native::builder()
|
||||
.plugin(plugin)
|
||||
.build(kanbangit_native::context())
|
||||
.expect("The macOS application must start");
|
||||
let handle = app.handle().clone();
|
||||
std::thread::spawn(move || {
|
||||
std::thread::sleep(std::time::Duration::from_secs(30));
|
||||
if !complete.load(Ordering::SeqCst) {
|
||||
eprintln!("macOS smoke test timed out before the server UI rendered");
|
||||
handle.exit(1);
|
||||
}
|
||||
});
|
||||
app.run_return(|_, _| {});
|
||||
assert!(
|
||||
passed.load(Ordering::SeqCst),
|
||||
"The native smoke test must complete successfully"
|
||||
);
|
||||
}
|
||||
|
||||
#[cfg(not(target_os = "macos"))]
|
||||
fn main() {
|
||||
panic!("Run this smoke test on macOS with an active graphical session");
|
||||
}
|
||||
Reference in New Issue
Block a user