Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[8.x] [embeddable] make presentation interface names consistent (#205279) #207881

Merged
merged 1 commit into from
Jan 22, 2025
Merged

[8.x] [embeddable] make presentation interface names consistent (#205279) #207881

merged 1 commit into from
Jan 22, 2025

Conversation

nreese
Copy link
Contributor

@nreese nreese commented Jan 22, 2025

Backport

This will backport the following commits from main to 8.x:

Questions ?

Please refer to the Backport tool documentation

Questions ?

Please refer to the Backport tool documentation

Questions ?

Please refer to the Backport tool documentation

Questions ?

Please refer to the Backport tool documentation

Questions ?

Please refer to the Backport tool documentation

Questions ?

Please refer to the Backport tool documentation

Questions ?

Please refer to the Backport tool documentation

Questions ?

Please refer to the Backport tool documentation

Questions ?

Please refer to the Backport tool documentation

Questions ?

Please refer to the Backport tool documentation

@nreese
[embeddable] make presentation interface names consistent (elastic#20…
e4b61f9 
…5279)

PR cleans up presentation interface names for consistentency
* adds `$` suffix to all observables. For example, `dataLoading` =>
`dataLoading$`
* removes `Panel` naming convention from interface names since an api
may not be a panel, an api may be a dashboard. For example,
`PublisesPanelTitle` => `PublishesTitle`

#### Note to Reviewers
Pay special attention to any place where your application creates an
untyped API. In the example below, there is no typescript violation when
the parent returns `dataLoading` instead of `dataLoading$` since the
parent is not typed as `PublishesDataLoading`. Please check for
instances like these.

```
<ReactEmbeddableRenderer
  getParentApi={() => {
    dataLoading: new BehaviorSubject()
  }}
/>
```

---------

Co-authored-by: Elastic Machine <[email protected]>
Co-authored-by: kibanamachine <[email protected]>
(cherry picked from commit 0591605)

# Conflicts:
#	x-pack/platform/plugins/shared/lens/public/react_embeddable/renderer/lens_custom_renderer_component.tsx
@nreese nreese requested a review from kibanamachine as a code owner January 22, 2025 16:58
@nreese nreese enabled auto-merge (squash) January 22, 2025 16:58
@nreese nreese mentioned this pull request Jan 22, 2025
Merged
@botelastic botelastic bot added Feature:Drilldowns Embeddable panel Drilldowns Feature:Embedding Embedding content via iFrame Team:obs-ux-infra_services Observability Infrastructure & Services User Experience Team Team:obs-ux-management Observability Management User Experience Team labels Jan 22, 2025
@elasticmachine
Copy link
Contributor

Pinging @elastic/obs-ux-infra_services-team (Team:obs-ux-infra_services)

@elasticmachine
Copy link
Contributor

Pinging @elastic/obs-ux-management-team (Team:obs-ux-management)

@nreese nreese merged commit c39e129 into elastic:8.x Jan 22, 2025
19 checks passed
@elasticmachine
Copy link
Contributor

💛 Build succeeded, but was flaky

Failed CI Steps

Test Failures

  • [job] [logs] FTR Configs #26 / alerting api integration security and spaces enabled - Group 2 Alerting and Actions Telemetry test telemetry should retrieve telemetry data in the expected format

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/presentation-publishing 204 205 +1

Async chunks

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

id before after diff
aiops 610.5KB 604.8KB -5.8KB
apm 2.6MB 2.6MB -110.0B
canvas 1.0MB 1.0MB +1.0B
cases 540.2KB 540.2KB +2.0B
controls 474.2KB 474.2KB -2.0B
dashboard 603.9KB 603.8KB -92.0B
dataVisualizer 598.6KB 598.5KB -76.0B
discover 818.6KB 818.5KB -53.0B
imageEmbeddable 65.3KB 65.2KB -62.0B
infra 1.7MB 1.7MB -27.0B
lens 1.5MB 1.5MB -57.0B
links 47.9KB 47.9KB -79.0B
maps 3.0MB 3.0MB -53.0B
ml 4.7MB 4.7MB -127.0B
presentationPanel 44.4KB 44.3KB -113.0B
securitySolution 18.5MB 18.5MB +1.0B
slo 851.3KB 851.2KB -150.0B
synthetics 905.7KB 905.6KB -97.0B
visualizations 327.4KB 327.4KB -33.0B
total -6.9KB

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
@kbn/presentation-publishing 6 5 -1

Page load bundle

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

id before after diff
aiops 17.1KB 17.1KB +13.0B
dashboardEnhanced 15.4KB 15.4KB -5.0B
discover 52.6KB 52.6KB +1.0B
discoverEnhanced 7.1KB 7.1KB +5.0B
embeddable 22.3KB 22.3KB +5.0B
infra 55.9KB 55.9KB -43.0B
inputControlVis 8.1KB 8.1KB +5.0B
lens 50.2KB 50.2KB -48.0B
maps 51.8KB 51.8KB -60.0B
reporting 50.1KB 50.1KB +3.0B
urlDrilldown 17.5KB 17.5KB -2.0B
visualizations 62.6KB 62.5KB -48.0B
total -174.0B
Unknown metric groups

API count

id before after diff
@kbn/presentation-publishing 241 242 +1

async chunk count

id before after diff
aiops 39 37 -2

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ThomThomson ThomThomson ThomThomson approved these changes

@kibanamachine kibanamachine Awaiting requested review from kibanamachine kibanamachine is a code owner

Assignees
No one assigned
Labels
backport Feature:Drilldowns Embeddable panel Drilldowns Feature:Embedding Embedding content via iFrame Team:obs-ux-infra_services Observability Infrastructure & Services User Experience Team Team:obs-ux-management Observability Management User Experience Team
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@nreese @elasticmachine @ThomThomson