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

fix: 941 - respect rate-limits during integration tests #943

Merged
merged 4 commits into from
Jul 7, 2024
Merged

fix: 941 - respect rate-limits during integration tests #943

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
655a321
fix: 941 - respect rate-limits during integration tests
monsieurtanuki Jun 24, 2024
c752d51
Merge branch 'master' into fix/941
monsieurtanuki Jun 24, 2024
78ef094
Merge branch 'master' into fix/941
monsieurtanuki Jul 2, 2024
c5d58e6
Merge branch 'master' into fix/941
monsieurtanuki Jul 7, 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
2 changes: 2 additions & 0 deletions lib/openfoodfacts.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -145,6 +145,8 @@ export 'src/utils/server_type.dart';
export 'src/utils/suggestion_manager.dart';
export 'src/utils/tag_type.dart';
export 'src/utils/tag_type_autocompleter.dart';
export 'src/utils/too_many_requests_exception.dart';
export 'src/utils/too_many_requests_manager.dart';
export 'src/utils/unit_helper.dart';
export 'src/utils/uri_helper.dart';
export 'src/utils/uri_reader.dart';
Expand Down
3 changes: 3 additions & 0 deletions lib/src/open_food_api_client.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@ import 'utils/product_query_configurations.dart';
import 'utils/product_search_query_configuration.dart';
import 'utils/tag_type.dart';
import 'utils/taxonomy_query_configuration.dart';
import 'utils/too_many_requests_exception.dart';
import 'utils/uri_helper.dart';

/// Client calls of the Open Food Facts API
Expand Down Expand Up @@ -356,6 +357,7 @@ class OpenFoodAPIClient {
final UriProductHelper uriHelper = uriHelperFoodProd,
}) async {
final Response response = await configuration.getResponse(user, uriHelper);
TooManyRequestsException.check(response);
return response.body;
}

Expand Down Expand Up @@ -519,6 +521,7 @@ class OpenFoodAPIClient {
final UriProductHelper uriHelper = uriHelperFoodProd,
}) async {
final Response response = await configuration.getResponse(user, uriHelper);
TooManyRequestsException.check(response);
final String jsonStr = _replaceQuotes(response.body);
final SearchResult result = SearchResult.fromJson(
HttpHelper().jsonDecode(jsonStr),
Expand Down
1 change: 1 addition & 0 deletions lib/src/prices/get_locations_order.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ import 'order_by.dart';

/// Field for the "order by" clause of "get locations".
enum GetLocationsOrderField implements OrderByField {
priceCount(offTag: 'price_count'),
created(offTag: 'created'),
updated(offTag: 'updated');

Expand Down
1 change: 1 addition & 0 deletions lib/src/prices/get_proofs_order.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ import 'order_by.dart';

/// Field for the "order by" clause of "get proofs".
enum GetProofsOrderField implements OrderByField {
priceCount(offTag: 'price_count'),
created(offTag: 'created');

const GetProofsOrderField({required this.offTag});
Expand Down
19 changes: 19 additions & 0 deletions lib/src/utils/too_many_requests_exception.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
import 'package:http/http.dart';

/// Exception when the server returns "Too many requests".
class TooManyRequestsException implements Exception {
const TooManyRequestsException();

/// Start of the response body when the server received too many requests.
static const String _tooManyRequestsError =
'<!DOCTYPE html><html><head><meta name="robots" content="noindex"></head><body><h1>TOO MANY REQUESTS</h1>';

static void check(final Response response) {
if (response.body.startsWith(_tooManyRequestsError)) {
throw TooManyRequestsException();
}
}

@override
String toString() => 'Too many requests';
}
46 changes: 46 additions & 0 deletions lib/src/utils/too_many_requests_manager.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
/// Manager dedicated to "too many requests" server response.
///
/// Typically, the server may limit the number of requests to a [maxCount]
/// during a specific [duration].
class TooManyRequestsManager {
TooManyRequestsManager({
required this.maxCount,
required this.duration,
});

final int maxCount;
final Duration duration;

final List<int> _requestTimestamps = <int>[];

/// Waits the needed duration in order to avoid "too many requests" error.
Future<void> waitIfNeeded() async {
while (_requestTimestamps.length >= maxCount) {
final int previousInMillis = _requestTimestamps.first;
final int nowInMillis = DateTime.now().millisecondsSinceEpoch;
final int waitingInMillis =
duration.inMilliseconds - nowInMillis + previousInMillis;
if (waitingInMillis > 0) {
await Future.delayed(Duration(milliseconds: waitingInMillis));
}
_requestTimestamps.removeAt(0);
}
final DateTime now = DateTime.now();
final int nowInMillis = now.millisecondsSinceEpoch;
_requestTimestamps.add(nowInMillis);
}
}

/// [TooManyRequestsManager] dedicated to "searchProducts" queries in PROD.
final TooManyRequestsManager searchProductsTooManyRequestsManager =
TooManyRequestsManager(
maxCount: 10,
duration: Duration(minutes: 1),
);

/// [TooManyRequestsManager] dedicated to "getProduct" queries in PROD.
final TooManyRequestsManager getProductTooManyRequestsManager =
TooManyRequestsManager(
maxCount: 100,
duration: Duration(minutes: 1),
);
22 changes: 14 additions & 8 deletions test/api_get_localized_product_test.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,13 @@ void main() {
OpenFoodAPIConfiguration.userAgent = TestConstants.TEST_USER_AGENT;
OpenFoodAPIConfiguration.globalUser = TestConstants.PROD_USER;

Future<ProductResultV3> getProductV3InProd(
ProductQueryConfiguration configuration,
) async {
await getProductTooManyRequestsManager.waitIfNeeded();
return OpenFoodAPIClient.getProductV3(configuration);
}

group('$OpenFoodAPIClient get localized product fields', () {
test('get packaging text in languages (Coca-Cola)', () async {
const String barcode = '5449000000996';
Expand All @@ -22,7 +29,7 @@ void main() {
fields: [ProductField.PACKAGING_TEXT_IN_LANGUAGES],
version: ProductQueryVersion.v3,
);
final ProductResultV3 result = await OpenFoodAPIClient.getProductV3(
final ProductResultV3 result = await getProductV3InProd(
configurations,
);
expect(result.status, ProductResultV3.statusSuccess);
Expand All @@ -42,8 +49,7 @@ void main() {
OpenFoodFactsLanguage.FRENCH,
];

final ProductResultV3 productResult =
await OpenFoodAPIClient.getProductV3(
final ProductResultV3 productResult = await getProductV3InProd(
ProductQueryConfiguration(
BARCODE_DANISH_BUTTER_COOKIES,
languages: languages,
Expand Down Expand Up @@ -107,7 +113,7 @@ void main() {
],
version: ProductQueryVersion.v3,
);
final ProductResultV3 result = await OpenFoodAPIClient.getProductV3(
final ProductResultV3 result = await getProductV3InProd(
configurations,
);
expect(result.status, ProductResultV3.statusSuccess);
Expand Down Expand Up @@ -265,7 +271,7 @@ void main() {
],
version: ProductQueryVersion.v3,
);
final ProductResultV3 result = await OpenFoodAPIClient.getProductV3(
final ProductResultV3 result = await getProductV3InProd(
configurations,
);
expect(result.status, ProductResultV3.statusSuccess);
Expand Down Expand Up @@ -325,7 +331,7 @@ void main() {
],
version: ProductQueryVersion.v3,
);
final ProductResultV3 result = await OpenFoodAPIClient.getProductV3(
final ProductResultV3 result = await getProductV3InProd(
configurations,
);
expect(result.status, ProductResultV3.statusSuccess);
Expand Down Expand Up @@ -396,7 +402,7 @@ void main() {
],
version: ProductQueryVersion.v3,
);
final ProductResultV3 result = await OpenFoodAPIClient.getProductV3(
final ProductResultV3 result = await getProductV3InProd(
configurations,
);
expect(result.status, ProductResultV3.statusSuccess);
Expand Down Expand Up @@ -447,7 +453,7 @@ void main() {
],
version: ProductQueryVersion.v3,
);
final ProductResultV3 result = await OpenFoodAPIClient.getProductV3(
final ProductResultV3 result = await getProductV3InProd(
configurations,
);
expect(result.status, ProductResultV3.statusSuccess);
Expand Down
1 change: 1 addition & 0 deletions test/api_get_product_image_ids_test.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ void main() {

test('get product images (all, main and raw)', () async {
const String barcode = '3019081238643';
await getProductTooManyRequestsManager.waitIfNeeded();
final ProductResultV3 result = await OpenFoodAPIClient.getProductV3(
ProductQueryConfiguration(
barcode,
Expand Down
Loading