[Data] Align deprecation messages #107175

lizozom · 2021-07-29T14:54:41Z

Summary

Depends on #107169

Align deprecation messages with #106973

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:54:44Z

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

…filter-docs

Dosant

LGTM. thanks for aligning!

Dosant · 2021-07-30T14:25:06Z

src/plugins/data/common/index_patterns/fields/types.ts

@@ -9,8 +9,8 @@ import { IndexPatternFieldBase } from '@kbn/es-query';
 import { FieldSpec, IndexPattern } from '../..';

 /**
- * @deprecated
- * Use IndexPatternField or FieldSpec instead
+ * @deprecated Use `IndexPatternField` or `FieldSpec` instead


I think if to use {@link IndexPatternField} in such cases, then it will nicely popup as a link in docs

…filter-docs

…ages

…filter-messages

kibanamachine · 2021-08-02T18:02:13Z

💚 Build Succeeded

Metrics [docs]

Unknown metric groups

API count

id	before	after	diff
`data`	3944	3978	+34

API count missing comments

id	before	after	diff
`data`	3396	3425	+29

History

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

cc @lizozom

kibanamachine · 2021-08-03T07:21:31Z

💔 Backport failed

Status	Branch	Result
❌	7.x	Commit could not be cherrypicked due to conflicts

To backport manually run:
node scripts/backport --pr 107175

* Move more utils to package and cleanup API * docs and imports * better imports * change comment * Better docs * typos * typo * Align deprecation messages * fixes * casting * Code review * Update meta_filter.ts * Update types.ts * Deprecate by 8.1 Co-authored-by: Kibana Machine <[email protected]> # Conflicts: # docs/development/plugins/data/server/kibana-plugin-plugins-data-server.buildqueryfromfilters.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/server/server.api.md

* Move more utils to package and cleanup API * docs and imports * better imports * change comment * Better docs * typos * typo * Align deprecation messages * fixes * casting * Code review * Update meta_filter.ts * Update types.ts * Deprecate by 8.1 Co-authored-by: Kibana Machine <[email protected]>

clintandrewhall · 2021-08-13T03:22:08Z

src/plugins/data/public/deprecated.ts

 */
 const convertRangeFilterToTimeRangeString = oldConvertRangeFilterToTimeRangeString;

 /**
 * Filter helpers namespace:
- * @deprecated Please import helpers from the package kbn/es-query directly. This import will be removed in v8.0.0.
+ * @deprecated Import helpers from the "@kbn/es-query" package directly instead.
+ * @removeBy 8.1
 */
 export const esFilters = {


@lizozom I'm getting this deprecation warning in a WIP branch, but this constant does not exist in @kbn/es-query... is this known/forthcoming?

Liza K and others added 13 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

typos

cf9d0eb

typo

1ddf909

Align deprecation messages

454efff

lizozom added v8.0.0 Team:AppServices release_note:skip Skip the PR/issue when compiling release notes docs auto-backport Deprecated - use backport:version if exact versions are needed v7.15.0 labels Jul 29, 2021

lizozom self-assigned this Jul 29, 2021

lizozom requested a review from a team as a code owner July 29, 2021 14:54

lizozom mentioned this pull request Jul 29, 2021

[data] Extract @kbn/field-types to a package #106973

Merged

1 task

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

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

2bf7167

…filter-docs

fixes

6250216

casting

f0b0042

Dosant approved these changes Jul 30, 2021

View reviewed changes

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

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

34abf16

…filter-docs

Code review

466e46c

Merge branch 'data-cleanup/filter-docs' into data-cleanup/filter-mess…

1d2e051

…ages

lizozom requested a review from a team as a code owner August 1, 2021 13:06

mshustov approved these changes Aug 1, 2021

View reviewed changes

Liza K and others added 5 commits August 2, 2021 12:32

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

8d24947

…filter-messages

Update meta_filter.ts

2114873

Update types.ts

0a2a35a

944440d

Deprecate by 8.1

e5d1fde

lizozom merged commit 7af1ec2 into elastic:master Aug 3, 2021

lizozom mentioned this pull request Aug 3, 2021

[7.x] [Data] Align deprecation messages (#107175) #107562

Merged

clintandrewhall reviewed Aug 13, 2021

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Data] Align deprecation messages #107175

[Data] Align deprecation messages #107175

lizozom commented Jul 29, 2021 •

edited

Loading

elasticmachine commented Jul 29, 2021

Dosant left a comment

Dosant Jul 30, 2021

kibanamachine commented Aug 2, 2021

API count

API count missing comments

kibanamachine commented Aug 3, 2021

clintandrewhall Aug 13, 2021

[Data] Align deprecation messages #107175

[Data] Align deprecation messages #107175

Conversation

lizozom commented Jul 29, 2021 • edited Loading

Summary

Checklist

Risk Matrix

For maintainers

elasticmachine commented Jul 29, 2021

Dosant left a comment

Choose a reason for hiding this comment

Dosant Jul 30, 2021

Choose a reason for hiding this comment

kibanamachine commented Aug 2, 2021

💚 Build Succeeded

Metrics [docs]

API count

API count missing comments

History

kibanamachine commented Aug 3, 2021

💔 Backport failed

clintandrewhall Aug 13, 2021

Choose a reason for hiding this comment

lizozom commented Jul 29, 2021 •

edited

Loading