fix defold api breaking change, set minimum version to 1.12.3

Author: atomicptr

README.md

@@ -17,6 +17,10 @@ Batteries-included development environment for the [Defold game engine](https://
 
 ## System Requirements
 
+### Defold
+
+The minimum supported Defold version is: **1.12.3**
+
 ### Operating System
 
 - Linux 🐧   - First class & fully supported

crates/core/src/editor.rs

@@ -1,10 +1,20 @@
-use std::{collections::HashMap, fs, path::Path};
+use std::{fs, path::Path};
 
-use anyhow::{Result, bail};
+use anyhow::{Context, Result, bail};
+use serde_json::Value;
+
+fn editor_url(port: u16) -> String {
+    format!("http://127.0.0.1:{port}")
+}
+
+fn openapi_url(port: u16) -> String {
+    format!("{}/openapi.json", editor_url(port))
+}
 
 fn command_url(port: u16, command: Option<String>) -> String {
     format!(
-        "http://127.0.0.1:{port}/command/{}",
+        "{}/command/{}",
+        editor_url(port),
         command.unwrap_or_default()
     )
 }
@@ -32,23 +42,35 @@ pub fn find_port(game_root: &Path) -> Option<u16> {
 #[must_use]
 pub fn is_editor_port(port: u16) -> bool {
     reqwest::blocking::Client::new()
-        .head(command_url(port, None))
+        .head(editor_url(port))
         .send()
         .is_ok_and(|r| r.status().is_success())
 }
 
-pub fn list_commands(port: u16) -> Result<HashMap<String, String>> {
-    let url = command_url(port, None);
+pub fn list_commands(port: u16) -> Result<Vec<String>> {
+    let url = openapi_url(port);
 
     let res = reqwest::blocking::get(url)?;
 
     if !res.status().is_success() {
         bail!("could not list commands, status: {:?}", res.status());
     }
 
-    let content = res.text()?.clone();
+    let root: Value = res.json().context("Failed to parse OpenAPI JSON")?;
 
-    serde_json::from_str(&content).map_err(anyhow::Error::from)
+    let enum_values =
+        &root["paths"]["/command/{command}"]["post"]["parameters"][0]["schema"]["enum"];
+
+    if let Some(list) = enum_values.as_array() {
+        let commands = list
+            .iter()
+            .filter_map(|v| v.as_str().map(|s| s.to_string()))
+            .collect();
+
+        Ok(commands)
+    } else {
+        bail!("Could not find command values in the OpenAPI specification")
+    }
 }
 
 pub fn send_command(port: u16, cmd: &str) -> Result<()> {

crates/sidecar/src/lib.rs

@@ -143,7 +143,13 @@ fn is_editor_port(_lua: &Lua, port: u16) -> LuaResult<bool> {
 fn list_commands(lua: &Lua, port: u16) -> LuaResult<LuaTable> {
     let commands = editor::list_commands(port)?;
 
-    lua.create_table_from(commands)
+    let table = lua.create_table()?;
+
+    for (i, cmd) in commands.into_iter().enumerate() {
+        table.set(i + 1, cmd)?;
+    }
+
+    Ok(table)
 }
 
 #[instrument(level = "debug", err(Debug), skip_all)]

lua/defold/editor.lua

@@ -1,7 +1,7 @@
 local M = {}
 
 ---List all available Defold commands
----@return table|nil
+---@return string[]
 function M.list_commands()
     local log = require "defold.service.logger"
     local project = require "defold.project"
@@ -10,7 +10,7 @@ function M.list_commands()
 
     if not port then
         log.error "Could not find Defold editor, is it running?"
-        return
+        return {}
     end
 
     local sidecar = require "defold.sidecar"
@@ -19,10 +19,9 @@ function M.list_commands()
 
     if not ok then
         log.error(string.format("Could not fetch commands from Defold, because: %s", res))
-        return nil
+        return {}
     end
 
-    ---@cast res table<string, string>
     return res
 end
 

lua/defold/init.lua

@@ -258,14 +258,14 @@ function M.load_plugin()
             return
         end
 
-        for cmd, desc in pairs(commands) do
+        for _, cmd in ipairs(commands) do
             -- hide debugger related commands as they'd give the user the impression that these
             -- work with our debugger integration
             local is_debugger_command = string.find(cmd, "debugger")
 
             if not is_debugger_command then
                 table.insert(cmds, cmd)
-                table.insert(options, string.format("%s - %s", cmd, desc))
+                table.insert(options, cmd)
             end
         end