Skip to content
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.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 32 additions & 0 deletions lib/src/network_response.dart
Original file line number Diff line number Diff line change
Expand Up @@ -20,12 +20,18 @@ sealed class NetworkResponseSuccess<R> extends NetworkResponse<R> {

final class OkNoContent<R> extends NetworkResponseSuccess<R> {
const OkNoContent();

@override
String toString() => 'OkNoContent()';
}

final class OkResponse<T> extends NetworkResponseSuccess<T> {
final T response;

const OkResponse(this.response);

@override
String toString() => 'OkResponse(response: $response)';
}

sealed class NetworkResponseFailure<R> extends NetworkResponse<R> {
Expand All @@ -37,6 +43,9 @@ final class Unauthorized<R> extends NetworkResponseFailure<R> {
final DioException error;

const Unauthorized({required this.error});

@override
String toString() => 'Unauthorized(error: $error)';
}

/// 403 - for responses when the request was authenticated but the
Expand All @@ -45,6 +54,9 @@ final class Forbidden<R> extends NetworkResponseFailure<R> {
final DioException error;

const Forbidden({required this.error});

@override
String toString() => 'Forbidden(error: $error)';
}

/// 404 - for responses when we could not locate a resource, or when
Expand All @@ -53,6 +65,9 @@ final class NotFound<R> extends NetworkResponseFailure<R> {
final DioException error;

const NotFound({required this.error});

@override
String toString() => 'NotFound(error: $error)';
}

/// 422 - for responses when the request inputs failed our validations.
Expand All @@ -61,13 +76,20 @@ final class UnprocessableEntity<R> extends NetworkResponseFailure<R> {
final R response;

const UnprocessableEntity({required this.error, required this.response});

@override
String toString() =>
'UnprocessableEntity(error: $error, response: $response)';
}

/// 426 - for responses when a client version upgrade is required
final class UpgradeRequired<R> extends NetworkResponseFailure<R> {
final DioException error;

const UpgradeRequired({required this.error});

@override
String toString() => 'UpgradeRequired(error: $error)';
}

/// 500 - for responses where the service had an error while processing
Expand All @@ -76,6 +98,9 @@ final class ServerError<R> extends NetworkResponseFailure<R> {
final DioException error;

const ServerError({required this.error});

@override
String toString() => 'ServerError(error: $error)';
}

/// 503 - for responses when an underlying service issue prevents us from
Expand All @@ -84,6 +109,9 @@ final class ServiceUnavailable<R> extends NetworkResponseFailure<R> {
final DioException error;

const ServiceUnavailable({required this.error});

@override
String toString() => 'ServiceUnavailable(error: $error)';
}

/// Any "other" error not covered by the above cases. If a [DioException] is present,
Expand All @@ -99,6 +127,10 @@ final class GenericError<R> extends NetworkResponseFailure<R> {
final DioException? error;
final String message;
final bool isConnectionIssue;

@override
String toString() =>
'GenericError(error: $error, message: $message, isConnectionIssue: $isConnectionIssue)';
}

/// Extensions on the [NetworkResponse] type
Expand Down
125 changes: 125 additions & 0 deletions test/src/network_response_test.dart
Original file line number Diff line number Diff line change
@@ -0,0 +1,125 @@
import 'package:dio/dio.dart';
import 'package:sturdy_http/sturdy_http.dart';
import 'package:test/test.dart';

void main() {
group('NetworkResponse toString', () {
group('success types', () {
test('OkNoContent', () {
const response = OkNoContent<void>();

expect(response.toString(), 'OkNoContent()');
});

test('OkResponse', () {
const response = OkResponse<String>('success data');

expect(response.toString(), 'OkResponse(response: success data)');
});
});

group('failure types', () {
late DioException dioException;

setUp(() {
dioException = DioException(
requestOptions: RequestOptions(path: '/test'),
message: 'Test error message',
type: DioExceptionType.badResponse,
);
});

test('Unauthorized', () {
final response = Unauthorized<void>(error: dioException);

expect(
response.toString(),
'Unauthorized(error: DioException [bad response]: Test error message)',
);
});

test('Forbidden', () {
final response = Forbidden<void>(error: dioException);

expect(
response.toString(),
'Forbidden(error: DioException [bad response]: Test error message)',
);
});

test('NotFound', () {
final response = NotFound<void>(error: dioException);

expect(
response.toString(),
'NotFound(error: DioException [bad response]: Test error message)',
);
});

test('UnprocessableEntity', () {
final response = UnprocessableEntity<Map<String, dynamic>>(
error: dioException,
response: {'field': 'email', 'message': 'is invalid'},
);

expect(
response.toString(),
'UnprocessableEntity(error: DioException [bad response]: Test error message, response: {field: email, message: is invalid})',
);
});

test('UpgradeRequired', () {
final response = UpgradeRequired<void>(error: dioException);

expect(
response.toString(),
'UpgradeRequired(error: DioException [bad response]: Test error message)',
);
});

test('ServerError', () {
final response = ServerError<void>(error: dioException);

expect(
response.toString(),
'ServerError(error: DioException [bad response]: Test error message)',
);
});

test('ServiceUnavailable', () {
final response = ServiceUnavailable<void>(error: dioException);

expect(
response.toString(),
'ServiceUnavailable(error: DioException [bad response]: Test error message)',
);
});

test('GenericError', () {
final response = GenericError<void>(
error: dioException,
message: 'Something went wrong',
isConnectionIssue: false,
);

expect(
response.toString(),
'GenericError(error: DioException [bad response]: Test error message, message: Something went wrong, isConnectionIssue: false)',
);
});

test('GenericError with null error', () {
const response = GenericError<void>(
error: null,
message: 'Connection timeout',
isConnectionIssue: true,
);

expect(
response.toString(),
'GenericError(error: null, message: Connection timeout, isConnectionIssue: true)',
);
});
});
});
}