@grafana/plugin-e2e 3.0.0-canary.2093.18278023316.0 → 3.0.0-canary.2242.18774949404.0

package/dist/fixtures/page.js

@@ -1,11 +1,11 @@
 'use strict';
 
-var overrideFeatureToggles = require('./scripts/overrideFeatureToggles.js');
+var overrideGrafanaBootData = require('./scripts/overrideGrafanaBootData.js');
 
-const page = async ({ page: page2, featureToggles }, use) => {
-  if (Object.keys(featureToggles).length > 0) {
+const page = async ({ page: page2, featureToggles, userPreferences }, use) => {
+  if (Object.keys(featureToggles).length > 0 || Object.keys(userPreferences).length > 0) {
     try {
-      await page2.addInitScript(overrideFeatureToggles.overrideFeatureToggles, featureToggles);
+      await page2.addInitScript(overrideGrafanaBootData.overrideGrafanaBootData, { featureToggles, userPreferences });
     } catch (error) {
       console.error("Failed to set feature toggles", error);
     }

package/dist/fixtures/scripts/overrideGrafanaBootData.js

@@ -0,0 +1,30 @@
+'use strict';
+
+const overrideGrafanaBootData = ({ featureToggles, userPreferences }) => {
+  const timeout = 1;
+  const waitForGrafanaBootData = (cb) => {
+    if (window?.grafanaBootData?.user) {
+      cb();
+    } else {
+      setTimeout(() => waitForGrafanaBootData(cb), timeout);
+    }
+  };
+  waitForGrafanaBootData(() => {
+    if (Object.keys(featureToggles).length > 0) {
+      console.log("@grafana/plugin-e2e: setting the following feature toggles", featureToggles);
+      window.grafanaBootData.settings.featureToggles = {
+        ...window.grafanaBootData.settings.featureToggles,
+        ...featureToggles
+      };
+    }
+    if (Object.keys(userPreferences).length > 0) {
+      console.log("@grafana/plugin-e2e: setting the following user preferences", userPreferences);
+      window.grafanaBootData.user = {
+        ...window.grafanaBootData.user,
+        ...userPreferences
+      };
+    }
+  });
+};
+
+exports.overrideGrafanaBootData = overrideGrafanaBootData;

package/dist/index.d.ts

@@ -1,8 +1,8 @@
 import * as _playwright_test from '@playwright/test';
 import { Locator, Request, Response as Response$1, APIRequestContext, TestInfo, PlaywrightTestArgs, PlaywrightTestOptions, PlaywrightWorkerArgs, PlaywrightWorkerOptions, MatcherReturnType } from '@playwright/test';
 export { selectors } from '@playwright/test';
-import * as playwright_core from 'playwright-core';
 import { SelectorsOf, versionedPages, versionedComponents } from '@grafana/e2e-selectors';
+import * as playwright_core from 'playwright-core';
 
 /**
  * Base class for all Grafana pages.
@@ -57,6 +57,58 @@ declare class DataSourcePicker extends GrafanaPage {
     set(name: string): Promise<void>;
 }
 
+declare class AlertRuleQuery extends GrafanaPage {
+    readonly ctx: PluginTestCtx;
+    readonly locator: Locator;
+    datasource: DataSourcePicker;
+    constructor(ctx: PluginTestCtx, locator: Locator);
+    getByGrafanaSelector(selector: string, options?: getByGrafanaSelectorOptions): Locator;
+}
+
+declare class AlertRuleEditPage extends GrafanaPage {
+    readonly ctx: PluginTestCtx;
+    readonly args?: AlertRuleArgs | undefined;
+    constructor(ctx: PluginTestCtx, args?: AlertRuleArgs | undefined);
+    /**
+     * Navigates to the annotation edit page. If a dashboard uid was not provided, it's assumed that it's a new dashboard.
+     */
+    goto(options?: NavigateOptions): Promise<void>;
+    /**
+     * Returns a locator for hte alert rule name field
+     */
+    get alertRuleNameField(): _playwright_test.Locator;
+    get advancedModeSwitch(): _playwright_test.Locator;
+    isAdvancedModeSupported(): Promise<boolean>;
+    enableAdvancedQueryMode(): Promise<void>;
+    disableAdvancedQueryMode(): Promise<void>;
+    getQueryRow(refId?: string): Promise<AlertRuleQuery>;
+    /**
+     * @deprecated Use getQueryRow instead
+     * Returns an instance of the {@link AlertRuleQuery} class for a query in the query and expression step (step 2)
+     *
+     * @param refId is optional. If not provided, it will return query row with refId 'A' in Grafana versions <11.6.
+     * In Grafana versions >=11.6 where advanced mode is supported, it will return the default query if advanced mode
+     * is not enabled. If advanced mode is enabled, it will return the a query by refId.
+     */
+    getAlertRuleQueryRow(refId?: string): AlertRuleQuery;
+    /**
+     * Clicks the "Add query" button and returns an instance of the {@link AlertRuleQuery} class for the new query row.
+     *
+     * Since Grafana 11.6, this method is only available if advanced mode is enabled. Use enableQueryAdvancedMode() method to enable it.
+     */
+    clickAddQueryRow(): Promise<AlertRuleQuery>;
+    /**
+     * Clicks the evaluate button and waits for the evaluation to complete. If the evaluation is successful, the status code of the response is 200.
+     * If one or more queries are invalid, an error status code is returned.
+     *
+     * Note that this method intercepts the response of the alerting evaluation endpoint and returns the status code of the first failed query.
+     * This means that any mocks defined with page.route in your tests will be overriden.
+     *
+     * Only supported for Grafana version 9.5.0 ad later.
+     */
+    evaluate(options?: RequestOptions): Promise<_playwright_test.Response>;
+}
+
 declare class AnnotationEditPage extends GrafanaPage {
     readonly ctx: PluginTestCtx;
     readonly args: DashboardEditViewArgs<string>;
@@ -378,6 +430,17 @@ declare class ExplorePage extends GrafanaPage {
     runQuery(options?: RequestOptions): Promise<_playwright_test.Response>;
 }
 
+declare class GrafanaAPIClient {
+    private request;
+    constructor(request: APIRequestContext);
+    getUserIdByUsername(userName: string): Promise<any>;
+    createUser(user: User): Promise<void>;
+    getDataSourceSettingsByUID(uid: string): Promise<DataSourceSettings<{}, {}>>;
+    createDataSource(datasource: CreateDataSourceArgs, dsName: string): Promise<_playwright_test.APIResponse>;
+    getDataSourceByName(name: string): Promise<_playwright_test.APIResponse>;
+    deleteDataSourceByUID(uid: string): Promise<_playwright_test.APIResponse>;
+}
+
 type VariableType = 'Query' | 'Constant' | 'Custom';
 declare class VariableEditPage extends GrafanaPage {
     readonly ctx: PluginTestCtx;
@@ -416,69 +479,6 @@ declare class VariablePage extends GrafanaPage {
     clickAddNew(): Promise<VariableEditPage>;
 }
 
-declare class AlertRuleQuery extends GrafanaPage {
-    readonly ctx: PluginTestCtx;
-    readonly locator: Locator;
-    datasource: DataSourcePicker;
-    constructor(ctx: PluginTestCtx, locator: Locator);
-    getByGrafanaSelector(selector: string, options?: getByGrafanaSelectorOptions): Locator;
-}
-
-declare class AlertRuleEditPage extends GrafanaPage {
-    readonly ctx: PluginTestCtx;
-    readonly args?: AlertRuleArgs | undefined;
-    constructor(ctx: PluginTestCtx, args?: AlertRuleArgs | undefined);
-    /**
-     * Navigates to the annotation edit page. If a dashboard uid was not provided, it's assumed that it's a new dashboard.
-     */
-    goto(options?: NavigateOptions): Promise<void>;
-    /**
-     * Returns a locator for hte alert rule name field
-     */
-    get alertRuleNameField(): _playwright_test.Locator;
-    get advancedModeSwitch(): _playwright_test.Locator;
-    isAdvancedModeSupported(): Promise<boolean>;
-    enableAdvancedQueryMode(): Promise<void>;
-    disableAdvancedQueryMode(): Promise<void>;
-    getQueryRow(refId?: string): Promise<AlertRuleQuery>;
-    /**
-     * @deprecated Use getQueryRow instead
-     * Returns an instance of the {@link AlertRuleQuery} class for a query in the query and expression step (step 2)
-     *
-     * @param refId is optional. If not provided, it will return query row with refId 'A' in Grafana versions <11.6.
-     * In Grafana versions >=11.6 where advanced mode is supported, it will return the default query if advanced mode
-     * is not enabled. If advanced mode is enabled, it will return the a query by refId.
-     */
-    getAlertRuleQueryRow(refId?: string): AlertRuleQuery;
-    /**
-     * Clicks the "Add query" button and returns an instance of the {@link AlertRuleQuery} class for the new query row.
-     *
-     * Since Grafana 11.6, this method is only available if advanced mode is enabled. Use enableQueryAdvancedMode() method to enable it.
-     */
-    clickAddQueryRow(): Promise<AlertRuleQuery>;
-    /**
-     * Clicks the evaluate button and waits for the evaluation to complete. If the evaluation is successful, the status code of the response is 200.
-     * If one or more queries are invalid, an error status code is returned.
-     *
-     * Note that this method intercepts the response of the alerting evaluation endpoint and returns the status code of the first failed query.
-     * This means that any mocks defined with page.route in your tests will be overriden.
-     *
-     * Only supported for Grafana version 9.5.0 ad later.
-     */
-    evaluate(options?: RequestOptions): Promise<_playwright_test.Response>;
-}
-
-declare class GrafanaAPIClient {
-    private request;
-    constructor(request: APIRequestContext);
-    getUserIdByUsername(userName: string): Promise<any>;
-    createUser(user: User): Promise<void>;
-    getDataSourceSettingsByUID(uid: string): Promise<DataSourceSettings<{}, {}>>;
-    createDataSource(datasource: CreateDataSourceArgs, dsName: string): Promise<_playwright_test.APIResponse>;
-    getDataSourceByName(name: string): Promise<_playwright_test.APIResponse>;
-    deleteDataSourceByUID(uid: string): Promise<_playwright_test.APIResponse>;
-}
-
 declare const versionedAPIs: {
     Alerting: {
         eval: {
@@ -584,6 +584,29 @@ type PluginOptions = {
      * });
      */
     featureToggles: Record<string, boolean>;
+    /**
+     * Optionally, you can add or override user preferences for the Grafana user.
+     * The user preferences you specify here will be applied to window.grafanaBootData.user.preferences object.
+     * Since all tests receive a new, isolated browser context, the user preferences will be reset for each test.
+     *
+     * This is only supported for Grafana 11 and later.
+     *
+     * @example
+     * ```typescript
+     * export default defineConfig({
+     *   use: {
+     *     userPreferences: {
+     *       theme: 'dark',
+     *       timezone: 'browser',
+     *       weekStart: 'monday',
+     *       language: 'en-US',
+     *       regionalFormat: 'en',
+     *     },
+     *   },
+     * });
+     * ```
+     */
+    userPreferences: UserPreferences;
     /**
      * The Grafana user to use for the tests. If no user is provided, the default admin/admin user will be used.
      *
@@ -1094,6 +1117,49 @@ interface AlertPageOptions {
     hasText?: string | RegExp;
 }
 type OrgRole = 'None' | 'Viewer' | 'Editor' | 'Admin';
+/**
+ * User preferences configuration for tests.
+ *
+ * These preferences control various aspects of the Grafana user's
+ * appearance and behavior during test execution.
+ */
+interface UserPreferences {
+    /**
+     * The theme to use for the user.
+     *
+     * @default 'dark'
+     * @example 'dark' | 'light'
+     */
+    theme?: 'dark' | 'light';
+    /**
+     * The timezone setting for the organization.
+     *
+     * @default 'browser'
+     * @example 'browser' | 'utc' | 'America/New_York'
+     */
+    timezone?: string;
+    /**
+     * The first day of the week for date pickers and calendars.
+     *
+     * @default 'sunday'
+     * @example 'sunday' | 'monday'
+     */
+    weekStart?: 'sunday' | 'monday';
+    /**
+     * The language/locale for the organization's UI.
+     *
+     * @default 'en-US'
+     * @example 'en-US' | 'sv-SE' | 'de-DE'
+     */
+    language?: string;
+    /**
+     * The regional format for numbers, dates, and currencies.
+     *
+     * @default 'en'
+     * @example 'en' | 'sv' | 'de'
+     */
+    regionalFormat?: string;
+}
 /**
  * Panel visualization types
  */
@@ -1222,4 +1288,4 @@ declare global {
 }
 
 export { AnnotationEditPage, AnnotationPage, AppConfigPage, AppPage, DashboardPage, DataSourceConfigPage, DataSourcePicker, ExplorePage, GrafanaPage, Panel, PanelEditPage, PluginConfigPage, TimeRange, VariableEditPage, VariablePage, expect, test };
-export type { AlertPageOptions, AlertRule, AlertRuleArgs, AlertVariant$1 as AlertVariant, AppPageNavigateOptions, ContainTextOptions, CreateDataSourceArgs, CreateDataSourcePageArgs, Credentials, Dashboard, DashboardEditViewArgs, DashboardPageArgs, DataSourceSettings, E2ESelectorGroups, GotoAppConfigPageArgs, GotoAppPageArgs, GrafanaPageArgs, NavigateOptions, OrgRole, PlaywrightArgs, PluginFixture, PluginOptions, PluginPageArgs, PluginTestCtx, ReadProvisionedAlertRuleArgs, ReadProvisionedDashboardArgs, ReadProvisionedDataSourceArgs, RequestOptions, TimeRangeArgs, TriggerRequestOptions, User, Visualization, getByGrafanaSelectorOptions };
+export type { AlertPageOptions, AlertRule, AlertRuleArgs, AlertVariant$1 as AlertVariant, AppPageNavigateOptions, ContainTextOptions, CreateDataSourceArgs, CreateDataSourcePageArgs, Credentials, Dashboard, DashboardEditViewArgs, DashboardPageArgs, DataSourceSettings, E2ESelectorGroups, GotoAppConfigPageArgs, GotoAppPageArgs, GrafanaPageArgs, NavigateOptions, OrgRole, PlaywrightArgs, PluginFixture, PluginOptions, PluginPageArgs, PluginTestCtx, ReadProvisionedAlertRuleArgs, ReadProvisionedDashboardArgs, ReadProvisionedDataSourceArgs, RequestOptions, TimeRangeArgs, TriggerRequestOptions, User, UserPreferences, Visualization, getByGrafanaSelectorOptions };

package/dist/models/pages/PanelEditPage.js

@@ -177,6 +177,8 @@ class PanelEditPage extends GrafanaPage.GrafanaPage {
       root: this.getByGrafanaSelector(this.ctx.selectors.components.PanelEditor.General.content)
     });
     try {
+      await test.expect(refreshPanelButton).toBeVisible();
+      await test.expect(refreshPanelButton).toHaveText(/refresh/i, { timeout: 2e3 });
       await refreshPanelButton.click({ timeout: 2e3 });
     } catch (error) {
       await this.getByGrafanaSelector(this.ctx.selectors.components.PanelEditor.toggleVizOptions).click();

package/dist/options.js

@@ -6,6 +6,7 @@ const DEFAULT_ADMIN_USER = {
   password: process.env.GRAFANA_ADMIN_PASSWORD || "admin"
 };
 const options = {
+  userPreferences: [{}, { option: true, scope: "worker" }],
   featureToggles: [{}, { option: true, scope: "worker" }],
   provisioningRootDir: [path.join(process.cwd(), "provisioning"), { option: true, scope: "worker" }],
   user: [DEFAULT_ADMIN_USER, { option: true, scope: "worker" }],

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@grafana/plugin-e2e",
-  "version": "3.0.0-canary.2093.18278023316.0",
+  "version": "3.0.0-canary.2242.18774949404.0",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "files": [
@@ -31,13 +31,13 @@
     "playwright:test": "npx playwright test"
   },
   "engines": {
-    "node": ">=18 <=22"
+    "node": ">=20 <=24"
   },
   "peerDependencies": {
     "@playwright/test": "^1.52.0"
   },
   "devDependencies": {
-    "@playwright/test": "^1.55.0",
+    "@playwright/test": "^1.55.1",
     "@types/uuid": "^11.0.0",
     "dotenv": "^17.2.2"
   },
@@ -47,5 +47,5 @@
     "uuid": "^13.0.0",
     "yaml": "^2.3.4"
   },
-  "gitHead": "a273808c2709e083c1540d627acfd3f1d038b70c"
+  "gitHead": "5132fdd12fa7057c8d7166bd9e50b2105f9eed44"
 }

package/dist/fixtures/scripts/overrideFeatureToggles.js

@@ -1,21 +0,0 @@
-'use strict';
-
-const overrideFeatureToggles = (featureToggles) => {
-  const timeout = 1;
-  const waitForGrafanaBootData = (cb) => {
-    if (window?.grafanaBootData?.settings?.featureToggles) {
-      cb();
-    } else {
-      setTimeout(() => waitForGrafanaBootData(cb), timeout);
-    }
-  };
-  waitForGrafanaBootData(() => {
-    console.log("@grafana/plugin-e2e: setting the following feature toggles", featureToggles);
-    window.grafanaBootData.settings.featureToggles = {
-      ...window.grafanaBootData.settings.featureToggles,
-      ...featureToggles
-    };
-  });
-};
-
-exports.overrideFeatureToggles = overrideFeatureToggles;