durbun_dio 0.3.0
durbun_dio: ^0.3.0 copied to clipboard
Dio adapter wrapper and interceptor for Dürbün: reports requests made through adapters that bypass dart:io (NativeAdapter, cronet_http) and applies the desktop's mocks.
durbun_dio #
What you get · Install · Start · What is captured · Mocks · Release builds and safety · Development
What you get #
Dio adapter wrapper and interceptor for adapters that bypass dart:io (NativeAdapter, cronet_http). It reports
requests to
Dürbün and applies the Mac app's mock rules: respond (resolved without a
network call), delay, and fail (connectionTimeout, connectionError, badCertificate or an unknown
DioException).
Connecting to the Mac, the in-app panel, options and troubleshooting are in
package:durbun.
Install #
flutter pub add durbun_dio
durbun_dio depends on durbun, so both end up in your pubspec.yaml:
dependencies:
durbun: ^0.3.0
durbun_dio: ^0.3.0
Start #
Wrap the adapter (recommended):
final dio = Dio()..httpClientAdapter = DurbunDioAdapter(NativeAdapter());
Start the SDK as usual (Durbun.run / Durbun.init, see package:durbun).
A complete example is in example/main.dart.
The interceptor from earlier versions still works:
final dio = Dio()..httpClientAdapter = NativeAdapter();
dio.interceptors.add(DurbunDioInterceptor(dio: dio)); // last
What is captured #
Network #
DurbunDioAdapter sits where the request leaves the app:
- Every request that reaches the network gets its own row, and every row ends: a retry after a token refresh
shows the first
401and the second request separately, whatever your interceptors do. - Request headers are the final ones, after every interceptor.
- The response body is the bytes the adapter delivered, and its size is the number of those bytes. The time runs until the last byte, before Dio decodes the JSON.
DurbunDioInterceptor only sees what reaches it. When an interceptor added before it answers an error itself
(for example a token refresh that calls handler.resolve(await dio.fetch(err.requestOptions))), the first row
ends when the request is sent again, with a note instead of the response; the body shown is Dio's decoded data
encoded again. Keeping the interceptor while you switch to the adapter is safe: it stays out of the way of a
DurbunDioAdapter.
- Dio's default adapter (
IOHttpClientAdapter) is already captured and mocked bypackage:durbun. Both the adapter wrapper and the interceptor (thanks to its requireddio:argument) then stay out of the way: no duplicate entries, anddelaymocks are not applied twice. - On iOS,
NativeAdapterandCupertinoAdapterrun on URLSession, which the plugin's native layer already captures, so Dürbün's Dio layer does not report those requests again. In--obfuscatebuilds, class names are minified and this cannot be told apart, so these requests may show up twice on iOS. - Interceptor only: add it last. A request is reported as the interceptors before it left it (headers, body). If you add it before the interceptor that sets your authorization header, for example, the report will not show that header.
- Bodies are kept only up to the body limit (
maxBodyBytes); large JSON responses are not re-encoded in full. - With
ResponseType.stream, a row ends when your code reads the stream to the end or stops reading it. - Server-Sent Events (
text/event-streamread withResponseType.stream): while the Mac app asks for WebSocket and event stream messages, the response shows as soon as its headers arrive and each event follows under the same row; a stream your code stops reading shows as cancelled. Otherwise the row ends with the body as above. Event streams through Dio's default adapter are captured bypackage:durbunitself.
Mocks #
Mock rules are applied by the adapter too: respond answers without a network call and Dio treats the status as
usual. Writing rules: Mock rules.
Release builds and safety #
Both follow package:durbun: while Dürbün is off in a build, the adapter wrapper and the interceptor pass every
request through untouched. Errors inside Dürbün's Dio layer never reach your requests.
Development #
Inside the Dürbün repository, pubspec_overrides.yaml points durbun at ../durbun, so
flutter pub get --offline, flutter analyze and flutter test --concurrency=2 work against the local SDK.