feat: improve runner and executer notification handling (#254)

* feat: improve runner and executer notification handling

With the new approach we get rid of the global states managed in the
notifications table. Everything is capsulated within the created
notification instance.
That also allows to fix an issue where a notification is dismissed while
a build process is still ongoing and the spinner should be updated.
Updating the spinner fails, because the notification timed out and got
dismissed, resulting in a repeating "No Matching notification to replace
found" error.
The new instance based approach tracks the shown notification and
replaces any existing notification when the message is updated. If the
notification times out and is dismissed, the instance will create a new
notification automatically.

* feat: automatically resize notification window

When the content gets updated, the notification window is resized to
match the new message

---------

Co-authored-by: Denzel <>

Author: lceWolf

lua/cmake-tools/init.lua

@@ -34,6 +34,8 @@ function cmake.setup(values)
     const.cmake_runner.opts or {}
   )
 
+  require("cmake-tools.notification").setup(const.cmake_notifications)
+
   config = Config:new(const)
 
   -- auto reload previous session
@@ -119,7 +121,7 @@ function cmake.generate(opt, callback)
       end
       cmake.configure_compile_commands()
       cmake.create_regenerate_on_save_autocmd()
-    end, const.cmake_notifications)
+    end)
   end
 
   -- if exists cmake-kits.json, kit is used to set
@@ -181,7 +183,7 @@ function cmake.generate(opt, callback)
     end
     cmake.configure_compile_commands()
     cmake.create_regenerate_on_save_autocmd()
-  end, const.cmake_notifications)
+  end)
 end
 
 --- Clean targets
@@ -208,7 +210,7 @@ function cmake.clean(callback)
     if type(callback) == "function" then
       callback()
     end
-  end, const.cmake_notifications)
+  end)
 end
 
 --- Build this project using the make toolchain of target platform
@@ -276,7 +278,7 @@ function cmake.build(opt, callback)
     if type(callback) == "function" then
       callback()
     end
-  end, const.cmake_notifications)
+  end)
 end
 
 function cmake.quick_build(opt, callback)
@@ -341,8 +343,7 @@ function cmake.install(opt)
     args,
     config.cwd,
     config.executor,
-    nil,
-    const.cmake_notifications
+    nil
   )
 end
 
@@ -421,16 +422,7 @@ function cmake.run(opt)
       local env = environment.get_run_environment(config, opt.target)
       local _args = opt.args and opt.args or config.target_settings[opt.target].args
       local cmd = target_path
-      utils.run(
-        cmd,
-        config.env_script,
-        env,
-        _args,
-        launch_path,
-        config.runner,
-        nil,
-        const.cmake_notifications
-      )
+      utils.run(cmd, config.env_script, env, _args, launch_path, config.runner, nil)
     end)
   else
     local result = config:get_launch_target()
@@ -468,8 +460,7 @@ function cmake.run(opt)
             cmake:get_launch_args(),
             launch_path,
             config.runner,
-            nil,
-            const.cmake_notifications
+            nil
           )
         end
       )

lua/cmake-tools/notification.lua

@@ -1,33 +1,100 @@
 local has_notify, notify = pcall(require, "notify")
 
-local notification = {
-  notification = {},
-}
-
-function notification.update_spinner() -- update spinner helper function to defer
-  if notification.notification.spinner_idx then
-    local new_spinner = (notification.notification.spinner_idx + 1)
-      % #notification.notification.spinner
-    notification.notification.spinner_idx = new_spinner
-
-    notification.notification.id = notification.notify(nil, notification.notification.level, {
-      title = "CMakeTools",
-      hide_from_history = true,
-      icon = notification.notification.spinner[new_spinner],
-      replace = notification.notification.id,
-    })
-
-    vim.defer_fn(function()
-      notification.update_spinner()
-    end, notification.notification.refresh_rate_ms)
+local function render(self)
+  if self.closed then
+    self.opts.replace = nil
+  else
+    self.opts.replace = self.id
   end
+
+  self.id = notify(self.msg, self.level, self.opts)
+  self.opts.replace = nil
+  self.closed = false
+end
+
+local config = {}
+local Notification = {}
+
+function Notification.setup(cfg)
+  config = cfg
+end
+
+function Notification:new(type)
+  local instance = setmetatable({}, self)
+  self.__index = self
+
+  instance.spinner_idx = 1
+  instance.closed = true
+  instance.enabled = has_notify and config[type].enabled
+
+  instance.spinnerTimer = vim.loop.new_timer()
+
+  return instance
+end
+
+function Notification:startSpinner()
+  if not self.enabled or self.spinnerRunning then
+    return
+  end
+  self.spinnerRunning = true
+  self.spinnerTimer:start(
+    config.refresh_rate_ms,
+    config.refresh_rate_ms,
+    vim.schedule_wrap(function()
+      self.spinner_idx = (self.spinner_idx + 1) % #config.spinner
+
+      self.opts.replace = self.id
+      self.opts.icon = config.spinner[self.spinner_idx]
+      render(self)
+    end)
+  )
+end
+
+function Notification:stopSpinner()
+  self.spinnerRunning = false
+  self.spinnerTimer:stop()
 end
 
-function notification.notify(msg, lvl, opts)
-  if notification.notification.enabled and has_notify then
-    opts.hide_from_history = true
-    return notify(msg, lvl, opts)
+function Notification:notify(msg, level, opts)
+  if not self.enabled then
+    return
+  end
+
+  self.msg = msg or ""
+  self.level = level
+  self.opts = opts or {}
+
+  local on_close = self.opts.on_close
+  local on_open = self.opts.on_open
+
+  self.opts.hide_from_history = true
+  self.opts.title = "CMakeTools"
+  self.opts.on_close = function(win)
+    self.closed = true
+    if on_close then
+      on_close(win)
+    end
+  end
+  self.opts.on_open = function(win)
+    self.win = win
+    self.width = vim.api.nvim_win_get_width(win)
+    if on_open then
+      on_open(win)
+    end
+  end
+
+  render(self)
+
+  -- update the notification width when the message was updated
+  local timeDigits = 8
+  local headlineLength = (self.opts.icon and (#self.opts.icon + 1) or 0)
+    + #self.opts.title
+    + 3 -- padding between title and time
+    + timeDigits
+
+  if self.width then
+    vim.api.nvim_win_set_width(self.win, math.max(#self.msg + 1, headlineLength))
   end
 end
 
-return notification
+return Notification

lua/cmake-tools/utils.lua

@@ -160,18 +160,17 @@ function utils.has_active_job(runner_data, executor_data)
     or utils.get_runner(runner_data.name).has_active_job(runner_data.opts)
 end
 
-local notify_update_line = function(out, err)
-  if not notification.notification.enabled then
-    return
-  end
-  local line = err and err or out
-  if line ~= nil then
-    if line and vim.fn.match(line, "^%[%s*(%d+)%s*%%%]") then -- only show lines containing build progress e.g [ 12%]
-      notification.notification.id = notification.notify( -- notify with percentage and message
-        line,
-        err and "warn" or notification.notification.level,
-        { replace = notification.notification.id, title = "CMakeTools" }
-      )
+local notify_update_line = function(ntfy)
+  return function(out, err)
+    if not ntfy.enabled then
+      return
+    end
+    local line = err and err or out
+    if line ~= nil then
+      if line and vim.fn.match(line, "^%[%s*(%d+)%s*%%%]") then -- only show lines containing build progress e.g [ 12%]
+        ntfy:notify(line, err and "warn" or "info")
+        ntfy:startSpinner()
+      end
     end
   end
 end
@@ -185,44 +184,31 @@ end
 ---@param runner runner_conf the executor or runner
 ---@param on_success nil|function extra arguments, f.e on_success is a callback to be called when the process finishes
 ---@return nil
-function utils.run(cmd, env_script, env, args, cwd, runner, on_success, cmake_notifications)
+function utils.run(cmd, env_script, env, args, cwd, runner, on_success)
   -- save all
   vim.cmd("silent exec " .. '"wall"')
 
-  notification.notification = cmake_notifications
-  notification.notification.enabled = cmake_notifications.runner.enabled
+  local ntfy = notification:new("runner")
 
-  if notification.notification.enabled then
-    notification.notification.spinner_idx = 1
-    notification.notification.level = "info"
-
-    notification.notification.id =
-      notification.notify(cmd, notification.notification.level, { title = "CMakeTools" })
-    notification.update_spinner()
-  end
+  ntfy:notify(cmd, "info")
 
   local _mes =
     { "[RUN]:", cmd, table.concat(args, " "), "<ENV>", table.concat(env, " "), "{CWD}", cwd }
   scratch.append(table.concat(_mes, " "))
 
   utils.get_runner(runner.name).run(cmd, env_script, env, args, cwd, runner.opts, function(code)
     local msg = "Exited with code " .. code
-    local level = cmake_notifications.level
     local icon = ""
+    local level = nil -- use the previously defined level
     if code ~= 0 then
       level = "error"
       icon = ""
     end
-    notification.notify(
-      msg,
-      level,
-      { icon = icon, replace = notification.notification.id, timeout = 3000 }
-    )
-    notification.notification = {} -- reset and stop update_spinner
+    ntfy:notify(msg, level, { icon = icon, timeout = 3000 })
     if code == 0 and on_success then
       on_success()
     end
-  end, notify_update_line)
+  end, notify_update_line(ntfy))
 end
 
 ---Run a command using specified executor, this is used by generate, build, clean, install, etc.
@@ -234,21 +220,12 @@ end
 ---@param executor executor_conf the executor or runner
 ---@param on_success nil|function extra arguments, f.e on_success is a callback to be called when the process exits with a 0 exit code
 ---@return nil
-function utils.execute(cmd, env_script, env, args, cwd, executor, on_success, cmake_notifications)
+function utils.execute(cmd, env_script, env, args, cwd, executor, on_success)
   -- save all
   vim.cmd("silent exec " .. '"wall"')
 
-  notification.notification = cmake_notifications
-  notification.notification.enabled = cmake_notifications.executor.enabled
-
-  if notification.notification.enabled then
-    notification.notification.spinner_idx = 1
-    notification.notification.level = "info"
-
-    notification.notification.id =
-      notification.notify(cmd, notification.notification.level, { title = "CMakeTools" })
-    notification.update_spinner()
-  end
+  local ntfy = notification:new("executor")
+  ntfy:notify(cmd, "info")
 
   local _mes =
     { "[EXECUTE]:", cmd, table.concat(args, " "), "<ENV>", table.concat(env, " "), "{CWD}", cwd }
@@ -257,23 +234,19 @@ function utils.execute(cmd, env_script, env, args, cwd, executor, on_success, cm
   utils
     .get_executor(executor.name)
     .run(cmd, env_script, env, args, cwd, executor.opts, function(code)
+      ntfy:stopSpinner()
       local msg = "Exited with code " .. code
-      local level = cmake_notifications.level
+      local level = nil -- use the previously defined level
       local icon = ""
       if code ~= 0 then
         level = "error"
         icon = ""
       end
-      notification.notify(
-        msg,
-        level,
-        { icon = icon, replace = notification.notification.id, timeout = 3000 }
-      )
-      notification.notification = {} -- reset and stop update_spinner
+      ntfy:notify(msg, level, { icon = icon, timeout = 3000 })
       if code == 0 and type(on_success) == "function" then
         on_success()
       end
-    end, notify_update_line)
+    end, notify_update_line(ntfy))
 end
 
 return utils