[Console Migration] Add action for auto indentation

[ElenaStoeva]

Closes #180213

Summary

This PR adds an action for applying indentation to the selected requests in the Console Monaco editor.

Screen.Recording.2024-05-14.at.16.20.03.mov

Note: This PR doesn't auto-indent requests that contain comments. This will be part of a follow-up work (#182138).

[elasticmachine]

Pinging @elastic/kibana-management (Team:Kibana Management)

[yuliacech]

Thanks a lot for implementing the auto-indent, @ElenaStoeva!
Since loosing any user content might be an issue, let's discuss in the team sync on how to approach auto-indentation of comments

[ElenaStoeva]

/ci

[yuliacech]

nit: I think for completeness sake we should use some kind of string to indicate that the edit was made by the auto-indent button

[ElenaStoeva]

Ah I wasn't sure how this string would be used... will it be visible to the user somehow or do you think we'll only need it for internal use? I added a translated string (in case it will be displayed to the user), let me know what you think.

[yuliacech]

I think the string might be used for undo/redo actions which I don't think we currently have. I believe the value won't be displayed in the UI to the user though.

[ElenaStoeva]

I see... Then it might be good to store this in a constant in case it's needed somewhere. I added this change with 3e1264f.

[yuliacech]

Thanks a lot for working on this feature, @ElenaStoeva!
I think that is a good approach to only auto-indent the requests that don't contain any comments.
I think though that we don't need to keep track of the text of the request in the parser: You are already using the model to get the text in the range of selected requests with model.getValueInRange. Each request also has startLineNumber and endLineNumber. If you pass the model to the util auto-indent function, you should be able to iterate over the requests array and for each you should know when it's the start line with the method (startLineNumber) and where the request body begins (startLineNumber + 1) and where the request body ends (endLineNumber). With this line numbers you can get the text from the model and do the same check for comments. WDYT?

[ElenaStoeva]

Thanks a lot for working on this feature, @ElenaStoeva! I think that is a good approach to only auto-indent the requests that don't contain any comments. I think though that we don't need to keep track of the text of the request in the parser: You are already using the model to get the text in the range of selected requests with model.getValueInRange. Each request also has startLineNumber and endLineNumber. If you pass the model to the util auto-indent function, you should be able to iterate over the requests array and for each you should know when it's the start line with the method (startLineNumber) and where the request body begins (startLineNumber + 1) and where the request body ends (endLineNumber). With this line numbers you can get the text from the model and do the same check for comments. WDYT?

Thanks for the review @yuliacech! You're right, we don't need to add a text property to the parsed requests. I refactored the auto-indent util function so that we don't need this property from the parser. Instead of passing the editor model to the util function as you suggested, I decided to take a slightly different approach, and obtain all needed text from the editor inside the actions provider function. This way, we can isolate the editor model from the util functions to minimize complexity and allow easier unit testing of the util function. Let me know what you think.

[yuliacech]

nit: the argument "event" is now unused and can be deleted

[ElenaStoeva]

Nice catch! I removed it in 3e1264f.

[yuliacech]

Thanks a lot for addressing my comments, @ElenaStoeva!
Latest changes LGTM 👍

[kibana-ci]

💚 Build Succeeded

• Buildkite Build
• Commit: 3e1264f

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
console	447.8KB	448.9KB	+1.1KB

History

• 💚 Build #209939 succeeded ff3a57b
• 💛 Build #209913 was flaky addacb6
• 💔 Build #209181 failed e0fe0c4
• 💔 Build #209160 failed 8f79193
• 💛 Build #208736 was flaky 09f5333
• 💛 Build #206953 was flaky b37881f

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

cc @ElenaStoeva