elastic/kibana

Saved object import: show validation errors in UI

Open

#166.795 aberto em 20 de set. de 2023

Ver no GitHub
 (1 comment) (1 reaction) (0 assignees)TypeScript (8.021 forks)batch import
Feature:Saved Objects ManagementTeam:Coregood first issue

Métricas do repositório

Stars
 (19.065 stars)
Métricas de merge de PR
 (Mesclagem média 1d 16h) (999 fundiu PRs em 30d)

Description

If importing saved objects results in the API returning validation errors these errors should be displayed in the UI so users can take action on them.

For example, importing a dashboard with kibanaSavedObjectMeta.searchSourceJSON as a object instead of a string causes the API to respond with:

{
    "successCount": 0,
    "success": false,
    "warnings": [],
    "errors": [
        {
            "id": "elasticsearch-storage-dashboard",
            "type": "dashboard",
            "meta": {
                "title": "Cluster Ingest Per Day (Technical Preview/Beta)",
                "icon": "dashboardApp"
            },
            "error": {
                "isBoom": true,
                "isServer": false,
                "data": null,
                "output": {
                    "statusCode": 400,
                    "payload": {
                        "message": "[attributes.kibanaSavedObjectMeta.searchSourceJSON]: expected value of type [string] but got [Object]: Bad Request",
                        "statusCode": 400,
                        "error": "Bad Request"
                    },
                    "headers": {}
                },
                "type": "unknown"
            }
        }
    ]
}

But the UI just shows "Error" without any explanation

Guia do colaborador

Direção de pesquisa
Investigue o componente de UI que lida com os resultados da importação de objetos salvos, provavelmente no plugin de gerenciamento de objetos salvos. A API retorna erros de validação em um formato estruturado, conforme mostrado na issue. A UI atual exibe uma mensagem genérica 'Erro'. A correção provavelmente envolve analisar a resposta de erro e exibir as mensagens de erro específicas (por exemplo, de `error.output.payload.message`) no painel de resultados da importação. Examine o cliente da API de importação e o componente que renderiza o resumo da importação. Arquivos vinculados: src/plugins/saved objects management/ ou similar. Nenhum PR aberto ou responsáveis atribuídos.
Pilha de tecnologia
typescript
Domain
frontend
Tipo Issue
Bug
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
Git
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
75