Add definitions for a module erroring

[jpinkney-aws]

Problem

We have no way to track errors that occur within a module that occur outside of a regular telemetry execution scope. E.g. listening on a window for errors via window.addEventListener('error')

Solution

• toolkit_errorModule which is called when an unexpected error occurs outside of regular telemetry messages

License

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

[awschristou]

I suggest building on toolkit_openModule from #835 and making these

• toolkit_loadModule
• toolkit_errorModule

These become more generalized than "web views"

(suggestion is non-blocking)

[justinmk3]

Why is this needed? Every event can store result, reason, reasonDesc. Errors should not be modeled as separate events, they should be modeled as existing events with result=Failed + reason.

E.g. in this case webview_load could be such an event. If failure can occur after load, and we want a generic "webview interaction" event, then let's consider that instead. E.g. webview_click, webview_submit, etc.

[jpinkney-aws]

webview_error in this case is an generic error that can get thrown inside of mynah ui. Not sure if you can tie it directly to a chatMessage or anything since it can appear whenever: https://github.com/aws/aws-toolkit-vscode/blob/master/packages/core/src/amazonq/webview/ui/main.ts#L26

In the case of webview_load, thats how we do it. If the webview fails to load we set the reason description and result failed

[justinmk3]

see #839 (comment)

[justinmk3]

[toolkit_loadModule, toolkit_errorModule are] more generalized than "web views"

+1

Though toolkit_errorModule is questionable for the same reason as webview_error.

Instead of dedicated "error" events, model actual events which can fail (result=Failed).

[jpinkney-aws]

Does Called when an unexpected error occurs within a module outside of regular metrics tracking make it more clear where toolkit_errorModule can be used?

In VSCode it's goal is to track: window.addEventListener('error') messages that can occur at any time for any reason

[justinmk3]

Does Called when an unexpected error occurs within a module outside of regular metrics tracking make it more clear where toolkit_errorModule can be used?

In VSCode it's goal is to track: window.addEventListener('error') messages that can occur at any time for any reason

That could make sense. Mentioning "Example: window.addEventListener('error')" in the description could help too.

OTOH, if we want a generic thing that captures unknown webview events, can we not name it webview_event ? That leaves the door open for capturing other events (both successes and failures). This is similar to ui_click and vscode_executeCommand which are rather generic but capture both success and failure.