bluetooth: Implement getAvailability()

This change implements the getAvailability() method for
navigator.bluetooth as defined in the specification.

Bug: 707640
Change-Id: I9e9b3e7f8ea7f259e975f71cb6d9570e5f04b479
Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/1651516
Reviewed-by: Chris Harrelson <[email protected]>
Reviewed-by: Giovanni Ortuño Urquidi <[email protected]>
Reviewed-by: Kinuko Yasuda <[email protected]>
Commit-Queue: Ovidio de Jesús Ruiz-Henríquez <[email protected]>
Auto-Submit: Ovidio de Jesús Ruiz-Henríquez <[email protected]>
Cr-Commit-Position: refs/heads/master@{#688987}

Author: odejesush

bluetooth/adapter/adapter-absent-getAvailability.https.window.js

@@ -0,0 +1,16 @@
+// META: script=/resources/testharness.js
+// META: script=/resources/testharnessreport.js
+// META: script=/resources/testdriver.js
+// META: script=/resources/testdriver-vendor.js
+// META: script=/bluetooth/resources/bluetooth-helpers.js
+'use strict';
+const test_desc = 'getAvailability() resolves with false if the system does ' +
+    'not have an adapter.';
+
+bluetooth_test(async () => {
+  await navigator.bluetooth.test.simulateCentral({state: 'absent'});
+  let availability = await navigator.bluetooth.getAvailability();
+  assert_false(
+      availability,
+      'getAvailability() resolves promise with false when adapter is absent.');
+}, test_desc);

bluetooth/adapter/adapter-added-getAvailability.https.window.js

@@ -0,0 +1,24 @@
+// META: script=/resources/testharness.js
+// META: script=/resources/testharnessreport.js
+// META: script=/resources/testdriver.js
+// META: script=/resources/testdriver-vendor.js
+// META: script=/bluetooth/resources/bluetooth-helpers.js
+'use strict';
+const test_desc = 'getAvailability() resolves with true after adapter is ' +
+    'inserted into a system with a platform that supports Bluetooth LE.';
+
+bluetooth_test(async () => {
+  const fake_central =
+      await navigator.bluetooth.test.simulateCentral({state: 'absent'});
+  let availability = await navigator.bluetooth.getAvailability();
+  assert_false(
+      availability,
+      'getAvailability() resolves promise with false when adapter is absent.');
+
+  await fake_central.setState('powered-on');
+  availability = await navigator.bluetooth.getAvailability();
+  assert_true(
+      availability,
+      'getAvailability() resolves promise with true after Bluetooth LE ' +
+          'capable adapter has been has been added.');
+}, test_desc);

bluetooth/adapter/adapter-powered-off-getAvailability.https.window.js

@@ -0,0 +1,17 @@
+// META: script=/resources/testharness.js
+// META: script=/resources/testharnessreport.js
+// META: script=/resources/testdriver.js
+// META: script=/resources/testdriver-vendor.js
+// META: script=/bluetooth/resources/bluetooth-helpers.js
+'use strict';
+const test_desc = 'getAvailability() resolves with true if the Bluetooth ' +
+    'radio is powered off, but the platform that supports Bluetooth LE.';
+
+bluetooth_test(async () => {
+  await navigator.bluetooth.test.simulateCentral({state: 'powered-off'});
+  let availability = await navigator.bluetooth.getAvailability();
+  assert_true(
+      availability,
+      'getAvailability() resolves promise with true when adapter is powered ' +
+          'off.');
+}, test_desc);

bluetooth/adapter/adapter-powered-on-getAvailability.https.window.js

@@ -0,0 +1,17 @@
+// META: script=/resources/testharness.js
+// META: script=/resources/testharnessreport.js
+// META: script=/resources/testdriver.js
+// META: script=/resources/testdriver-vendor.js
+// META: script=/bluetooth/resources/bluetooth-helpers.js
+'use strict';
+const test_desc = 'getAvailability() resolves with true if the Bluetooth ' +
+    'radio is powered on and the platform supports Bluetooth LE.';
+
+bluetooth_test(async () => {
+  await navigator.bluetooth.test.simulateCentral({state: 'powered-on'});
+  let availability = await navigator.bluetooth.getAvailability();
+  assert_true(
+      availability,
+      'getAvailability() resolves promise with true when adapter is powered ' +
+          'on and it supports Bluetooth Low-Energy.');
+}, test_desc);

bluetooth/adapter/adapter-powered-on-off-on-getAvailability.https.window.js

@@ -0,0 +1,38 @@
+// META: script=/resources/testharness.js
+// META: script=/resources/testharnessreport.js
+// META: script=/resources/testdriver.js
+// META: script=/resources/testdriver-vendor.js
+// META: script=/bluetooth/resources/bluetooth-helpers.js
+'use strict';
+const test_desc = 'getAvailability() is not affected by the powered state of ' +
+    'the adapter.';
+
+bluetooth_test(async () => {
+  const fake_central =
+      await navigator.bluetooth.test.simulateCentral({state: 'powered-on'});
+  {
+    const availability = await navigator.bluetooth.getAvailability();
+    assert_true(
+        availability,
+        'getAvailability() resolves promise with true when adapter is ' +
+            'powered on and it supports Bluetooth Low-Energy.');
+  }
+
+  {
+    await fake_central.setState('powered-off');
+    const availability = await navigator.bluetooth.getAvailability();
+    assert_true(
+        availability,
+        'getAvailability() resolves promise with true after adapter powered ' +
+            'off.');
+  }
+
+  {
+    await fake_central.setState('powered-on');
+    const availability = await navigator.bluetooth.getAvailability();
+    assert_true(
+        availability,
+        'getAvailability() resolves promise with true when adapter is ' +
+            'powered back on.');
+  }
+}, test_desc);

bluetooth/adapter/adapter-removed-getAvailability.https.window.js

@@ -0,0 +1,25 @@
+// META: script=/resources/testharness.js
+// META: script=/resources/testharnessreport.js
+// META: script=/resources/testdriver.js
+// META: script=/resources/testdriver-vendor.js
+// META: script=/bluetooth/resources/bluetooth-helpers.js
+'use strict';
+const test_desc = 'getAvailability() resolves with false after the powered ' +
+    'on adapter is removed.';
+
+bluetooth_test(async () => {
+  const fake_central =
+      await navigator.bluetooth.test.simulateCentral({state: 'powered-on'});
+  let availability = await navigator.bluetooth.getAvailability();
+  assert_true(
+      availability,
+      'getAvailability() resolves promise with true when adapter is powered ' +
+          'on and it supports Bluetooth Low-Energy.');
+
+  await fake_central.setState('absent');
+  availability = await navigator.bluetooth.getAvailability();
+  assert_false(
+      availability,
+      'getAvailability() resolves promise with false after adapter has been ' +
+          'has been removed.');
+}, test_desc);

bluetooth/adapter/cross-origin-iframe-getAvailability.sub.https.window.js

@@ -0,0 +1,32 @@
+// META: script=/resources/testharness.js
+// META: script=/resources/testharnessreport.js
+// META: script=/resources/testdriver.js
+// META: script=/resources/testdriver-vendor.js
+// META: script=/bluetooth/resources/bluetooth-helpers.js
+'use strict';
+const test_desc = 'getAvailability() resolves with false if called from a ' +
+    'unique origin';
+const cross_origin_src = 'https://{{domains[www]}}:{{ports[https][0]}}' +
+    '/bluetooth/resources/health-thermometer-iframe.html'
+let iframe = document.createElement('iframe');
+
+bluetooth_test(async () => {
+  await navigator.bluetooth.test.simulateCentral({state: 'powered-on'});
+  await new Promise(resolve => {
+    iframe.src = cross_origin_src;
+    document.body.appendChild(iframe);
+    iframe.addEventListener('load', resolve);
+  });
+  await new Promise(resolve => {
+    callWithTrustedClick(
+        () => iframe.contentWindow.postMessage({type: 'GetAvailability'}, '*'));
+
+    window.onmessage = messageEvent => {
+      assert_equals(
+          messageEvent.data, false,
+          'getAvailability resolves to false when called from a unique ' +
+              'origin.');
+      resolve();
+    };
+  });
+}, test_desc);

bluetooth/resources/health-thermometer-iframe.html

@@ -9,6 +9,10 @@
 
 window.addEventListener('message', (messageEvent) => {
   switch (messageEvent.data.type) {
+    case 'GetAvailability':
+      navigator.bluetooth.getAvailability().then(
+          availability => parent.postMessage(availability, '*'));
+      break;
     case 'RequestDevice':
       navigator.bluetooth
           .requestDevice({filters: [{services: ['generic_access']}]})

resources/chromium/web-bluetooth-test.js

@@ -82,6 +82,7 @@ class FakeBluetooth {
     this.fake_bluetooth_ptr_ = new bluetooth.mojom.FakeBluetoothPtr();
     Mojo.bindInterface(bluetooth.mojom.FakeBluetooth.name,
         mojo.makeRequest(this.fake_bluetooth_ptr_).handle, 'process');
+    this.fake_central_ = null;
   }
 
   // Set it to indicate whether the platform supports BLE. For example,
@@ -105,12 +106,16 @@ class FakeBluetooth {
   // See Bluetooth 4.2 Vol 3 Part C 2.2.2 "Roles when Operating over an
   // LE Physical Transport".
   async simulateCentral({state}) {
+    if (this.fake_central_)
+      throw 'simulateCentral() should only be called once';
+
     await this.setLESupported(true);
 
     let {fakeCentral: fake_central_ptr} =
       await this.fake_bluetooth_ptr_.simulateCentral(
         toMojoCentralState(state));
-    return new FakeCentral(fake_central_ptr);
+    this.fake_central_ = new FakeCentral(fake_central_ptr);
+    return this.fake_central_;
   }
 
   // Returns true if there are no pending responses.
@@ -202,6 +207,16 @@ class FakeCentral {
     return this.fetchOrCreatePeripheral_(scanResult.deviceAddress);
   }
 
+  // Simulates a change in the central device described by |state|. For example,
+  // setState('powered-off') can be used to simulate the central device powering
+  // off.
+  //
+  // This method should be used for any central state changes after
+  // simulateCentral() has been called to create a FakeCentral object.
+  async setState(state) {
+    await this.fake_central_ptr_.setState(toMojoCentralState(state));
+  }
+
   // Create a fake_peripheral object from the given address.
   fetchOrCreatePeripheral_(address) {
     let peripheral = this.peripherals_.get(address);