[RAM] Category fields endpoint #138245

jcger · 2022-08-08T11:06:36Z

Summary

Implements #137988 server part

Checklist

Functional tests will be added with the frontend pr
unit test

How to QA

The new endpoint is internal/rac/alerts/browser_fields and it expects featureIds as query param, for example curl -u 'user:password' '[HOST:PORT/BASE_PATH]/internal/rac/alerts/browser_fields?featureIds=logs&featureIds=apm' should return all field capabilities in logs and apm

…ield-api

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

…nto 137988-category-field-api

…ield-api

jcger · 2022-09-07T09:05:35Z

@elasticmachine merge upstream

x-pack/plugins/rule_registry/server/routes/get_browser_fields_by_feature_id.ts

x-pack/plugins/rule_registry/server/types.ts

XavierM

@jcger we should create some api integration test under this folder , and can we add basic unit test too?

…ield-api

x-pack/plugins/rule_registry/server/routes/get_browser_fields_by_feature_id.ts

XavierM · 2022-09-09T19:27:31Z

x-pack/plugins/rule_registry/server/routes/get_browser_fields_by_feature_id.ts

+        query: buildRouteValidation(
+          t.exact(
+            t.type({
+              featureIds: t.union([t.string, t.array(t.string)]),


@jcger That's one of the reason why your API integration was not working because before you only allow for array. However, when you just have one item in a query parameter, it is automatically converted to just be a string.

XavierM · 2022-09-09T19:28:54Z

x-pack/test/rule_registry/security_and_spaces/tests/basic/get_browser_fields_by_feature_id.ts

+    expectedStatusCode: number = 200
+  ) => {
+    const resp = await supertestWithoutAuth
+      .get(`${getSpaceUrlPrefix(SPACE1)}${TEST_URL}`)


@jcger I had to add the space because your user secOnlyRead only have access to space 1. On Monday let's go over kibana privileges together. It is always confusing for everybody.

XavierM

LGTM

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

maryam-saeidi

I've tested it locally, LGTM!

maryam-saeidi · 2022-09-12T12:01:30Z

x-pack/plugins/rule_registry/server/alert_data_client/browser_fields/index.ts

+import { BrowserField, BrowserFields } from '../../types';
+
+const getFieldCategory = (fieldCapability: FieldSpec) => {
+  const name = fieldCapability.name.split('.');


nit: Since it is an array, names would be a better naming.

I'm not sure if I agree. It's still the name capability but split into one array, each element of the name would a part of the name but not a name by itself. Calling it names would mean that each part is a name but I think it isn't, not sure though

I see what you mean, maybe nameParts or nameSections? In general, it helps when for arrays, we have a plural name but up to you :)

maryam-saeidi · 2022-09-12T12:12:49Z

x-pack/plugins/rule_registry/server/alert_data_client/browser_fields/index.ts

+};
+
+export const fieldDescriptorToBrowserFieldMapper = (
+  fieldDescriptor: FieldSpec[]


nit: We can call this fields for this variable and when we iterate over it, use field for each item.

maryam-saeidi · 2022-09-12T12:14:08Z

x-pack/plugins/rule_registry/server/alert_data_client/browser_fields/index.ts

+): BrowserFields => {
+  return fieldDescriptor.reduce((browserFields: BrowserFields, fieldCapability: FieldSpec) => {
+    const category = getFieldCategory(fieldCapability);
+    const field = browserFieldFactory(fieldCapability, category);


This field is browserField, right? We can name it browserField

kibana-ci · 2022-09-12T14:05:24Z

💚 Build Succeeded

Buildkite Build
Commit: f10c273

Metrics [docs]

Public APIs missing comments

Total count of every public API that lacks a comment. Target amount is 0. Run node scripts/build_api_docs --plugin [yourplugin] --stats comments for more detailed information.

id	before	after	diff
`ruleRegistry`	180	185	+5

Public APIs missing exports

Total count of every type that is part of your API that should be exported but is not. This will cause broken links in the API documentation system. Target amount is 0. Run node scripts/build_api_docs --plugin [yourplugin] --stats exports for more detailed information.

id	before	after	diff
`ruleRegistry`	10	11	+1

Unknown metric groups

API count

id	before	after	diff
`ruleRegistry`	208	213	+5

History

💚 Build #71104 succeeded 0d9c674
💚 Build #71005 succeeded cbb46d3
💚 Build #70827 succeeded 0997730
💔 Build #70781 failed 9873093
💔 Build #70745 failed b7324cb
💔 Build #70505 failed 6af56ff

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

jcger and others added 7 commits August 8, 2022 13:04

first commit

c06a11a

Merge branch 'main' of github.com:jcger/kibana into 137988-category-f…

861f5df

…ield-api

get auth index and try field caps

fad8830

use esClient

61a5a49

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

c56de28

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

wait for promise to finish

56d89be

Merge branch '137988-category-field-api' of github.com:jcger/kibana i…

c30862b

…nto 137988-category-field-api

jcger mentioned this pull request Aug 9, 2022

[RAM] Category fields endpoint #137704

Closed

9 tasks

jcger added 6 commits August 10, 2022 09:58

format field capabilities

fbd357b

add simplier browserFields mapper

e0df512

update response

f5cf16b

Merge branch 'main' of github.com:jcger/kibana into 137988-category-f…

8461aeb

…ield-api

refactor

a3284bd

types and refactor

34a2cfd

jcger force-pushed the 137988-category-field-api branch from ab8955f to 34a2cfd Compare August 11, 2022 08:12

jcger added 7 commits August 11, 2022 10:13

Merge branch 'main' of github.com:jcger/kibana into 137988-category-f…

2eb8d92

…ield-api

Merge branch 'main' of github.com:jcger/kibana into 137988-category-f…

03cf83e

…ield-api

Merge branch 'main' of github.com:jcger/kibana into 137988-category-f…

7148021

…ield-api

remove browser fields dependency

43c3d62

update fn name

46423b9

update types

f111f4c

update imported type package

17f6171

Merge branch 'main' into 137988-category-field-api

106fdf1

jcger marked this pull request as ready for review September 7, 2022 09:05

jcger requested review from a team as code owners September 7, 2022 09:05

jcger added Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams) release_note:feature Makes this part of the condensed release notes labels Sep 7, 2022

update mock object

2c96b5c

XavierM reviewed Sep 7, 2022

View reviewed changes

x-pack/plugins/rule_registry/server/routes/get_browser_fields_by_feature_id.ts Outdated Show resolved Hide resolved

XavierM reviewed Sep 7, 2022

View reviewed changes

x-pack/plugins/rule_registry/server/types.ts Show resolved Hide resolved

XavierM reviewed Sep 7, 2022

View reviewed changes

jcger added 9 commits September 8, 2022 08:53

error message for no o11y alert indices

018bd72

add endpoint integration test

6af56ff

Merge branch 'main' of github.com:jcger/kibana into 137988-category-f…

dc1b1e0

…ield-api

Merge branch 'main' of github.com:jcger/kibana into 137988-category-f…

1969cff

…ield-api

activate commented tests

b7324cb

add unit test

f950a35

Merge branch 'main' of github.com:jcger/kibana into 137988-category-f…

9fbc94c

…ield-api

comment uncommented tests

9873093

fix tests

0997730

XavierM reviewed Sep 9, 2022

View reviewed changes

x-pack/plugins/rule_registry/server/routes/get_browser_fields_by_feature_id.ts Outdated Show resolved Hide resolved

review by Xavier

1d32de9

XavierM reviewed Sep 9, 2022

View reviewed changes

XavierM approved these changes Sep 9, 2022

View reviewed changes

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

cbb46d3

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

jcger enabled auto-merge (squash) September 12, 2022 06:28

Merge branch 'main' into 137988-category-field-api

0d9c674

jcger disabled auto-merge September 12, 2022 06:30

maryam-saeidi approved these changes Sep 12, 2022

View reviewed changes

jcger added 2 commits September 12, 2022 14:51

update param names + right type

f9ba067

Merge branch 'main' into 137988-category-field-api

f10c273

jcger enabled auto-merge (squash) September 12, 2022 12:52

jcger merged commit f236196 into elastic:main Sep 12, 2022

kibanamachine added the backport:skip This commit does not require backporting label Sep 12, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[RAM] Category fields endpoint #138245

[RAM] Category fields endpoint #138245

jcger commented Aug 8, 2022 •

edited

Loading

jcger commented Sep 7, 2022

XavierM left a comment

XavierM Sep 9, 2022

XavierM Sep 9, 2022

jcger Sep 12, 2022

XavierM left a comment

maryam-saeidi left a comment

maryam-saeidi Sep 12, 2022

jcger Sep 12, 2022

maryam-saeidi Sep 12, 2022

maryam-saeidi Sep 12, 2022

maryam-saeidi Sep 12, 2022

kibana-ci commented Sep 12, 2022

API count

[RAM] Category fields endpoint #138245

[RAM] Category fields endpoint #138245

Conversation

jcger commented Aug 8, 2022 • edited Loading

Summary

Checklist

How to QA

jcger commented Sep 7, 2022

XavierM left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

XavierM left a comment

Choose a reason for hiding this comment

maryam-saeidi left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kibana-ci commented Sep 12, 2022

💚 Build Succeeded

Metrics [docs]

Public APIs missing comments

Public APIs missing exports

API count

History

jcger commented Aug 8, 2022 •

edited

Loading