Fix dashboard deployment/creation #230
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
This PR breaks backwards compatibility for databrickslabs/ucx downstream. See build logs for more details. Running from downstreams #320 |
JCZuurmond
commented
Jul 19, 2024
|
|
||
| def deploy_dashboard(self, dashboard: Dashboard, **kwargs) -> SDKDashboard: | ||
| """Legacy method use :meth:create_dashboard instead.""" | ||
| warnings.warn("Deprecated method use `create_dashboard` instead.", category=DeprecationWarning) |
Contributor
Author
There was a problem hiding this comment.
To use the DashboardMetadata.validate on the before dashboard creation, the signature is updated to expect DashboardMetadata instead of Dashboard. For backwards capability, the deploy_dashboard signature is unchanged, but intended to be deprecated. The implementation below creates the DashboardMetadata from the Dashboard through saving the dashboard to a temporary folder.
@nfx: Do you want to add a date to the deprecation warning?
Collaborator
There was a problem hiding this comment.
one transition version is fine
|
✅ 35/35 passed, 2 skipped, 8m45s total Running from acceptance #324 |
JCZuurmond
commented
Jul 19, 2024
| assert ws.lakeview.get(sdk_dashboard.dashboard_id) | ||
|
|
||
|
|
||
| def test_dashboards_deploys_dashboard_with_invalid_query(ws, make_dashboard, tmp_path): |
Contributor
Author
There was a problem hiding this comment.
Removed as we want the dashboard creation with an invalid query to fail
nfx
approved these changes
Jul 22, 2024
|
|
||
| def deploy_dashboard(self, dashboard: Dashboard, **kwargs) -> SDKDashboard: | ||
| """Legacy method use :meth:create_dashboard instead.""" | ||
| warnings.warn("Deprecated method use `create_dashboard` instead.", category=DeprecationWarning) |
Collaborator
There was a problem hiding this comment.
one transition version is fine
nfx
added a commit
that referenced
this pull request
Jul 22, 2024
* Fixed dashboard deployment/creation ([#230](#230)). The recent changes to our open-source library address issues related to dashboard deployment and creation, enhancing their reliability and consistency. The `deploy_dashboard` function has been deprecated in favor of the more accurate `create_dashboard` function, which now includes a `publish` flag. A `validate` method has been added to the `Tile`, `MarkdownTile`, and `QueryTile` classes to raise an error if the dashboard is invalid. The `test_dashboards.py` file has been updated to reflect these changes. These enhancements address issues [#222](#222), [#229](#229), and partially resolve [#220](#220). The commit includes an image of a dashboard created through the deprecated `deploy_dashboard` method. These improvements ensure better dashboard creation, validation, and deployment, while also maintaining backward compatibility through the deprecation of `deploy_dashboard`.
Merged
nfx
added a commit
that referenced
this pull request
Jul 22, 2024
* Fixed dashboard deployment/creation ([#230](#230)). The recent changes to our open-source library address issues related to dashboard deployment and creation, enhancing their reliability and consistency. The `deploy_dashboard` function has been deprecated in favor of the more accurate `create_dashboard` function, which now includes a `publish` flag. A `validate` method has been added to the `Tile`, `MarkdownTile`, and `QueryTile` classes to raise an error if the dashboard is invalid. The `test_dashboards.py` file has been updated to reflect these changes. These enhancements address issues [#222](#222), [#229](#229), and partially resolve [#220](#220). The commit includes an image of a dashboard created through the deprecated `deploy_dashboard` method. These improvements ensure better dashboard creation, validation, and deployment, while also maintaining backward compatibility through the deprecation of `deploy_dashboard`.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes the dashboard deployment by:
deploy_dashboardfor thecreate_dashboardas this is more accurate and available after refactoring Lakeview dashboard creation to be part ofDashboardMetadatapublishflag tocreate_dashboardRelated issues
save_to_folderdoes not persist markdown tiles #229Below the dashboard created through the deprecated
deploy_dashboard: