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.

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

[Canvas] Versioned and internal routes #159426

Merged
merged 7 commits into from
Jun 20, 2023

Conversation

cqliu1
Copy link
Contributor

@cqliu1 cqliu1 commented Jun 9, 2023

Summary

Closes #157101.
Closes #157083.

This refactors all Canvas routes to use the versioned router for BWC and makes access for all routes internal only. I also removed the es_fields routes because the last usage of that route was removed in #139610.

All routes have been changed from /api/canvas/* to /internal/canvas/*.

Checklist

Delete any items that are not applicable to this PR.

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

@cqliu1 cqliu1 added Team:Presentation Presentation Team for Dashboard, Input Controls, and Canvas loe:medium Medium Level of Effort release_note:skip Skip the PR/issue when compiling release notes impact:critical This issue should be addressed immediately due to a critical level of impact on the product. Feature:Canvas v8.9.0 labels Jun 9, 2023
@cqliu1 cqliu1 force-pushed the canvas/internal-versioned-routes branch from 1a61918 to e684a98 Compare June 14, 2023 22:18
@cqliu1 cqliu1 marked this pull request as ready for review June 14, 2023 22:25
@cqliu1 cqliu1 requested a review from a team as a code owner June 14, 2023 22:25
@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-presentation (Team:Presentation)

@kibana-ci
Copy link
Collaborator

💚 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
canvas 993.2KB 993.4KB +161.0B

Page load bundle

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

id before after diff
canvas 13.3KB 13.3KB +19.0B
Unknown metric groups

ESLint disabled line counts

id before after diff
enterpriseSearch 13 15 +2
securitySolution 410 414 +4
total +6

References to deprecated APIs

id before after diff
canvas 134 128 -6

Total ESLint disabled count

id before after diff
enterpriseSearch 14 16 +2
securitySolution 493 497 +4
total +6

History

  • 💔 Build #134955 failed 1a619186121d61798ea03913c72a85fde2c2bf24
  • 💔 Build #134142 failed eec087b3feaa602b10aa521df68d445ebde58e5c
  • 💔 Build #134137 failed ea2ffd06691389871fa4ebbe7cd1e637ee1e895b

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

Copy link
Contributor

@ThomThomson ThomThomson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Deleted route & versioned router onboarding LGTM, all as expected. Code review only, as it seems to me that if any saved object loading was off in Canvas, many tests would fail!

@cqliu1 cqliu1 merged commit 5ec3a27 into elastic:main Jun 20, 2023
@kibanamachine kibanamachine added the backport:skip This commit does not require backporting label Jun 20, 2023
@cqliu1 cqliu1 deleted the canvas/internal-versioned-routes branch June 20, 2023 15:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport:skip This commit does not require backporting Feature:Canvas impact:critical This issue should be addressed immediately due to a critical level of impact on the product. loe:medium Medium Level of Effort release_note:skip Skip the PR/issue when compiling release notes Team:Presentation Presentation Team for Dashboard, Input Controls, and Canvas v8.9.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Canvas] Routes must satisfy bwca [Canvas] Move routes to internal
5 participants