fix(snippets): insert nested snippet with cursor change

chemzqm · chemzqm · commit a16b6f058705 · 2025-04-28T02:05:04.000+08:00
Cancel snippet session and remove insert range to make sure cursor
position is correct for nested snippet.
diff --git a/src/__tests__/snippets/manager.test.ts b/src/__tests__/snippets/manager.test.ts
@@ -1,17 +1,22 @@
 import { Neovim } from '@chemzqm/neovim'
 import path from 'path'
-import { InsertTextMode, Position, Range, TextEdit } from 'vscode-languageserver-protocol'
+import { CompletionItem, Disposable, InsertTextFormat, InsertTextMode, Position, Range, TextEdit } from 'vscode-languageserver-protocol'
 import commandManager from '../../commands'
 import events from '../../events'
+import languages from '../../languages'
 import Document from '../../model/document'
+import { CompletionItemProvider } from '../../provider'
 import snippetManager, { SnippetManager } from '../../snippets/manager'
 import { SnippetString } from '../../snippets/string'
+import { disposeAll } from '../../util'
 import window from '../../window'
 import workspace from '../../workspace'
 import helper from '../helper'
 
 let nvim: Neovim
 let doc: Document
+let disposables: Disposable[] = []
+
 beforeAll(async () => {
   await helper.setup()
   nvim = helper.nvim
@@ -24,6 +29,7 @@ afterAll(async () => {
 })
 
 afterEach(async () => {
+  disposeAll(disposables)
   await helper.reset()
 })
 
@@ -172,6 +178,34 @@ describe('snippet provider', () => {
       let last = await nvim.getVar('last')
       expect(last).toBe('i')
     })
+
+    it('should insert nested snippet on CompleteDone with correct position', async () => {
+      await snippetManager.insertSnippet('`!p snip.rv = " " * (10 - len(t[1]))`${1:inner}', true, Range.create(0, 0, 0, 0), InsertTextMode.asIs, {})
+      let bufnr = await nvim.call('bufnr', ['%']) as number
+      let session = snippetManager.getSession(bufnr)
+      expect(session.isActive).toBe(true)
+      let line = await nvim.line
+      expect(line).toBe('     inner')
+      let provider: CompletionItemProvider = {
+        provideCompletionItems: async (): Promise<CompletionItem[]> => [{
+          label: 'bar',
+          insertTextFormat: InsertTextFormat.Snippet,
+          textEdit: { range: Range.create(0, 5, 0, 6), newText: '${1:foobar}' },
+          preselect: true
+        }]
+      }
+      disposables.push(languages.registerCompletionItemProvider('edits', 'edit', null, provider))
+      await nvim.input('b')
+      await helper.waitPopup()
+      let res = await helper.items()
+      let idx = res.findIndex(o => o.source?.name == 'edits')
+      await helper.confirmCompletion(idx)
+      await session.synchronize()
+      let m = await nvim.mode
+      expect(m.mode).toBe('s')
+      line = await nvim.line
+      expect(line).toBe('    foobar')
+    })
   })
 
   describe('nextPlaceholder()', () => {
@@ -533,19 +567,6 @@ describe('snippet provider', () => {
     })
   })
 
-  describe('synchronizeSession', () => {
-    it('should synchronize range on session synchronize', async () => {
-      let active = await snippetManager.insertSnippet('foo foo$1', true)
-      expect(active).toBe(true)
-      let buf = await nvim.buffer
-      let range = Range.create(0, 4, 0, 7)
-      let session = snippetManager.getSession(buf.id)
-      nvim.call('setline', ['.', 'foo" foo'], true)
-      let newRange = await snippetManager.synchronizeSession(session, range)
-      expect(newRange).toEqual(Range.create(0, 5, 0, 8))
-    })
-  })
-
   describe('dispose()', () => {
     it('should dispose', async () => {
       let active = await snippetManager.insertSnippet('${1:foo}')
diff --git a/src/__tests__/snippets/snippet.test.ts b/src/__tests__/snippets/snippet.test.ts
@@ -565,7 +565,7 @@ describe('CocSnippet', () => {
       let p = c.getPlaceholderByIndex(index)
       expect(p != null).toBe(true)
       p.marker.setOnlyChild(new Text(value))
-      await c.tmSnippet.update(nvim, p.marker, ultisnip?.noPython ? [] : ['context = None'], CancellationToken.None)
+      await c.tmSnippet.update(nvim, p.marker, CancellationToken.None)
       expect(c.tmSnippet.toString()).toBe(result)
       return c
     }
@@ -593,7 +593,7 @@ describe('CocSnippet', () => {
       let p = c.getPlaceholderByIndex(2)
       expect(p).toBeDefined()
       p.marker.setOnlyChild(new Text('foo'))
-      await c.tmSnippet.update(nvim, p.marker, ['context = None'], CancellationToken.None)
+      await c.tmSnippet.update(nvim, p.marker, CancellationToken.None)
       let t = c.tmSnippet.toString()
       expect(t.startsWith(first)).toBe(true)
       expect(t.split('\n').map(s => s.endsWith('foo'))).toEqual([true, true, true])
diff --git a/src/snippets/manager.ts b/src/snippets/manager.ts
@@ -7,23 +7,20 @@ import BufferSync from '../model/bufferSync'
 import { StatusBarItem } from '../model/status'
 import { UltiSnippetOption } from '../types'
 import { defaultValue, disposeAll } from '../util'
-import { Mutex } from '../util/mutex'
 import { deepClone } from '../util/object'
 import { emptyRange, toValidRange } from '../util/position'
 import { Disposable } from '../util/protocol'
-import { getPositionFromEdits } from '../util/textedit'
 import window from '../window'
 import workspace from '../workspace'
 import { executePythonCode, generateContextId, getInitialPythonCode, hasPython } from './eval'
 import { SnippetConfig, SnippetSession } from './session'
 import { SnippetString } from './string'
-import { getAction, normalizeSnippetString, reduceTextEdit, shouldFormat, SnippetFormatOptions, UltiSnippetContext } from './util'
+import { getAction, normalizeSnippetString, shouldFormat, SnippetFormatOptions, UltiSnippetContext } from './util'
 
 export class SnippetManager {
   private disposables: Disposable[] = []
   private _statusItem: StatusBarItem
   private bufferSync: BufferSync<SnippetSession>
-  private mutex: Mutex = new Mutex()
   private config: SnippetConfig
 
   public init() {
@@ -112,120 +109,84 @@ export class SnippetManager {
    * Insert snippet to specific buffer, ultisnips not supported, and the placeholder is not selected
    */
   public async insertBufferSnippet(bufnr: number, snippet: string | SnippetString, range: Range, insertTextMode?: InsertTextMode): Promise<boolean> {
-    let release = await this.mutex.acquire()
-    try {
-      let document = workspace.getAttachedDocument(bufnr)
-      const session = this.bufferSync.getItem(bufnr)
-      range = await this.synchronizeSession(session, range)
-      range = toValidRange(range)
-      const currentLine = document.getline(range.start.line)
-      const snippetStr = SnippetString.isSnippetString(snippet) ? snippet.value : snippet
-      const inserted = await this.normalizeInsertText(document.bufnr, snippetStr, currentLine, insertTextMode)
-      let isActive = await session.start(inserted, range, false)
-      release()
-      return isActive
-    } catch (e) {
-      release()
-      throw e
-    }
-  }
-
-  /**
-   * Synchronize session when needed (ex: snippet insert during TextChange),
-   * the range could be changed
-   */
-  public async synchronizeSession(session: SnippetSession, range: Range): Promise<Range> {
-    let { document, isActive } = session
-    if (!isActive) return range
-    let disposable = document.onDocumentChange(e => {
-      let changes = e.contentChanges
-      let { start, end } = range
-      changes.forEach(change => {
-        let edit = reduceTextEdit(TextEdit.replace(change.range, change.text), e.original)
-        start = getPositionFromEdits(start, [edit])
-        end = getPositionFromEdits(end, [edit])
-      })
-      range = Range.create(start, end)
-    })
-    await session.forceSynchronize()
-    disposable.dispose()
-    return range
+    let document = workspace.getAttachedDocument(bufnr)
+    const session = this.bufferSync.getItem(bufnr)
+    session.cancel()
+    range = toValidRange(range)
+    const line = document.getline(range.start.line)
+    const snippetStr = SnippetString.isSnippetString(snippet) ? snippet.value : snippet
+    const inserted = await this.normalizeInsertText(document.bufnr, snippetStr, line, insertTextMode)
+    return await session.start(inserted, range, false)
   }
 
   /**
    * Insert snippet at current cursor position
    */
   public async insertSnippet(snippet: string | SnippetString, select = true, range?: Range, insertTextMode?: InsertTextMode, ultisnip?: UltiSnippetOption): Promise<boolean> {
     let { nvim } = workspace
-    let release = await this.mutex.acquire()
-    try {
-      let document = workspace.getAttachedDocument(workspace.bufnr)
-      const session = this.bufferSync.getItem(document.bufnr)
-      let context: UltiSnippetContext
-      if (range) await this.synchronizeSession(session, range)
-      range = await this.toRange(range)
-      const currentLine = document.getline(range.start.line)
-      const snippetStr = SnippetString.isSnippetString(snippet) ? snippet.value : snippet
-      const inserted = await this.normalizeInsertText(document.bufnr, snippetStr, currentLine, insertTextMode, ultisnip)
-      let usePy = false
-      if (ultisnip != null) {
-        usePy = hasPython(ultisnip) || inserted.includes('`!p')
-        const bufnr = document.bufnr
-        context = Object.assign({ range: deepClone(range), line: currentLine }, ultisnip, { id: generateContextId(bufnr) })
-        if (usePy) {
-          if (session.placeholder) {
-            let { start, end } = session.placeholder.range
-            let last = {
-              current_text: session.placeholder.value,
-              start: { line: start.line, col: start.character, character: start.character },
-              end: { line: end.line, col: end.character, character: end.character }
-            }
-            this.nvim.setVar('coc_last_placeholder', last, true)
-          } else {
-            this.nvim.call('coc#compat#del_var', ['coc_last_placeholder'], true)
-          }
-          const codes = getInitialPythonCode(context)
-          let preExpand = getAction(ultisnip, 'preExpand')
-          if (preExpand) {
-            await executePythonCode(nvim, codes.concat(['snip = coc_ultisnips_dict["PreExpandContext"]()', preExpand]))
-            const [valid, pos] = await nvim.call('pyxeval', 'snip.getResult()') as [boolean, [number, number]]
-            // need remove the trigger
-            if (valid) {
-              let count = range.end.character - range.start.character
-              let end = Position.create(pos[0], pos[1])
-              let start = Position.create(pos[0], Math.max(0, pos[1] - count))
-              range = Range.create(start, end)
-            } else {
-              // trigger removed already
-              let start = Position.create(pos[0], pos[1])
-              range = Range.create(start, deepClone(start))
-            }
-          } else {
-            await executePythonCode(nvim, codes)
+    let document = workspace.getAttachedDocument(workspace.bufnr)
+    const session = this.bufferSync.getItem(document.bufnr)
+    let context: UltiSnippetContext
+    session.cancel()
+    range = await this.toRange(range)
+    const currentLine = document.getline(range.start.line)
+    const snippetStr = SnippetString.isSnippetString(snippet) ? snippet.value : snippet
+    const inserted = await this.normalizeInsertText(document.bufnr, snippetStr, currentLine, insertTextMode, ultisnip)
+    let usePy = false
+    if (ultisnip != null) {
+      usePy = hasPython(ultisnip) || inserted.includes('`!p')
+      const bufnr = document.bufnr
+      context = Object.assign({ range: deepClone(range), line: currentLine }, ultisnip, { id: generateContextId(bufnr) })
+      if (usePy) {
+        if (session.placeholder) {
+          let { start, end } = session.placeholder.range
+          let last = {
+            current_text: session.placeholder.value,
+            start: { line: start.line, col: start.character, character: start.character },
+            end: { line: end.line, col: end.character, character: end.character }
           }
+          this.nvim.setVar('coc_last_placeholder', last, true)
+        } else {
+          this.nvim.call('coc#compat#del_var', ['coc_last_placeholder'], true)
         }
-        // same behavior as Ultisnips
-        const { start } = range
-        this.nvim.call('coc#cursor#move_to', [start.line, start.character], true)
-        if (!emptyRange(range)) {
-          await document.applyEdits([TextEdit.del(range)])
-          if (session.isActive) {
-            await session.synchronize()
-            // the cursor position may changed on session synchronize.
-            let pos = await window.getCursorPosition()
-            range = Range.create(pos, pos)
+        const codes = getInitialPythonCode(context)
+        let preExpand = getAction(ultisnip, 'preExpand')
+        if (preExpand) {
+          await executePythonCode(nvim, codes.concat(['snip = coc_ultisnips_dict["PreExpandContext"]()', preExpand]))
+          const [valid, pos] = await nvim.call('pyxeval', 'snip.getResult()') as [boolean, [number, number]]
+          // need remove the trigger
+          if (valid) {
+            let count = range.end.character - range.start.character
+            let end = Position.create(pos[0], pos[1])
+            let start = Position.create(pos[0], Math.max(0, pos[1] - count))
+            range = Range.create(start, end)
           } else {
-            range.end = Position.create(start.line, start.character)
+            // trigger removed already
+            let start = Position.create(pos[0], pos[1])
+            range = Range.create(start, deepClone(start))
           }
+        } else {
+          await executePythonCode(nvim, codes)
         }
       }
-      await session.start(inserted, range, select, context)
-      release()
-      return session.isActive
-    } catch (e) {
-      release()
-      throw e
     }
+    // same behavior as Ultisnips
+    // range could outside snippet range when session synchronize is canceled
+    const { start } = range
+    this.nvim.call('coc#cursor#move_to', [start.line, start.character], true)
+    if (!emptyRange(range)) {
+      await document.applyEdits([TextEdit.del(range)])
+      if (session.isActive) {
+        await session.synchronize()
+        // the cursor position may changed on session synchronize.
+        let pos = await window.getCursorPosition()
+        range = Range.create(pos, pos)
+      } else {
+        range.end = Position.create(start.line, start.character)
+      }
+    }
+    await session.start(inserted, range, select, context)
+    return session.isActive
   }
 
   public async selectCurrentPlaceholder(triggerAutocmd = true): Promise<void> {
@@ -286,18 +247,10 @@ export class SnippetManager {
   /**
    * Exposed for snippet preview
    */
-  public async resolveSnippet(snippetString: string, ultisnip?: UltiSnippetOption): Promise<string> {
+  public async resolveSnippet(snippetString: string, ultisnip?: UltiSnippetOption): Promise<string | undefined> {
     let session = this.bufferSync.getItem(workspace.bufnr)
     if (!session) return
-    let release = await this.mutex.acquire()
-    try {
-      let res = await session.resolveSnippet(this.nvim, snippetString, ultisnip)
-      release()
-      return res
-    } catch (e) {
-      release()
-      throw e
-    }
+    return await session.resolveSnippet(this.nvim, snippetString, ultisnip)
   }
 
   public async normalizeInsertText(bufnr: number, snippetString: string, currentLine: string, insertTextMode: InsertTextMode, ultisnip?: Partial<UltiSnippetOption>): Promise<string> {
@@ -306,7 +259,12 @@ export class SnippetManager {
       inserted = snippetString
     } else {
       const currentIndent = currentLine.match(/^\s*/)[0]
-      const formatOptions = window.activeTextEditor ? window.activeTextEditor.options : await workspace.getFormatOptions(bufnr) as SnippetFormatOptions
+      let formatOptions: SnippetFormatOptions
+      if (bufnr == window.activeTextEditor?.bufnr) {
+        formatOptions = window.activeTextEditor.options
+      } else {
+        formatOptions = await workspace.getFormatOptions(bufnr) as SnippetFormatOptions
+      }
       let opts: Partial<UltiSnippetOption> = ultisnip ?? {}
       // trim when option not exists
       formatOptions.trimTrailingWhitespace = opts.trimTrailingWhitespace !== false
diff --git a/src/snippets/snippet.ts b/src/snippets/snippet.ts
@@ -4,7 +4,7 @@ import { Position, Range } from 'vscode-languageserver-types'
 import events from '../events'
 import { LinesTextDocument } from '../model/textdocument'
 import { TabStopInfo } from '../types'
-import { defaultValue, waitNextTick } from '../util'
+import { defaultValue, waitWithToken } from '../util'
 import { adjacentPosition, comparePosition, emptyRange, getEnd, positionInRange, rangeInRange, samePosition } from '../util/position'
 import { CancellationToken } from '../util/protocol'
 import { getPyBlockCode, getResetPythonCode, hasPython } from './eval'
@@ -359,6 +359,7 @@ export class CocSnippet {
   }
 
   public async onMarkerUpdate(marker: Marker, token: CancellationToken): Promise<void> {
+    let ts = Date.now()
     while (marker != null) {
       if (marker instanceof Placeholder) {
         let snip = marker.snippet
@@ -371,7 +372,7 @@ export class CocSnippet {
       }
     }
     // Avoid document change fired during document change event, which may cause unexpected behavior.
-    await waitNextTick()
+    await waitWithToken(Math.max(0, 16 - Date.now() + ts), token)
     if (token.isCancellationRequested) return
     this.synchronize()
   }

Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,7 @@ import { Position, Range } from 'vscode-languageserver-types'`
`4`	`4`	`import events from '../events'`
`5`	`5`	`import { LinesTextDocument } from '../model/textdocument'`
`6`	`6`	`import { TabStopInfo } from '../types'`
`7`		`-import { defaultValue, waitNextTick } from '../util'`
	`7`	`+import { defaultValue, waitWithToken } from '../util'`
`8`	`8`	`import { adjacentPosition, comparePosition, emptyRange, getEnd, positionInRange, rangeInRange, samePosition } from '../util/position'`
`9`	`9`	`import { CancellationToken } from '../util/protocol'`
`10`	`10`	`import { getPyBlockCode, getResetPythonCode, hasPython } from './eval'`
`@@ -359,6 +359,7 @@ export class CocSnippet {`
`359`	`359`	`}`
`360`	`360`
`361`	`361`	`public async onMarkerUpdate(marker: Marker, token: CancellationToken): Promise<void> {`
	`362`	`+ let ts = Date.now()`
`362`	`363`	`while (marker != null) {`
`363`	`364`	`if (marker instanceof Placeholder) {`
`364`	`365`	`let snip = marker.snippet`
`@@ -371,7 +372,7 @@ export class CocSnippet {`
`371`	`372`	`}`
`372`	`373`	`}`
`373`	`374`	`// Avoid document change fired during document change event, which may cause unexpected behavior.`
`374`		`- await waitNextTick()`
	`375`	`+ await waitWithToken(Math.max(0, 16 - Date.now() + ts), token)`
`375`	`376`	`if (token.isCancellationRequested) return`
`376`	`377`	`this.synchronize()`
`377`	`378`	`}`