Bug 883298 - [FTU] Check whether there is no need to retrieve the APN settings from the apn.json database.

Author: jaoo

apps/communications/ftu/js/data_mobile.js

@@ -4,7 +4,7 @@ var DataMobile = {
   key: 'ril.data.enabled',
   apnRetrieved: false,
   init: function dm_init() {
-    var settings = window.navigator.mozSettings;
+    var settings = navigator.mozSettings;
     if (!settings) {
       console.log('Settings is not available');
       return;
@@ -39,49 +39,32 @@ var DataMobile = {
       return;
     }
     this.settings.createLock().set(options);
-    self.apnRetrieved = true;
+    this.apnRetrieved = true;
     this.isDataAvailable = status;
     if (callback)
       callback();
   },
-  // TODO: Bug 883298 - [FTU] Check whether there is no need to retrieve the APN
-  // settings from the apn.json database
   getAPN: function dm_getapn(callback) {
-    // TODO Use 'shared' version
-    var APN_FILE = '/shared/resources/apn.json';
-    var self = this;
-    // Retrieve the list of APN configurations
-    // load and query APN database, then trigger callback on results
-    var xhr = new XMLHttpRequest();
-    xhr.open('GET', APN_FILE, true);
-    xhr.responseType = 'json';
-    xhr.onreadystatechange = function() {
-      if (xhr.readyState == 4 && (xhr.status == 200 || xhr.status === 0)) {
-        // TODO: read mcc and mnc codes from 'operatorvariant.{mcc, mnc}'.
-        var mcc = IccHelper.iccInfo.mcc;
-        var mnc = IccHelper.iccInfo.mnc;
-        var apnList = xhr.response;
-        var apns = apnList[mcc] ? (apnList[mcc][mnc] || []) : [];
-        // Looks for a valid APN configuration for data calls.
-        var selectedAPN = {};
-        for (var i = 0; i < apns.length; i++) {
-          if (apns[i] && apns[i].type.indexOf('default') != -1) {
-            selectedAPN = apns[i];
-            break;
+    // By the time the APN settings are needed in the FTU before enabling data
+    // calls the system app (through the operator variant logic) might store the
+    // APN settings into the settings database. If not wait for that before
+    // enabling data calls.
+    var _self = this;
+    function ensureApnSettings() {
+      var req = _self.settings.createLock().get('ril.data.apnSettings');
+      req.onsuccess = function loadApn() {
+        var apnSettings = req.result['ril.data.apnSettings'];
+        if (apnSettings) {
+          if (callback) {
+            callback(req.result);
           }
+          _self.settings.removeObserver('ril.data.apnSettings',
+                                        ensureApnSettings);
         }
-        // Set data in 'Settings'
-        var lock = self.settings.createLock();
-        lock.set({ 'ril.data.apn': selectedAPN.apn || '' });
-        lock.set({ 'ril.data.user': selectedAPN.user || '' });
-        lock.set({ 'ril.data.passwd': selectedAPN.password || '' });
-        lock.set({ 'ril.data.httpProxyHost': selectedAPN.proxy || '' });
-        lock.set({ 'ril.data.httpProxyPort': selectedAPN.port || '' });
-        if (callback) {
-          callback();
-        }
-      }
-    };
-    xhr.send();
+      };
+    }
+
+    ensureApnSettings();
+    this.settings.addObserver('ril.data.apnSettings', ensureApnSettings);
   }
 };

apps/communications/ftu/test/unit/data_mobile_test.js

@@ -1,60 +1,65 @@
 'use strict';
 
-requireApp('communications/ftu/test/unit/mock_icc_helper.js');
-requireApp('communications/ftu/test/unit/mock_settings.js');
-requireApp('system/test/unit/mock_settings_listener.js');
+requireApp('communications/shared/test/unit/mocks/mock_navigator_moz_settings.js');
 requireApp('communications/ftu/js/data_mobile.js');
 
-var mocksHelperForNavigation = new MocksHelper(['IccHelper']);
-mocksHelperForNavigation.init();
-
 suite('mobile data >', function() {
   var realSettings,
-      settingKey = 'ril.data.enabled';
+      settingToggleKey = 'ril.data.enabled',
+      settingApnKey = 'ril.data.apnSettings';
   var mocksHelper = mocksHelperForNavigation;
 
   suiteSetup(function() {
     realSettings = navigator.mozSettings;
-    navigator.mozSettings = MockNavigatorSettings;
+    navigator.mozSettings = window.MockNavigatorSettings;
 
-    mocksHelper.suiteSetup();
     DataMobile.init();
   });
 
   suiteTeardown(function() {
     navigator.mozSettings = realSettings;
     realSettings = null;
-
-    mocksHelper.suiteTeardown();
   });
 
-  test('load APN values from file', function(done) {
-    var settingList = ['ril.data.apn',
-                       'ril.data.user',
-                       'ril.data.passwd',
-                       'ril.data.httpProxyHost',
-                       'ril.data.httpProxyPort'];
-    // real values taken from /shared/resources/apn.json, careful if changed
-    IccHelper.setProperty('iccInfo', {mcc: '214', mnc: '07'});
-    for (var settingName in settingList) {
-      MockNavigatorSettings.mSettings[settingList[settingName]] = null;
-    }
-
-    DataMobile.getAPN(function() {
-      for (var settingName in settingList) {
-        assert.isNotNull(
-                    MockNavigatorSettings.mSettings[settingList[settingName]]);
-      }
-      done();
+  suite('Load APN values from database', function() {
+    var result;
+
+    setup(function(done) {
+      window.MockNavigatorSettings.mSettings[settingApnKey] = '[[]]';
+      DataMobile.getAPN(function(response) {
+        result = response;
+        done();
+      });
+    });
+
+    test('Values are loaded', function() {
+      assert.isNotNull(result);
+    });
+
+    test('Observer is added before', function() {
+      assert.isNotNull(window.MockNavigatorSettings.mObservers);
+    });
+
+    test('Observer is removed after', function() {
+      assert.isNotNull(window.MockNavigatorSettings.mRemovedObservers);
     });
   });
 
-  test('toggle status of mobile data', function(done) {
-    // real values taken from /shared/resources/apn.json, careful if changed
-    IccHelper.setProperty('iccInfo', {mcc: '214', mnc: '07'});
-    DataMobile.toggle(false, function() {
-      assert.isFalse(MockNavigatorSettings.mSettings[settingKey]);
-      done();
+  suite('Toggle status of mobile data', function() {
+    test('toggle status of mobile data', function(done) {
+      DataMobile.toggle(true, function() {
+        assert.isTrue(window.MockNavigatorSettings.mSettings[settingToggleKey]);
+        done();
+      });
+    });
+
+    test('toggle status of mobile data', function(done) {
+      DataMobile.toggle(false, function() {
+        assert.isFalse(
+          window.MockNavigatorSettings.mSettings[settingToggleKey]
+        );
+        done();
+      });
     });
   });
 

apps/communications/ftu/test/unit/language_test.js

@@ -1,6 +1,6 @@
 'use strict';
 
-requireApp('communications/ftu/test/unit/mock_navigator_settings.js');
+requireApp('communications/shared/test/unit/mocks/mock_navigator_moz_settings.js');
 requireApp('communications/ftu/test/unit/mock_settings.js');
 requireApp('communications/ftu/js/language.js');