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.

Sign up for GitHub

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

Jump to bottom

feat(dart): add dio interceptors to client options #3054

Merged
merged 2 commits into from
May 17, 2024
Merged

feat(dart): add dio interceptors to client options #3054

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dd8edd2
feat(dart): add dio interceptors to client options
aallam Apr 29, 2024
80c8c79
Merge branch 'main' into feat/dio-interceptors
millotp May 17, 2024
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
17 changes: 14 additions & 3 deletions clients/algoliasearch-client-dart/packages/client_core/lib/src/config/client_options.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ import 'dart:core';
import 'package:algolia_client_core/src/config/agent_segment.dart';
import 'package:algolia_client_core/src/config/host.dart';
import 'package:algolia_client_core/src/transport/requester.dart';
import 'package:dio/dio.dart';

final class ClientOptions {
/// The list of hosts that the client can connect to.
Expand All @@ -29,6 +30,10 @@ final class ClientOptions {
/// Custom requester used to send HTTP requests.
final Requester? requester;

/// List of Dio interceptors.
/// Used only in case of using the default (dio) requester.
final Iterable<Interceptor>? interceptors;

/// Constructs a [ClientOptions] instance with the provided parameters.
const ClientOptions({
this.connectTimeout = const Duration(seconds: 2),
Expand All @@ -39,8 +44,10 @@ final class ClientOptions {
this.agentSegments,
this.requester,
this.logger,
this.interceptors
});


@override
bool operator ==(Object other) =>
identical(this, other) ||
Expand All @@ -52,7 +59,9 @@ final class ClientOptions {
readTimeout == other.readTimeout &&
headers == other.headers &&
agentSegments == other.agentSegments &&
requester == other.requester;
logger == other.logger &&
requester == other.requester &&
interceptors == other.interceptors;

@override
int get hashCode =>
Expand All @@ -62,10 +71,12 @@ final class ClientOptions {
readTimeout.hashCode ^
headers.hashCode ^
agentSegments.hashCode ^
requester.hashCode;
logger.hashCode ^
requester.hashCode ^
interceptors.hashCode;

@override
String toString() {
return 'ClientOptions{hosts: $hosts, connectTimeout: $connectTimeout, writeTimeout: $writeTimeout, readTimeout: $readTimeout, headers: $headers, agentSegments: $agentSegments, requester: $requester}';
return 'ClientOptions{hosts: $hosts, connectTimeout: $connectTimeout, writeTimeout: $writeTimeout, readTimeout: $readTimeout, headers: $headers, agentSegments: $agentSegments, logger: $logger, requester: $requester, interceptors: $interceptors}';
}
}
2 changes: 2 additions & 0 deletions ...s/algoliasearch-client-dart/packages/client_core/lib/src/transport/dio/dio_requester.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ class DioRequester implements Requester {
Duration? connectTimeout,
Iterable<AgentSegment>? clientSegments,
Function(Object?)? logger,
Iterable<Interceptor>? interceptors,
}) : _client = Dio(
BaseOptions(
headers: headers,
Expand All @@ -47,6 +48,7 @@ class DioRequester implements Requester {
responseBody: true,
logPrint: logger,
),
if (interceptors != null) ...interceptors,
]);

@override
Expand Down
1 change: 1 addition & 0 deletions clients/algoliasearch-client-dart/packages/client_core/lib/src/transport/retry_strategy.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ final class RetryStrategy {
connectTimeout: options.connectTimeout,
clientSegments: [segment, ...?options.agentSegments],
logger: options.logger,
interceptors: options.interceptors,
),
);

Expand Down
Loading