fix(default datasource): update default data source resolution (#1771)

* fix(default datasource): update default data source resolution

* chore: before each

* chore: fix types

* chore: change default data source

* chore: rename constant

Author: matyax

provisioning/datasources/default.yaml

@@ -2,11 +2,11 @@ apiVersion: 1
 
 datasources:
   - name: gdev-testdata
-    isDefault: true
     type: testdata
   - name: gdev-loki
     type: loki
     uid: gdev-loki
+    isDefault: true
     access: proxy
     url: http://host.docker.internal:3100
     jsonData:

src/Components/IndexScene/IndexScene.tsx

@@ -133,7 +133,7 @@ import {
 } from 'services/variables';
 export const showLogsButtonSceneKey = 'showLogsButtonScene';
 
-const DEFAULT_LOGS_DATASOURCE_UID = 'grafanacloud-logs';
+const FALLBACK_DATASOURCE_UID = 'grafanacloud-logs';
 
 interface EmbeddedIndexSceneConstructor {
   datasourceUid?: string;
@@ -151,7 +151,7 @@ export class IndexScene extends SceneObjectBase<IndexSceneState> {
       jsonData?.dataSource ??
       getLastUsedDataSourceFromStorage() ??
       getDefaultDatasourceFromDatasourceSrv() ??
-      DEFAULT_LOGS_DATASOURCE_UID;
+      FALLBACK_DATASOURCE_UID;
 
     const { unsub, variablesScene } = getVariableSet(
       datasourceUid,

src/services/store.test.ts

@@ -0,0 +1,97 @@
+import { DataSourceInstanceSettings } from '@grafana/data';
+import { getDataSourceSrv } from '@grafana/runtime';
+
+import { getDefaultDatasourceFromDatasourceSrv } from './store';
+
+jest.mock('@grafana/runtime', () => ({
+  ...jest.requireActual('@grafana/runtime'),
+  getDataSourceSrv: jest.fn(),
+}));
+
+function makeDs(overrides: Partial<DataSourceInstanceSettings>): DataSourceInstanceSettings {
+  return {
+    uid: 'uid',
+    id: 1,
+    name: 'ds',
+    type: 'loki',
+    isDefault: false,
+    readOnly: false,
+    jsonData: {},
+    access: 'proxy',
+    ...overrides,
+  } as DataSourceInstanceSettings;
+}
+
+describe('getDefaultDatasourceFromDatasourceSrv', () => {
+  beforeEach(() => jest.clearAllMocks());
+
+  it('returns the data source marked as default when present', () => {
+    const defaultDs = makeDs({ uid: 'default-uid', name: 'Default Loki', isDefault: true });
+    const otherDs = makeDs({ uid: 'other-uid', name: 'grafanacloud-mystack-logs', isDefault: false });
+    jest.mocked(getDataSourceSrv).mockReturnValue({
+      getList: () => [otherDs, defaultDs],
+    } as any);
+
+    expect(getDefaultDatasourceFromDatasourceSrv()).toBe('default-uid');
+  });
+
+  it('prefers grafanacloud-*-logs by name when no default is set', () => {
+    const firstInList = makeDs({ uid: 'first-uid', name: 'Some Other Loki' });
+    const grafanacloudDs = makeDs({
+      uid: 'grafanacloud-dev-logs',
+      name: 'grafanacloud-dev-logs',
+      isDefault: false,
+    });
+    jest.mocked(getDataSourceSrv).mockReturnValue({
+      getList: () => [firstInList, grafanacloudDs],
+    } as any);
+
+    expect(getDefaultDatasourceFromDatasourceSrv()).toBe('grafanacloud-dev-logs');
+  });
+
+  it('prefers grafanacloud-*-logs by uid when name is different', () => {
+    const firstInList = makeDs({ uid: 'first-uid', name: 'First' });
+    const grafanacloudDs = makeDs({
+      uid: 'grafanacloud-prod-logs',
+      name: 'Grafana Cloud Logs (prod)',
+      isDefault: false,
+    });
+    jest.mocked(getDataSourceSrv).mockReturnValue({
+      getList: () => [firstInList, grafanacloudDs],
+    } as any);
+
+    expect(getDefaultDatasourceFromDatasourceSrv()).toBe('grafanacloud-prod-logs');
+  });
+
+  it('returns first in list when no default and no grafanacloud-*-logs match', () => {
+    const firstDs = makeDs({ uid: 'first-uid', name: 'First Loki' });
+    const secondDs = makeDs({ uid: 'second-uid', name: 'Second Loki' });
+    jest.mocked(getDataSourceSrv).mockReturnValue({
+      getList: () => [firstDs, secondDs],
+    } as any);
+
+    expect(getDefaultDatasourceFromDatasourceSrv()).toBe('first-uid');
+  });
+
+  it('returns undefined when Loki list is empty', () => {
+    jest.mocked(getDataSourceSrv).mockReturnValue({
+      getList: () => [],
+    } as any);
+
+    expect(getDefaultDatasourceFromDatasourceSrv()).toBeUndefined();
+  });
+
+  it('does not match grafanacloud-logs without stack name (single dash)', () => {
+    const exactName = makeDs({ uid: 'grafanacloud-logs', name: 'grafanacloud-logs', isDefault: false });
+    const withStack = makeDs({
+      uid: 'grafanacloud-mystack-logs',
+      name: 'grafanacloud-mystack-logs',
+      isDefault: false,
+    });
+    jest.mocked(getDataSourceSrv).mockReturnValue({
+      getList: () => [exactName, withStack],
+    } as any);
+
+    expect(getDefaultDatasourceFromDatasourceSrv()).toBe('grafanacloud-mystack-logs');
+  });
+});

src/services/store.ts

@@ -165,12 +165,27 @@ export function getLastUsedDataSourceFromStorage(): string | undefined {
   return localStorage.getItem(DS_LOCALSTORAGE_KEY) ?? undefined;
 }
 
+/**
+ * Matches Grafana Cloud Logs data source names/UIDs: grafanacloud-{stack}-logs
+ */
+const GRAFANACLOUD_LOGS_DS_PATTERN = /^grafanacloud-.+-logs$/;
+
 export function getDefaultDatasourceFromDatasourceSrv(): string | undefined {
   const dsList = getDataSourceSrv().getList({
     type: 'loki',
   });
-  const ds = dsList.find((ds) => ds.isDefault);
-  return ds?.uid ?? dsList?.[0]?.uid;
+  const defaultDs = dsList.find((ds) => ds.isDefault);
+  if (defaultDs?.uid) {
+    return defaultDs.uid;
+  }
+  const grafanacloudLogsDs = dsList.find(
+    (ds) =>
+      (ds.name && GRAFANACLOUD_LOGS_DS_PATTERN.test(ds.name)) || (ds.uid && GRAFANACLOUD_LOGS_DS_PATTERN.test(ds.uid))
+  );
+  if (grafanacloudLogsDs?.uid) {
+    return grafanacloudLogsDs.uid;
+  }
+  return dsList?.[0]?.uid;
 }
 
 export function addLastUsedDataSourceToStorage(dsKey: string) {