Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit bd5410fa authored by Sundeep Ghuman's avatar Sundeep Ghuman
Browse files

Change initial value of mStaleScanResults to false. 

In ag/2409026 we introduced a stale scan result bit to prevent callbacks
from sticky broadcasts from occuring until we have fetched the latest
set of scan results. However, this initial value was set to true hence
there is a race condition in which the currently connected network can
still be shown without any other networks, as the scan results have not
yet been processed.

By changing the initial value to false, we address this race condition.

Bug: b/62493360
Test:  runtest --path
frameworks/base/packages/SettingsLib/tests/integ/src/com/android/settingslib/wifi/WifiTrackerTest.java

Change-Id: I82ff8d6c547f1bec4ebfe9b768e6b12435a400ee
parent b00b9763

packages/SettingsLib/src/com/android/settingslib/wifi/WifiTracker.java

+24 −10
Original line number Diff line number Diff line
@@ -144,7 +144,15 @@ public class WifiTracker { 


    @VisibleForTesting

    Scanner mScanner;

    private boolean mStaleScanResults = false;



    /**

     * Bit used to indicate that a SCAN_RESULTS_AVAILABLE_ACTION broadcast has not been received

     * since the last time tracking was resumed.

     *

     * <p>This bit is used to prevent callbacks to {@link WifiListener#onAccessPointChanged()} that

     * would result in stale data being fetched.

     */

    private boolean mStaleScanResults = true;



    public WifiTracker(Context context, WifiListener wifiListener,

            boolean includeSaved, boolean includeScans) {
@@ -767,20 +775,21 @@ public class WifiTracker { 
        public void onReceive(Context context, Intent intent) {

            String action = intent.getAction();



            if (WifiManager.SCAN_RESULTS_AVAILABLE_ACTION.equals(action)) {

                mStaleScanResults = false;

            }



            if (WifiManager.WIFI_STATE_CHANGED_ACTION.equals(action)) {

                updateWifiState(intent.getIntExtra(WifiManager.EXTRA_WIFI_STATE,

                        WifiManager.WIFI_STATE_UNKNOWN));

            } else if (WifiManager.SCAN_RESULTS_AVAILABLE_ACTION.equals(action) ||

                    WifiManager.CONFIGURED_NETWORKS_CHANGED_ACTION.equals(action) ||

                    WifiManager.LINK_CONFIGURATION_CHANGED_ACTION.equals(action)) {

            } else if (WifiManager.SCAN_RESULTS_AVAILABLE_ACTION.equals(action)) {

                Message.obtain(

                            mWorkHandler,

                            WorkHandler.MSG_UPDATE_ACCESS_POINTS,

                            WorkHandler.ARG_CLEAR_STALE_SCAN_RESULTS,

                            0)

                        .sendToTarget();

            } else if (WifiManager.CONFIGURED_NETWORKS_CHANGED_ACTION.equals(action)

                    || WifiManager.LINK_CONFIGURATION_CHANGED_ACTION.equals(action)) {

                mWorkHandler.sendEmptyMessage(WorkHandler.MSG_UPDATE_ACCESS_POINTS);

            } else if (WifiManager.NETWORK_STATE_CHANGED_ACTION.equals(action)) {

                NetworkInfo info = (NetworkInfo) intent.getParcelableExtra(

                        WifiManager.EXTRA_NETWORK_INFO);

                NetworkInfo info = intent.getParcelableExtra(WifiManager.EXTRA_NETWORK_INFO);

                mConnected.set(info.isConnected());



                mMainHandler.sendEmptyMessage(MainHandler.MSG_CONNECTED_CHANGED);
@@ -872,6 +881,8 @@ public class WifiTracker { 
        private static final int MSG_RESUME = 2;

        private static final int MSG_UPDATE_WIFI_STATE = 3;



        private static final int ARG_CLEAR_STALE_SCAN_RESULTS = 1;



        public WorkHandler(Looper looper) {

            super(looper);

        }
@@ -888,6 +899,9 @@ public class WifiTracker { 


            switch (msg.what) {

                case MSG_UPDATE_ACCESS_POINTS:

                    if (msg.arg1 == ARG_CLEAR_STALE_SCAN_RESULTS) {

                        mStaleScanResults = false;

                    }

                    updateAccessPoints();

                    break;

                case MSG_UPDATE_NETWORK_INFO:

packages/SettingsLib/tests/integ/src/com/android/settingslib/wifi/WifiTrackerTest.java

+20 −1
Original line number Diff line number Diff line
@@ -724,7 +724,7 @@ public class WifiTrackerTest { 
        verify(mockWifiManager, times(2)).getConfiguredNetworks();

        verify(mockConnectivityManager).getNetworkInfo(any(Network.class));



        verify(mockWifiListener).onAccessPointsChanged();

        verify(mockWifiListener, never()).onAccessPointsChanged(); // mStaleAccessPoints is true

        assertThat(tracker.getAccessPoints().size()).isEqualTo(2);

        assertThat(tracker.getAccessPoints().get(0).isActive()).isTrue();

    }
@@ -797,6 +797,25 @@ public class WifiTrackerTest { 
        sendScanResultsAndProcess(tracker); // verifies onAccessPointsChanged is invoked

    }



    @Test

    public void startTrackingShouldNotSendAnyCallbacksUntilScanResultsAreProcessed()

            throws Exception {

        WifiTracker tracker = createMockedWifiTracker();

        startTracking(tracker);

        waitForHandlersToProcessCurrentlyEnqueuedMessages(tracker);



        tracker.mReceiver.onReceive(mContext, new Intent(WifiManager.WIFI_STATE_CHANGED_ACTION));

        tracker.mReceiver.onReceive(

                mContext, new Intent(WifiManager.CONFIGURED_NETWORKS_CHANGED_ACTION));

        tracker.mReceiver.onReceive(

                mContext, new Intent(WifiManager.LINK_CONFIGURATION_CHANGED_ACTION));



        waitForHandlersToProcessCurrentlyEnqueuedMessages(tracker);

        verify(mockWifiListener, never()).onAccessPointsChanged();



        sendScanResultsAndProcess(tracker); // verifies onAccessPointsChanged is invoked

    }



    @Test

    public void disablingWifiShouldClearExistingAccessPoints() throws Exception {

        WifiTracker tracker = createTrackerWithScanResultsAndAccessPoint1Connected();