Skip to content

Enhance a data route error handling regression #39

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

Merged
merged 2 commits into from
Aug 8, 2025
Merged

Enhance a data route error handling regression #39

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
86072df
fix(data): improve error handling for filter, sort, and create operat…
fulleni Aug 8, 2025
8064abe
refactor(api): improve error handling and type checking in PUT request
fulleni Aug 8, 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
33 changes: 24 additions & 9 deletions routes/api/v1/data/[id]/index.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,18 +84,33 @@ Future<Response> _handlePut(RequestContext context, String id) async {
);
}

final bodyItemId = modelConfig.getId(itemToUpdate);
if (bodyItemId != id) {
throw BadRequestException(
'Bad Request: ID in request body ("$bodyItemId") does not match ID in path ("$id").',
);
try {
final bodyItemId = modelConfig.getId(itemToUpdate);
if (bodyItemId != id) {
throw BadRequestException(
'Bad Request: ID in request body ("$bodyItemId") does not match ID in path ("$id").',
);
}
} catch (e) {
// Ignore if getId throws, as the ID might not be in the body,
// which can be acceptable for some models.
_logger.info('Could not get ID from PUT body: $e');
}

if (modelName == 'user_content_preferences') {
await userPreferenceLimitService.checkUpdatePreferences(
authenticatedUser,
itemToUpdate as UserContentPreferences,
);
if (itemToUpdate is UserContentPreferences) {
await userPreferenceLimitService.checkUpdatePreferences(
authenticatedUser,
itemToUpdate,
);
} else {
_logger.severe(
'Type Error: Expected UserContentPreferences for limit check, but got ${itemToUpdate.runtimeType}.',
);
throw const OperationFailedException(
'Internal Server Error: Model type mismatch for limit check.',
);
}
}

final userIdForRepoCall = _getUserIdForRepoCall(
Expand Down
49 changes: 35 additions & 14 deletions routes/api/v1/data/index.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,20 +28,34 @@ Future<Response> _handleGet(RequestContext context) async {
final authenticatedUser = context.read<User>();
final params = context.request.uri.queryParameters;

final filter = params.containsKey('filter')
? jsonDecode(params['filter']!) as Map<String, dynamic>
: null;
Map<String, dynamic>? filter;
if (params.containsKey('filter')) {
try {
filter = jsonDecode(params['filter']!) as Map<String, dynamic>;
} on FormatException catch (e) {
throw BadRequestException(
'Invalid "filter" parameter: Not valid JSON. $e',
);
}
}

final sort = params.containsKey('sort')
? (params['sort']!.split(',').map((s) {
final parts = s.split(':');
final field = parts[0];
final order = (parts.length > 1 && parts[1] == 'desc')
? SortOrder.desc
: SortOrder.asc;
return SortOption(field, order);
}).toList())
: null;
List<SortOption>? sort;
if (params.containsKey('sort')) {
try {
sort = params['sort']!.split(',').map((s) {
final parts = s.split(':');
final field = parts[0];
final order = (parts.length > 1 && parts[1] == 'desc')
? SortOrder.desc
: SortOrder.asc;
return SortOption(field, order);
}).toList();
} catch (e) {
throw const BadRequestException(
'Invalid "sort" parameter format. Use "field:order,field2:order".',
);
}
}

final pagination =
(params.containsKey('limit') || params.containsKey('cursor'))
Expand Down Expand Up @@ -91,7 +105,14 @@ Future<Response> _handlePost(RequestContext context) async {
requestBody['createdAt'] = now;
requestBody['updatedAt'] = now;

final itemToCreate = modelConfig.fromJson(requestBody);
dynamic itemToCreate;
try {
itemToCreate = modelConfig.fromJson(requestBody);
} on TypeError catch (e) {
throw BadRequestException(
'Invalid request body: Missing or invalid required field(s). $e',
);
}

final userIdForRepoCall =
(modelConfig.getOwnerId != null &&
Expand Down
Loading