Navigation Menu

Skip to content

Commit

Permalink
BluetoothUUID refactor
Browse files Browse the repository at this point in the history
  • Loading branch information
Zakor Gyula committed Dec 1, 2016
1 parent 61a225b commit 7e2a012
Show file tree
Hide file tree
Showing 11 changed files with 82 additions and 57 deletions.
35 changes: 30 additions & 5 deletions components/script/dom/bluetoothuuid.rs
View file
Expand Up @@ -3,7 +3,7 @@
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */

use dom::bindings::codegen::UnionTypes::StringOrUnsignedLong;
use dom::bindings::error::Error::Syntax;
use dom::bindings::error::Error::Type;
use dom::bindings::error::Fallible;
use dom::bindings::reflector::Reflector;
use dom::bindings::str::DOMString;
Expand Down Expand Up @@ -268,6 +268,18 @@ const SERVICE_PREFIX: &'static str = "org.bluetooth.service";
const CHARACTERISTIC_PREFIX: &'static str = "org.bluetooth.characteristic";
const DESCRIPTOR_PREFIX: &'static str = "org.bluetooth.descriptor";
const VALID_UUID_REGEX: &'static str = "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}";
// https://cs.chromium.org/chromium/src/third_party/WebKit/Source/modules/bluetooth/BluetoothUUID.cpp?l=314
const UUID_ERROR_MESSAGE: &'static str = "It must be a valid UUID alias (e.g. 0x1234), \
UUID (lowercase hex characters e.g. '00001234-0000-1000-8000-00805f9b34fb'),\nor recognized standard name from";
// https://cs.chromium.org/chromium/src/third_party/WebKit/Source/modules/bluetooth/BluetoothUUID.cpp?l=321
const SERVICES_ERROR_MESSAGE: &'static str = "https://developer.bluetooth.org/gatt/services/Pages/ServicesHome.aspx\
\ne.g. 'alert_notification'.";
// https://cs.chromium.org/chromium/src/third_party/WebKit/Source/modules/bluetooth/BluetoothUUID.cpp?l=327
const CHARACTERISTIC_ERROR_MESSAGE: &'static str = "https://developer.bluetooth.org/gatt/characteristics/Pages/\
CharacteristicsHome.aspx\ne.g. 'aerobic_heart_rate_lower_limit'.";
// https://cs.chromium.org/chromium/src/third_party/WebKit/Source/modules/bluetooth/BluetoothUUID.cpp?l=333
const DESCRIPTOR_ERROR_MESSAGE: &'static str = "https://developer.bluetooth.org/gatt/descriptors/Pages/\
DescriptorsHomePage.aspx\ne.g. 'gatt.characteristic_presentation_format'.";

impl BluetoothUUID {
// https://webbluetoothcg.github.io/web-bluetooth/#dom-bluetoothuuid-canonicaluuid
Expand Down Expand Up @@ -325,22 +337,35 @@ fn resolve_uuid_name(
prefix: &str)
-> Fallible<DOMString> {
match name {
// Step 1
// Step 1.
StringOrUnsignedLong::UnsignedLong(unsigned32) => {
Ok(canonical_uuid(unsigned32))
},
StringOrUnsignedLong::String(dstring) => {
// Step 2
// Step 2.
let regex = Regex::new(VALID_UUID_REGEX).unwrap();
if regex.is_match(&*dstring) {
Ok(dstring)
} else {
// Step 3
// Step 3.
let concatenated = format!("{}.{}", prefix, dstring);
let is_in_table = assigned_numbers_table.iter().find(|p| p.0 == concatenated);
match is_in_table {
Some(&(_, alias)) => Ok(canonical_uuid(alias)),
None => Err(Syntax),
None => {
let (attribute_type, error_url_message) = match prefix {
SERVICE_PREFIX => ("Service", SERVICES_ERROR_MESSAGE),
CHARACTERISTIC_PREFIX => ("Characteristic", CHARACTERISTIC_ERROR_MESSAGE),
DESCRIPTOR_PREFIX => ("Descriptor", DESCRIPTOR_ERROR_MESSAGE),
_ => unreachable!(),
};
// Step 4.
return Err(Type(format!("Invalid {} name : '{}'.\n{} {}",
attribute_type,
dstring,
UUID_ERROR_MESSAGE,
error_url_message)));
},
}
}
},
Expand Down
4 changes: 2 additions & 2 deletions tests/wpt/mozilla/tests/mozilla/bluetooth/getCharacteristic/invalid-characteristic-name.html
View file
Expand Up @@ -12,6 +12,6 @@
})
.then(device => device.gatt.connect())
.then(gattServer => gattServer.getPrimaryService(generic_access.name))
.then(service => promise_rejects(t, 'SyntaxError', service.getCharacteristic(wrong.name)));
}, 'Wrong Characteristic name. Reject with SyntaxError.');
.then(service => promise_rejects(t, new TypeError(), service.getCharacteristic(wrong.name)));
}, 'Wrong Characteristic name. Reject with TypeError.');
</script>
4 changes: 2 additions & 2 deletions ...s/wpt/mozilla/tests/mozilla/bluetooth/getCharacteristics/invalid-characteristic-name.html
View file
Expand Up @@ -12,6 +12,6 @@
})
.then(device => device.gatt.connect())
.then(gattServer => gattServer.getPrimaryService(generic_access.name))
.then(service => promise_rejects(t, 'SyntaxError', service.getCharacteristics(wrong.name)));
}, 'Invalid Characteristic name. Reject with SyntaxError.');
.then(service => promise_rejects(t, new TypeError(), service.getCharacteristics(wrong.name)));
}, 'Invalid Characteristic name. Reject with TypeError.');
</script>
4 changes: 2 additions & 2 deletions tests/wpt/mozilla/tests/mozilla/bluetooth/getDescriptor/invalid-descriptor-name.html
View file
Expand Up @@ -13,6 +13,6 @@
.then(device => device.gatt.connect())
.then(gattServer => gattServer.getPrimaryService(generic_access.name))
.then(service => service.getCharacteristic(device_name.name))
.then(characteristic => promise_rejects(t, 'SyntaxError', characteristic.getDescriptor(wrong.name)));
}, 'Wrong descriptor name. Reject with SyntaxError.');
.then(characteristic => promise_rejects(t, new TypeError(), characteristic.getDescriptor(wrong.name)));
}, 'Wrong descriptor name. Reject with TypeError.');
</script>
4 changes: 2 additions & 2 deletions tests/wpt/mozilla/tests/mozilla/bluetooth/getDescriptors/invalid-descriptor-name.html
View file
Expand Up @@ -13,6 +13,6 @@
.then(device => device.gatt.connect())
.then(gattServer => gattServer.getPrimaryService(generic_access.name))
.then(service => service.getCharacteristic(device_name.name))
.then(characteristic => promise_rejects(t, 'SyntaxError', characteristic.getDescriptors(wrong.name)));
}, 'Wrong descriptor name. Reject with SyntaxError.');
.then(characteristic => promise_rejects(t, new TypeError(), characteristic.getDescriptors(wrong.name)));
}, 'Wrong descriptor name. Reject with TypeError.');
</script>
4 changes: 2 additions & 2 deletions tests/wpt/mozilla/tests/mozilla/bluetooth/getPrimaryService/invalid-service-name.html
View file
Expand Up @@ -10,6 +10,6 @@
filters: [{services: [heart_rate.name]}]
})
.then(device => device.gatt.connect())
.then(gattServer => promise_rejects(t, 'SyntaxError', gattServer.getPrimaryService(wrong.name)));
}, 'Wrong Service name. Reject with SyntaxError.');
.then(gattServer => promise_rejects(t, new TypeError(), gattServer.getPrimaryService(wrong.name)));
}, 'Wrong Service name. Reject with TypeError.');
</script>
4 changes: 2 additions & 2 deletions tests/wpt/mozilla/tests/mozilla/bluetooth/getPrimaryServices/invalid-service-name.html
View file
Expand Up @@ -10,6 +10,6 @@
filters: [{services: [heart_rate.name]}]
})
.then(device => device.gatt.connect())
.then(gattServer => promise_rejects(t, 'SyntaxError', gattServer.getPrimaryServices(wrong.name)));
}, 'Wrong Service name. Reject with SyntaxError.');
.then(gattServer => promise_rejects(t, new TypeError(), gattServer.getPrimaryServices(wrong.name)));
}, 'Wrong Service name. Reject with TypeError.');
</script>
72 changes: 36 additions & 36 deletions tests/wpt/mozilla/tests/mozilla/bluetooth/idl-BluetoothUUID.html
View file
Expand Up @@ -83,23 +83,23 @@

test(() => {
let all_caps_uuid = '1A2B3C4D-5E6F-7A8B-9C0D-1E2F3A4B5C6D';
assert_throws('SyntaxError', () => BluetoothUUID.getService(all_caps_uuid));
assert_throws('SyntaxError', () => BluetoothUUID.getCharacteristic(all_caps_uuid));
assert_throws('SyntaxError', () => BluetoothUUID.getDescriptor(all_caps_uuid));
assert_throws(new TypeError(), () => BluetoothUUID.getService(all_caps_uuid));
assert_throws(new TypeError(), () => BluetoothUUID.getCharacteristic(all_caps_uuid));
assert_throws(new TypeError(), () => BluetoothUUID.getDescriptor(all_caps_uuid));
}, 'A UUID String with uppercase letters is an invalid UUID.');

test(() => {
let string_alias = 'deadbeef';
assert_throws('SyntaxError', () => BluetoothUUID.getService(string_alias));
assert_throws('SyntaxError', () => BluetoothUUID.getCharacteristic(string_alias));
assert_throws('SyntaxError', () => BluetoothUUID.getDescriptor(string_alias));
assert_throws(new TypeError(), () => BluetoothUUID.getService(string_alias));
assert_throws(new TypeError(), () => BluetoothUUID.getCharacteristic(string_alias));
assert_throws(new TypeError(), () => BluetoothUUID.getDescriptor(string_alias));
}, 'A 32bit *String* alias is invalid.');

test(() => {
let invalid_character_uuid = '0000000g-0000-1000-8000-00805f9b34fb';
assert_throws('SyntaxError', () => BluetoothUUID.getService(invalid_character_uuid));
assert_throws('SyntaxError', () => BluetoothUUID.getCharacteristic(invalid_character_uuid));
assert_throws('SyntaxError', () => BluetoothUUID.getDescriptor(invalid_character_uuid));
assert_throws(new TypeError(), () => BluetoothUUID.getService(invalid_character_uuid));
assert_throws(new TypeError(), () => BluetoothUUID.getCharacteristic(invalid_character_uuid));
assert_throws(new TypeError(), () => BluetoothUUID.getDescriptor(invalid_character_uuid));
}, 'A UUID with invalid characters is an invalid UUID.');

test(() => {
Expand All @@ -112,31 +112,31 @@
}, 'A valid UUID from a name.');

test(() => {
assert_throws('SyntaxError', () => {
assert_throws(new TypeError(), () => {
BluetoothUUID.getService(aerobic_heart_rate_lower_limit.name);
});
assert_throws('SyntaxError', () => {
assert_throws(new TypeError(), () => {
BluetoothUUID.getService(characteristic_extended_properties.name);
});
assert_throws('SyntaxError', () => {
assert_throws(new TypeError(), () => {
BluetoothUUID.getCharacteristic(alert_notification.name);
});
assert_throws('SyntaxError', () => {
assert_throws(new TypeError(), () => {
BluetoothUUID.getCharacteristic(characteristic_extended_properties.name);
});
assert_throws('SyntaxError', () => {
assert_throws(new TypeError(), () => {
BluetoothUUID.getDescriptor(alert_notification.name);
});
assert_throws('SyntaxError', () => {
assert_throws(new TypeError(), () => {
BluetoothUUID.getDescriptor(aerobic_heart_rate_lower_limit.name);
});
}, 'Make sure attributes don\'t share a map');

test(() => {
let wrong_name = 'wrong_name';
assert_throws('SyntaxError', () => BluetoothUUID.getService(wrong_name));
assert_throws('SyntaxError', () => BluetoothUUID.getCharacteristic(wrong_name));
assert_throws('SyntaxError', () => BluetoothUUID.getDescriptor(wrong_name));
assert_throws(new TypeError(), () => BluetoothUUID.getService(wrong_name));
assert_throws(new TypeError(), () => BluetoothUUID.getCharacteristic(wrong_name));
assert_throws(new TypeError(), () => BluetoothUUID.getDescriptor(wrong_name));
}, 'Invalid Descriptor name');

test(() => {
Expand All @@ -154,25 +154,25 @@
assert_equals(BluetoothUUID.canonicalUUID(true), BluetoothUUID.canonicalUUID(1));
assert_throws(new TypeError, () => BluetoothUUID.canonicalUUID(NaN));
// getService
assert_throws('SyntaxError', () => BluetoothUUID.getService(object));
assert_throws('SyntaxError', () => BluetoothUUID.getService(array));
assert_throws('SyntaxError', () => BluetoothUUID.getService(func));
assert_throws('SyntaxError', () => BluetoothUUID.getService(undefined));
assert_throws('SyntaxError', () => BluetoothUUID.getService(null));
assert_throws('SyntaxError', () => BluetoothUUID.getService(false));
assert_throws(new TypeError(), () => BluetoothUUID.getService(object));
assert_throws(new TypeError(), () => BluetoothUUID.getService(array));
assert_throws(new TypeError(), () => BluetoothUUID.getService(func));
assert_throws(new TypeError(), () => BluetoothUUID.getService(undefined));
assert_throws(new TypeError(), () => BluetoothUUID.getService(null));
assert_throws(new TypeError(), () => BluetoothUUID.getService(false));
// getCharacteristic
assert_throws('SyntaxError', () => BluetoothUUID.getCharacteristic(object));
assert_throws('SyntaxError', () => BluetoothUUID.getCharacteristic(array));
assert_throws('SyntaxError', () => BluetoothUUID.getCharacteristic(func));
assert_throws('SyntaxError', () => BluetoothUUID.getCharacteristic(undefined));
assert_throws('SyntaxError', () => BluetoothUUID.getCharacteristic(null));
assert_throws('SyntaxError', () => BluetoothUUID.getCharacteristic(false));
assert_throws(new TypeError(), () => BluetoothUUID.getCharacteristic(object));
assert_throws(new TypeError(), () => BluetoothUUID.getCharacteristic(array));
assert_throws(new TypeError(), () => BluetoothUUID.getCharacteristic(func));
assert_throws(new TypeError(), () => BluetoothUUID.getCharacteristic(undefined));
assert_throws(new TypeError(), () => BluetoothUUID.getCharacteristic(null));
assert_throws(new TypeError(), () => BluetoothUUID.getCharacteristic(false));
// getDescriptor
assert_throws('SyntaxError', () => BluetoothUUID.getDescriptor(object));
assert_throws('SyntaxError', () => BluetoothUUID.getDescriptor(array));
assert_throws('SyntaxError', () => BluetoothUUID.getDescriptor(func));
assert_throws('SyntaxError', () => BluetoothUUID.getDescriptor(undefined));
assert_throws('SyntaxError', () => BluetoothUUID.getDescriptor(null));
assert_throws('SyntaxError', () => BluetoothUUID.getDescriptor(false));
assert_throws(new TypeError(), () => BluetoothUUID.getDescriptor(object));
assert_throws(new TypeError(), () => BluetoothUUID.getDescriptor(array));
assert_throws(new TypeError(), () => BluetoothUUID.getDescriptor(func));
assert_throws(new TypeError(), () => BluetoothUUID.getDescriptor(undefined));
assert_throws(new TypeError(), () => BluetoothUUID.getDescriptor(null));
assert_throws(new TypeError(), () => BluetoothUUID.getDescriptor(false));
}, 'Non-number and non-strings');
</script>
4 changes: 2 additions & 2 deletions ...illa/tests/mozilla/bluetooth/requestDevice/canonicalizeFilter/wrong-service-data-key.html
View file
Expand Up @@ -81,8 +81,8 @@
window.testRunner.setBluetoothMockDataSet(adapter_type.glucose_heart_rate);
let promises = [];
wrong_service_data_keys.forEach(args => {
promises.push(promise_rejects(t, 'SyntaxError', window.navigator.bluetooth.requestDevice(args)));
promises.push(promise_rejects(t, new TypeError(), window.navigator.bluetooth.requestDevice(args)));
});
return Promise.all(promises);
}, 'Rejects with SyntaxError, if a serviceData key does not convert to a valid uuid.');
}, 'Rejects with TypeError, if a serviceData key does not convert to a valid uuid.');
</script>
2 changes: 1 addition & 1 deletion .../bluetooth/requestDevice/canonicalizeFilter/wrong-service-in-optionalServices-member.html
View file
Expand Up @@ -31,7 +31,7 @@
window.testRunner.setBluetoothMockDataSet(adapter_type.empty);
let promises = [];
test_specs.forEach(args => {
promises.push(promise_rejects(t, 'SyntaxError', window.navigator.bluetooth.requestDevice(args)));
promises.push(promise_rejects(t, new TypeError(), window.navigator.bluetooth.requestDevice(args)));
});
return Promise.all(promises);
}, 'Invalid optional service must reject the promise.');
Expand Down
2 changes: 1 addition & 1 deletion .../mozilla/bluetooth/requestDevice/canonicalizeFilter/wrong-service-in-services-member.html
View file
Expand Up @@ -30,7 +30,7 @@
window.testRunner.setBluetoothMockDataSet(adapter_type.empty);
let promises = [];
test_specs.forEach(args => {
promises.push(promise_rejects(t, 'SyntaxError', window.navigator.bluetooth.requestDevice(args)));
promises.push(promise_rejects(t, new TypeError(), window.navigator.bluetooth.requestDevice(args)));
});
return Promise.all(promises);
}, 'Invalid optional service must reject the promise.');
Expand Down

0 comments on commit 7e2a012

Please sign in to comment.