feat: add dio extension for flexible interseptor setup and update dio and mutex packages

CHANGELOG.md

@@ -6,6 +6,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.3.0] - 2023-11-13
+
+- Added Dio extension for interceptor setup
+- Updated the mutex package to version ^3.1.0
+
+### Breaking Changes
+
+- Updated the dio package to version ^5.0.0
+
 ## [0.2.8] - 2023-09-13
 
 - Adds 1.18 to the list of supported FDI versions

README.md

@@ -86,6 +86,17 @@ void setup() {
 }
 ```
 
+Or use instance method instead.
+
+```dart
+import 'package:supertokens_flutter/dio.dart';
+
+void setup() {
+  Dio dio = Dio();  // Create a Dio instance.
+  dio.addSupertokensInterceptor();
+}
+```
+
 #### Making network requests
 
 ```dart

lib/dio.dart

@@ -1 +1,2 @@
 export 'src/dio-interceptor-wrapper.dart' show SuperTokensInterceptorWrapper;
+export 'src/supertokens_dio_extension.dart' show SuperTokensDioExtension;

lib/src/dio-interceptor-wrapper.dart

@@ -23,9 +23,9 @@ class SuperTokensInterceptorWrapper extends Interceptor {
   void onRequest(
       RequestOptions options, RequestInterceptorHandler handler) async {
     if (!SuperTokens.isInitCalled) {
-      handler.reject(DioError(
+      handler.reject(DioException(
         requestOptions: options,
-        type: DioErrorType.other,
+        type: DioExceptionType.unknown,
         error: SuperTokensException(
             "SuperTokens.init must be called before using Client"),
       ));
@@ -52,7 +52,7 @@ class SuperTokensInterceptorWrapper extends Interceptor {
     }
 
     SuperTokensTokenTransferMethod tokenTransferMethod =
-        SuperTokens.config.tokenTransferMethod!;
+        SuperTokens.config.tokenTransferMethod;
     options.headers["st-auth-mode"] = tokenTransferMethod.getValue();
 
     options = await _setAuthorizationHeaderIfRequired(options);
@@ -131,10 +131,10 @@ class SuperTokensInterceptorWrapper extends Interceptor {
         } else {
           if (shouldRetry.exception != null) {
             handler.reject(
-              DioError(
+              DioException(
                   requestOptions: response.requestOptions,
                   error: SuperTokensException(shouldRetry.exception!.message),
-                  type: DioErrorType.other),
+                  type: DioExceptionType.unknown),
             );
             return;
           } else {
@@ -146,13 +146,13 @@ class SuperTokensInterceptorWrapper extends Interceptor {
         _refreshAPILock.release();
         return handler.next(response);
       }
-    } on DioError catch (e) {
+    } on DioException catch (e) {
       handler.reject(e);
     } catch (e) {
       handler.reject(
-        DioError(
+        DioException(
             requestOptions: response.requestOptions,
-            type: DioErrorType.other,
+            type: DioExceptionType.unknown,
             error: e),
       );
     } finally {

lib/src/supertokens_dio_extension.dart

@@ -0,0 +1,20 @@
+import 'package:dio/dio.dart';
+import 'package:supertokens_flutter/src/dio-interceptor-wrapper.dart';
+
+/// Dio extension for flexible Dio instance setup.
+///
+/// Usage:
+/// ```dart
+/// import "package:supertokens_flutter/dio.dart";
+///
+/// final dio = Dio()
+///   ..addSupertokensInterceptor()
+///   ..addSentry()
+///   // ...
+/// ```
+extension SuperTokensDioExtension on Dio {
+  /// Adds the SuperTokens interceptor to the Dio instance.
+  void addSupertokensInterceptor() {
+    interceptors.add(SuperTokensInterceptorWrapper(client: this));
+  }
+}

lib/src/version.dart

@@ -1,4 +1,4 @@
 class Version {
   static List<String> supported_fdi = ["1.16", "1.17", "1.18"];
-  static String sdkVersion = "0.2.8";
+  static String sdkVersion = "0.3.0";
 }

lib/supertokens.dart

@@ -5,4 +5,4 @@
 library supertokens;
 
 export "src/supertokens.dart";
-export "src/errors.dart";
+export "src/errors.dart";

pubspec.lock

@@ -93,18 +93,18 @@ packages:
     dependency: "direct main"
     description:
       name: dio
-      sha256: "7d328c4d898a61efc3cd93655a0955858e29a0aa647f0f9e02d59b3bb275e2e8"
+      sha256: "417e2a6f9d83ab396ec38ff4ea5da6c254da71e4db765ad737a42af6930140b7"
       url: "https://pub.dev"
     source: hosted
-    version: "4.0.6"
+    version: "5.3.3"
   dio_http_formatter:
     dependency: "direct dev"
     description:
       name: dio_http_formatter
-      sha256: b2ce51f686e0b2739a10698cf8d518b0780f0e54fa3b23321782064694081259
+      sha256: "3ac0f427cbe1ac9dfaf14231bf2cccdc49c9015e67b786bde6bd9bacd148218d"
       url: "https://pub.dev"
     source: hosted
-    version: "2.1.1"
+    version: "3.2.1"
   fake_async:
     dependency: transitive
     description:
@@ -204,10 +204,10 @@ packages:
     dependency: transitive
     description:
       name: logger
-      sha256: "7ad7215c15420a102ec687bb320a7312afd449bac63bfb1c60d9787c27b9767f"
+      sha256: "6bbb9d6f7056729537a4309bda2e74e18e5d9f14302489cc1e93f33b3fe32cac"
       url: "https://pub.dev"
     source: hosted
-    version: "1.4.0"
+    version: "2.0.2+1"
   logging:
     dependency: transitive
     description:
@@ -252,10 +252,10 @@ packages:
     dependency: "direct main"
     description:
       name: mutex
-      sha256: "03116a4e46282a671b46c12de649d72c0ed18188ffe12a8d0fc63e83f4ad88f4"
+      sha256: "8827da25de792088eb33e572115a5eb0d61d61a3c01acbc8bcbe76ed78f1a1f2"
       url: "https://pub.dev"
     source: hosted
-    version: "3.0.1"
+    version: "3.1.0"
   node_preamble:
     dependency: transitive
     description:

pubspec.yaml

@@ -1,6 +1,6 @@
 name: supertokens_flutter
 description: SuperTokens SDK for Flutter apps
-version: 0.2.8
+version: 0.3.0
 homepage: https://supertokens.com/
 repository: https://github.com/supertokens/supertokens-flutter
 issue_tracker: https://github.com/supertokens/supertokens-flutter/issues
@@ -18,18 +18,17 @@ dependencies:
     sdk: flutter
   http: "<1.2.0"
   shared_preferences: ">=2.0.0 <3.0.0"
-  mutex: ^3.0.0
-  dio: ^4.0.0
+  mutex: ^3.1.0
+  dio: ^5.0.0
 
 dev_dependencies:
   flutter_test:
     sdk: flutter
   test: ^1.21.4
-  dio_http_formatter: ^2.1.0
+  dio_http_formatter: ^3.2.1
 
 # For information on the generic Dart part of this file, see the
 # following page: https://dart.dev/tools/pub/pubspec
 
 # The following section is specific to Flutter.
 flutter:
-

test/accesstoken_dio_test.dart

@@ -1,5 +1,4 @@
 import 'package:dio/dio.dart';
-import 'package:dio_http_formatter/dio_http_formatter.dart';
 import 'package:flutter_test/flutter_test.dart';
 import 'package:shared_preferences/shared_preferences.dart';
 import 'package:supertokens_flutter/src/dio-interceptor-wrapper.dart';
@@ -28,8 +27,8 @@ void main() {
     Dio dio = Dio(
       BaseOptions(
         baseUrl: apiBasePath,
-        connectTimeout: 5000,
-        receiveTimeout: 500,
+        connectTimeout: Duration(seconds: 5),
+        receiveTimeout: Duration(milliseconds: 500),
       ),
     );
     dio.interceptors.add(SuperTokensInterceptorWrapper(client: dio));

test/accesstoken_http_test.dart

@@ -1,12 +1,7 @@
-import 'dart:convert';
-import 'dart:ffi';
 import 'package:flutter_test/flutter_test.dart';
 import 'package:http/http.dart';
 import 'package:shared_preferences/shared_preferences.dart';
 import 'package:supertokens_flutter/http.dart' as http;
-import 'package:supertokens_flutter/src/anti-csrf.dart';
-import 'package:supertokens_flutter/src/front-token.dart';
-import 'package:supertokens_flutter/src/utilities.dart';
 import 'package:supertokens_flutter/supertokens.dart';
 
 import 'test-utils.dart';

test/concurrency_dio_tests.dart

@@ -30,8 +30,8 @@ void main() {
     Dio dio = Dio(
       BaseOptions(
         baseUrl: apiBasePath,
-        connectTimeout: 5000,
-        receiveTimeout: 500,
+        connectTimeout: Duration(seconds: 5),
+        receiveTimeout: Duration(milliseconds: 500),
       ),
     );
     dio.interceptors.add(SuperTokensInterceptorWrapper(client: dio));

test/dioInterceptor_test.dart

@@ -29,8 +29,8 @@ void main() {
     Dio dio = Dio(
       BaseOptions(
         baseUrl: apiBasePath,
-        connectTimeout: 5000,
-        receiveTimeout: 500,
+        connectTimeout: Duration(seconds: 5),
+        receiveTimeout: Duration(milliseconds: 500),
       ),
     );
     dio.interceptors.add(SuperTokensInterceptorWrapper(client: dio));
@@ -403,8 +403,8 @@ void main() {
     Dio dio = Dio(
       BaseOptions(
         baseUrl: apiBasePath,
-        connectTimeout: 5000,
-        receiveTimeout: 500,
+        connectTimeout: Duration(seconds: 5),
+        receiveTimeout: Duration(milliseconds: 500),
       ),
     );
     dio.interceptors.add(SuperTokensInterceptorWrapper(client: dio));
@@ -421,8 +421,8 @@ void main() {
     Dio dio = Dio(
       BaseOptions(
         baseUrl: apiBasePath,
-        connectTimeout: 5000,
-        receiveTimeout: 500,
+        connectTimeout: Duration(seconds: 5),
+        receiveTimeout: Duration(milliseconds: 500),
       ),
     );
     dio.interceptors.add(HttpFormatter());