Debugging an Orb Application

For debugging and development, Orb has a debug mode that can be enabled by calling Orb@setDebug(true) in the initialization method of an Orb application.

Disabling debug mode after an application has started up is not supported. To stop debugging your Orb application, restart the application and do not call Orb@setDebug(true).

The following is enabled by debug mode.

• Behavior changes

  • Any exceptions that occur are passed back to the application

  • HTML template files are automatically re‑read each time the template is rendered

    This is to assist development so you do not need to restart the application to see the effect of changes to template files.

• Diagnostics

  The following additional information is logged to the Web Application Monitor window.

  • New live connections and the channel identifier

  • Events sent by using live updates

  • The route class and methods invoked on each request

• Warnings

  The following informational warnings that can assist in debugging are logged to the Web Application Monitor window.

  • Missing data‑orb‑id attribute

    Warning	Description
    Warning text	Warning: Template <name> missing [data-orb-id] attribute Updates and removes will not be reflected by live updates for this template
    When it happens	Live updates sent an add or update event and the outer HTML element did not contain a data‑orb‑id attribute.
    What it means	For updates and removes to work in live updates, the outer element of the HTML must have a data‑orb‑id attribute that is set to the expanded value of <@@ orb-id @@>.
    What to do	Add a data‑orb‑id attribute to the outer element of any template that is expanded by live updates; for example: <div class="outer" data-orb-id="<@@ orb-id @@>"> <div class="inner"> <@@ value @@> </div> </div>

    For details, see "HTML Data Attributes", elsewhere in this document.

  • Direct bind on collection

    Warning	Description
    Warning text	Warning: Collection (<collection‑class‑and‑oid>) directly passed to bind This does not expand the collection, pass the parent instead
    When it happens	The Orb@bind method (or its variants) is called with an object parameter that is a collection.
    What it means	Passing an object to bind expands its properties by the template. If any of those properties is a reference to a collection, the members of that collection are expanded. Directly passing a collection reference to bind would cause any properties on the collection object to be expanded, not the members of the collection. A common error is passing the collection that the template is to expand, instead of the parent object that has the collection reference. As collection objects typically do not have properties, a bind of a collection is probably an error.
    What to do	Pass the parent object of the collection to bind, not the collection itself.

    For details, see "bind", elsewhere in this document.