Scopes: Adapt for new API

[bfmatei]

What is this feature?

The Scopes API moved to a node-based approach. This PR brings compatibility for the UI to use that client.

Why do we need this feature?

Implement Scopes?

Who is this feature for?

Which issue(s) does this PR fix?:

Special notes for your reviewer:

• Video:

Screen.Recording.2024-05-16.at.11.54.39.mov

Please check that:

• It works as expected from a user's perspective.
• If this is a pre-GA feature, it is behind a feature toggle.
• The docs are updated, and if this is a notable improvement, it's added to our What's New doc.

[grafanabot]

❌ Failed to run Playwright plugin e2e tests.

Click here to browse the Playwright report and trace viewer.
For information on how to run Playwright tests locally, refer to the Developer guide.

[dprokop]

@bfmatei - the overall flow works good I think, and API adjustments are fine.

However, I have concerns about the UX, on top of the comments that I've left:

1. Any change in the scope selector (selecting a scope) results in new queries. I think we may want to defer that until the scopes selector is closed.
2. Would love the entire scope selector row to be clickable rather than the checkbox only.
3. I miss some placeholder on the empty scope selector, currently it's just an empty input.

Would be also good if we added some tests for the tree navigation UI to make sure we are not breaking anything in the future.

[grafana-pr-automation]

⚠️   Possible breaking changes (md version)   ⚠️

grafana-data

Removals

DataQueryRequest.scope
_{/home/runner/work/grafana/grafana/base/grafana-data/dist/index.d.ts}

scope?: Scope | undefined;

Changes

CustomVariableSupport.query
_{/home/runner/work/grafana/grafana/pr/grafana-data/dist/index.d.ts}

Parameter type changed:
     endTime?: number;
     liveStreaming?: boolean;
     hideFromInspector?: boolean;
     queryGroupId?: string;
-    scope?: Scope | undefined;
+    scopes?: Scope[] | undefined;
 }

DataSourceApi.query

_{/home/runner/work/grafana/grafana/pr/grafana-data/dist/index.d.ts}

Parameter type changed:
     endTime?: number;
     liveStreaming?: boolean;
     hideFromInspector?: boolean;
     queryGroupId?: string;
-    scope?: Scope | undefined;
+    scopes?: Scope[] | undefined;
 }

DataSourceWithSupplementaryQueriesSupport.getDataProvider

_{/home/runner/work/grafana/grafana/pr/grafana-data/dist/index.d.ts}

Parameter type changed:
     endTime?: number;
     liveStreaming?: boolean;
     hideFromInspector?: boolean;
     queryGroupId?: string;
-    scope?: Scope | undefined;
+    scopes?: Scope[] | undefined;
 }

DataSourceWithSupplementaryQueriesSupport.getSupplementaryRequest

_{/home/runner/work/grafana/grafana/pr/grafana-data/dist/index.d.ts}

Parameter type changed:
     endTime?: number;
     liveStreaming?: boolean;
     hideFromInspector?: boolean;
     queryGroupId?: string;
-    scope?: Scope | undefined;
+    scopes?: Scope[] | undefined;
 }

StandardVariableSupport.query

_{/home/runner/work/grafana/grafana/pr/grafana-data/dist/index.d.ts}

Parameter type changed:
     endTime?: number;
     liveStreaming?: boolean;
     hideFromInspector?: boolean;
     queryGroupId?: string;
-    scope?: Scope | undefined;
+    scopes?: Scope[] | undefined;
 }

grafana-prometheus

Removals

Prometheus.scope

_{/home/runner/work/grafana/grafana/base/grafana-prometheus/dist/index.d.ts}

scope?: ScopeSpec;

Read our guideline
Console output