@grafana/plugin-e2e 3.1.3 → 3.2.0-canary.2408.21202715809.0

package/dist/fixtures/bootData.js

@@ -0,0 +1,25 @@
+'use strict';
+
+const bootData = async ({ context }, use) => {
+  const tempPage = await context.newPage();
+  try {
+    await tempPage.goto("/");
+    const bootDataSettings = await tempPage.evaluate(() => {
+      return {
+        version: window.grafanaBootData.settings.buildInfo.version,
+        namespace: window.grafanaBootData.settings.namespace
+      };
+    });
+    await use({
+      version: bootDataSettings.version,
+      namespace: bootDataSettings.namespace
+    });
+  } catch (error) {
+    console.error("@grafana/plugin-e2e: Failed to fetch boot data", error);
+    await use({ version: void 0, namespace: void 0 });
+  } finally {
+    await tempPage.close();
+  }
+};
+
+exports.bootData = bootData;

package/dist/fixtures/grafanaVersion.js

@@ -1,12 +1,8 @@
 'use strict';
 
-const grafanaVersion = async ({ page }, use) => {
-  let grafanaVersion2 = process.env.GRAFANA_VERSION ?? "";
-  if (!grafanaVersion2) {
-    await page.goto("/");
-    grafanaVersion2 = await page.evaluate("window.grafanaBootData.settings.buildInfo.version");
-  }
-  await use(grafanaVersion2.replace(/\-.*/, ""));
+const grafanaVersion = async ({ bootData }, use) => {
+  const version = process.env.GRAFANA_VERSION || bootData.version || "";
+  await use(version.replace(/\-.*/, ""));
 };
 
 exports.grafanaVersion = grafanaVersion;

package/dist/fixtures/namespace.js

@@ -0,0 +1,7 @@
+'use strict';
+
+const namespace = async ({ bootData }, use) => {
+  await use(bootData.namespace || "default");
+};
+
+exports.namespace = namespace;

package/dist/fixtures/page.js

@@ -2,14 +2,96 @@
 
 var overrideGrafanaBootData = require('./scripts/overrideGrafanaBootData.js');
 
-const page = async ({ page: page2, featureToggles, userPreferences }, use) => {
-  if (Object.keys(featureToggles).length > 0 || Object.keys(userPreferences).length > 0) {
+function delay(ms) {
+  return new Promise((resolve) => setTimeout(resolve, ms));
+}
+async function handleBulkEvaluationRoute(route, featureToggles, latency) {
+  try {
+    const response = await route.fetch();
+    if (!response.ok()) {
+      await route.fulfill({ response });
+      return;
+    }
+    const body = await response.json();
+    for (const flag of body.flags) {
+      if (flag.key in featureToggles) {
+        flag.value = featureToggles[flag.key];
+        flag.reason = "STATIC";
+        flag.variant = "playwright-override";
+      }
+    }
+    for (const [key, value] of Object.entries(featureToggles)) {
+      const exists = body.flags.some((f) => f.key === key);
+      if (!exists) {
+        body.flags.push({
+          key,
+          value,
+          reason: "STATIC",
+          variant: "playwright-override"
+        });
+      }
+    }
+    if (latency > 0) {
+      await delay(latency);
+    }
+    await route.fulfill({
+      response,
+      body: JSON.stringify(body),
+      headers: { "content-type": "application/json" }
+    });
+  } catch (error) {
+    console.error("@grafana/plugin-e2e: Failed to intercept OFREP bulk evaluation", error);
+    await route.continue();
+  }
+}
+async function handleSingleFlagRoute(route, featureToggles, latency) {
+  try {
+    const url = new URL(route.request().url());
+    const flagKey = url.pathname.split("/").pop();
+    if (flagKey && flagKey in featureToggles) {
+      if (latency > 0) {
+        await delay(latency);
+      }
+      await route.fulfill({
+        status: 200,
+        body: JSON.stringify({
+          key: flagKey,
+          value: featureToggles[flagKey],
+          reason: "STATIC",
+          variant: "playwright-override"
+        }),
+        headers: { "content-type": "application/json" }
+      });
+      return;
+    }
+    await route.continue();
+  } catch (error) {
+    console.error("@grafana/plugin-e2e: Failed to intercept OFREP single flag evaluation", error);
+    await route.continue();
+  }
+}
+async function setupOpenFeatureRoutes(page2, featureToggles, latency, selectors) {
+  console.log("@grafana/plugin-e2e: setting up OpenFeature OFREP interception", { featureToggles, latency });
+  await page2.route(selectors.apis.OpenFeature.ofrepBulkPattern, async (route) => {
+    await handleBulkEvaluationRoute(route, featureToggles, latency);
+  });
+  await page2.route(selectors.apis.OpenFeature.ofrepSinglePattern, async (route) => {
+    await handleSingleFlagRoute(route, featureToggles, latency);
+  });
+}
+const page = async ({ page: page2, featureToggles, userPreferences, openFeatureLatency, selectors }, use) => {
+  const hasFeatureToggles = Object.keys(featureToggles).length > 0;
+  const hasUserPreferences = Object.keys(userPreferences).length > 0;
+  if (hasFeatureToggles || hasUserPreferences) {
     try {
       await page2.addInitScript(overrideGrafanaBootData.overrideGrafanaBootData, { featureToggles, userPreferences });
     } catch (error) {
       console.error("Failed to set feature toggles", error);
     }
   }
+  if (hasFeatureToggles) {
+    await setupOpenFeatureRoutes(page2, featureToggles, openFeatureLatency, selectors);
+  }
   await page2.goto("/");
   await use(page2);
 };

package/dist/index.d.ts

@@ -521,6 +521,20 @@ declare const versionedAPIs: {
             "8.0.0": (pluginId: string) => string;
         };
     };
+    OpenFeature: {
+        ofrepBulkPattern: {
+            '12.1.0': string;
+        };
+        ofrepSinglePattern: {
+            '12.1.0': string;
+        };
+        ofrepBulkPath: {
+            '12.1.0': (namespace?: string) => string;
+        };
+        ofrepSinglePath: {
+            '12.1.0': (namespace?: string) => string;
+        };
+    };
 };
 type VersionedAPIs = typeof versionedAPIs;
 
@@ -563,25 +577,31 @@ type PluginOptions = {
     provisioningRootDir: string;
     /**
      * Optionally, you can add or override feature toggles.
-     * The feature toggles you specify here will only work in the frontend. If you need a feature toggle to work across the entire stack, you
-     * need to need to enable the feature in the Grafana config. Also see https://grafana.com/developers/plugin-tools/e2e-test-a-plugin/feature-toggles
+     * The feature toggles you specify here will work for both legacy feature toggles (via `window.grafanaBootData.settings.featureToggles`)
+     * and OpenFeature flags (via OFREP API interception).
+     *
+     * If you need a feature toggle to work across the entire stack, you need to enable the feature in the Grafana config.
+     * Also see https://grafana.com/developers/plugin-tools/e2e-test-a-plugin/feature-toggles
      *
-     * To override feature toggles globally in the playwright.config.ts file:
+     * @example
+     * ```typescript
+     * // Override feature toggles globally in playwright.config.ts
      * export default defineConfig({
-        use: {
-          featureToggles: {
-            exploreMixedDatasource: true,
-            redshiftAsyncQueryDataSupport: false
-          },
-        },
-      });
+     *   use: {
+     *     featureToggles: {
+     *       exploreMixedDatasource: true,
+     *       redshiftAsyncQueryDataSupport: false
+     *     },
+     *   },
+     * });
      *
-     * To override feature toggles for tests in a certain file:
-       test.use({
-        featureToggles: {
-          exploreMixedDatasource: true,
-        },
+     * // Override feature toggles for tests in a specific file
+     * test.use({
+     *   featureToggles: {
+     *     exploreMixedDatasource: true,
+     *   },
      * });
+     * ```
      */
     featureToggles: Record<string, boolean>;
     /**
@@ -619,6 +639,20 @@ type PluginOptions = {
      * If no credentials are provided, the server default admin:admin credentials will be used.
      */
     grafanaAPICredentials: Credentials;
+    /**
+     * Artificial latency in milliseconds to add to OpenFeature OFREP API responses.
+     * Useful for testing how the UI behaves with slow network conditions when fetching feature flags.
+     *
+     * @default 0
+     * @example
+     * ```typescript
+     * // Simulate 500ms network latency for OpenFeature flag fetching
+     * test.use({
+     *   openFeatureLatency: 500,
+     * });
+     * ```
+     */
+    openFeatureLatency: number;
 };
 type PluginFixture = {
     /**
@@ -628,6 +662,13 @@ type PluginFixture = {
      * the version will be picked from window.grafanaBootData.settings.buildInfo.version.
      */
     grafanaVersion: string;
+    /**
+     * The Grafana namespace/tenant id that was detected when the test runner was started.
+     *
+     * The namespace will be picked from window.grafanaBootData.settings.namespace.
+     * Defaults to 'default' if not available.
+     */
+    namespace: string;
     /**
      * The E2E selectors to use for the current version of Grafana.
      * See https://grafana.com/developers/plugin-tools/e2e-test-a-plugin/selecting-elements#grafana-end-to-end-selectors for more information.
@@ -842,10 +883,15 @@ type PluginTestCtx = {
     selectors: E2ESelectorGroups;
     testInfo: TestInfo;
 } & Pick<PlaywrightTestArgs, 'page' | 'request'>;
+/**
+ * Internal fixtures that are not exposed in the test API.
+ * These fixtures can be used by other fixtures but not by tests directly.
+ */
+type InternalFixtures = {};
 /**
  * Playwright args used when defining fixtures
  */
-type PlaywrightArgs = PluginFixture & PluginOptions & PlaywrightTestArgs & PlaywrightTestOptions & PlaywrightWorkerArgs & PlaywrightWorkerOptions;
+type PlaywrightArgs = PluginFixture & PluginOptions & InternalFixtures & PlaywrightTestArgs & PlaywrightTestOptions & PlaywrightWorkerArgs & PlaywrightWorkerOptions;
 /**
  * The data source settings
  */
@@ -1203,7 +1249,7 @@ declare class AnnotationPage extends GrafanaPage {
     clickAddNew(): Promise<AnnotationEditPage>;
 }
 
-declare const test: _playwright_test.TestType<_playwright_test.PlaywrightTestArgs & _playwright_test.PlaywrightTestOptions & PluginFixture, _playwright_test.PlaywrightWorkerArgs & _playwright_test.PlaywrightWorkerOptions & PluginOptions>;
+declare const test: _playwright_test.TestType<_playwright_test.PlaywrightTestArgs & _playwright_test.PlaywrightTestOptions & InternalFixtures & PluginFixture, _playwright_test.PlaywrightWorkerArgs & _playwright_test.PlaywrightWorkerOptions & PluginOptions>;
 declare const expect: _playwright_test.Expect<{
     toHaveAlert: (grafanaPage: GrafanaPage, severity: AlertVariant, options?: AlertPageOptions) => Promise<{
         message: () => any;
@@ -1239,6 +1285,10 @@ declare global {
         grafanaBootData: {
             settings: {
                 featureToggles: Record<string, boolean>;
+                buildInfo: {
+                    version: string;
+                };
+                namespace: string;
             };
         };
     }
@@ -1288,4 +1338,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, UserPreferences, Visualization, getByGrafanaSelectorOptions };
+export type { AlertPageOptions, AlertRule, AlertRuleArgs, AlertVariant$1 as AlertVariant, AppPageNavigateOptions, ContainTextOptions, CreateDataSourceArgs, CreateDataSourcePageArgs, Credentials, Dashboard, DashboardEditViewArgs, DashboardPageArgs, DataSourceSettings, E2ESelectorGroups, GotoAppConfigPageArgs, GotoAppPageArgs, GrafanaPageArgs, InternalFixtures, NavigateOptions, OrgRole, PlaywrightArgs, PluginFixture, PluginOptions, PluginPageArgs, PluginTestCtx, ReadProvisionedAlertRuleArgs, ReadProvisionedDashboardArgs, ReadProvisionedDataSourceArgs, RequestOptions, TimeRangeArgs, TriggerRequestOptions, User, UserPreferences, Visualization, getByGrafanaSelectorOptions };

package/dist/index.js

@@ -20,7 +20,9 @@ var readProvisionedDataSource = require('./fixtures/commands/readProvisionedData
 var readProvisionedAlertRule = require('./fixtures/commands/readProvisionedAlertRule.js');
 var dashboardPage = require('./fixtures/dashboardPage.js');
 var explorePage = require('./fixtures/explorePage.js');
+var bootData = require('./fixtures/bootData.js');
 var grafanaVersion = require('./fixtures/grafanaVersion.js');
+var namespace = require('./fixtures/namespace.js');
 var isFeatureToggleEnabled = require('./fixtures/isFeatureToggleEnabled.js');
 var page = require('./fixtures/page.js');
 var panelEditPage = require('./fixtures/panelEditPage.js');
@@ -53,9 +55,13 @@ var AppConfigPage = require('./models/pages/AppConfigPage.js');
 var PluginConfigPage = require('./models/pages/PluginConfigPage.js');
 var AppPage = require('./models/pages/AppPage.js');
 
-const test = test$1.test.extend({
+const testWithInternal = test$1.test.extend({
+  bootData: bootData.bootData
+});
+const test = testWithInternal.extend({
   selectors: selectors.selectors,
   grafanaVersion: grafanaVersion.grafanaVersion,
+  namespace: namespace.namespace,
   login: login.login,
   grafanaAPIClient: grafanaAPIClient.grafanaAPIClient,
   createDataSourceConfigPage: createDataSourceConfigPage.createDataSourceConfigPage,

package/dist/options.js

@@ -8,6 +8,7 @@ const DEFAULT_ADMIN_USER = {
 const options = {
   userPreferences: [{}, { option: true, scope: "worker" }],
   featureToggles: [{}, { option: true, scope: "worker" }],
+  openFeatureLatency: [0, { option: true, scope: "worker" }],
   provisioningRootDir: [path.join(process.cwd(), "provisioning"), { option: true, scope: "worker" }],
   user: [DEFAULT_ADMIN_USER, { option: true, scope: "worker" }],
   grafanaAPICredentials: [DEFAULT_ADMIN_USER, { option: true, scope: "worker" }]

package/dist/selectors/versionedAPIs.js

@@ -43,6 +43,20 @@ const versionedAPIs = {
     settings: {
       [minGrafanaVersion.MIN_GRAFANA_VERSION]: (pluginId) => `/api/plugins/${pluginId}/settings`
     }
+  },
+  OpenFeature: {
+    ofrepBulkPattern: {
+      "12.1.0": "**/apis/features.grafana.app/**/ofrep/v*/evaluate/flags"
+    },
+    ofrepSinglePattern: {
+      "12.1.0": "**/apis/features.grafana.app/**/ofrep/v*/evaluate/flags/*"
+    },
+    ofrepBulkPath: {
+      "12.1.0": (namespace = "default") => `/apis/features.grafana.app/v0alpha1/namespaces/${namespace}/ofrep/v1/evaluate/flags`
+    },
+    ofrepSinglePath: {
+      "12.1.0": (namespace = "default") => `/apis/features.grafana.app/v0alpha1/namespaces/${namespace}/ofrep/v1/evaluate/flags`
+    }
   }
 };
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@grafana/plugin-e2e",
-  "version": "3.1.3",
+  "version": "3.2.0-canary.2408.21202715809.0",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "files": [
@@ -47,5 +47,5 @@
     "uuid": "^13.0.0",
     "yaml": "^2.3.4"
   },
-  "gitHead": "a9c6fab9844ef8b56a11c4ce4f72fdf6da9baea1"
+  "gitHead": "043c6c46215cc086eb03bedf1ea92a11cd94d2dc"
 }