jargonsdev / jargonsdev/jargons.dev

Code Quality: Implement specific error handling for jAI search API endpoint

Aperta
#220 3 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

:arrow_upper_right: medium priority :red_circle: wontfix :sparkles: enhancement ✨jai backend hacktoberfest
Lingua principale
MDX
Stelle
56
Fork
45
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

## **Problem**
The jAI search API endpoint (`src/pages/api/jai/search.js`) currently uses a generic error handler that returns basic error information for all failures. This makes it difficult for users and developers to understand the cause of errors and respond appropriately.

## **Current Behavior**
- All errors are caught and returned as a generic error message with status 500 (or e.status if present).
- No distinction between validation errors, network errors, rate limiting, or other specific scenarios.

## **Expected Behavior**
- The API should distinguish between different error types and return specific, user-friendly messages and appropriate HTTP status codes.
- Should handle:
- Validation errors (400)
- Network/service errors (503)
- Rate limiting (429)
- Generic server errors (500)

## **Location**
File: `src/pages/api/jai/search.js`

## **Proposed Implementation**
```javascript
catch (e) {
console.error('jAI Search API Error:', e);
// Handle different types of errors
if (e.name === 'ValidationError') {
return Response.json(
{ error: 'Invalid request parameters', details: e.message },
{ status: 400, headers: corsHeaders }
);
}
if (e.name === 'NetworkError' || e.code === 'ENOTFOUND') {
return Response.json(
{ error: 'External service unavailable', details: 'AI service is temporarily unavailable' },
{ status: 503, headers: corsHeaders }
);
}
if (e.status === 429) {
return Response.json(
{ error: 'Rate limit exceeded', details: 'Too many requests. Please try again later.' },
{ status: 429, headers: corsHeaders }
);
}
// Generic server error
return Response.json(
{ error: 'Internal server error', details: process.env.NODE_ENV === 'development' ? e.message : 'Something went wrong' },
{ status: e.status ?? 500, headers: corsHeaders }
);
}
```

## **Steps to Complete**
1. Update catch block to handle specific error types.
2. Return 400 for validation errors, 503 for network/service errors, 429 for rate limiting, 500 for generic errors.
3. Test each error scenario.

## **Definition of Done**
- [ ] Error handler distinguishes between error types.
- [ ] Each error returns a specific status code and message.
- [ ] CORS headers are included in all error responses.
- [ ] Existing functionality for successful requests remains intact.

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Inizia leggendo src/pages/api/jai/search.js, concentrandoti sul blocco catch esistente e su come le risposte riuscite utilizzano gli header CORS. Esegui i percorsi di validazione, rete, limite di richieste ed errore generico, quindi verifica che ciascuno restituisca lo status, il messaggio e gli header CORS specificati, senza modificare le richieste riuscite.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
javascript, nodejs
Ambito
api, backend
Tipo di issue
Bug
Difficoltà
2/5
Tempo stimato
1-3 ore
Stato di attività
Ferma
Chiarezza
Specificata chiaramente
Idoneità per principianti
45/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.