[Data views] Implement persistable state #132959

lukasolson · 2022-05-25T17:37:29Z

Summary

Implements the PersistableState interface for data views. Currently these are a no-op, but this could change in the future.

As PersistableState interface requires Serializable to be implemented, I needed to update some of the types from DataViewSpec to properly implement Serializable. For many types, this was simply a matter of converting from an interface to a type.

Checklist

Unit or functional tests were updated or added to match the most common scenarios

For maintainers

This was checked for breaking API changes and was labeled appropriately

elasticmachine · 2022-05-25T17:37:31Z

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

src/plugins/data_views/common/data_views/persistable_state.test.ts

lukasolson

Need to add to data view service as well.

ppisljar · 2022-05-30T07:39:02Z

src/plugins/data_views/common/data_views/persistable_state.ts

+import { PersistableStateService } from '@kbn/kibana-utils-plugin/common';
+
+export const DataViewPersistableStateService: PersistableStateService<DataViewBaseSerializable> = {
+  inject: (state, references) => {


As data view spec can contain fields we should call field methods inside each of this.

cc @mattkime @sixstringcode if we don't plan to work on local runtime fields (if local data views can satisfy that requirement for some time) then we don't need to implement persistable state interface for fields.

I believe from my conversation with @mattkime that this is still up in the air, so I'll remove the implementation for fields from this PR.

lukasolson · 2022-06-02T21:02:26Z

packages/kbn-es-query/src/es_query/types.ts

@@ -34,7 +36,8 @@ export interface IFieldSubTypeNested {
 * A base interface for an index pattern field
 * @public
 */
-export interface DataViewFieldBase {
+// eslint-disable-next-line @typescript-eslint/consistent-type-definitions
+export type DataViewFieldBase = {


These changes are necessary for DataViewFieldBase to meet the SerializableRecord definition, which is necessary for implementing persistable state. I could also do export interface DataViewFieldBase extends SerializableRecord but that add unnamed properties to the DataViewFieldBase spec.

darnautov

ML changes LGTM

flash1293

VisEditors type changes LGTM

Dosant

FF changes lgtm 👍

ppisljar

LGTM

lukasolson · 2022-06-06T17:05:08Z

@elasticmachine merge upstream

kibana-ci · 2022-06-06T18:09:06Z

💚 Build Succeeded

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
`@kbn/es-query`	168	162	-6
`data`	2522	2520	-2
`dataViews`	187	184	-3
`fieldFormats`	251	245	-6
total			-17

Async chunks

Total size of all lazy-loaded chunks that will be downloaded as the user navigates the app

id	before	after	diff
`dataViewFieldEditor`	147.9KB	148.0KB	+30.0B
`lens`	1.2MB	1.2MB	+2.0B
total			+32.0B

Page load bundle

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

id	before	after	diff
`data`	424.6KB	424.7KB	+24.0B

Unknown metric groups

API count

id	before	after	diff
`@kbn/es-query`	222	213	-9
`data`	3431	3398	-33
`dataViews`	987	914	-73
`fieldFormats`	290	284	-6
total			-121

ESLint disabled line counts

id	before	after	diff
`@kbn/es-query`	4	8	+4
`dataViews`	4	10	+6
`fieldFormats`	3	5	+2
total			+12

Total ESLint disabled count

id	before	after	diff
`@kbn/es-query`	5	9	+4
`dataViews`	6	12	+6
`fieldFormats`	3	5	+2
total			+12

History

💚 Build #48983 succeeded 6dc21c5
💔 Build #48976 failed 0f0347e
💔 Build #48973 failed 9501327
💔 Build #48960 failed 92fa1b8
💔 Build #48955 failed b138f14
💔 Build #48953 failed ece074f

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

cc @lukasolson

shahzad31

Uptime code owner changes LGTM !!

kibanamachine · 2022-06-09T16:46:19Z

Friendly reminder: Looks like this PR hasn’t been backported yet.
To create automatically backports add the label auto-backport or prevent reminders by adding the backport:skip label.
You can also create backports manually by running node scripts/backport --pr 132959 locally

kibanamachine · 2022-06-10T16:56:18Z

Friendly reminder: Looks like this PR hasn’t been backported yet.
To create automatically backports add the label auto-backport or prevent reminders by adding the backport:skip label.
You can also create backports manually by running node scripts/backport --pr 132959 locally

kibanamachine · 2022-06-13T17:06:18Z

Friendly reminder: Looks like this PR hasn’t been backported yet.
To create automatically backports add the label auto-backport or prevent reminders by adding the backport:skip label.
You can also create backports manually by running node scripts/backport --pr 132959 locally

bhavyarm · 2022-08-17T21:00:04Z

@lukasolson how do I make sure this is working fine? Thanks!

lukasolson added 4 commits May 10, 2022 12:47

Tmp commit

d16a7da

Merge branch 'main' into data-views/persistable-state

69317b3

Use serializable version

d2d36e2

Update tests

cf34478

lukasolson added Feature:Data Views Data Views code and UI - index patterns before 8.0 Team:AppServicesSv release_note:skip Skip the PR/issue when compiling release notes labels May 25, 2022

lukasolson requested review from mattkime and ppisljar May 25, 2022 17:37

lukasolson requested a review from a team as a code owner May 25, 2022 17:37

lukasolson self-assigned this May 25, 2022

Add test for fields

8ac389a

lukasolson commented May 25, 2022

View reviewed changes

src/plugins/data_views/common/data_views/persistable_state.test.ts Outdated Show resolved Hide resolved

lukasolson commented May 26, 2022

View reviewed changes

ppisljar reviewed May 30, 2022

View reviewed changes

lukasolson added 3 commits May 31, 2022 12:20

Merge branch 'main' into data-views/persistable-state

5b0425d

Merge branch 'main' into data-views/persistable-state

8672c12

Use spec instead of base

ece074f

lukasolson requested a review from a team as a code owner June 2, 2022 20:43

lukasolson added v9.0.0 v8.4.0 labels Jun 2, 2022

lukasolson requested a review from Dosant June 2, 2022 20:45

Update types

b138f14

lukasolson commented Jun 2, 2022

View reviewed changes

lukasolson added 2 commits June 2, 2022 14:14

Fix type errors

92fa1b8

Fix tests & types

9501327

lukasolson requested a review from a team as a code owner June 2, 2022 23:10

Update types

0f0347e

lukasolson requested a review from a team as a code owner June 2, 2022 23:53

Fix lint

6dc21c5

darnautov approved these changes Jun 3, 2022

View reviewed changes

flash1293 approved these changes Jun 3, 2022

View reviewed changes

Dosant approved these changes Jun 3, 2022

View reviewed changes

lukasolson requested a review from ppisljar June 3, 2022 18:04

ppisljar approved these changes Jun 6, 2022

View reviewed changes

Merge branch 'main' into data-views/persistable-state

afcc9c7

kibanamachine requested a review from a team as a code owner June 6, 2022 17:05

shahzad31 approved these changes Jun 7, 2022

View reviewed changes

lukasolson merged commit 6a7ad6f into elastic:main Jun 7, 2022

justinkambic mentioned this pull request Jun 7, 2022

[Exploratory View] Re-introduce required id types for FormatType #133812

Merged

kibanamachine added the backport missing Added to PRs automatically when the are determined to be missing a backport. label Jun 9, 2022

flash1293 removed the v9.0.0 label Jun 13, 2022

kibanamachine added backport:skip This commit does not require backporting and removed backport missing Added to PRs automatically when the are determined to be missing a backport. labels Jun 13, 2022

flash1293 removed the backport:skip This commit does not require backporting label Jun 13, 2022

kibanamachine added the backport:skip This commit does not require backporting label Jun 13, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Data views] Implement persistable state #132959

[Data views] Implement persistable state #132959

lukasolson commented May 25, 2022 •

edited

Loading

elasticmachine commented May 25, 2022

lukasolson left a comment

ppisljar May 30, 2022

lukasolson Jun 2, 2022

lukasolson Jun 2, 2022

darnautov left a comment

flash1293 left a comment

Dosant left a comment

ppisljar left a comment

lukasolson commented Jun 6, 2022

kibana-ci commented Jun 6, 2022

API count

ESLint disabled line counts

Total ESLint disabled count

shahzad31 left a comment

kibanamachine commented Jun 9, 2022

kibanamachine commented Jun 10, 2022

kibanamachine commented Jun 13, 2022

bhavyarm commented Aug 17, 2022

[Data views] Implement persistable state #132959

[Data views] Implement persistable state #132959

Conversation

lukasolson commented May 25, 2022 • edited Loading

Summary

Checklist

For maintainers

elasticmachine commented May 25, 2022

lukasolson left a comment

Choose a reason for hiding this comment

ppisljar May 30, 2022

Choose a reason for hiding this comment

lukasolson Jun 2, 2022

Choose a reason for hiding this comment

lukasolson Jun 2, 2022

Choose a reason for hiding this comment

darnautov left a comment

Choose a reason for hiding this comment

flash1293 left a comment

Choose a reason for hiding this comment

Dosant left a comment

Choose a reason for hiding this comment

ppisljar left a comment

Choose a reason for hiding this comment

lukasolson commented Jun 6, 2022

kibana-ci commented Jun 6, 2022

💚 Build Succeeded

Metrics [docs]

Public APIs missing comments

Async chunks

Page load bundle

API count

ESLint disabled line counts

Total ESLint disabled count

History

shahzad31 left a comment

Choose a reason for hiding this comment

kibanamachine commented Jun 9, 2022

kibanamachine commented Jun 10, 2022

kibanamachine commented Jun 13, 2022

bhavyarm commented Aug 17, 2022

lukasolson commented May 25, 2022 •

edited

Loading