elastic/kibana

[Response Ops][Alerting] Restructure actions FT route definition

Open

#179,086 opened on Mar 20, 2024

View on GitHub
 (1 comment) (0 reactions) (0 assignees)TypeScript (8,021 forks)batch import
Feature:ActionsTeam:ResponseOpsgood first issuetechnical debt

Repository metrics

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

Description

Suggestion from PR review for https://github.com/elastic/kibana/pull/178682 to restructure the way routes are defined in the actions FT plugin. Referencing the route definitions in x-pack/test/alerting_api_integration/common/plugins/actions_simulators/server/unsecured_actions_simulation.ts

should we structure this like we do pagerduty, so we don't hardcode the `/api/...` path - which in theory, someday, could become a real API (but doubtful).  Eg, 

- https://github.com/elastic/kibana/blob/main/x-pack/test/alerting_api_integration/common/plugins/actions_simulators/server/pagerduty_simulation.ts
- https://github.com/elastic/kibana/blob/main/x-pack/test/alerting_api_integration/common/plugins/actions_simulators/server/plugin.ts

This is mostly pre-existing code, so I'd say we could just create a cleanup issue for it as well ...

Originally posted by @pmuellr in https://github.com/elastic/kibana/pull/178682#discussion_r1532077936

Contributor guide

Research direction
Examine the referenced pagerduty simulation route definition pattern and apply it to the unsecured actions simulation.ts file. Restructure the route definitions to avoid hardcoding `/api/` paths.
Tech stack
typescript
Domain
backendtesting
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
TypeScriptKibana plugin structure
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70