[FEATURE]: JS messages and errors should be distinguishable from regular messages

[mlipok]

What feature would you like, or what problem are you facing?

JS messages and errors should be distinguishable from regular messages

What's your proposed solution?

to work on it

Screenshots

No response

Do you want to work on this issue/improvement?

Maybe

Any additional context?

https://github.com/mlipok/NetWebView2Lib/blob/7255dd85ae93e7fd0ad08457d964532ac5d6923b/examples/014-pdfJS-Static_PDF_Viewer.au3#L171

https://github.com/mlipok/NetWebView2Lib/blob/9be6e8011acfdab48584b85f92ddfa7bd383d316/NetWebView2Lib.au3#L1391-L1453

[ioa747]

Hi @mlipok,

After analyzing the current behavior of the Bridge and the logging system, I have a "package" proposal that solves the noise issue while ensuring we never miss critical errors.

1. The "Force Log" Logic (Small but Mighty change)
   Instead of adding more parameters to __NetWebView2_Log, we can introduce a Priority Prefix (!!!). If a log string starts with !!!, it bypasses the $_g_bNetWebView2_DebugInfo check.

Updated __NetWebView2_Log:

Func __NetWebView2_Log($s_ScriptLineNumber, $sString, $iErrorNoLineNo = 1, $iError = @error, $iExtended = @extended)
    Local $bForceLog = (StringLeft($sString, 3) == "!!!")
    If Not $_g_bNetWebView2_DebugInfo And Not $bForceLog Then Return SetError($iError, $iExtended, 0)
	If $iErrorNoLineNo = 1 Then
		If $iError Then
			$sString = "! ( NetWebView2Lib UDF : SLN=" & $s_ScriptLineNumber & ", @error=" & $iError & ", @extended=" & $iExtended & " ) :: " & $sString
		Else
			$sString = "+> ( NetWebView2Lib UDF : SLN=" & $s_ScriptLineNumber & " ) :: " & $sString
		EndIf
	EndIf
    Local $iReturn = ConsoleWrite($sString & @CRLF)
	Return SetError($iError, $iExtended, $iReturn)
EndFunc

2. Refactoring __NetWebView2_JSEvents__OnMessageReceived
   We should strip the Core Handler of any "User-level" logic (like COM_TEST or JSON_CLICKED). The Core should only act as a System Monitor.

Proposed Logic:

Identify Errors: Check if the message is an Error (JSON or Legacy).

Conditional Log: - If it's an Error, use the !!! prefix to ensure visibility.

For everything else, log normally (it will only show if Debug is ON).

Ignore User Data: If the message is not a system error, let the Core Handler exit and let the User's Bridge Handler manage it.

Example of Cleaned Internal Handler:

Volatile Func __NetWebView2_JSEvents__OnMessageReceived($oWebV2M, $hGUI, $sMsg)
	Local Const $s_Prefix = "[JSEvents__OnMessageReceived]: GUI:" & $hGUI
	Local $oMyError = ObjEvent("AutoIt.Error", __NetWebView2_COMErrFunc) ; Local COM Error Handler
	#forceref $oMyError, $oWebV2M

    Local $sFirstChar = StringLeft($sMsg, 1)
    Local $bIsError = False

    ; Quick check for Errors
    If $sFirstChar = "{" Or $sFirstChar = "[" Then
        If StringInStr($sMsg, '"type":"error"') Then $bIsError = True
    Else
        If StringLeft($sMsg, 6) == "ERROR|" Or StringLeft($sMsg, 10) == "NAV_ERROR|" Then $bIsError = True
    EndIf

    ; Logic: Errors are Forced (!!!), regular messages follow Global Debug flag
    If $bIsError Then
		__NetWebView2_Log(@ScriptLineNumber, "!!! " & $s_Prefix & " JSEvents ERROR: " & $sMsg, 1)
    ElseIf $_g_bNetWebView2_DebugInfo Then
		__NetWebView2_Log(@ScriptLineNumber, $s_Prefix  & " JSEvents ERROR: " & $sMsg, 1)
    EndIf

    ; REMOVED: COM_TEST, JSON_CLICKED, etc. (They belong to the User's Bridge Handler)
EndFunc

Users won't see "Title Changed" or "Metadata" logs during normal operation (Debug=False).
JS Errors will always Write in the console.

What do you think about?

[ioa747]

Revised

Volatile Func __NetWebView2_JSEvents__OnMessageReceived($oWebV2M, $hGUI, $sMsg)
	Local Const $s_Prefix = "[JSEvents__OnMessageReceived]: GUI:" & $hGUI
	Local $oMyError = ObjEvent("AutoIt.Error", __NetWebView2_COMErrFunc) ; Local COM Error Handler
	#forceref $oMyError, $oWebV2M

    Local $sFirstChar = StringLeft($sMsg, 1)
    Local $bIsError = False

    ; Quick check for Errors
    If $sFirstChar = "{" Or $sFirstChar = "[" Then
        If StringInStr($sMsg, '"type":"error"') Then $bIsError = True
    Else
        If StringLeft($sMsg, 6) == "ERROR|" Or StringLeft($sMsg, 10) == "NAV_ERROR|" Then $bIsError = True
    EndIf
	
	; Logic: Errors are Forced (!!!), regular messages follow Global Debug flag
    If $bIsError Then
        __NetWebView2_Log(@ScriptLineNumber, "!!! " & $s_Prefix & " JSEvents ERROR: " & $sMsg, 1)
    ElseIf $_g_bNetWebView2_DebugInfo Then
        __NetWebView2_Log(@ScriptLineNumber, $s_Prefix & " JSEvents DATA: " & $sMsg, 1)
    EndIf

EndFunc

in the same logic

Volatile Func __NetWebView2_Events__OnProcessFailed($oWebV2M, $hGUI, $oArgs)
	#forceref $oWebV2M
	Local Const $s_Prefix = "!!! [NetWebView2Lib:EVENT: OnProcessFailed]: GUI:" & $hGUI

	; Converting codes to text using Enums
	Local $sKind = "Unknown"
	Switch $oArgs.ProcessFailedKind
		Case $NETWEBVIEW2_PROCESS_FAILED_KIND_BROWSER_EXITED
			$sKind = "Main browser engine failure"
		Case $NETWEBVIEW2_PROCESS_FAILED_KIND_RENDER_EXITED
			$sKind = "Tab or page content crash"
		Case $NETWEBVIEW2_PROCESS_FAILED_KIND_RENDER_UNRESPONSIVE
			$sKind = "Page is hanging/frozen"
		Case $NETWEBVIEW2_PROCESS_FAILED_KIND_FRAME_RENDER_EXITED
			$sKind = "Subframe/iframe crash"
		Case $NETWEBVIEW2_PROCESS_FAILED_KIND_UTILITY_EXITED
			$sKind = "Background service failure"
		Case $NETWEBVIEW2_PROCESS_FAILED_KIND_SANDBOX_EXITED
			$sKind = "Security layer failure"
		Case $NETWEBVIEW2_PROCESS_FAILED_KIND_GPU_EXITED
			$sKind = "Graphics acceleration failure"
	EndSwitch

	Local $sReason = "Unknown Reason"
	Switch $oArgs.Reason
		Case $NETWEBVIEW2_PROCESS_FAILED_REASON_UNEXPECTED
			$sReason = "Unexpected Failure"
		Case $NETWEBVIEW2_PROCESS_FAILED_REASON_UNRESPONSIVE
			$sReason = "Process Unresponsive"
		Case $NETWEBVIEW2_PROCESS_FAILED_REASON_TERMINATED
			$sReason = "Terminated"
		Case $NETWEBVIEW2_PROCESS_FAILED_REASON_CRASHED
			$sReason = "Crashed"
		Case $NETWEBVIEW2_PROCESS_FAILED_REASON_LAUNCH_FAILED
			$sReason = "Launch Failed"
		Case $NETWEBVIEW2_PROCESS_FAILED_REASON_OUT_OF_MEMORY
			$sReason = "Out Of Memory"
	EndSwitch

	; Constructing the diagnostic message
	Local $sDetailedError = StringFormat("Process Kind: %s\nReason: %s\nExit Code: 0x%s\nDescription: %s", _
			$sKind, $sReason, Hex($oArgs.ExitCode, 8), $oArgs.ProcessDescription)

	__NetWebView2_Log(@ScriptLineNumber, $s_Prefix & " CRITICAL: " & $sDetailedError, 1)

	__NetWebView2_LastMessageReceived($oWebV2M, $NETWEBVIEW2_MESSAGE__PROCESS_FAILED)

	$oArgs = 0 ; Clean up the object reference
EndFunc   ;==>__NetWebView2_Events__OnProcessFailed

[mlipok]

I think that we finally need to add DEBUG LEVELS like in https://github.com/Danp2/au3WebDriver

https://github.com/Danp2/au3WebDriver/blob/1834e95206bd4a6ef6952c47a1f1192042f98c0b/wd_core.au3#L94-L98

Global Enum _
		$_WD_DEBUG_None = 0, _ ; No logging
		$_WD_DEBUG_Error, _    ; logging in case of Error
		$_WD_DEBUG_Info, _     ; logging with additional information
		$_WD_DEBUG_Full        ; logging with full details for developers

https://github.com/Danp2/au3WebDriver/blob/1834e95206bd4a6ef6952c47a1f1192042f98c0b/wd_core.au3#L1631-L1643

Func __WD_MessageCreator($sFuncName, $sURL, ByRef Const $sResponseText, $sData = '')
	Local $sMessage = "HTTP status = " & $_WD_HTTPRESULT
	Switch $_WD_DEBUG
		Case $_WD_DEBUG_Full ; in case of $_WD_DEBUG_Full  >  Full $sResponseText
			__WD_ConsoleWrite($sFuncName & ": URL=" & $sURL & (($sData) ? ("; Data=" & $sData) : ("")))
			If $_WD_RESPONSE_TRIM <> -1 And StringLen($sResponseText) > $_WD_RESPONSE_TRIM Then
				$sMessage &= " ResponseText=" & StringLeft($sResponseText, $_WD_RESPONSE_TRIM) & "..."
			Else
				$sMessage &= " ResponseText=" & $sResponseText
			EndIf
	EndSwitch
	Return $sMessage
EndFunc   ;==>__WD_MessageCreator

https://github.com/Danp2/au3WebDriver/blob/1834e95206bd4a6ef6952c47a1f1192042f98c0b/wd_core.au3#L1661-L1695

Func __WD_Error($sWhere, $iErr, $sMessage = Default, $iExt = Default)
	Local Const $sFuncName = "__WD_Error"
	Local $sMsg


	If $sMessage = Default Then $sMessage = ''


	Switch $_WD_DEBUG
		Case $_WD_DEBUG_None


		Case $_WD_DEBUG_Error
			If $iErr <> $_WD_ERROR_Success Then ContinueCase


		Case $_WD_DEBUG_Info, $_WD_DEBUG_Full
			Local $sExtended = ($iExt <> Default) ? (" / " & $iExt) : ("")
			$sMsg = $sWhere & " ==> " & $aWD_ERROR_DESC[$iErr] & " [" & $iErr & $sExtended & "]"
			$sMsg &= ($sMessage) ? (" : " & $sMessage) : ("")
			__WD_ConsoleWrite($sMsg)


			If $iErr <> $_WD_ERROR_Success Then
				If $_WD_ERROR_MSGBOX Then
					Local $iAnswer = MsgBox($MB_ICONERROR + $MB_OKCANCEL + $MB_TOPMOST, "WebDriver UDF Error:", $sMsg)
					If $iAnswer = $IDCANCEL Then
						$iErr = $_WD_ERROR_UserAbort ; change $iErr to give a way to stop further processing by user interaction
						__WD_ConsoleWrite($sFuncName & ": User Abort", $_WD_DEBUG_Info)
					EndIf
				EndIf
				If $_WD_ERROR_OUTPUTDEBUG Then
					DllCall("kernel32.dll", "none", "OutputDebugString", "str", $sMsg)
				EndIf
			EndIf


	EndSwitch


	Return $iErr
EndFunc   ;==>__WD_Error

https://github.com/Danp2/au3WebDriver/blob/1834e95206bd4a6ef6952c47a1f1192042f98c0b/wd_core.au3#L330

	Return SetError(__WD_Error($sFuncName, $iErr, $sMessage), 0, $sSession)
EndFunc   ;==>_WD_CreateSession

And it would be good to adopt/take over some general guidelines from this UDF