Mejorando el diagnóstico de errores en integraciones con Apify en Brenia
En el proyecto Brenia, nuestra arquitectura depende en gran medida de servicios externos de scraping para alimentar nuestro pipeline de análisis de marca. Recientemente, detectamos una limitación técnica: el sistema no distinguía correctamente entre una cuenta de Instagram sin imágenes y un error de ejecución en la plataforma externa, lo que dificultaba el diagnóstico de problemas operativos.
El Desafío: Visibilidad de Estado
El problema principal radicaba en que nuestro cliente interno de Apify, ApifyClient, trataba de forma ambigua los resultados vacíos. Si una ejecución fallaba por límites de tasa o tiempo de espera, la aplicación lo interpretaba simplemente como un resultado nulo, perdiendo la causa raíz. Esto causaba frustración tanto en los usuarios, que veían errores genéricos, como en el equipo de desarrollo, al intentar depurar incidentes.
Implementación de Diagnóstico Detallado
Para resolver esto, extendimos el objeto ApifyRunResult para capturar el estado final de la ejecución. Ahora, cada respuesta incluye un estado detallado que nos permite diferenciar errores del sistema de casos donde la cuenta analizada simplemente no contiene datos procesables.
namespace App\Services;
class ApifyRunResult {
public function __construct(
public readonly array $items,
public readonly ?string $status = null
) {}
public function succeeded(): bool {
return $this->status === 'SUCCEEDED';
}
}
Normalización de Entradas
Además de la visibilidad de errores, optimizamos la captura de los handles de Instagram. Implementamos una normalización robusta que permite a los usuarios ingresar sus perfiles como texto plano, con @ o como URL completa, asegurando que handles complejos (como aquellos que terminan en guion bajo) se procesen sin truncamientos.
Asegurando la Calidad con PHPUnit
Utilizamos PHPUnit para garantizar que estos cambios no afecten la estabilidad de nuestros flujos de trabajo críticos. Mediante tests de regresión, verificamos tanto la normalización correcta de los handles como la propagación adecuada de los estados de error.
public function test_api_status_is_propagated_on_failure(): void {
$result = new ApifyRunResult(items: [], status: 'FAILED');
$this->assertFalse($result->succeeded());
$this->assertEquals('FAILED', $result->status);
}
Con esta mejora, ahora nuestros logs reflejan fielmente lo que ocurre en los servicios de terceros, reduciendo el tiempo de resolución y mejorando la experiencia del usuario final durante el alta de su marca.
Generated with Gitvlg.com