elastic/kibana

[Console] Line break is sometimes opaquely inserted when submitting request

Closed

#193,241 opened on Sep 18, 2024

View on GitHubContributor guide
 (5 comments) (0 reactions) (1 assignee)TypeScript (8,021 forks)batch import
Feature:ConsoleTeam:Kibana Managementbuggood first issue

Repository metrics

Stars
 (19,065 stars)
PR merge metrics
 (Avg merge 1d 16h) (999 merged PRs in 30d)

Description

In some cases, when submitting a request with a certain pattern, console inserts a line break under the water which breaks the request, without a hint to the user as to why that has happened. Here's a snippet to reproduce:

PUT _ingest/pipeline/entities-v1-latest-builtin_data_streams
{
  "processors": [
    {
      "set": {
        "field": "entity.displayName",
        "value": "{{remote}}{{data_stream.type}}-{{data_stream.dataset}}-{{data_stream.namespace}}"
      }
    }
  ]
}

The issue is with {{remote}}{{data_stream.type}}. If that is changed to {{remote}}-{{data_stream.type}}, the request works again.

Contributor guide

Research direction
Investigate how the console parses request bodies, particularly the mustache template syntax. Look for logic that splits on certain characters or detects template boundaries. The issue occurs when templates are concatenated without a delimiter. Check the console's code in the x pack/plugins/console directory, specifically the request processing logic. Consider adding a validation or escaping mechanism.
Tech stack
typescriptrest api
Domain
apideveloper experience
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Blocked
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Familiarity with Kibana's Dev Tools consoleUnderstanding of HTTP request parsing
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50