[Data] Cleanup filter docs #107169

lizozom · 2021-07-29T14:22:23Z

Summary

Cleanup filter docs
Mark APIs with @public and @internal
Cleanup any types wherever possible

Checklist

Delete any items that are not applicable to this PR.

Any text added follows EUI's writing guidelines, uses sentence case text and includes i18n support
Documentation was added for features that require explanation or tutorials
Unit or functional tests were updated or added to match the most common scenarios
Any UI touched in this PR is usable by keyboard only (learn more about keyboard accessibility)
Any UI touched in this PR does not create any new axe failures (run axe in browser: FF, Chrome)
If a plugin configuration key changed, check if it needs to be allowlisted in the cloud and added to the docker list
This renders correctly on smaller devices using a responsive layout. (You can test this in your browser)
This was checked for cross-browser compatibility

Risk Matrix

Delete this section if it is not applicable to this PR.

Before closing this PR, invite QA, stakeholders, and other developers to identify risks that should be tested prior to the change/feature release.

When forming the risk matrix, consider some of the following examples and how they may potentially impact the change:

Risk	Probability	Severity	Mitigation/Notes
Multiple Spaces—unexpected behavior in non-default Kibana Space.	Low	High	Integration tests will verify that all features are still supported in non-default Kibana Space and when user switches between spaces.
Multiple nodes—Elasticsearch polling might have race conditions when multiple Kibana nodes are polling for the same tasks.	High	Low	Tasks are idempotent, so executing them multiple times will not result in logical error, but will degrade performance. To test for this case we add plenty of unit tests around this logic and document manual testing procedure.
Code should gracefully handle cases when feature X or plugin Y are disabled.	Medium	High	Unit tests will verify that any feature flag or plugin combination still results in our service operational.
See more potential risk examples

For maintainers

This was checked for breaking API changes and was labeled appropriately

…filters

… data-cleanup/filters

…filter-docs

elasticmachine · 2021-07-29T14:28:08Z

Pinging @elastic/kibana-app-services (Team:AppServices)

…filter-docs

Bamieh

core changes lgtm: fixing a comment typo in src/core/public/fatal_errors/fatal_errors_service.tsx

tsullivan · 2021-07-29T19:45:06Z

packages/kbn-es-query/src/filters/build_filters/exists_filter.ts

+ * @public
+ */
+export const isExistsFilter = (filter: FieldFilter): filter is ExistsFilter =>
+  get(filter, 'exists');


This function doesn't explicitly return a boolean, the return value of get is any.

Should this be:

Suggested change

get(filter, 'exists');

get(filter, 'exists') != null;

?

If it's valid for filter.exists to be 0, then this function seems it would return the wrong value. Perhaps this is not a big deal, and also the same issue existed in the previous code.

Fixed it by replacing get with has which does exactly that

tsullivan

Great job on this! It looks very thorough.

I left a comment about a pattern of code that uses get to determine an object type, and it looks a bit loose to me. But I wouldn't block you from merging this PR based on my comment.

…filter-docs

lizozom · 2021-08-01T13:22:21Z

@elasticmachine merge upstream

kibanamachine · 2021-08-01T19:42:49Z

💚 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
`infra`	1.7MB	1.7MB	-11.3KB
`maps`	3.2MB	3.2MB	-11.4KB
`securitySolution`	6.4MB	6.4MB	-9.7KB
total			-32.5KB

Page load bundle

Size of the bundles that are downloaded on every page load. Target size is below 100kb

id	before	after	diff
`data`	907.1KB	891.0KB	-16.0KB

Unknown metric groups

API count missing comments

id	before	after	diff
`data`	3397	3396	-1

API count with any type

id	before	after	diff
`data`	99	80	-19

History

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

cc @lizozom

kibanamachine · 2021-08-04T10:18:42Z

Friendly reminder: Looks like this PR hasn’t been backported yet.
To create backports run node scripts/backport --pr 107169 or prevent reminders by adding the backport:skip label.

kibanamachine · 2021-08-05T10:28:41Z

Friendly reminder: Looks like this PR hasn’t been backported yet.
To create backports run node scripts/backport --pr 107169 or prevent reminders by adding the backport:skip label.

kibanamachine · 2021-08-06T10:38:43Z

Friendly reminder: Looks like this PR hasn’t been backported yet.
To create backports run node scripts/backport --pr 107169 or prevent reminders by adding the backport:skip label.

* Move more utils to package and cleanup API * docs and imports * better imports * change comment * Better docs * typos * typo * fixes * casting * Code review * Update meta_filter.ts * fix Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com> # Conflicts: # docs/development/plugins/data/public/kibana-plugin-plugins-data-public.castestokbnfieldtypename.md # docs/development/plugins/data/public/kibana-plugin-plugins-data-public.getkbntypenames.md # docs/development/plugins/data/public/kibana-plugin-plugins-data-public.md # docs/development/plugins/data/server/kibana-plugin-plugins-data-server.buildqueryfromfilters.md # docs/development/plugins/data/server/kibana-plugin-plugins-data-server.castestokbnfieldtypename.md # docs/development/plugins/data/server/kibana-plugin-plugins-data-server.esqueryconfig.md # docs/development/plugins/data/server/kibana-plugin-plugins-data-server.filter.md # docs/development/plugins/data/server/kibana-plugin-plugins-data-server.ifieldsubtype.md # docs/development/plugins/data/server/kibana-plugin-plugins-data-server.kuerynode.md # src/plugins/data/public/public.api.md

* Update SM doc for alert per object (#107420) Update stack monitoring doc to account for alert notification now being send for each node, index, or cluster based on the rule type, instead of always per cluster (PR# 102544) * [Data] Cleanup filter docs (#107169) * Move more utils to package and cleanup API * docs and imports * better imports * change comment * Better docs * typos * typo * fixes * casting * Code review * Update meta_filter.ts * fix Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com> # Conflicts: # docs/development/plugins/data/public/kibana-plugin-plugins-data-public.castestokbnfieldtypename.md # docs/development/plugins/data/public/kibana-plugin-plugins-data-public.getkbntypenames.md # docs/development/plugins/data/public/kibana-plugin-plugins-data-public.md # docs/development/plugins/data/server/kibana-plugin-plugins-data-server.buildqueryfromfilters.md # docs/development/plugins/data/server/kibana-plugin-plugins-data-server.castestokbnfieldtypename.md # docs/development/plugins/data/server/kibana-plugin-plugins-data-server.esqueryconfig.md # docs/development/plugins/data/server/kibana-plugin-plugins-data-server.filter.md # docs/development/plugins/data/server/kibana-plugin-plugins-data-server.ifieldsubtype.md # docs/development/plugins/data/server/kibana-plugin-plugins-data-server.kuerynode.md # src/plugins/data/public/public.api.md * doc Co-authored-by: Ravi Kesarwani <64450378+ravikesarwani@users.noreply.github.com> Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>

* Move more utils to package and cleanup API * docs and imports * better imports * change comment * Better docs * typos * typo * fixes * casting * Code review * Update meta_filter.ts * fix Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>

Liza K and others added 10 commits July 22, 2021 18:13

Move more utils to package and cleanup API

670249f

docs and imports

838b131

Merge branch 'master' of github.com:elastic/kibana into data-cleanup/…

5219bf9

…filters

Merge branch 'master' into data-cleanup/filters

05d29a7

better imports

3dfa3a7

Merge branch 'master' of github.com:elastic/kibana into data-cleanup/…

6ccf17b

…filters

change comment

f6f4f4b

Merge branch 'data-cleanup/filters' of github.com:lizozom/kibana into…

e70cefc

… data-cleanup/filters

Merge branch 'master' of github.com:elastic/kibana into data-cleanup/…

5bd24f4

…filter-docs

Better docs

adf8a0b

lizozom self-assigned this Jul 29, 2021

lizozom requested review from a team as code owners July 29, 2021 14:22

lizozom added release_note:skip Skip the PR/issue when compiling release notes Team:AppServices v7.15.0 v8.0.0 labels Jul 29, 2021

lizozom added the docs label Jul 29, 2021

Liza K added 2 commits July 29, 2021 16:36

typos

cf9d0eb

typo

1ddf909

lizozom added the auto-backport Deprecated - use backport:version if exact versions are needed label Jul 29, 2021

Liza K added 2 commits July 29, 2021 16:56

Merge branch 'master' of github.com:elastic/kibana into data-cleanup/…

2bf7167

…filter-docs

fixes

6250216

Bamieh approved these changes Jul 29, 2021

View reviewed changes

casting

f0b0042

tsullivan reviewed Jul 29, 2021

View reviewed changes

tsullivan approved these changes Jul 29, 2021

View reviewed changes

Liza K added 2 commits August 1, 2021 14:21

Merge branch 'master' of github.com:elastic/kibana into data-cleanup/…

34abf16

…filter-docs

Code review

466e46c

Update meta_filter.ts

2b76196

lizozom mentioned this pull request Aug 1, 2021

[Data] Align deprecation messages #107175

Merged

9 tasks

kibanamachine and others added 2 commits August 1, 2021 09:22

Merge branch 'master' into data-cleanup/filter-docs

0231562

fix

b8ec67a

lizozom merged commit c048f71 into elastic:master Aug 2, 2021

kibanamachine added the backport missing Added to PRs automatically when the are determined to be missing a backport. label Aug 4, 2021

lizozom mentioned this pull request Aug 6, 2021

[7.x] [Data] Cleanup filter docs (#107169) #107834

Merged

kibanamachine removed the backport missing Added to PRs automatically when the are determined to be missing a backport. label Aug 7, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Data] Cleanup filter docs #107169

[Data] Cleanup filter docs #107169

lizozom commented Jul 29, 2021

elasticmachine commented Jul 29, 2021

Bamieh left a comment

tsullivan Jul 29, 2021 •

edited

Loading

lizozom Aug 1, 2021

tsullivan left a comment

lizozom commented Aug 1, 2021

kibanamachine commented Aug 1, 2021

API count missing comments

API count with any type

kibanamachine commented Aug 4, 2021

kibanamachine commented Aug 5, 2021

kibanamachine commented Aug 6, 2021

[Data] Cleanup filter docs #107169

[Data] Cleanup filter docs #107169

Conversation

lizozom commented Jul 29, 2021

Summary

Checklist

Risk Matrix

For maintainers

elasticmachine commented Jul 29, 2021

Bamieh left a comment

Choose a reason for hiding this comment

tsullivan Jul 29, 2021 • edited Loading

Choose a reason for hiding this comment

lizozom Aug 1, 2021

Choose a reason for hiding this comment

tsullivan left a comment

Choose a reason for hiding this comment

lizozom commented Aug 1, 2021

kibanamachine commented Aug 1, 2021

💚 Build Succeeded

Metrics [docs]

Async chunks

Page load bundle

API count missing comments

API count with any type

History

kibanamachine commented Aug 4, 2021

kibanamachine commented Aug 5, 2021

kibanamachine commented Aug 6, 2021

tsullivan Jul 29, 2021 •

edited

Loading