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

Commit 4e0755c3 authored by Rongxuan Liu's avatar Rongxuan Liu
Browse files

PeriodicScanManager: Notify address type in onSyncEstablished device 

Currently the BT device in onSyncEstablished callback does not include
the address type for LE device. This caused issue that callback client
will not know the address type from native.
We should notify the Le device with address type in this callback.

Bug: 311514710
Test: atest PeriodicScanManagerTest
Test: manual test with periodic sync
Change-Id: I79aea28a6b64f6f0a813612aa58ace7d0dcfce64
parent 292e410b

android/app/src/com/android/bluetooth/gatt/PeriodicScanManager.java

+30 −11
Original line number Diff line number Diff line
@@ -195,12 +195,20 @@ public class PeriodicScanManager { 
                    e.setValue(new SyncInfo(syncHandle, sid, address, e.getValue().skip,

                                            e.getValue().timeout, e.getValue().deathRecipient,

                                            callback));

                    callback.onSyncEstablished(syncHandle, mAdapter.getRemoteDevice(address),

                                               sid, e.getValue().skip, e.getValue().timeout,

                    callback.onSyncEstablished(

                            syncHandle,

                            mAdapter.getRemoteLeDevice(address, addressType),

                            sid,

                            e.getValue().skip,

                            e.getValue().timeout,

                            status);

                } else {

                    callback.onSyncEstablished(syncHandle, mAdapter.getRemoteDevice(address),

                                               sid, e.getValue().skip, e.getValue().timeout,

                    callback.onSyncEstablished(

                            syncHandle,

                            mAdapter.getRemoteLeDevice(address, addressType),

                            sid,

                            e.getValue().skip,

                            e.getValue().timeout,

                            status);

                    IBinder binder = e.getKey();

                    binder.unlinkToDeath(e.getValue().deathRecipient, 0);
@@ -266,9 +274,17 @@ public class PeriodicScanManager { 
        }



        String address = scanResult.getDevice().getAddress();

        int addressType = scanResult.getDevice().getAddressType();

        int sid = scanResult.getAdvertisingSid();

        if (DBG) {

            Log.d(TAG, "startSync for Device: " + address + " sid: " + sid);

            Log.d(

                    TAG,

                    "startSync for Device: "

                            + address

                            + " addressType: "

                            + addressType

                            + " sid: "

                            + sid);

        }

        synchronized (mSyncs) {

            Map.Entry<IBinder, SyncInfo> entry = findMatchingSync(sid, address);
@@ -282,10 +298,13 @@ public class PeriodicScanManager { 
                        callback));

                if (entry.getValue().id >= 0) {

                    try {

                        callback.onSyncEstablished(entry.getValue().id,

                                                   mAdapter.getRemoteDevice(address),

                                                   sid, entry.getValue().skip,

                                                   entry.getValue().timeout, 0 /*success*/);

                        callback.onSyncEstablished(

                                entry.getValue().id,

                                mAdapter.getRemoteLeDevice(address, addressType),

                                sid,

                                entry.getValue().skip,

                                entry.getValue().timeout,

                                0 /*success*/);

                    } catch (RemoteException e) {

                        throw new IllegalArgumentException("Can't invoke callback");

                    }

android/app/tests/unit/src/com/android/bluetooth/gatt/PeriodicScanManagerTest.java

0 → 100644
+120 −0
Original line number Diff line number Diff line 
/*

 * Copyright (C) 2023 The Android Open Source Project

 *

 * Licensed under the Apache License, Version 2.0 (the "License");

 * you may not use this file except in compliance with the License.

 * You may obtain a copy of the License at

 *

 *      http://www.apache.org/licenses/LICENSE-2.0

 *

 * Unless required by applicable law or agreed to in writing, software

 * distributed under the License is distributed on an "AS IS" BASIS,

 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

 * See the License for the specific language governing permissions and

 * limitations under the License.

 */



package com.android.bluetooth.gatt;



import static com.google.common.truth.Truth.assertThat;

import static org.mockito.Mockito.any;

import static org.mockito.Mockito.anyInt;

import static org.mockito.Mockito.doReturn;

import static org.mockito.Mockito.doNothing;

import static org.mockito.Mockito.eq;

import static org.mockito.Mockito.mock;

import static org.mockito.Mockito.verify;



import android.bluetooth.BluetoothAdapter;

import android.bluetooth.BluetoothManager;

import android.bluetooth.BluetoothDevice;

import android.bluetooth.le.ScanResult;

import android.bluetooth.le.IPeriodicAdvertisingCallback;

import android.content.Context;

import android.os.IBinder;



import androidx.test.filters.SmallTest;

import androidx.test.runner.AndroidJUnit4;

import androidx.test.InstrumentationRegistry;



import com.android.bluetooth.btservice.AdapterService;



import org.junit.After;

import org.junit.Before;

import org.junit.Test;

import org.junit.runner.RunWith;

import org.mockito.ArgumentCaptor;

import org.mockito.Mock;

import org.mockito.MockitoAnnotations;



/** Test cases for {@link PeriodicScanManagerTest}. */

@SmallTest

@RunWith(AndroidJUnit4.class)

public class PeriodicScanManagerTest {

    @Mock private PeriodicScanNativeInterface mPeriodicScanNativeInterface;

    @Mock private AdapterService mAdapterService;

    @Mock private IPeriodicAdvertisingCallback mCallback;

    @Mock private IBinder mBinder;



    private BluetoothAdapter mAdapter;

    private PeriodicScanManager mPeriodicScanManager;

    private BluetoothDevice mTestDevice;

    private ScanResult mScanResult;

    private Context mTargetContext;



    private static final String REMOTE_DEVICE_ADDRESS = "00:01:02:03:04:05";



    @Before

    public void setUp() throws Exception {

        mTargetContext = InstrumentationRegistry.getTargetContext();

        MockitoAnnotations.initMocks(this);

        PeriodicScanNativeInterface.setInstance(mPeriodicScanNativeInterface);

        mPeriodicScanManager = new PeriodicScanManager(mAdapterService);



        BluetoothManager manager = mTargetContext.getSystemService(BluetoothManager.class);

        assertThat(manager).isNotNull();

        mAdapter = manager.getAdapter();

        mTestDevice =

                mAdapter.getRemoteLeDevice(

                        REMOTE_DEVICE_ADDRESS, BluetoothDevice.ADDRESS_TYPE_RANDOM);



        mScanResult = new ScanResult(mTestDevice, 0, 0, 0, 0, 0, 0, 0, null, 0);

        mCallback = mock(IPeriodicAdvertisingCallback.class);



        doReturn(mBinder).when(mCallback).asBinder();

        doNothing().when(mBinder).linkToDeath(any(), eq(0));

    }



    @After

    public void tearDown() throws Exception {

        mPeriodicScanManager.cleanup();

        PeriodicScanNativeInterface.setInstance(null);

    }



    @Test

    public void testStartSync() throws Exception {

        mPeriodicScanManager.startSync(mScanResult, 0, 0, mCallback);

        verify(mPeriodicScanNativeInterface)

                .startSync(eq(0), eq(REMOTE_DEVICE_ADDRESS), eq(0), eq(0), anyInt());

    }



    @Test

    public void testOnSyncStarted() throws Exception {

        mPeriodicScanManager.startSync(mScanResult, 0, 0, mCallback);



        ArgumentCaptor<Integer> regId = ArgumentCaptor.forClass(Integer.class);

        verify(mPeriodicScanNativeInterface)

                .startSync(eq(0), eq(REMOTE_DEVICE_ADDRESS), eq(0), eq(0), regId.capture());



        mPeriodicScanManager.onSyncStarted(

                regId.getValue(),

                0,

                0,

                BluetoothDevice.ADDRESS_TYPE_RANDOM,

                REMOTE_DEVICE_ADDRESS,

                0,

                100,

                0);

        verify(mCallback).onSyncEstablished(anyInt(), eq(mTestDevice), eq(0), eq(0), eq(0), eq(0));

    }

}