Moodle Mobile debugging WS requests

Revision as of 09:08, 30 July 2019 by Patrick Lemaire (talk | contribs) (Debugging a web service (WS) error: link error)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Introduction

This guide will help you find and report problems with the Moodle Mobile app on your site.

It is especially useful for the following problems:

  • Unable to log in on your site
  • When you receive one of the following error messages in the app:
    • Can not find data record in database table external_functions
    • Invalid response value detected
    • Cannot get course contents

Requirements

  • Moodle 3.1 onwards (your site needs at least this version)
  • Moodle Desktop app 3.6.1 onwards or Google Chrome/Chromium browser
moodlemobile enabledebug.png

Enabling debugging on your Moodle site

  1. Go to Debugging in the Site administration
  2. For "Debug messages" select 'DEVELOPER'
  3. Tick "Display debug messages"
  4. Click the 'Save changes' button.

Note: Remember to disable debugging again once you have finished debugging your problem.

Enabling debugging on the mobile app

  1. Go to the More tab
  2. Go to Settings > General
  3. Enable "Display debug messages"

Note: Remember to disable debugging again once you have finished debugging your problem.

First try

At this point, you may not need fo go further on this guide.

Log-out and log-in again into your site and try to reproduce the error, hopefully, with Moodle and app debugging enabled you will see an explanatory message of what is happening.

If you are unable to find a solution, contact a Moodle Partner or post in the Moodle for mobile forum on moodle.org for non-guaranteed community support.

Setting up the debugging tool

Moodle Desktop

The recommended way to debug the problem is using the Moodle Desktop app. Please notice that the app version should be 3.6.1 or higher. The desktop app lets you debug some features, such as Single Sign-On, that require a built app to work, rather than a hosted or local ionic build running in a web browser.

You can download the desktop app from here.

Download the desktop app, install it and open it. Once it's open, you can open the "Developer tools" with the following shortcut:

  • In MacOS: Cmd + Option + I
  • In Windows or Linux: Ctrl + Shift + I

Once the Developer Tools are open, follow these steps:

  1. Dock the new panels on the right side (in the new panel top-right options choose “Dock to the right” icon)
  2. Click the Network tab (at the top-center)
  3. Enable the filter (filter shape icon) so it changes to colour red
  4. In the new text field displayed when enabling the filter write
    .php

Now you are ready to debug all the web services requests sent to your Moodle site by the mobile app.

Chrome or Chromium

moodlemobile chrome inspect network.png

Another option is to use Google Chrome or Google Chromium to debug this. If you already have the Moodle Desktop app you can skip this section.

Debugging the mobile app is not so easy, so we have provided an online web version of the app that can be easily debugged using the Chrome browser.

  1. Open your Chrome browser and go to https://mobileapp.moodledemo.net/
  2. Open your browser options (icon at the top-right of your browser window), then go to More tools -> Developer tools
  3. Dock the new panels on the right side (in the new panel top-right options choose “Dock to the right” icon)
  4. Click the Network tab (at the top-center)
  5. Enable the filter (filter shape icon) so it changes to colour red
  6. In the new text field displayed when enabling the filter write
    .php

Now you are ready to debug all the web services requests sent to your Moodle site by the mobile app.

Debugging a web service (WS) error

moodlemobile chrome debug ws error.png
  1. Connect to your site and browse to the functionality displaying an error
  2. In the right panel you will see a list of requests made by the app to your Moodle site (token.php server.php server.php etc..)
  3. Click on each one of them (starting with the last one in the list) but skip those that don’t start with token.php or server.php
  4. In the new sub-window open select the “Response” tab and check if you see an error
  5. Copy the error then go to the Moodle Mobile FAQ in the user docs to check if there is a known solution for it
  6. If you are unable to find a solution, contact a Moodle Partner or post in the Moodle for mobile forum on moodle.org for non-guaranteed community support.

See also