bug 915920 - ensure APN settings only get applied once per boot.

Author: Ghislain 'Aus' Lacroix

apps/system/js/operator_variant/operator_variant.js

@@ -4,6 +4,9 @@
 'use strict';
 
 (function OperatorVariant() {
+  // Reserved Test Network MCC. This is how we know we're running tests vs
+  // running in the real world.
+  const TEST_NETWORK_MCC = 1;
 
   // Cache the values we've seen.
   var iccSettings = { mcc: -1, mnc: -1 };
@@ -37,6 +40,14 @@
   operatorVariantHelper.listen();
 
   function applySettings(mcc, mnc) {
+
+    // Only apply once per device boot-up, except when in tests. All tests
+    // use the reserved Test Network MCC value of '1'. See this handy table
+    // for more information: http://en.wikipedia.org/wiki/Mobile_country_code
+    if (mcc != TEST_NETWORK_MCC) {
+      operatorVariantHelper.listen(false);
+    }
+
     // same SIM card => do nothing
     if ((mcc == iccSettings.mcc) && (mnc == iccSettings.mnc)) {
       var apnSettingsKey = 'ril.data.apnSettings';

apps/system/test/unit/operator_variant_test.js

@@ -10,7 +10,7 @@ var mocksForOperatorVariant = new MocksHelper([
 ]).init();
 
 suite('operator variant', function() {
-  const TEST_NETWORK_MCC = 111;
+  const TEST_NETWORK_MCC = 1;
 
   const EXPECTED_DATA_MNC = 1;
   const EXPECTED_DATA_ICC_INFO = {
@@ -30,6 +30,20 @@ suite('operator variant', function() {
     mnc: EXPECTED_OV_MNC
   };
 
+  const T_MOBILE_US_MCC = 310;
+  const T_MOBILE_160_US_MNC = 160;
+  const T_MOBILE_200_US_MNC = 200;
+
+  const T_MOBILE_160_US_ICC_INFO = {
+    mcc: T_MOBILE_US_MCC,
+    mnc: T_MOBILE_160_US_MNC
+  };
+
+  const T_MOBILE_200_US_ICC_INFO = {
+    mcc: T_MOBILE_US_MCC,
+    mnc: T_MOBILE_200_US_MNC
+  };
+
   const NULL_ICC_INFO = { mcc: 0, mnc: 0 };
   const PERSIST_KEY = 'operator_variant_test.customize';
 
@@ -198,4 +212,37 @@ suite('operator variant', function() {
     MockIccHelper.mProps.iccInfo = EXPECTED_OV_ICC_INFO;
     MockIccHelper.mTriggerEventListeners('iccinfochange', {});
   });
+
+  test('operator variant apply once per boot', function() {
+    var observer = {
+      bound: null,
+      hasApplied: false,
+      func: function(event) {
+        if (event.settingName == 'ril.data.carrier') {
+          assert.false(
+            this.hasApplied,
+            'Settings should *not* be applied twice!'
+          );
+
+          assert.match(
+            event.settingValue,
+            /^T-Mobile US/,
+            'Expected network name to contain "T-Mobile US"'
+          );
+
+          this.hasApplied = true;
+        }
+      }
+    };
+
+    observer.bound = observer.func.bind(observer);
+    MockNavigatorSettings.addObserver('ril.data.carrier', observer.bound);
+
+    // Testing apply once per boot requires *real* mcc/mnc information.
+    MockIccHelper.mProps.iccInfo = T_MOBILE_160_US_ICC_INFO;
+    MockIccHelper.mTriggerEventListeners('iccinfochange', {});
+
+    MockIccHelper.mProps.iccInfo = T_MOBILE_200_US_ICC_INFO;
+    MockIccHelper.mTriggerEventListeners('iccinfochange', {});
+  });
 });

shared/resources/apn.json

@@ -1,5 +1,5 @@
 {
-"111": {
+"1": {
   "01": [
     {"carrier":"Test Network","apn":"internet","user":"user","password":"password","proxy":"127.0.0.1","port":"8080","authtype":"0","type":["default","supl"]}
   ],

shared/resources/apn/apns_conf_local.xml

@@ -4,7 +4,7 @@
 <!-- This version must agree with that in apps/common/res/apns.xml -->
 <apns version="7">
   <apn carrier="Test Network"
-      mcc="111"
+      mcc="001"
       mnc="01"
       apn="internet"
       user="user"
@@ -16,7 +16,7 @@
   />
 
   <apn carrier="Test Network with MMS"
-      mcc="111"
+      mcc="001"
       mnc="02"
       apn="mms.internet"
       user="user"
@@ -31,7 +31,7 @@
   />
 
   <apn carrier="Test Network with Operator Variant Settings"
-      mcc="111"
+      mcc="001"
       mnc="03"
       apn="mms.internet"
       user="user"