Merge pull request #2680 from emmericp/throttle-awaits

Throttle calls to await.delay() in some diagnostics

Author: sumneko

script/await.lua

@@ -176,6 +176,28 @@ function m.delay()
     return coroutine.yield()
 end
 
+local throttledDelayer = {}
+throttledDelayer.__index = throttledDelayer
+
+---@async
+function throttledDelayer:delay()
+    if not m._enable then
+        return
+    end
+    self.calls = self.calls + 1
+    if self.calls == self.factor then
+        self.calls = 0
+        return m.delay()
+    end
+end
+
+function m.newThrottledDelayer(factor)
+    return setmetatable({
+        factor = factor,
+        calls = 0,
+    }, throttledDelayer)
+end
+
 --- stop then close
 ---@async
 function m.stop()

script/core/diagnostics/assign-type-mismatch.lua

@@ -52,13 +52,14 @@ return function (uri, callback)
         return
     end
 
+    local delayer = await.newThrottledDelayer(15)
     ---@async
     guide.eachSourceTypes(state.ast, checkTypes, function (source)
         local value = source.value
         if not value then
             return
         end
-        await.delay()
+        delayer:delay()
         if source.type == 'setlocal' then
             local locNode = vm.compileNode(source.node)
             if not locNode.hasDefined then

script/core/diagnostics/need-check-nil.lua

@@ -11,9 +11,10 @@ return function (uri, callback)
         return
     end
 
+    local delayer = await.newThrottledDelayer(500)
     ---@async
     guide.eachSourceType(state.ast, 'getlocal', function (src)
-        await.delay()
+        delayer:delay()
         local checkNil
         local nxt = src.next
         if nxt then

script/core/diagnostics/redundant-value.lua

@@ -11,8 +11,9 @@ return function (uri, callback)
         return
     end
 
+    local delayer = await.newThrottledDelayer(50000)
     guide.eachSource(state.ast, function (src) ---@async
-        await.delay()
+        delayer:delay()
         if src.redundant then
             callback {
                 start   = src.start,

script/core/diagnostics/trailing-space.lua

@@ -10,9 +10,10 @@ return function (uri, callback)
     if not state or not text then
         return
     end
+    local delayer = await.newThrottledDelayer(5000)
     local lines = state.lines
     for i = 0, #lines do
-        await.delay()
+        delayer:delay()
         local startOffset  = lines[i]
         local finishOffset = text:find('[\r\n]', startOffset) or (#text + 1)
         local lastOffset   = finishOffset - 1

script/core/diagnostics/unbalanced-assignments.lua

@@ -41,9 +41,10 @@ return function (uri, callback, code)
         end
     end
 
+    local delayer = await.newThrottledDelayer(1000)
     ---@async
     guide.eachSourceTypes(ast.ast, types, function (source)
-        await.delay()
+        delayer:delay()
         checkSet(source)
     end)
 end