Skip to content

feat: Implement REST API retry mechanism #1102

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

Open
kirkmorrow wants to merge 10 commits into
base: master
Choose a base branch
from
Open

feat: Implement REST API retry mechanism #1102

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
22fde31
Implement REST API retry mechanism
kirkmorrow Dec 6, 2025
bb98ddd
Update packages/dart/lib/src/network/parse_network_retry.dart
kirkmorrow Dec 6, 2025
5096a9e
PR feedback fixes
kirkmorrow Dec 6, 2025
26d407d
PR feedback
kirkmorrow Dec 6, 2025
aab707e
CodeRabbitAI nitpicks
kirkmorrow Dec 6, 2025
71e71ed
Change default to no retry for write operations
kirkmorrow Dec 7, 2025
8135d14
Update packages/dart/lib/src/network/parse_dio_client.dart
kirkmorrow Dec 7, 2025
7e8623d
Add parameters to comments for initialize
kirkmorrow Dec 7, 2025
a7271bb
Nitpick comment fix
kirkmorrow Dec 7, 2025
6b1ecb4
Update packages/dart/lib/src/network/parse_network_retry.dart
kirkmorrow Dec 7, 2025
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
3 changes: 3 additions & 0 deletions packages/dart/lib/parse_server_sdk.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ part 'src/network/options.dart';
part 'src/network/parse_client.dart';
part 'src/network/parse_connectivity.dart';
part 'src/network/parse_live_query.dart';
part 'src/network/parse_network_retry.dart';
part 'src/network/parse_query.dart';
part 'src/objects/parse_acl.dart';
part 'src/objects/parse_array.dart';
Expand Down Expand Up @@ -118,6 +119,7 @@ class Parse {
Map<String, ParseObjectConstructor>? registeredSubClassMap,
ParseUserConstructor? parseUserConstructor,
ParseFileConstructor? parseFileConstructor,
List<int>? restRetryIntervals,
List<int>? liveListRetryIntervals,
ParseConnectivityProvider? connectivityProvider,
String? fileDirectory,
Expand All @@ -144,6 +146,7 @@ class Parse {
registeredSubClassMap: registeredSubClassMap,
parseUserConstructor: parseUserConstructor,
parseFileConstructor: parseFileConstructor,
restRetryIntervals: restRetryIntervals,
liveListRetryIntervals: liveListRetryIntervals,
connectivityProvider: connectivityProvider,
fileDirectory: fileDirectory,
Expand Down
4 changes: 4 additions & 0 deletions packages/dart/lib/src/data/parse_core_data.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ class ParseCoreData {
Map<String, ParseObjectConstructor>? registeredSubClassMap,
ParseUserConstructor? parseUserConstructor,
ParseFileConstructor? parseFileConstructor,
List<int>? restRetryIntervals,
List<int>? liveListRetryIntervals,
ParseConnectivityProvider? connectivityProvider,
String? fileDirectory,
Expand All @@ -52,6 +53,8 @@ class ParseCoreData {
_instance.sessionId = sessionId;
_instance.autoSendSessionId = autoSendSessionId;
_instance.securityContext = securityContext;
_instance.restRetryIntervals =
restRetryIntervals ?? <int>[0, 250, 500, 1000, 2000];
_instance.liveListRetryIntervals =
liveListRetryIntervals ??
(parseIsWeb
Expand Down Expand Up @@ -89,6 +92,7 @@ class ParseCoreData {
late bool debug;
late CoreStore storage;
late ParseSubClassHandler _subClassHandler;
late List<int> restRetryIntervals;
late List<int> liveListRetryIntervals;
ParseConnectivityProvider? connectivityProvider;
String? fileDirectory;
Expand Down
284 changes: 168 additions & 116 deletions packages/dart/lib/src/network/parse_dio_client.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,24 @@
import 'dart:convert';

import 'package:dio/dio.dart' as dio;
import 'package:parse_server_sdk/parse_server_sdk.dart';

import 'dio_adapter_io.dart' if (dart.library.js) 'dio_adapter_js.dart';

/// HTTP client implementation for Parse Server using the Dio package.
///
/// Coverage Note:
///
/// This file typically shows low test coverage (4-5%) in LCOV reports because:
/// - Integration tests use MockParseClient which bypasses actual HTTP operations
/// - The retry logic (tested at 100% in parse_network_retry_test.dart) wraps
/// these HTTP methods but isn't exercised when using mocks
/// - This is architecturally correct: retry operates at the HTTP layer,
/// while mocks operate at the ParseClient interface layer above it
///
/// The core retry mechanism has 100% coverage in its dedicated unit tests.
/// This file's primary responsibility is thin wrapper code around executeWithRetry().

class ParseDioClient extends ParseClient {
// securityContext is SecurityContext
ParseDioClient({bool sendSessionId = false, dynamic securityContext}) {
Expand All @@ -22,22 +38,26 @@ class ParseDioClient extends ParseClient {
ParseNetworkOptions? options,
ProgressCallback? onReceiveProgress,
}) async {
try {
final dio.Response<String> dioResponse = await _client.get<String>(
path,
options: _Options(headers: options?.headers),
);
return executeWithRetry(
operation: () async {
try {
final dio.Response<String> dioResponse = await _client.get<String>(
path,
options: _Options(headers: options?.headers),
);

return ParseNetworkResponse(
data: dioResponse.data!,
statusCode: dioResponse.statusCode!,
);
} on dio.DioException catch (error) {
return ParseNetworkResponse(
data: error.response?.data ?? _fallbackErrorData,
statusCode: error.response?.statusCode ?? ParseError.otherCause,
);
}
return ParseNetworkResponse(
data: dioResponse.data!,
statusCode: dioResponse.statusCode!,
);
} on dio.DioException catch (error) {
return ParseNetworkResponse(
data: error.response?.data ?? _fallbackErrorData,
statusCode: error.response?.statusCode ?? ParseError.otherCause,
);
}
},
);
}

@override
Expand All @@ -47,34 +67,38 @@ class ParseDioClient extends ParseClient {
ProgressCallback? onReceiveProgress,
dynamic cancelToken,
}) async {
try {
final dio.Response<List<int>> dioResponse = await _client.get<List<int>>(
path,
cancelToken: cancelToken,
onReceiveProgress: onReceiveProgress,
options: _Options(
headers: options?.headers,
responseType: dio.ResponseType.bytes,
),
);
return ParseNetworkByteResponse(
bytes: dioResponse.data,
statusCode: dioResponse.statusCode!,
);
} on dio.DioException catch (error) {
if (error.response != null) {
return ParseNetworkByteResponse(
data: error.response?.data ?? _fallbackErrorData,
statusCode: error.response?.statusCode ?? ParseError.otherCause,
);
} else {
return ParseNetworkByteResponse(
data:
"{\"code\":${ParseError.otherCause},\"error\":\"${error.error.toString()}\"}",
statusCode: ParseError.otherCause,
);
}
}
return executeWithRetry(
operation: () async {
try {
final dio.Response<List<int>> dioResponse = await _client
.get<List<int>>(
path,
cancelToken: cancelToken,
onReceiveProgress: onReceiveProgress,
options: _Options(
headers: options?.headers,
responseType: dio.ResponseType.bytes,
),
);
return ParseNetworkByteResponse(
bytes: dioResponse.data,
statusCode: dioResponse.statusCode!,
);
} on dio.DioException catch (error) {
if (error.response != null) {
return ParseNetworkByteResponse(
data: error.response?.data ?? _fallbackErrorData,
statusCode: error.response?.statusCode ?? ParseError.otherCause,
);
} else {
return ParseNetworkByteResponse(
data: _buildErrorJson(error.error.toString()),
statusCode: ParseError.otherCause,
);
}
}
},
);
}

@override
Expand All @@ -83,23 +107,27 @@ class ParseDioClient extends ParseClient {
String? data,
ParseNetworkOptions? options,
}) async {
try {
final dio.Response<String> dioResponse = await _client.put<String>(
path,
data: data,
options: _Options(headers: options?.headers),
);
return executeWithRetry(
operation: () async {
try {
final dio.Response<String> dioResponse = await _client.put<String>(
path,
data: data,
options: _Options(headers: options?.headers),
);

return ParseNetworkResponse(
data: dioResponse.data!,
statusCode: dioResponse.statusCode!,
);
} on dio.DioException catch (error) {
return ParseNetworkResponse(
data: error.response?.data ?? _fallbackErrorData,
statusCode: error.response?.statusCode ?? ParseError.otherCause,
);
}
return ParseNetworkResponse(
data: dioResponse.data!,
statusCode: dioResponse.statusCode!,
);
} on dio.DioException catch (error) {
return ParseNetworkResponse(
data: error.response?.data ?? _fallbackErrorData,
statusCode: error.response?.statusCode ?? ParseError.otherCause,
);
}
},
);
}

@override
Expand All @@ -108,23 +136,27 @@ class ParseDioClient extends ParseClient {
String? data,
ParseNetworkOptions? options,
}) async {
try {
final dio.Response<String> dioResponse = await _client.post<String>(
path,
data: data,
options: _Options(headers: options?.headers),
);
return executeWithRetry(
operation: () async {
try {
final dio.Response<String> dioResponse = await _client.post<String>(
path,
data: data,
options: _Options(headers: options?.headers),
);

return ParseNetworkResponse(
data: dioResponse.data!,
statusCode: dioResponse.statusCode!,
);
} on dio.DioException catch (error) {
return ParseNetworkResponse(
data: error.response?.data ?? _fallbackErrorData,
statusCode: error.response?.statusCode ?? ParseError.otherCause,
);
}
return ParseNetworkResponse(
data: dioResponse.data!,
statusCode: dioResponse.statusCode!,
);
} on dio.DioException catch (error) {
return ParseNetworkResponse(
data: error.response?.data ?? _fallbackErrorData,
statusCode: error.response?.statusCode ?? ParseError.otherCause,
);
}
},
);
}

@override
Expand All @@ -135,64 +167,84 @@ class ParseDioClient extends ParseClient {
ProgressCallback? onSendProgress,
dynamic cancelToken,
}) async {
try {
final dio.Response<String> dioResponse = await _client.post<String>(
path,
data: data,
cancelToken: cancelToken,
options: _Options(headers: options?.headers),
onSendProgress: onSendProgress,
);
return executeWithRetry(
operation: () async {
try {
final dio.Response<String> dioResponse = await _client.post<String>(
path,
data: data,
cancelToken: cancelToken,
options: _Options(headers: options?.headers),
onSendProgress: onSendProgress,
);

return ParseNetworkResponse(
data: dioResponse.data!,
statusCode: dioResponse.statusCode!,
);
} on dio.DioException catch (error) {
if (error.response != null) {
return ParseNetworkResponse(
data: error.response?.data ?? _fallbackErrorData,
statusCode: error.response?.statusCode ?? ParseError.otherCause,
);
} else {
return _getOtherCaseErrorForParseNetworkResponse(
error.error.toString(),
);
}
}
return ParseNetworkResponse(
data: dioResponse.data!,
statusCode: dioResponse.statusCode!,
);
} on dio.DioException catch (error) {
if (error.response != null) {
return ParseNetworkResponse(
data: error.response?.data ?? _fallbackErrorData,
statusCode: error.response?.statusCode ?? ParseError.otherCause,
);
} else {
return _getOtherCaseErrorForParseNetworkResponse(
error.error.toString(),
);
}
}
},
);
}

ParseNetworkResponse _getOtherCaseErrorForParseNetworkResponse(String error) {
return ParseNetworkResponse(
data: "{\"code\":${ParseError.otherCause},\"error\":\"$error\"}",
data: _buildErrorJson(error),
statusCode: ParseError.otherCause,
);
}

/// Builds a properly escaped JSON error payload.
///
/// This helper ensures error messages are safely escaped to prevent
/// malformed JSON when the message contains quotes or special characters.
String _buildErrorJson(String errorMessage) {
final Map<String, dynamic> errorPayload = <String, dynamic>{
'code': ParseError.otherCause,
'error': errorMessage,
};
return jsonEncode(errorPayload);
}

@override
Future<ParseNetworkResponse> delete(
String path, {
ParseNetworkOptions? options,
}) async {
try {
final dio.Response<String> dioResponse = await _client.delete<String>(
path,
options: _Options(headers: options?.headers),
);
return executeWithRetry(
operation: () async {
try {
final dio.Response<String> dioResponse = await _client.delete<String>(
path,
options: _Options(headers: options?.headers),
);

return ParseNetworkResponse(
data: dioResponse.data!,
statusCode: dioResponse.statusCode!,
);
} on dio.DioException catch (error) {
return ParseNetworkResponse(
data: error.response?.data ?? _fallbackErrorData,
statusCode: error.response?.statusCode ?? ParseError.otherCause,
);
}
return ParseNetworkResponse(
data: dioResponse.data!,
statusCode: dioResponse.statusCode!,
);
} on dio.DioException catch (error) {
return ParseNetworkResponse(
data: error.response?.data ?? _fallbackErrorData,
statusCode: error.response?.statusCode ?? ParseError.otherCause,
);
}
},
);
}

String get _fallbackErrorData => '{"$keyError":"NetworkError"}';
String get _fallbackErrorData => _buildErrorJson('NetworkError');
}

/// Creates a custom version of HTTP Client that has Parse Data Preset
Expand Down
Loading