BACK - Preditor não retorna resultado, exibir causa do erro

[yxuo]

Situação

29/03/2024

O preditor está retornando zero resultados no dia de hoje, sendo que há serviços de exceção (calendar_dates) que deveriam aparecer.

Foi feita uma correção na query do banco seguindo a lógica de negócio (requisito da geração de predição)

08/01/2024

O endpoint do preditor começou a retornar 0 resultados.

Possíveis causas:

• ❌ Endpoint externo do realtime está fora do ar
  • Os dados estão sim no ar.
• ❌ Endpoint externo do realtime parou de atualizar os dados
  • Os dados estão sim atualizados.
• ✅ Problema com o banco de dados
  • Os service_id estão desatualizados (2023 ao invés de 2024), portanto o preditor não teve dados atuais para gerar o resutado.
• ❌ Endpoint externo do realtime exibe veículos com previsão longa demais, por isso estão sendo ignorados.
  • Os dados são recentes

Tarefas

• [x] Descobrir o problema
• [x] Testar novo GTFS em homologação
• [x] Aplicar GTFS em produção
• [x] Fazer API mostrar possíveis causas da resposta vir zerada no Preditor
• [x] Criar endpoint para teste

[yxuo]

Requisitos do preditor

• [x] O preditor deve lançar erro quando calendar e calendar_dates estão vazios (bom para debug)
• [x] O preditor deve lançar erro quando não foi encontrado nenhum service_id
• [x] O preditor deve lançar erro quando a api realtime retornar erro
• [x] O preditor deve lançar erro quando a api realtime retornar zero resultados
• [x] O preditor deve lançar erro quando encontrar mais de um shape_id para fazer a previsão
• [x] O preditor deve lançar erro quando não encontrar nenhum shape_id para fazer a previsão
• [x] O preditor deve lançar erro quando finalizar com sucesso a predição mas retornar zero resultados
• [x] O preditor deve retornar um resultado válido em um cenário ideal qualquer
• [x] O endpoint do preditor deve retornar o dado formatado:

[yxuo]

Retorno de erro em /predictor

Exemplo de predição sem erro:

{
    "results": [{"...": "..."}],
    "error": null
}

Exemplo quando ocorre erro:

{
    "results": [],
    "error": {
        "code": "empty-db-tables",
        "type": "error",
        "message": "Não foram encontrados service_id para o dia de hoje",
        "details": {
            "service_id": {
                "obsolete_count": 0,
                "future_count": 0,
                "available_today_count": 0,
                "obsolete": [],
                "future": [],
                "available_today": [],
            }
        }
    }
}

Exemplo quando não há alteração há mais de 5 minutos:

{
    "results": [],
    "error": { "...", "qualquer erro"},
    "code": "result-unchanged-timeout",
    "message": "Sem alterações no banco do preditor há mais de 5 minutos."
}

[yxuo]

Requisitos do endpoint do preditor

• [x] Quando não houver resultado do preditor salvo no banco, retornar erro 404
• [x] Quando o preditor retornar qualquer erro, retornar erro 500
• [x] Quando o preditor não atualizar os dados após 5 minutos, retornar erro 500

[yxuo]

Acertos a fazer

[yxuo]

Criar endponit para testes

[yxuo]

Requisitos da geração de predição

Para qualquer dia, sempre são validas trips cujo service_id:

• É adicionado para o dia na tabela calendar_dates, ou
• É programado para o dia na calendar e não é removido na calendar_dates