perf(document): check sha256 on vim9 CursorHold

Check last checked changedtick, avoid transfer buffer

Author: chemzqm

autoload/coc/vim9.vim

@@ -1,6 +1,14 @@
 vim9script
 scriptencoding utf-8
 
+# Check if lines synchronized as expected
+export def Check_sha256(bufnr: number, expected: string): bool
+  if !exists('*sha256')
+    return true
+  endif
+  return getbufline(bufnr, 1, '$')->join("\n")->sha256() ==# expected
+enddef
+
 # From `coc#highlight#set(`:
 #   type HighlightItem = [hlGroup, lnum, colStart, colEnd, combine?, start_incl?, end_incl?]
 # From `src/core/highlights.ts`:

src/__tests__/vim.test.ts

@@ -429,7 +429,7 @@ describe('Buffer API', () => {
         called = true
       }
     }, null, disposables)
-    Object.assign(doc, { lines: [''] })
+    Object.assign(doc, { lines: [''], _changedtick: doc.changedtick + 1 })
     await events.fire('CursorHold', [buffer.id, [1, 1]])
     expect(called).toBe(true)
     expect(doc.getLines()).toEqual(['1', '2'])

src/core/documents.ts

@@ -81,9 +81,15 @@ export default class Documents implements Disposable {
     this._bufnr = bufnr
     await Promise.all(bufnrs.map(bufnr => this.createDocument(bufnr)))
     if (isVim) {
+      const checkedTick: Map<number, number> = new Map()
       events.on('CursorHold', async bufnr => {
         let doc = this.getDocument(bufnr)
-        if (doc && doc.attached) await doc.checkLines()
+        if (doc && doc.attached && checkedTick.get(bufnr) != doc.changedtick) {
+          let sha256 = doc.getSha256()
+          let same = await nvim.callVim('coc#vim9#Check_sha256', [bufnr, sha256])
+          checkedTick.set(bufnr, doc.changedtick)
+          if (!same) await doc.fetchLines()
+        }
       }, null, this.disposables)
     }
     events.on('BufDetach', this.onBufDetach, this, this.disposables)

src/model/document.ts

@@ -8,7 +8,7 @@ import { createLogger } from '../logger'
 import { BufferOption, DidChangeTextDocumentParams, HighlightItem, HighlightItemOption, TextDocumentContentChange } from '../types'
 import { isVim } from '../util/constants'
 import { diffLines, getTextEdit } from '../util/diff'
-import { disposeAll, getConditionValue, wait, waitNextTick } from '../util/index'
+import { disposeAll, getConditionValue, sha256, wait, waitNextTick } from '../util/index'
 import { isUrl } from '../util/is'
 import { debounce, path } from '../util/node'
 import { equals, toObject } from '../util/object'
@@ -17,7 +17,7 @@ import { Disposable, Emitter, Event } from '../util/protocol'
 import { byteIndex, byteLength, byteSlice, characterIndex, toText } from '../util/string'
 import { applyEdits, filterSortEdits, getPositionFromEdits, getStartLine, mergeTextEdits, TextChangeItem, toTextChanges } from '../util/textedit'
 import { Chars } from './chars'
-import { firstDiffLine, LinesTextDocument } from './textdocument'
+import { LinesTextDocument } from './textdocument'
 const logger = createLogger('document')
 
 export type LastChangeType = 'insert' | 'change' | 'delete'
@@ -627,15 +627,16 @@ export default class Document {
     this._forceSync()
   }
 
-  public async checkLines(): Promise<void> {
+  public getSha256(): string {
+    return sha256(this.lines.join('\n'))
+  }
+
+  public async fetchLines(): Promise<void> {
     let lines = await this.nvim.call('getbufline', [this.bufnr, 1, '$']) as ReadonlyArray<string>
-    let diff = firstDiffLine(this.lines, lines)
-    if (diff) {
-      this.lines = lines
-      fireLinesChanged(this.bufnr)
-      this.fireContentChanges()
-      logger.error(`Buffer ${this.bufnr} not synchronized on line ${diff[0]}\nExpected:${diff[2]}\nCurrent:${diff[1]}`)
-    }
+    this.lines = lines
+    fireLinesChanged(this.bufnr)
+    this.fireContentChanges()
+    logger.error(`Buffer ${this.bufnr} not synchronized on vim9, consider send bug report!`)
   }
 }
 

src/util/index.ts

@@ -1,10 +1,15 @@
 'use strict'
 import type { CancellationToken } from 'vscode-languageserver-protocol'
+import { crypto } from './node'
 
 export interface Disposable {
   dispose(): void
 }
 
+export function sha256(data: string): string {
+  return crypto.createHash('sha256').update(data).digest('hex')
+}
+
 export function getConditionValue<T>(value: T, testValue: T): T {
   return global.__TEST__ ? testValue : value
 }