Run response mapper in isolate

ISOLATE_PERFORMANCE.md

@@ -0,0 +1,7 @@
+# Isolate parsing performance
+
+**Parsing in isolate took 2400-2500 microseconds.**
+
+**Parsing on main thread took 20-60 microseconds.**
+
+Parsing JSON on an isolate allows you to perform the operation in the background without blocking the main thread, which can be useful for large JSON files or when you need to perform other operations while parsing.

example/lib/api/application_api.dart

@@ -12,8 +12,8 @@ class ApplicationApi extends ApiClient {
           dio: dio,
         );
 
-  Future<UsersResponseModel> getUserList() => get(
-        path: 'users',
+  Future<UsersResponseModel> getUserList({int? page}) => get(
+        path: 'users${page != null ? '?page=$page' : ''}',
         responseMapper: response_mappers.users,
         validate: false,
         receiveTimeout: Duration(seconds: 30),
@@ -30,4 +30,12 @@ class ApplicationApi extends ApiClient {
       return Future.error(error!);
     });
   }
+
+  Future<void> getErrorRequest() => get(
+        path: 'users/23',
+        responseMapper: response_mappers.users,
+        validate: false,
+        receiveTimeout: Duration(seconds: 30),
+        sendTimeout: Duration(seconds: 30),
+      );
 }

example/lib/api/models/errors/error_response_model.dart

@@ -11,6 +11,7 @@ class ResponseErrorModel extends Error {
   factory ResponseErrorModel.fromJson(Map<String, dynamic> json) =>
       _$ResponseErrorModelFromJson(json);
 
+  @JsonKey(defaultValue: {})
   final Map<String, List<String>> errors;
 
   Map<String, dynamic> toJson() => _$ResponseErrorModelToJson(this);

example/lib/app.dart

@@ -46,6 +46,7 @@ class _MyHomePageState extends State<MyHomePage> {
   bool isLoading = false;
   StreamSubscription? subscription;
   List<UserResponseModel> users = [];
+  int currentPage = 1;
 
   @override
   void initState() {
@@ -61,9 +62,36 @@ class _MyHomePageState extends State<MyHomePage> {
       appBar: AppBar(
         title: Text(widget.title),
       ),
-      body: Container(
-        child: isLoading ? _getProgressWidget() : getUsersWidget(users),
-      ),
+      body: LayoutBuilder(builder: (context, constraints) {
+        return isLoading
+            ? _getProgressWidget()
+            : Column(
+                mainAxisSize: MainAxisSize.min,
+                children: [
+                  SizedBox(
+                    height: constraints.maxHeight * 0.8,
+                    child: getUsersWidget(users),
+                  ),
+                  Spacer(),
+                  MaterialButton(
+                    child: Text("Get next users"),
+                    padding: EdgeInsets.all(10),
+                    color: Colors.blueAccent,
+                    onPressed: () => _loadNextPage(),
+                    minWidth: constraints.maxWidth * 0.9,
+                  ),
+                  SizedBox(height: 8),
+                  MaterialButton(
+                    child: Text("Error request"),
+                    padding: EdgeInsets.all(10),
+                    color: Colors.red,
+                    onPressed: _loadErrorPage,
+                    minWidth: constraints.maxWidth * 0.9,
+                  ),
+                  Spacer(),
+                ],
+              );
+      }),
       floatingActionButton: FloatingActionButton(
         onPressed: _loadUserList,
         tooltip: 'Load a user list',
@@ -152,4 +180,34 @@ class _MyHomePageState extends State<MyHomePage> {
 
     setState(() => isLoading = false);
   }
+
+  Future<void> _loadNextPage() async {
+    await subscription?.cancel();
+
+    setState(() => isLoading = true);
+
+    try {
+      currentPage++;
+      final response = await widget.apiClient.getUserList(page: currentPage);
+      users.addAll(response.data);
+    } catch (e) {
+      showErrorDialog();
+    }
+
+    setState(() => isLoading = false);
+  }
+
+  Future<void> _loadErrorPage() async {
+    await subscription?.cancel();
+
+    setState(() => isLoading = true);
+
+    try {
+      await widget.apiClient.getErrorRequest();
+    } catch (e) {
+      showErrorDialog();
+    }
+
+    setState(() => isLoading = false);
+  }
 }

example/pubspec.lock

@@ -191,7 +191,7 @@ packages:
       path: ".."
       relative: true
     source: path
-    version: "3.5.2"
+    version: "3.6.0"
   dio:
     dependency: transitive
     description:

lib/src/api_client.dart

@@ -1,10 +1,11 @@
-import 'dart:async';
 import 'dart:io';
 
 import 'package:dash_kit_network/src/error_handler_delegate.dart';
 import 'package:dash_kit_network/src/exceptions/network_connection_exception.dart';
 import 'package:dash_kit_network/src/exceptions/refresh_tokens_delegate_missing_exception.dart';
 import 'package:dash_kit_network/src/exceptions/request_error_exception.dart';
+import 'package:dash_kit_network/src/isolate_manager/isolate_manager_io.dart'
+    if (dart.library.html) 'package:dash_kit_network/src/isolate_manager/isolate_manager_web.dart';
 import 'package:dash_kit_network/src/models/api_environment.dart';
 import 'package:dash_kit_network/src/models/http_header.dart';
 import 'package:dash_kit_network/src/models/request_params.dart';
@@ -14,7 +15,7 @@ import 'package:dash_kit_network/src/refresh_tokens_delegate.dart';
 import 'package:dash_kit_network/src/token_manager.dart';
 import 'package:dio/dio.dart';
 
-/// Componet for communication with an API. Includes functionality
+/// Component for communication with an API. Includes functionality
 /// for updating tokens if they expired.
 // ignore_for_file: long-parameter-list
 abstract class ApiClient {
@@ -39,6 +40,7 @@ abstract class ApiClient {
     dio.options.baseUrl = environment.baseUrl;
   }
 
+  final isolateManager = IsolateManager()..start();
   final ApiEnvironment environment;
   final Dio dio;
   final List<HttpHeader> commonHeaders;
@@ -227,7 +229,7 @@ abstract class ApiClient {
     final performRequest = (tokenPair) async {
       final response = await _createRequest(params, tokenPair);
 
-      return params.responseMapper.call(response);
+      return await isolateManager.send(response, params.responseMapper);
     };
 
     if (params.isAuthorisedRequest) {

lib/src/isolate_manager/isolate_manager.dart

@@ -0,0 +1,56 @@
+import 'dart:async';
+
+import 'package:dash_kit_network/dash_kit_network.dart';
+
+// ignore: prefer-match-file-name
+abstract class IsolateManagerInterface {
+  Future<void> start();
+
+  void stop();
+
+  Future<FutureOr<T>> send<T>(
+    Response<dynamic> response,
+    FutureOr<T> Function(Response<dynamic>) mapper,
+  );
+}
+
+class Task<T> {
+  const Task(
+    this.id,
+    this.response,
+    this.mapper,
+  );
+
+  final String id;
+  final Response<dynamic> response;
+  final T Function(Response<dynamic>) mapper;
+
+  @override
+  String toString() {
+    return 'Task{id: $id, response: $response, mapper: $mapper}';
+  }
+}
+
+class Result<T> {
+  const Result({
+    required this.id,
+    this.result,
+    this.error,
+  });
+
+  final String id;
+  final T? result;
+  final dynamic error;
+
+  @override
+  String toString() {
+    return 'Result{id: $id, result: $result, error: $error}';
+  }
+}
+
+enum IsolateStatus {
+  created,
+  initializing,
+  initialized,
+  stopped,
+}