debugging - What are the recommended ways to debug Worklight applications?

Question

Welcome To Ask or Share your Answers For Others

debugging - What are the recommended ways to debug Worklight applications?

asked Oct 17, 2021 in Technique[技术] by 深蓝 (71.8m points)

debugging - What are the recommended ways to debug Worklight applications?

I'm finding it incredibly slow to fix issues that are specific to the iOS portion of my app. I'd like the know the recommended way to debug Worklight apps when the browser debugger isn't available.

In particular, I'm working on issues with WL.JSONStore which only works on iOS and Android. I can't use the browser debugger to see what's going on. When I do WL.Logger.debug() statements, nothing is showing up in the Xcode console, and the iPad simulator console (Cordova) only displays a few lines. There have also been periods this week that no output is printed anywhere.

I have downloaded and installed Weinre too, but none of the print statements appear to show up in its console and in general I just don't see information about the areas I need.

Thanks in advance for your suggestions.

See Question&Answers more detail:os

与恶龙缠斗过久,自身亦成为恶龙；凝视深渊过久,深渊将回以凝视…

1 Answer

深蓝 · Answer 1 · 2021-10-17T01:13:38+0000

General Worklight 5.0.6 Debugging

Look at the training module titled Debugging your applications. (Direct PDF link)

Debug Tips for JSONStore on Worklight 5.0.6

Try console.log('message') or WL.Logger.debug('message') inside jsonstore.js and your code ([app-name].js, etc.). The output should show up in Xcode's console and Android's LogCat.
Reset the Simulator or Emulator and/or call WL.JSONStore.destroy().
Make sure you're running on a supported environment:
- Android >=2.2 ARM/x86 Emulator or Devices
- iOS >=5.0 Simulator or Device
Try turning encryption off (ie. do not pass a password to WL.JSONStore.init or WL.JSONStore.initCollection).
Look at the SQLite Database file generated by JSONStore. This only works if encryption is off.
- Android:
```
  $ adb shell
  $ cd /data/data/com.[app-name]/databases/wljsonstore
  $ sqlite3 jsonstore.sqlite
```
- iOS
```
  $ cd ~/Library/Application Support/iPhone Simulator/6.1/Applications/[id]/Documents/wljsonstore
  $ sqlite3 jsonstore.sqlite
```
Try looking at the searchFields with .schema and selecting data with SELECT * FROM [collection-name];. To exit sqlite3 type .exit. Take a look at this StackOverflow question for an example.

(Android Only) Enable verbose JSONStore.

  adb shell setprop log.tag.jsonstore-core VERBOSE
  adb shell getprop log.tag.jsonstore-core

(iOS >=6.0 and Safari >=6.0 Only) Try to use the JavaScript debugger. Set break points inside jsonstore.js. Helpful lines:
- Bridge to Native code:
```
  cdv.exec(options.onSuccess, options.onFailure, pluginName, nativeFunction, args);
```
- Success Callbacks returning from Native code:
```
  deferred.resolve(data, more);
```
- Failure Callbacks returning from Native code:
```
  deferred.reject(new ErrorObject(errorObject));
```

Write Proper Tests (Unit, Functional, Integration -- get test coverage). Here's a template that uses QUnit and Sinon.js to create a Sandbox environment where you can test how JSONStore handles different types of data/calls:

  <!DOCTYPE HTML>
  <html>

  <head>
      <title>JSONStore Test App</title>
      <link rel="stylesheet" href="http://code.jquery.com/qunit/qunit-1.11.0.css">
      <script src="http://code.jquery.com/qunit/qunit-1.11.0.js"></script>
      <script src="http://sinonjs.org/releases/sinon-1.6.0.js"></script>
      <script>
          //QUnit configuration flags, no need to change it.
          QUnit.config.requireExpects = true;
      </script>
  </head>

  <body id="content" style="display: none;">

      <!-- Test results will be appended to the div below, no need to make changes here. -->
      <div id="qunit"></div>

  <script>

  //Start Worklight
  WL.Client.init({connectOnStartup : false});

  //Hook into the deviceready event
  document.addEventListener("deviceready", onDeviceReady, false);

  //onDeviceReady will be called when JSONStore/Cordova is ready
  function onDeviceReady () {

      //Auto executing function that holds the test
      (function (jQuery) { //The variable jQuery is usable inside.

          //Mock WL.Client.invokeProcedure using a Stub.
          //This is only useful if you need to link a Worklight Adapter
          //to a JSONStore collection to reproduce your issue or bug.
          //API Doc: http://sinonjs.org/docs/#stubs
          var fakeAdapter = sinon.stub(WL.Client, "invokeProcedure", function (invocationData, options) {

              //DO NOT Create a real adapter, just mock the reponse here if it's relevant to the bug.
              var ADAPTER_RESPONSE = {invocationResult: {fakeKey: [{fn: 'carlos'}, {fn: 'mike'}]}};
              options.onSuccess(ADAPTER_RESPONSE);
          });

          //[**Explain your test here**]
          var EXPECTED_ASSERTIONS = 2; //every assertion is a deepEqual below.
          asyncTest('[**Meaningful title here**]', EXPECTED_ASSERTIONS, function () {

              //Destroy first to make sure we don't depend on state
              WL.JSONStore.destroy()

              .then(function () {

                  //[**Start writting your test here**]
                  //The test below is an example, it does the following:
                  // - Initializes a collection linked to a fake adapter (see stub above).
                  // - Checks if initialization worked by checking the collection name.
                  // - Loads data from the fake adapter (see stub above).
                  // - Checks if load worked by checking the number of documents loaded.

                  var collections = {
                      col1 : {
                          searchFields : {fn: 'string'},
                          adapter : {name: 'fakeAdapter',
                              load: {
                                  procedure: 'fakeProcedure',
                                  params: [],
                                  key: 'fakeKey'
                              }
                          }
                      }
                  };

                  return WL.JSONStore.init(collections);
              })

              .then(function (response) {

                  //Prep for your assertion
                  var ACTUAL_VALUE = response.col1.name;
                  var EXPECTED_VALUE = 'col1';
                  var COMMENT = 'Checking for the right collection name';

                  //Do your assertion using deepEqual
                  //API Doc: http://api.qunitjs.com/deepEqual/
                  deepEqual(ACTUAL_VALUE, EXPECTED_VALUE, COMMENT);

                  return WL.JSONStore.get('col1').load();
              })

              .then(function (response) {

                  //Prep for your assertion
                  var ACTUAL_VALUE = response; //load returns number of documents loaded
                  var EXPECTED_VALUE = 2; //two documents are returned by the fake adapter (stub)
                  var COMMENT = 'Checking if load worked';

                  //Do the assertion using deepEqual
                  deepEqual(ACTUAL_VALUE, EXPECTED_VALUE, COMMENT);

                  start();//call start() after you finish your test succesfully
              })

              .fail(function (error) {

                  deepEqual(false, true, 'Failure callback should not be called' + error.toString());
                  start();//call start() after you finish your test with a failure
              });

          });

      }(WLJQ)); //end auto executing function that holds the test

  } //end wlCommonInit
  </script>

  </body>
  </html>

Expected output of the code above:

Side-note: Here's a general article about the PhoneGap/Cordova workflow for a specific developer. There's a part of debugging, just browser-based though. Some of it applies to IBM Worklight development too.

Categories

debugging - What are the recommended ways to debug Worklight applications?

debugging - What are the recommended ways to debug Worklight applications?

Please log in or register to add a comment.

Please log in or register to answer this question.

1 Answer

General Worklight 5.0.6 Debugging

Debug Tips for JSONStore on Worklight 5.0.6

Please log in or register to add a comment.

Just Browsing Browsing

Most popular tags