Vscode-jest: dot doesn't update on format a document without save

Created on 2 Jun 2017 · 16Comments · Source: jest-community/vscode-jest

When you run Jest, it put some passed and failed dots in tests, but if you have to format the text, the dots keeps in the middle of the text. Not a big problem at all, but I think we should improve the tool.

bug needs information coverage

Source

tiagor87

All 16 comments

Yeah, sure, I think that's about using the document edit API from vscose to update the dots - it's just a matter of adding it, I've been hesitant because it feels like a lot of code to be running all the time but maybe if we had a heuristic for updating them like total number of lines of code has changed?

orta on 6 Jun 2017

Yes @orta, I will try to develop this feature and do some tests on Saturday.

tiagor87 on 6 Jun 2017

Does this work the way you expect it to now? Seems like they update position (but not the state based on the unsaved document contents).

seanpoulter on 20 Nov 2017

Looks like we can improve this quite a bit. The dots are displayed every time the document changes, and not configured to "stick" to the test block. Here's an annotated "call graph" that walks through how the dots are unnecessarily applied every time the file changes.

// extension.ts
activate(context) {
  context.subscriptions.push(
    ...registerFileChangeWatchers(instance)
  )
}

// fileChangeWatchers.ts
registerFileChangeWatchers(extension) {
  vscode.workspace.onDidChangeTextDocument({ contentChanges, document }) => {
    extension.triggerUpdateDecorations(editor)
  })
}

// JestExt.ts
triggerUpdateDecorations(editor) {
  showCoverageOverlay(editor, this.coverage)
  // The coverage would have changed, but we haven't run the tests with the unsaved buffer

  if (!canUpdateDecorators(editor)) { ... }
  // Only changes if the Jest settings for testMatch or testRegex change

  updateDotDecorators(editor)
  // The dots may change, but we haven't run the tests with the unsaved buffer
}

// Coverage/overlay.ts
showCoverageOverlay(editor) {
  // Decorators applied using stale coverage. 
  // These decorators don't have a rangeBehavior set.
}

// JestExt.ts
canUpdateDecorators(editor) {
  wouldJestRunURI(uri)
}

wouldJestRunURI(
  // Return value only changes when Jest settings for testMatch or testRegex change
}

updateDotDecorations() {
  // The sorted test results may change, but we haven't run tests with the unsaved buffer.
  // Until then the sorted test results, dot decorations, Debug CodeLens, and inline errors don't change.

  // The dot decorators and inline errors don't have the rangeBehavior set.
  // Not sure how to keep the CodeLens following the decorator position. Hrm ...
}

Since we're already showing stale data, I'll submit a PR with GIFs demonstrating the behavior before and after for the:

dot decorations
inline error message
Debug CodeLens
coverage

seanpoulter on 20 Dec 2017

The dots are displayed every time the document changes

Dang!

orta on 21 Dec 2017

Even if we fix this up, we'll still end up with annotations in the wrong spot of a file that opens with unsaved changes. :cry:

seanpoulter on 21 Dec 2017

After 2.5.6, I'm getting an issue with the decorators never updating. They are green for every status type. Perhaps adding an option to disable these decorators might be a good idea as well?