Error Handling and Debugging

From Lianjapedia
Jump to: navigation, search

Debugging is one of the most important skills for a developer. Software development is all about writing code, making mistakes, and fixing them.

Strong debugging skills minimize the development cycle by allowing developers to pinpoint bugs quicker, make fixes that actually address the problems encountered, and verify the modifications are correct. This is particularly important as the code gets more complex.

Lianja App Builder is quite unique in that as you develop an App you are working directly on live data running live dynamically compiled code. This development paradigm encourages agile development and to assist you further, Lianja App Builder provides some very powerful graphical debugging tools for you to use.

Troubleshooter

The Troubleshooter provides a tabbed interface bringing together debugging, tracing and performance metrics to assist you in testing and tuning your Apps.

Troubleshooter


Desktop Tab

The Desktop Tab contains the following:

Tab Description
Debugger Contains the LianjaScript Debugger.
Python Debugger Contains the Python Debugger.
JavaScript Debugger Contains the JavaScript Debugger.
Error Viewer Contains error message output.
Debugout Contains debugout message output.
Debug File Contains debug information in the event of an error.
Trace File Contains debug tracing information.
UIState Trace Contains tracing information about UI State transition operations.
Performance Metrics Contains tracing and performance metrics for internal operations and events to allow you to see how events are fired and handled in your code and help you in performance tuning.
Profiler Metrics Contains Profiler environment settings and data when a LianjaScript prg is profiled in the Apps Workspace.

Server Tab

The Server Tab contains the following:

Tab Description
Error Viewer Contains server error message output.

LianjaScript Debugging Commands

debugout

With set debugout on, the debugout command can be used to log text messages to the debug.txt file in the Lianja debug sub-directory and displayed in the Troubleshooter Debugout Tab. The debugout command is ignored if set debugout is off.

// debugdoc.prg
set debugout on
debugout "about to open database"
open database southwind
debugout "about to open table"
use example
replace all available with limit - balance
debugout "after replace"
close databases
debugout "after close data"
set debugout off
// Following line will not be logged:
debugout "no need to log this"
// end

debug.txt contents:

Debugout called from DEBUGDOC at line 3: about to open database
Debugout called from DEBUGDOC at line 5: about to open table
Debugout called from DEBUGDOC at line 8: after replace
Debugout called from DEBUGDOC at line 10: after close data

set debug

With set debug on, debugging and error information is logged to the debug text file in the lianja debug sub-directory and displayed in the Troubleshooter Debug File Tab. By default, set debug is off. The debugging information will contain a valuable insight into the internal code so when trying to track down a hard to locate bug set debug on may be your life saver.

set debugtrace

With set debugtrace on, a trace of command execution is included in the debug text file output when set debug is on. By default, set debugtrace is off.

set debugcompile

With set debugcompile on, the compiler includes debugging information in the compiled code file. This information is then included in the debug text file output when set debug is on. By default, set debugcompile is off.

set errorlogging

With set errorlogging on, errors are logged to the debug text file. By default, set errorlogging is ON.

Lianja System Object Methods

The following cross platform and cross language Lianja system object text logging methods are available:

Method Description
Lianja.console() Write the specified string to the console output window.
Lianja.log() Write the specified string to the log.
Lianja.logEvent() Write the specified string to the Performance Metrics tab in the Troubleshooter.
Lianja.writeDebug() Write the specified string to the debug file.
Lianja.writeError() Write the specified string to the console.
Lianja.writeLog() Write the specified string to the log (desktop) or JavaScript Console (web/mobile).
Lianja.writeOutput() Write the specified string to the Output Window (desktop) or JavaScript Console (web/mobile).

Exception Handling

LianjaScript

TRY...CATCH...FINALLY is a command structure to handle errors and exceptions within a block of code. The <tryCommands> which follow the TRY statement are executed. If no error occurs in the <tryCommands> program execution continues from the FINALLY statement. If an error occurs, program execution jumps immediately to the CATCH statement. RETURN statements should not be issued within a TRY... ENDTRY block.

try
    use example exclusive
catch
    messageBox("Unable to open example table")
endtry
 
//Another example
try
    use example exclusive
catch to oExc
    if oExc.message = "ALIAS name already in use"
        select example
        exit
    else
        messageBox("Unable to open example table")
    endif
endtry
 
//Another example
try
    ? [Outer Try]
    try 
        use example exclusive
    catch to oExc 
        oExc.UserValue = "Nested CATCH message: Unable to handle"
        ?[: Nested Catch]  
        ?[  Inner Exception Object: ]
        ?[  Error: ] + str(oExc.ErrorNo) 
        ?[  LineNo: ] + str(oExc.LineNo) 
        ?[  Message: ] + oExc.Message 
        ?[  Procedure: ] + oExc.Procedure 
        ?[  StackLevel: ] + str(oExc.StackLevel) 
        ?[  LineContents: ] + oExc.LineContents
        ?[  UserValue: ] + oExc.UserValue 
        throw oExc 
    finally
        ?[: Nested FINALLY executed ] 
    endtry   
catch to oExc1
    ?[: Outer CATCH ]
    ?[  Outer Exception Object: ] 
    ?[  Error: ] + str(oExc1.ErrorNo)
    ?[  LineNo: ] + str(oExc1.LineNo) 
    ?[  Message: ] + oExc1.Message 
    ?[  Procedure: ] + oExc1.Procedure 
    ?[  StackLevel: ] + str(oExc1.StackLevel) 
    ?[  LineContents: ] + oExc1.LineContents 
    ?[  ->UserValue becomes inner exception THROWn from nested TRY/CATCH ]
    if oExc1.UserValue.Message = "ALIAS name already in use"
        select example
    endif    
finally
?[: FINALLY executed ] 
endtry

JavaScript

The try...catch statement marks a block of statements to try, and specifies a response, should an exception be thrown.

try {
   throw 'myException'; // generates an exception
}
catch (e) {
   // statements to handle any exceptions
   logMyErrors(e); // pass exception object to error handler
}

Python

try:
  print(x)
except:
  print("An exception occurred")

Subcategories

This category has only the following subcategory.