add bridge download/management

Author: atomicptr

crates/core/src/bridge.rs

@@ -0,0 +1,142 @@
+use anyhow::{Context, Result, bail};
+use std::{
+    fs::{self},
+    path::{Path, PathBuf},
+    time::Duration,
+};
+use version_compare::Version;
+
+use crate::github;
+
+#[cfg(target_os = "windows")]
+const EXE_SUFFIX: &'static str = ".exe";
+
+#[cfg(not(target_os = "windows"))]
+const EXE_SUFFIX: &str = "";
+
+#[cfg(target_os = "linux")]
+const NAME: &str = "linux-x86-defold-nvim-bridge";
+
+#[cfg(all(target_os = "macos", target_arch = "x86_64"))]
+const NAME: &str = "macos-x86-defold-nvim-bridge";
+
+#[cfg(all(target_os = "macos", target_arch = "aarch64"))]
+const NAME: &str = "macos-arm-defold-nvim-bridge";
+
+#[cfg(target_os = "windows")]
+const NAME: &str = "windows-x86-defold-nvim-bridge";
+
+const OWNER: &str = "atomicptr";
+const REPOSITORY: &str = "defold.nvim";
+
+pub fn path(plugin_root: &Path) -> Result<PathBuf> {
+    let exe = exe_name();
+
+    if plugin_root.exists() {
+        let candidates = [
+            plugin_root.join(&exe),
+            plugin_root.join("target").join("debug").join(&exe),
+            plugin_root.join("target").join("release").join(&exe),
+        ];
+
+        if let Some(bridge_path) = candidates.into_iter().find(|p| p.exists()) {
+            return Ok(bridge_path);
+        }
+    }
+
+    install()
+}
+
+fn exe_name() -> String {
+    format!("defold-nvim-bridge{EXE_SUFFIX}")
+}
+
+fn local_path() -> Result<PathBuf> {
+    let dir = dirs::data_dir()
+        .context("could not get state dir")?
+        .join("defold.nvim")
+        .join("bin");
+
+    fs::create_dir_all(&dir)?;
+
+    Ok(dir.join(exe_name()))
+}
+
+fn version_path() -> Result<PathBuf> {
+    let dir = dirs::data_dir()
+        .context("could not get state dir")?
+        .join("defold.nvim")
+        .join("meta");
+
+    fs::create_dir_all(&dir)?;
+
+    Ok(dir.join("bridge_version"))
+}
+
+fn version() -> Result<String> {
+    let file = version_path()?;
+
+    if !file.exists() {
+        bail!("Version not found");
+    }
+
+    Ok(fs::read_to_string(file)?)
+}
+
+fn is_update_available() -> Result<bool> {
+    if version_path()?.exists() {
+        // if the version file is younger than a week dont bother
+        let last_modified = version_path()?.metadata()?.modified()?;
+        if last_modified.elapsed()? < Duration::from_hours(24 * 7) {
+            return Ok(false);
+        }
+    }
+
+    let Ok(v) = version() else {
+        return Ok(true);
+    };
+
+    // re-write the file again so that we only check once a week
+    fs::write(version_path()?, &v)?;
+
+    tracing::debug!("Bridge Version {v} installed");
+
+    let Some(installed) = Version::from(&v) else {
+        return Ok(true);
+    };
+
+    let release = github::fetch_release(OWNER, REPOSITORY)?;
+
+    tracing::debug!("Bridge Version {} is newest", release.tag_name);
+
+    let Some(current) = Version::from(&release.tag_name) else {
+        return Ok(false);
+    };
+
+    Ok(current > installed)
+}
+
+fn install() -> Result<PathBuf> {
+    let path = local_path()?;
+
+    if path.exists() && !is_update_available()? {
+        return local_path();
+    }
+
+    let (downloaded_file, release) = github::download_release(OWNER, REPOSITORY, NAME)?;
+
+    tracing::debug!("New Bridge version found {}", release.tag_name);
+
+    fs::rename(downloaded_file, &path)?;
+    fs::write(version_path()?, release.tag_name)?;
+
+    #[cfg(any(target_os = "linux", target_os = "macos"))]
+    {
+        use std::{fs::Permissions, os::unix::fs::PermissionsExt};
+        fs::set_permissions(&path, Permissions::from_mode(0o700))?;
+    }
+
+    github::clear_downloads(OWNER, REPOSITORY)?;
+
+    Ok(path)
+}

crates/core/src/editor_config.rs

@@ -7,6 +7,8 @@ use std::{
     str::FromStr,
 };
 
+use crate::bridge;
+
 #[derive(Debug, Deserialize)]
 pub enum LauncherType {
     #[serde(rename = "neovide")]
@@ -104,31 +106,6 @@ const SCRIPT_EXT: &'static str = "bat";
 #[cfg(not(target_os = "windows"))]
 const SCRIPT_EXT: &str = "sh";
 
-#[cfg(target_os = "windows")]
-const EXE_SUFFIX: &'static str = ".exe";
-
-#[cfg(not(target_os = "windows"))]
-const EXE_SUFFIX: &str = "";
-
-fn find_bridge_path(plugin_root: &Path) -> Result<PathBuf> {
-    let exe = format!("defold-nvim-bridge{EXE_SUFFIX}");
-
-    if plugin_root.exists() {
-        let candidates = [
-            plugin_root.join(&exe),
-            plugin_root.join("target").join("debug").join(&exe),
-            plugin_root.join("target").join("release").join(&exe),
-        ];
-
-        if let Some(bridge_path) = candidates.into_iter().find(|p| p.exists()) {
-            return Ok(bridge_path);
-        }
-    }
-
-    // TODO: if not lets download it
-    bail!("not yet implemented")
-}
-
 fn create_runner_script(
     plugin_root: &Path,
     launcher_settings: &LauncherSettings,
@@ -140,7 +117,7 @@ fn create_runner_script(
     fs::create_dir_all(&dir)?;
 
     let script_path = dir.join(format!("run.{SCRIPT_EXT}"));
-    let bridge_path = find_bridge_path(plugin_root)?;
+    let bridge_path = bridge::path(plugin_root)?;
     let launch_args = launcher_settings.bridge_cli_args().join(" ");
 
     fs::write(

crates/core/src/lib.rs

@@ -1,3 +1,4 @@
+pub mod bridge;
 pub mod cache;
 pub mod defold_annotations;
 pub mod editor;

crates/sidecar/src/lib.rs

@@ -1,5 +1,5 @@
 use anyhow::Context;
-use defold_nvim_core::{editor, editor_config, mobdap, project};
+use defold_nvim_core::{bridge, editor, editor_config, mobdap, project};
 use defold_nvim_core::{focus, game_project::GameProject};
 use mlua::Value;
 use mlua::prelude::*;
@@ -68,6 +68,7 @@ fn register_exports(lua: &Lua) -> LuaResult<LuaTable> {
         "set_default_editor",
         lua.create_function(set_default_editor)?,
     )?;
+    exports.set("find_bridge_path", lua.create_function(find_bridge_path)?)?;
     exports.set("focus_neovim", lua.create_function(focus_neovim)?)?;
     exports.set("focus_game", lua.create_function(focus_game)?)?;
     exports.set("mobdap_install", lua.create_function(mobdap_install)?)?;
@@ -140,6 +141,15 @@ fn set_default_editor(
     Ok(())
 }
 
+fn find_bridge_path(_lua: &Lua, plugin_root: String) -> LuaResult<String> {
+    let path = bridge::path(&absolute(plugin_root)?)?;
+
+    Ok(path
+        .to_str()
+        .context("could not convert path to string")?
+        .to_string())
+}
+
 fn focus_neovim(_lua: &Lua, game_root: String) -> LuaResult<()> {
     focus::focus_neovim(absolute(game_root)?)?;
 

lua/defold/init.lua

@@ -219,7 +219,13 @@ end
 
 ---Makes sure the native library `sidecar` gets loaded
 function M.download()
-    require "defold.sidecar"
+    local log = require "defold.service.logger"
+    local sidecar = require "defold.sidecar"
+
+    local ok, err = pcall(sidecar.find_bridge_path, M.plugin_root())
+    if not ok then
+        log.error(string.format("Could not setup bridge: %s", err))
+    end
 end
 
 function M.load_plugin()
@@ -239,7 +245,13 @@ function M.load_plugin()
     local project = require "defold.project"
 
     log.debug "============= defold.nvim: Loaded plugin"
-    log.debug("Sidecar Version:" .. sidecar.version)
+    log.debug("Sidecar Version: " .. sidecar.version)
+
+    local bridge_ok, bridge_path = pcall(sidecar.find_bridge_path, M.plugin_root())
+    if bridge_ok then
+        log.debug("Bridge Path: " .. bridge_path)
+    end
+
     if debugger.mobdap_path() then
         log.debug("Mobdap Path: " .. debugger.mobdap_path())
     end

lua/defold/sidecar.lua

@@ -123,6 +123,7 @@ package.cpath = package.cpath
 ---@field list_commands function(port: integer|nil): table<string, string>
 ---@field send_command function(port: integer|nil, cmd: string)
 ---@field set_default_editor function(plugin_root: string, launcher_config: LauncherSettings)
+---@field find_bridge_path function(plugin_root: string): string
 ---@field focus_neovim function(game_root: string)
 ---@field focus_game function(game_root: string)
 ---@field mobdap_install function(): string