Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Automatic Import] Add Error handling framework #193577

Merged
merged 16 commits into from
Sep 25, 2024

Conversation

bhapas
Copy link
Contributor

@bhapas bhapas commented Sep 20, 2024

Release Note

Adds error handling framework that provides error message with more context to user.

Summary

Relates - 192916

This PR adds an error handling framework.

  • Add Error classes for specific error scenarios.
  • If the error caught is of the predefined Error type the message and errorCode is sent back to UI from server.
  • The original error message is used to track telemetry and the errorCode can be translated into a User visible error.
  • If there is any non-predefined error server still throws a badRequest with the error message.

This PR also adds/updates the graph images for different langgraphs

Screenshots for error messages

image image

Checklist

For maintainers

@bhapas bhapas added enhancement New value added to drive a business result release_note:feature Makes this part of the condensed release notes Team:Security-Scalability Team label for Security Integrations Scalability Team Feature:AutomaticImport labels Sep 20, 2024
@bhapas bhapas self-assigned this Sep 20, 2024
@bhapas bhapas force-pushed the automatic_import_improve_error_logging branch from 2a6bed6 to 6486b9c Compare September 24, 2024 08:34
export const RECURSION_LIMIT_ERROR = i18n.translate(
'xpack.plugins.integration_assistant.server.errors.recursionLimitReached',
{
defaultMessage: 'Max attempts exceeded. Please try again.',
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jamiehynds Need a better wording here.

@bhapas bhapas marked this pull request as ready for review September 24, 2024 08:43
@bhapas bhapas requested a review from a team as a code owner September 24, 2024 08:43
@elasticmachine
Copy link
Contributor

Pinging @elastic/security-scalability (Team:Security-Scalability)

@bhapas bhapas marked this pull request as draft September 24, 2024 08:43
@bhapas bhapas added the backport:skip This commit does not require backporting label Sep 24, 2024
@bhapas bhapas force-pushed the automatic_import_improve_error_logging branch from 6486b9c to 73106e0 Compare September 24, 2024 08:44
@bhapas bhapas marked this pull request as ready for review September 24, 2024 12:47
@bhapas bhapas force-pushed the automatic_import_improve_error_logging branch from 81d7d9a to a568412 Compare September 24, 2024 12:50
@bhapas bhapas requested a review from semd September 24, 2024 13:29
@bhapas bhapas requested a review from semd September 25, 2024 11:53
Copy link
Contributor

@semd semd left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

Copy link
Member

@P1llus P1llus left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looking great!

@bhapas bhapas added backport:prev-minor Backport to the previous minor version (i.e. one version back from main) and removed backport:skip This commit does not require backporting labels Sep 25, 2024
@kibana-ci
Copy link
Collaborator

💚 Build Succeeded

Metrics [docs]

Async chunks

Total size of all lazy-loaded chunks that will be downloaded as the user navigates the app

id before after diff
integrationAssistant 947.9KB 948.8KB +919.0B
Unknown metric groups

ESLint disabled line counts

id before after diff
integrationAssistant 7 8 +1

Total ESLint disabled count

id before after diff
integrationAssistant 12 13 +1

History

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

cc @bhapas

@bhapas bhapas merged commit 9fb6f55 into elastic:main Sep 25, 2024
21 checks passed
kibanamachine pushed a commit to kibanamachine/kibana that referenced this pull request Sep 25, 2024
## Release Note

Adds error handling framework that provides error message with more
context to user.

## Summary

Relates - [192916](elastic#192916)

This PR adds an error handling framework.
- Add Error classes for specific error scenarios.
- If the error caught is of the predefined Error type the `message` and
`errorCode` is sent back to UI from server.
- The original error message is used to track telemetry and the
errorCode can be translated into a User visible error.
- If there is any non-predefined error server still throws a
`badRequest` with the error message.

This PR also adds/updates the graph images for different langgraphs

## Screenshots for error messages
<img width="690" alt="image"
src="https://github.com/user-attachments/assets/bb848ce7-e474-4e4e-8d07-59b534c543ea">

<img width="691" alt="image"
src="https://github.com/user-attachments/assets/fbf4cf46-9bbe-4c37-aaaa-0ede1cdcba7c">

### Checklist

- [x] [Unit or functional
tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)
were updated or added to match the most common scenarios

### For maintainers

- [ ] This was checked for breaking API changes and was [labeled
appropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)

(cherry picked from commit 9fb6f55)
@kibanamachine
Copy link
Contributor

💚 All backports created successfully

Status Branch Result
8.x

Note: Successful backport PRs will be merged automatically after passing CI.

Questions ?

Please refer to the Backport tool documentation

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport:prev-minor Backport to the previous minor version (i.e. one version back from main) enhancement New value added to drive a business result Feature:AutomaticImport release_note:feature Makes this part of the condensed release notes Team:Security-Scalability Team label for Security Integrations Scalability Team v9.0.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants