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

[Canvas] Routes must satisfy bwca #157101

Closed
13 tasks done
thomasneirynck opened this issue May 8, 2023 · 1 comment · Fixed by #159426
Closed
13 tasks done

[Canvas] Routes must satisfy bwca #157101

thomasneirynck opened this issue May 8, 2023 · 1 comment · Fixed by #159426
Assignees
@cqliu1
Labels
chore Feature:Canvas impact:high Addressing this issue will have a high level of impact on the quality/strength of our product. loe:large Large Level of Effort Team:Presentation Presentation Team for Dashboard, Input Controls, and Canvas

Comments

@thomasneirynck
Copy link
Contributor

thomasneirynck commented May 8, 2023 •
edited by cqliu1
Loading

Routes must be backward compliant.

  • - [ ] /public/canvas/zip
  • /api/canvas/custom-element/**
  • /api/canvas/es_fields
  • /api/canvas/fns/
  • /api/canvas/templates
  • /api/canvas/workpad
  • /api/canvas/workpad-assets
  • /api/canvas/workpad-structures
  • /api/canvas/workpad
  • /api/canvas/workpad/{id}
  • /api/canvas/workpad/find
  • /api/canvas/workpad/import
  • /api/canvas/workpad/resolve/{id}

*note: we may decide not to migrate these routes due to Canvas not getting actively developed. If so, will record decision here.

Part of #157046
@botelastic botelastic bot added the needs-team Issues missing a team label label May 8, 2023
@thomasneirynck thomasneirynck added Team:Presentation Presentation Team for Dashboard, Input Controls, and Canvas and removed needs-team Issues missing a team label labels May 8, 2023
@elasticmachine
Copy link
Contributor

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

@ThomThomson ThomThomson added loe:large Large Level of Effort impact:high Addressing this issue will have a high level of impact on the quality/strength of our product. Feature:Canvas labels May 9, 2023
@cqliu1 cqliu1 mentioned this issue Jun 9, 2023
Merged
9 tasks
cqliu1 added a commit that referenced this issue Jun 20, 2023
@cqliu1
[Canvas] Versioned and internal routes (#159426)
5ec3a27 
## Summary

Closes #157101 and #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.

- [ ] Any text added follows [EUI's writing
guidelines](https://elastic.github.io/eui/#/guidelines/writing), uses
sentence case text and includes [i18n
support](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md)
- [ ]
[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)
was added for features that require explanation or tutorials
- [ ] [Unit or functional
tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)
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](https://webaim.org/techniques/keyboard/))
- [ ] Any UI touched in this PR does not create any new axe failures
(run axe in browser:
[FF](https://addons.mozilla.org/en-US/firefox/addon/axe-devtools/),
[Chrome](https://chrome.google.com/webstore/detail/axe-web-accessibility-tes/lhdoppojpmngadmnindnejefpokejbdd?hl=en-US))
- [ ] If a plugin configuration key changed, check if it needs to be
allowlisted in the cloud and added to the [docker
list](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker)
- [ ] This renders correctly on smaller devices using a responsive
layout. (You can test this [in your
browser](https://www.browserstack.com/guide/responsive-testing-on-local-server))
- [ ] This was checked for [cross-browser
compatibility](https://www.elastic.co/support/matrix#matrix_browsers)


### 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](https://github.com/elastic/kibana/blob/main/RISK_MATRIX.mdx) |


### For maintainers

- [ ] This was checked for breaking API changes and was [labeled
appropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@cqliu1 cqliu1

Labels
chore Feature:Canvas impact:high Addressing this issue will have a high level of impact on the quality/strength of our product. loe:large Large Level of Effort Team:Presentation Presentation Team for Dashboard, Input Controls, and Canvas
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

[Canvas] Versioned and internal routes cqliu1/kibana
4 participants
@cqliu1 @thomasneirynck @ThomThomson @elasticmachine