Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make callMethod always return success and throw exception on error. #215

Merged
merged 1 commit into from May 10, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
36 changes: 24 additions & 12 deletions lib/src/dbus_client.dart
Expand Up @@ -371,15 +371,19 @@ class DBusClient {

/// Returns the unique connection name of the client that owns [name].
Future<String?> getNameOwner(String name) async {
var result = await callMethod(
destination: 'org.freedesktop.DBus',
path: DBusObjectPath('/org/freedesktop/DBus'),
interface: 'org.freedesktop.DBus',
name: 'GetNameOwner',
values: [DBusString(name)]);
if (result is DBusMethodErrorResponse &&
result.errorName == 'org.freedesktop.DBus.Error.NameHasNoOwner') {
return null;
DBusMethodSuccessResponse result;
try {
result = await callMethod(
destination: 'org.freedesktop.DBus',
path: DBusObjectPath('/org/freedesktop/DBus'),
interface: 'org.freedesktop.DBus',
name: 'GetNameOwner',
values: [DBusString(name)]);
} on DBusMethodResponseException catch (e) {
if (e.response.errorName == 'org.freedesktop.DBus.Error.NameHasNoOwner') {
return null;
}
rethrow;
}
if (result.signature != DBusSignature('s')) {
throw 'org.freedesktop.DBus.GetNameOwner returned invalid result: ${result.returnValues}';
Expand Down Expand Up @@ -530,7 +534,8 @@ class DBusClient {
}

/// Invokes a method on a D-Bus object.
Future<DBusMethodResponse> callMethod(
/// Throws [DBusMethodResponseException] if the remote side returns an error.
Future<DBusMethodSuccessResponse> callMethod(
{String? destination,
required DBusObjectPath path,
String? interface,
Expand Down Expand Up @@ -992,7 +997,7 @@ class DBusClient {
}

/// Invokes a method on a D-Bus object.
Future<DBusMethodResponse> _callMethod(
Future<DBusMethodSuccessResponse> _callMethod(
{DBusBusName? destination,
required DBusObjectPath path,
DBusInterfaceName? interface,
Expand Down Expand Up @@ -1029,7 +1034,14 @@ class DBusClient {
.toSet());
await _sendMessage(message, requireConnect: requireConnect);

return response;
var r = await response;
if (r is DBusMethodSuccessResponse) {
return r;
} else if (r is DBusMethodErrorResponse) {
throw DBusMethodResponseException(r);
} else {
throw 'Unknown response type';
}
}

/// Sends a method return to the D-Bus server.
Expand Down
3 changes: 2 additions & 1 deletion lib/src/dbus_remote_object.dart
Expand Up @@ -123,7 +123,8 @@ class DBusRemoteObject {
}

/// Invokes a method on this object.
Future<DBusMethodResponse> callMethod(
/// Throws [DBusMethodResponseException] if the remote side returns an error.
Future<DBusMethodSuccessResponse> callMethod(
String? interface, String name, Iterable<DBusValue> values,
{Set<DBusMethodCallFlag> flags = const {}}) async {
return client.callMethod(
Expand Down
34 changes: 15 additions & 19 deletions test/dbus_test.dart
Expand Up @@ -683,9 +683,7 @@ void main() {
path: DBusObjectPath('/'),
name: 'Test',
values: [DBusString('Hello'), DBusUint32(42)]);
expect(response, TypeMatcher<DBusMethodSuccessResponse>());
expect((response as DBusMethodSuccessResponse).values,
equals([DBusString('World'), DBusUint32(99)]));
expect(response.values, equals([DBusString('World'), DBusUint32(99)]));

await client1.close();
await client2.close();
Expand All @@ -709,8 +707,7 @@ void main() {
name: 'Test',
values: [DBusString('Hello'), DBusUint32(42)],
flags: {DBusMethodCallFlag.noReplyExpected});
expect(response, TypeMatcher<DBusMethodSuccessResponse>());
expect((response as DBusMethodSuccessResponse).values, equals([]));
expect(response.values, equals([]));

await client1.close();
await client2.close();
Expand All @@ -734,8 +731,7 @@ void main() {
path: DBusObjectPath('/'),
name: 'Test',
values: [DBusString('Hello'), DBusUint32(42)]);
expect(response, TypeMatcher<DBusMethodSuccessResponse>());
expect((response as DBusMethodSuccessResponse).values, equals([]));
expect(response.values, equals([]));

await client1.close();
await client2.close();
Expand All @@ -760,8 +756,7 @@ void main() {
name: 'Test',
values: [DBusString('Hello'), DBusUint32(42)],
flags: {DBusMethodCallFlag.noAutoStart});
expect(response, TypeMatcher<DBusMethodSuccessResponse>());
expect((response as DBusMethodSuccessResponse).values, equals([]));
expect(response.values, equals([]));

await client1.close();
await client2.close();
Expand All @@ -786,8 +781,7 @@ void main() {
name: 'Test',
values: [DBusString('Hello'), DBusUint32(42)],
flags: {DBusMethodCallFlag.allowInteractiveAuthorization});
expect(response, TypeMatcher<DBusMethodSuccessResponse>());
expect((response as DBusMethodSuccessResponse).values, equals([]));
expect(response.values, equals([]));

await client1.close();
await client2.close();
Expand All @@ -808,14 +802,16 @@ void main() {
}));

// Call the method from another client.
var response = await client2.callMethod(
destination: client1.uniqueName,
path: DBusObjectPath('/'),
name: 'Test');
expect(response, TypeMatcher<DBusMethodErrorResponse>());
expect((response as DBusMethodErrorResponse).errorName,
equals('com.example.Error'));
expect(response.values, equals([DBusString('Count'), DBusUint32(42)]));
try {
await client2.callMethod(
destination: client1.uniqueName,
path: DBusObjectPath('/'),
name: 'Test');
fail('Expected DBusMethodResponseException');
} on DBusMethodResponseException catch (e) {
expect(e.response.errorName, equals('com.example.Error'));
expect(e.response.values, equals([DBusString('Count'), DBusUint32(42)]));
}

await client1.close();
await client2.close();
Expand Down