Share via

Debug Node.JS Azure Mobile Apps with Node Inspector

  • Article

You can debug interactively your Node.JS apps on Azure using the built-in Node Inspector.  I will walk you through how to set up Node Inspector and debug an Azure Mobile App.

Review

You can debug using the Monaco interface without doing any special setup, however it is not interactive debugging with variable inspection etc.  To use the Monaco interface, Go through Easy Tables and select the ‘Edit Script’ icon:

snip_20160406091606

You can edit the script and see the results of errors here when you make a change and hit the play button.  In this example you can see I have an error:   error:  TypeError: Cannot read property 'id' of undefined

snip_20160406091826

This may be all you need, however if you want a richer experience, you can use Node Inspector with Azure App Services for a richer debugging experience

Requirements/Checklist

  • Web Kit enabled browser such as Chrome
  • Azure Web App or Azure Mobile App using Node.JS backend
  • Enable WebSockets in the app configuration
  • Modify the iisnode.yml file on the site
  • Modify the web.config file on the site
  • Hit a special URI to start debugging
  • Note:  This will not work for https:// which is required if you are using Authentication (so you would have to disable Authentication temporarily for this to work).

 

Walkthrough

I created a Node.JS backend based Azure Mobile App called ‘jsandersdebugnodejs’.  Monaco was not interactive enough for me so I decided to use Node Inspector built into the Azure Mobile App/Web App.

First step is modify the app settings to allow web sockets and Save:

snip_20160406092345

Next go to Kudu.  You can do this through the portal using the Tools icon of your App or simply put ‘SCM’ between the name of you website like this example: https://jsandersdebugnodejs.scm.azurewebsites.net/

Once in Kudu choose ‘Debug console’ and ‘CMD’ to get to the command line interface (Note – you can use ‘Monaco’ to edit instead if you prefer):

snip_20160406092622

Then click on the ‘site’ and then ‘wwwroot’ folders to navigate to the wwwroot folder (or go old school and type cd site\wwwroot in the command area):

snip_20160406092847

Scroll down and find the ‘iisnode.yml’ and ‘web.config’ files.  Click on the pencil icon to edit iisnode.yml:

snip_20160406093422

Add the line:  debuggingEnabled: true
and click save:

snip_20160406093738

Now click on the pencil icon for web.config to edit it. 

It should already have this rule by default at the top (app.js is the startup script for a Mobile App):

<rules>
       <!-- Do not interfere with requests for node-inspector debugging -->
       <rule name="NodeInspector" patternSyntax="ECMAScript" stopProcessing="true">
         <match url="^app.js\/debug[\/]?" />
       </rule>

At the bottom of web.config modify this line (or line similar to this):

  <iisnode watchedFiles="sentinel;web.config;iisnode.yml;*.js;tables\*.*;api\*.*"/>

And add the highlighted section below:

  <iisnode debuggerExtensionDll="iisnode-inspector.dll" watchedFiles="sentinel;web.config;iisnode.yml;*.js;tables\*.*;api\*.*"/>

If the iisnode entry does not exist then set it to this:

<iisnode debuggerExtensionDll="iisnode-inspector.dll" />

Sample from Azure Mobile App:

snip_20160407082851

and save the changes!

Open your WebKit enabled browser (in my example I am using Chrome) and hit this URI (substitute the URL of your Azure Mobile App though):  https://jsandersdebugnodejs.azurewebsites.net/app.js/debug

TWO IMPORTANT NOTES:

1.  Use HTTP not HTTPS (Authentication requires HTTPS so you cannot debug the site if Authentication is required)

2.  User your Web App or Mobile App name:  https://yourapp.azurewebsites.net/app.js/debug

Now you have Node Inspector at your disposal!

snip_20160406094619

I want to debug that script I saw that had a problem when I was debugging in Monaco.  To do that choose the ‘Scripts’ icon then use the up-down arrow icon I have highlighted to find the table script I want (tables\TodoItem.js):

Note:  If scripts do not show anything, warm up the Mobile App site by hitting it in another browser tab, then refresh the debug session.

snip_20160406094847

Now click on the number ‘23’ on the left side to set a breakpoint in the insert statement:

snip_20160406095107

And use a tool like Fiddler or Postman (or your app) to call the App:

snip_20160406095351

You will have hit the breakpoint where you can inspect stuff and see what the problem is!

In my case I look at the ‘Scope Variables’ section and there is no ‘user’ property on the ‘context’ object and that is why it is faulting in my app:

 

snip_20160406095732

 

Also note above I can see the ‘context.item’ object that has the information I am trying to insert.  Pretty darn awesome or what?!?!

Final Important notes

Special thanks to Prashanth Madi on our team for help with this Blog!

Use this with caution.  Do not debug a live site because when you are in the debugger, you are stopping the scripts you are setting breakpoints for until you hit the ‘resume’ button (little triangle icon above the ‘Watch Expression’

Restore back the changes you made after debugging

Search for Node Inspector for cool tips using Node Inspector

This works for Azure Web Apps and Azure Mobile Apps.

You can use Monaco to edit iisnode.yml and web.config if you wish.

Send me a comment if this helped you out!

Helpful links:

Navigating the environment (Monaco)

Comments

  • Anonymous
    May 02, 2016
    > Use HTTP not HTTPS (Authentication requires HTTPS so you cannot debug the site if Authentication is required)Any workarounds for this? Or other ways to debug an NodeJS app using Authentication? Thanks!
  • Anonymous
    March 09, 2017
    Hi, Nice and useful, I was able to get it up and running quickly.Any plans to get that https:// working as it is needed on our application so this debugging not very useful with out it.
  • Anonymous
    July 13, 2017
    The comment has been removed