fix(dependency_resolution): Dashboard-Share-Settings can no longer be referenced from dashboards. #1614
Conversation
This file contains 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
Laubi
commented
Oct 24, 2024
Laubi
added
the
release-notes
E2E Test Results 4 files - 1 268 suites - 133 26m 58s ⏱️ - 40m 41s Results for commit ce27955. ± Comparison against base commit 2298653. This pull request removes 2 and adds 2 tests. Note that renamed tests count towards both.♻️ This comment has been updated with latest results. |
Laubi
force-pushed
the
fix/dashboard-share-settings-can-not-be-referenced
branch
from
1ba5f2d
to
ce27955
Compare
Laubi
added
run-e2e-test
Laubi
force-pushed
the
fix/dashboard-share-settings-can-not-be-referenced
branch
from
ce27955
to
139edc0
Compare
… referenced from dashboards. Dashboard share settings are a bit special. One dashboard always has exactly 1 dashbaord share setting connected to it. This share setting has the same ID as the dashboard itself. This is were the issues arise. Dashboards can't depend on other dashboards, as we ignore those references. They are usually only included in the markdown of the tiles, not the dashboards themselves. Since the dashboard share settings have the same ID as the dashboards, what means that instead of ignoring dashboard->dashboard references, we get unwanted dashboard->dashboard-share-settings references. What is more, the references are not within the same config, but some random dashboards can suddenly depend on the dashboard-share-settings. Since dashboard-share settings do depend on their parent dashboard, it can happen that we suddenly introduce unwanted cyclic dependencies. This fix ignores dashboard-share-settings completely as nothing can actually reference them.
Laubi
force-pushed
the
fix/dashboard-share-settings-can-not-be-referenced
branch
from
139edc0
to
4e643dc
Compare
|
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.
What this PR does / Why we need it:
Dashboard share settings are a bit special. One dashboard always has exactly 1 dashboard-share config connected to it. This share setting has the same ID as the dashboard itself. This is where the issues arise.
Dashboards can't depend on other dashboards, as we ignore those references. The references are usually only included in the markdown of the tiles, not the dashboards themselves. Since the dashboard share settings have the same ID as the dashboards, what means that instead of ignoring
dashboard->dashboardreferences, we get unwanteddashboard->dashboard-share-settingreferences. What is more, the references are not within the same config, but some random dashboards can suddenly depend on the dashboard-share-settings.Since dashboard-share settings do depend on their parent dashboard, it can happen that we suddenly introduce cyclic dependencies where there are actually none.
This fix ignores
dashboard-share-settingscompletely as nothing can actually reference them. They just exist as the children ofdashboards.Special notes for your reviewer:
Changeset contains a small refactoring in extracting common code to
shared.goDoes this PR introduce a user-facing change?
Yes, users will have a more stable experiencing when downloading/uploading dynatrace environments