[Console] Add logic for query params #160515

yuliacech · 2023-06-26T12:32:45Z

Summary

This PR adds logic for query parameters to the new script generating Console autocomplete definitions from ES specification. The logic is explained in details in the file but here is a short version:

Currently, the autocomplete engine only works with url params of 2 types: boolean (__flag__) and a list of options (for example ['all', 'open', 'hidden']). The script will convert all of the url params from the specification into this format: a boolean or a list. If there are no set options for a parameter, but a default value is known, then it will be converted into a list with 1 option, for example ['random'] so that the autocomplete engine will display it as a single suggestion. We also need to convert any numbers to strings, because they won't be displayed otherwise.
Endpoints in the specification have a property request which in turn has 2 properties describing url params: attachedBehaviours and query. Both object contain an array of property's each describing a url param. property is configured with either a built in type (string, number, boolean) or defined type, for example ExpandWildcards. By finding the type ExpandWildcards in the specification, we can convert this type to a list of options ['open', 'all', 'none', 'hidden'].

How to test

Similar to #159241, you need to re-generenate the definitions and see if local changes to definitions files make sense.

Checkout the ES specification repo
Run the command node scripts/generate_console_definitions.js --source <ES_SPECIFICATION_REPO> --emptyDest
Check the changes in the folder KIBANA_REPO/src/plugins/console/server/lib/spec_definitions/json/generated

Intended changes to the definitions files

Most of endpoints have 4 default url params that previously were not in the definitions files but added to all endpoints in this file. These params are configured in the interface CommonQueryParameters in the specification (see this file).

The interface in the specification

export interface CommonQueryParameters {
  error_trace?: boolean
  filter_path?: string | string[]
  human?: boolean
  pretty?: boolean
}

The converted url params

"error_trace": "__flag__",
"filter_path": [],
"human": "__flag__",
"pretty": "__flag__",

Previously existing url_components property in the definitions is deleted and this change will be addressed separately. (not sure it is currently working but added a task to the meta issue)
Previously numbers were configured as 0 or 0.0 but that is not currently displayed in suggestions. Instead, the new script converts numbers to strings and if any default value is present, it will be displayed as a suggestion.

…-ref HEAD~1..HEAD --fix'

yuliacech · 2023-06-29T15:25:01Z

packages/kbn-generate-console-definitions/src/types/specification_types.ts

+ */
+
+/**
+ * --------------- THIS FILE IS COPIED FROM ES SPECIFICATION REPO -------------------


I added a task to the meta issue to see if we could import the types instead of copying

elasticmachine · 2023-06-29T15:26:50Z

Pinging @elastic/platform-deployment-management (Team:Deployment Management)

yuliacech · 2023-06-29T15:46:42Z

The current UI for url params is limited so I open this issue to track some improvements.

sabarasaba

Nice one @yuliacech! I tested locally following the instructions and everything seems to be working as expected, I checked the changes in the generated file and seems to be correct.

I was wondering though if it would make sense to include the testing commands into the package readme along with some more deets about how this works so that whoever needs to run it or pick this work up has more context (this could totally be done with a separate issue though!)

sabarasaba · 2023-07-04T07:13:22Z

packages/kbn-generate-console-definitions/src/generate_query_params.ts

+ * - "__flag__" for a boolean (suggesting value 'true' and 'false')
+ * - list of options in an array, for example ['30s', '-1', '0'], suggesting all 3 values in a list
+ * If there is only a default value, we need to wrap it in an array, so that this value is displayed in a suggestion (similar to the list).
+ * Numbers need to be converted to strings, otherwise they are not displayed as suggestions.


interesting! is this a bug from the editor? 🤔

I haven't investigated in too much detail, but I added a note about numbers to the issue I opened for the current UI for url params. Basically, autocomplete suggestions currently only work for booleans and lists and could be improved.

sabarasaba · 2023-07-04T07:22:19Z

packages/kbn-generate-console-definitions/src/generate_query_params.ts

+      return booleanFlagString;
+    } else {
+      // if default value, convert to string and put in an array
+      return serverDefault ? [serverDefault + ''] : '';


nit: serverDefault.toString()

sabarasaba · 2023-07-04T07:24:19Z

packages/kbn-generate-console-definitions/src/generate_query_params.ts

+
+const convertLiteralValue = (type: SpecificationTypes.LiteralValue): UrlParamValue | undefined => {
+  // convert the value to a string
+  return [type.value + ''];


nit: type.value.toString()

yuliacech · 2023-07-05T09:38:46Z

Thanks a lot for your review, @sabarasaba! Great idea about the readme file, I updated it with the instructions how to run the command as you suggested.

kibana-ci · 2023-07-05T10:38:56Z

💚 Build Succeeded

Buildkite Build
Commit: 0b4f756

Metrics [docs]

Unknown metric groups

ESLint disabled line counts

id	before	after	diff
`enterpriseSearch`	14	16	+2
`securitySolution`	410	414	+4
total			+6

Total ESLint disabled count

id	before	after	diff
`enterpriseSearch`	15	17	+2
`securitySolution`	489	493	+4
total			+6

History

💚 Build #140213 succeeded 48dc57e
💚 Build #139719 succeeded a390c7e
💔 Build #139545 failed 801113e
💚 Build #139131 succeeded bcadd1e
💚 Build #139053 succeeded 2e61a7a
💚 Build #138576 succeeded 26fc146

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

[Console] Add logic for query params

97a934d

kibanamachine and others added 6 commits June 26, 2023 12:38

[CI] Auto-commit changed files from 'node scripts/precommit_hook.js -…

de8e8e3

…-ref HEAD~1..HEAD --fix'

Merge branch 'main' into console/new_script_url_params

e4b864c

[Console] Implement url params conversion logic

26fc146

[Console] Clean up the code, add comments, refactorings

2e61a7a

[Console] Unit tests for query params conversion logic

4b9b107

Merge branch 'main' into console/new_script_url_params

bcadd1e

yuliacech commented Jun 29, 2023

View reviewed changes

yuliacech marked this pull request as ready for review June 29, 2023 15:26

yuliacech requested a review from a team as a code owner June 29, 2023 15:26

yuliacech and others added 2 commits June 30, 2023 18:45

[Console] Make sure no undefined values are added to the param values

801113e

Merge branch 'main' into console/new_script_url_params

a390c7e

sabarasaba approved these changes Jul 4, 2023

View reviewed changes

yuliacech mentioned this pull request Jul 5, 2023

[Console] Improve information for query parameters #160915

Open

yuliacech and others added 3 commits July 5, 2023 10:23

[Console] Add code review suggestions

48dc57e

[Console] Add readme

7025979

Merge branch 'main' into console/new_script_url_params

0b4f756

yuliacech enabled auto-merge (squash) July 5, 2023 09:39

yuliacech merged commit ee6ca65 into elastic:main Jul 5, 2023

kibanamachine added the backport:skip This commit does not require backporting label Jul 5, 2023

yuliacech mentioned this pull request Jul 11, 2023

[Console] Implement logic to generate body params #161684

Closed

yuliacech deleted the console/new_script_url_params branch February 15, 2024 12:05

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Console] Add logic for query params #160515

[Console] Add logic for query params #160515

yuliacech commented Jun 26, 2023 •

edited

Loading

yuliacech Jun 29, 2023

elasticmachine commented Jun 29, 2023

yuliacech commented Jun 29, 2023

sabarasaba left a comment

sabarasaba Jul 4, 2023

yuliacech Jul 5, 2023

sabarasaba Jul 4, 2023

sabarasaba Jul 4, 2023

yuliacech commented Jul 5, 2023

kibana-ci commented Jul 5, 2023

ESLint disabled line counts

Total ESLint disabled count

[Console] Add logic for query params #160515

[Console] Add logic for query params #160515

Conversation

yuliacech commented Jun 26, 2023 • edited Loading

Summary

How to test

Intended changes to the definitions files

yuliacech Jun 29, 2023

Choose a reason for hiding this comment

elasticmachine commented Jun 29, 2023

yuliacech commented Jun 29, 2023

sabarasaba left a comment

Choose a reason for hiding this comment

sabarasaba Jul 4, 2023

Choose a reason for hiding this comment

yuliacech Jul 5, 2023

Choose a reason for hiding this comment

sabarasaba Jul 4, 2023

Choose a reason for hiding this comment

sabarasaba Jul 4, 2023

Choose a reason for hiding this comment

yuliacech commented Jul 5, 2023

kibana-ci commented Jul 5, 2023

💚 Build Succeeded

Metrics [docs]

ESLint disabled line counts

Total ESLint disabled count

History

yuliacech commented Jun 26, 2023 •

edited

Loading