Implement the DAP "invalidated" event

[weinand]

A new InvalidatedEvent has been added to the DAP:

vscode/src/vs/workbench/contrib/debug/common/debugProtocol.d.ts

Lines 378 to 393 in 6781d16

	/** Event message for 'invalidated' event type.
	This event signals that some state in the debug adapter has changed and requires that the client needs to re-render the data snapshot previously requested.
	Debug adapters do not have to emit this event for runtime changes like stopped or thread events because in that case the client refetches the new state anyway. But the event can be used for example to refresh the UI after rendering formatting has changed in the debug adapter.
	This event should only be sent if the debug adapter has received a value true for the 'supportsInvalidatedEvent' capability of the 'initialize' request.
	*/
	export interface InvalidatedEvent extends Event {
	// event: 'invalidated';
	body: {
	/** Optional set of logical areas that got invalidated. If this property is missing or empty, a single value 'all' is assumed. */
	areas?: InvalidatedAreas[];
	/** If specified, the client only needs to refetch data related to this thread. */
	threadId?: number;
	/** If specified, the client only needs to refetch data related to this stack frame (and the 'threadId' is ignored). */
	stackFrameId?: number;
	};
	}

This feature request asks for handling the event in VS Code and sending the corresponding supportsInvalidatedEvent property in the initialize request.

[weinand]

@isidorn I've added the new InvalidatedEvent to VS Code's debugProtocol.d.ts.

[isidorn]

Great. I can look into adding this. For now this event on the VS Code side would refresh the corresponding InvalidatedAreas and would probably automatically re-evaluate all watch expressions?
Also I am not sure if we need a different event for stacks and threads?

[weinand]

@isidorn yes, reevaluating the watches makes sense because watches are unknown to the DAP.

different event for stacks and threads

Yes, for VS Code stacks and threads are combined in one UI, but for other clients that might not be the case.

[isidorn]

Related DAP request microsoft/debug-adapter-protocol#128

[weinand]

I've released "invalidated" event support in Mock debug. Just use the context menu action "Toggle between decimal and hex formatting".

[isidorn]

I have pushed a first version of this and it seems to work just fine.
Try it out and let me know how it goes

fyi @gregg-miskelly @testforstephen

[testforstephen]

Have a quick try on this new event, it works well. Thanks for your amazing work. @weinand @isidorn

After i change the formatter setting, then send an invalidatedEvent to client, the whole variables view will be refreshed. One drawback is the Variables menu doesn't support icon. If icon is allowed, it's very easy to express the toggle effect since most of my formatter options are boolean. This is out of scope of this issue. If icon is viable, i can create a new issue for it.

[isidorn]

@testforstephen thanks a lot for trying it out. Based on your comment adding verified label.
As for the icons -> we do not support them, and we can not support them (electron does not support icons in native context menus). Though feel free to file a feature reuqest (though there might be something open already, I am not sure)