Debugging Your App

How to debug your app.

Debugging your app is a big part of any development, using any other tools and Appery.io is no different. If something doesn’t work, read this page to learn how to debug various parts of your app.

REST API Services

  1. Invoke the REST API service from a command link (curl) to ensure it works properly. If the service doesn’t work from the command link, you need to contact the service vendor. Alternatively, you can test the API service via Chrome Postman plugin or a service such as hurt.it.
  2. Debugging the service from Server Code script
    • Remove any code before and after the API call and debug just the REST API call.
    • Use default values.
  3. Debugging the service from API Express:
    • Test just the REST component, without any other flow services.
    • You can test the actual external API before testing the API Express service. Click the Generate button under the service Properties.
  4. Debugging the service inside the App Builder:
    • Test the service inside the App Builder with default values (service editor > Test tab)
    • Add and invoke the service from the page but also with just the default values.
    • Chrome, Firefox, and Safari provide built-in tools to debug an API request.
    • If you have custom JavaScript in mapping, remove the mapping and invoke the service with default values. Then use console.log(..) statements to debug custom mapping code to ensure the service gets the correct values.
    • Check the browser console for any JavaScript errors (click F12).
  5. If your service worked and has now stopped:
    • A service might stop working if there is a JavaScript error prior to its invocation. If the service is invoked (you can check it in the Network tab), check what response you get.
    • If you are mapping data from the browser’s local storage, do a simple alert(..) on the values to make sure they are set correctly, or use the browser’s debug tools below to see the local storage values.
  6. To debug the service when running the app on the device, use Weinre remote debugger.

Native API (Cordova)

Debugging native APIs.

  • If you are testing a native API or feature, it needs to be tested on the device. Only Geolocation can be tested in-browser.
  • You can use the Weinre debugger to do remote debugging when the app is running on your device.
  • Ensure that the Cordova library has started successfully. Use the Weinre debugger console to check if there are any errors when the app launches.

JavaScript

How to debug JavaScript code.

  • Please try debugging the script first. You can use the browser’s built-in debugger (Chrome Dev. Tools/Firebug) or even use console.log(..) to see where the script fails. Learn more about Chrome developer tools here.

🚧

Custom JavaScript

Any custom JavaScript you’ve written is usually outside the scope of our support, but we’ll be happy to try and help you.

API Express

This section shows a number of ways to debug API Express projects and APIs.

  1. When creating or editing a database connection, test to ensure the connect works.
  2. Once you generated an API, make sure it works by testing it.
  3. When creating a database connection or testing an API, it might also help to look at the browser’s developer tools to see if there are any errors.
  4. Ensure that API Express is able to connect to your database. This Database Connection page shows how to do that.
  5. When trying to generate REST APIs but the wizard is not showing any tables, make sure you have connected to the right database. Some server instances might have two more databases so make sure you select the right one.
  6. When the service you are testing returns an error (from the underlying external system), enable the debug mode that will show you more information about any errors.
  7. If you made changes to an API Express service but still see the old result when testing, please see this section on service caching.

Connection Errors

Possible API Express database connection errors.

java.net.SocketTimeOutException: connect timed out

Possible causes for this error:

  • Remote database server is slow to respond and takes more than 1 second to connect to a socket.
  • API Express is waiting for a free (available) connection, to connect to a database.
  • Slow connection speed between API Express and remote database server.

Server Code

This section shows how to debug a Server Code script.

  1. When a script fails to execute errors will be added to the Trace tab.
  2. Use console.log(...) for debugging. For example, place console.log() after each statement and display variable information. This way you can see where the script stops executing.
  3. A script should be tested inside before using it in an app. A script can be quickly tested form the Run tab. You can enter sample data in the Script parameters tab. This video shows how to debug a script.

Push Notifications

This section shows how to debug a Server Code script.

  • When a script fails to execute errors will be added to the Trace tab.
  • Use console.log(...) for debugging. For example, place console.log() after each statement and display variable information. This way you can see where the script stops executing.

Troubleshooting for Android

Make sure that you use the correct Sender ID and that it was entered without any spaces.
Check the validity of an API key that is set for your app. You can learn more here.
If this does not help, try recreating the API key in the Google developer console for your app and reset it in your Push Settings. Build the app again and re-install it on the device.

Troubleshooting for iOS

Inside the Provisioning Portal – make sure that you have enabled the Push Notification service in the AppID configuration page.

Check if your test devices UDID are added to​ your provisioning profile which is linked with your Push Notifications certificate file (this section is available under Devices on the left-hand side):

Make sure that you are using a valid/active certificate in your app Push Notifications Settings.
If your app is in the development and you are using a Development Certificate, then you need to create a Development Certificate for Push Notifications and the same thing for Production.

When you enable push in an app and run it for the first time on a device push registration will happen automatically. The device will be registered in the Devices collection in the database. If for some reason you don’t see the device registration, you can try to manually register the device by using this curl command:

curl -X POST -H "X-Appery-App-ID: 3a5860b4-xxxx-4cef-8b31-063312fxxxxx" -H "Content-Type: application/json" -d'{"type":"I","token":"testTokenI","deviceID":"testDeviceIdI"}' https://api.appery.io/rest/push/reg

📘

X-Appery-App-ID is your app ID.
You can define any type, token, and deviceID values.

  • For debugging Push Notification events, it is also useful to create push events in your app to see whether push is initialized and to make sure that your device is registered. This example will show you how to use push events in your app.
  • When you export your Appery.io project to xCode IDE the prepared binary app won't be tied to Appery.io Backend services and Push messaging won't work in your app - for correct work of Push notifications in your app, use Appery.io binary .ipa file export and install the app on your local device and test it before submitting binary to the Apple App Store.

If you are using TestFlight to distribute builds:

👍

Using TestFlight

TestFlight builds perform similarly to production builds and do not work with development push certificates. You need to create an App Store Distribution profile and Production Push Cert in the Apple Developer Portal for TestFlight AND you must upload them to App Settings > iOS binary and Apple Production Push certificate to the App Push Settings tab in Appery.io.