@grafana/plugin-e2e 0.18.0 → 0.19.0-canary.769.63a3ce3.0

package/dist/e2e-selectors/types.d.ts

@@ -11,6 +11,7 @@ export type APIs = {
         query: string;
         health: (uid: string, id: string) => string;
         datasourceByUID: (uid: string) => string;
+        proxy: (uid: string) => string;
     };
     Dashboard: {
         delete: (uid: string) => string;

package/dist/e2e-selectors/versioned/apis.d.ts

@@ -20,6 +20,9 @@ export declare const versionedAPIs: {
         datasourceByUID: {
             "8.0.0": (uid: string) => string;
         };
+        proxy: {
+            "8.0.0": (uid: string) => string;
+        };
     };
     Dashboard: {
         delete: {

package/dist/e2e-selectors/versioned/apis.js

@@ -24,6 +24,9 @@ exports.versionedAPIs = {
         datasourceByUID: {
             [constants_1.MIN_GRAFANA_VERSION]: (uid) => `/api/datasources/uid/${uid}`,
         },
+        proxy: {
+            [constants_1.MIN_GRAFANA_VERSION]: (uid) => `api/datasources/proxy/uid/${uid}`,
+        },
     },
     Dashboard: {
         delete: {

package/dist/fixtures/annotationEditPage.js

@@ -1,8 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const models_1 = require("../models");
-const annotationEditPage = async ({ page, selectors, grafanaVersion, request }, use) => {
-    const annotationPage = new models_1.AnnotationPage({ page, selectors, grafanaVersion, request });
+const annotationEditPage = async ({ page, selectors, grafanaVersion, request }, use, testInfo) => {
+    const annotationPage = new models_1.AnnotationPage({ page, selectors, grafanaVersion, request, testInfo });
     await annotationPage.goto();
     const annotationEditPage = await annotationPage.clickAddNew();
     await use(annotationEditPage);

package/dist/fixtures/commands/createDataSourceConfigPage.js

@@ -2,13 +2,13 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const models_1 = require("../../models");
 const createDataSource_1 = require("./createDataSource");
-const createDataSourceConfigPage = async ({ request, page, selectors, grafanaVersion }, use) => {
+const createDataSourceConfigPage = async ({ request, page, selectors, grafanaVersion }, use, testInfo) => {
     let datasourceConfigPage;
     let deleteDataSource = true;
     await use(async (args) => {
         deleteDataSource = args.deleteDataSourceAfterTest ?? true;
         const datasource = await (0, createDataSource_1.createDataSourceViaAPI)(request, args);
-        datasourceConfigPage = new models_1.DataSourceConfigPage({ page, selectors, grafanaVersion, request }, datasource);
+        datasourceConfigPage = new models_1.DataSourceConfigPage({ page, selectors, grafanaVersion, request, testInfo }, datasource);
         await datasourceConfigPage.goto();
         return datasourceConfigPage;
     });

package/dist/fixtures/explorePage.js

@@ -1,8 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const ExplorePage_1 = require("../models/pages/ExplorePage");
-const explorePage = async ({ page, selectors, grafanaVersion, request }, use) => {
-    const explorePage = new ExplorePage_1.ExplorePage({ page, selectors, grafanaVersion, request });
+const explorePage = async ({ page, selectors, grafanaVersion, request }, use, testInfo) => {
+    const explorePage = new ExplorePage_1.ExplorePage({ page, selectors, grafanaVersion, request, testInfo });
     await explorePage.goto();
     await use(explorePage);
 };

package/dist/fixtures/newDashboardPage.js

@@ -1,8 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const models_1 = require("../models");
-const newDashboardPage = async ({ page, request, selectors, grafanaVersion }, use) => {
-    const newDashboardPage = new models_1.DashboardPage({ page, selectors, grafanaVersion, request });
+const newDashboardPage = async ({ page, request, selectors, grafanaVersion }, use, testInfo) => {
+    const newDashboardPage = new models_1.DashboardPage({ page, selectors, grafanaVersion, request, testInfo });
     await newDashboardPage.goto();
     await use(newDashboardPage);
 };

package/dist/fixtures/variableEditPage.js

@@ -1,8 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const models_1 = require("../models");
-const variableEditPage = async ({ page, selectors, grafanaVersion, request }, use) => {
-    const variablePage = new models_1.VariablePage({ page, selectors, grafanaVersion, request });
+const variableEditPage = async ({ page, selectors, grafanaVersion, request }, use, testInfo) => {
+    const variablePage = new models_1.VariablePage({ page, selectors, grafanaVersion, request, testInfo });
     await variablePage.goto();
     const variableEditPage = await variablePage.clickAddNew();
     await use(variableEditPage);

package/dist/models/pages/DataSourceConfigPage.d.ts

@@ -1,8 +1,8 @@
 import { Response } from '@playwright/test';
-import { DataSourceSettings, NavigateOptions, PluginTestCtx, TriggerQueryOptions } from '../../types';
+import { DataSourceSettings, NavigateOptions, PluginTestCtx, TriggerRequestOptions } from '../../types';
 import { GrafanaPage } from './GrafanaPage';
 export declare class DataSourceConfigPage extends GrafanaPage {
-    private datasource;
+    datasource: DataSourceSettings;
     constructor(ctx: PluginTestCtx, datasource: DataSourceSettings);
     deleteDataSource(): Promise<void>;
     /**
@@ -18,7 +18,9 @@ export declare class DataSourceConfigPage extends GrafanaPage {
     /**
      * Clicks the save and test button and waits for the response
      *
-     * Optionally, you can skip waiting for the response by passing in { skipWaitForResponse: true } as the options parameter
+     * By default, this will return the response of the health check call to /api/datasources/uid/<pluginUid>/health.
+     * Optionally, if your plugin uses a custom health check endpoint, you can provide the {@link TriggerRequestOptions.path } of this url.
+     * May be useful for data source plugins that don't have a backend.
      */
-    saveAndTest(options?: TriggerQueryOptions): Promise<Response>;
+    saveAndTest(options?: TriggerRequestOptions): Promise<Response>;
 }

package/dist/models/pages/DataSourceConfigPage.js

@@ -23,24 +23,22 @@ class DataSourceConfigPage extends GrafanaPage_1.GrafanaPage {
      * @param status the HTTP status code to return. Defaults to 200
      */
     async mockHealthCheckResponse(json, status = 200) {
-        await this.ctx.page.route(`${this.ctx.selectors.apis.DataSource.health(this.datasource.uid, this.datasource.id?.toString() ?? '')}`, async (route) => {
+        await this.ctx.page.route(`${this.ctx.selectors.apis.DataSource.health(this.datasource.uid, this.datasource.id.toString())}`, async (route) => {
             await route.fulfill({ json, status });
         });
     }
     /**
      * Clicks the save and test button and waits for the response
      *
-     * Optionally, you can skip waiting for the response by passing in { skipWaitForResponse: true } as the options parameter
+     * By default, this will return the response of the health check call to /api/datasources/uid/<pluginUid>/health.
+     * Optionally, if your plugin uses a custom health check endpoint, you can provide the {@link TriggerRequestOptions.path } of this url.
+     * May be useful for data source plugins that don't have a backend.
      */
     async saveAndTest(options) {
-        if (options?.skipWaitForResponse) {
-            await this.getByTestIdOrAriaLabel(this.ctx.selectors.pages.DataSource.saveAndTest).click();
-            return this.ctx.page.waitForResponse('');
-        }
-        const saveResponsePromise = this.ctx.page.waitForResponse((resp) => resp.url().includes(this.ctx.selectors.apis.DataSource.datasourceByUID(this.datasource.uid)));
-        const healthResponsePromise = this.ctx.page.waitForResponse((resp) => resp
-            .url()
-            .includes(this.ctx.selectors.apis.DataSource.health(this.datasource.uid, this.datasource.id?.toString() ?? '')));
+        const { datasourceByUID, health } = this.ctx.selectors.apis.DataSource;
+        const saveResponsePromise = this.ctx.page.waitForResponse((resp) => resp.url().includes(datasourceByUID(this.datasource.uid)));
+        const healthPath = options?.path ?? health(this.datasource.uid, this.datasource.id.toString());
+        const healthResponsePromise = this.ctx.page.waitForResponse((resp) => resp.url().includes(healthPath));
         await this.getByTestIdOrAriaLabel(this.ctx.selectors.pages.DataSource.saveAndTest).click();
         return saveResponsePromise.then(() => healthResponsePromise);
     }

package/dist/types.d.ts

@@ -1,4 +1,4 @@
-import { Locator, PlaywrightTestArgs, Response } from '@playwright/test';
+import { Locator, PlaywrightTestArgs, Response, TestInfo } from '@playwright/test';
 import { E2ESelectors } from './e2e-selectors/types';
 /**
  * The context object passed to page object models
@@ -6,6 +6,7 @@ import { E2ESelectors } from './e2e-selectors/types';
 export type PluginTestCtx = {
     grafanaVersion: string;
     selectors: E2ESelectors;
+    testInfo: TestInfo;
 } & Pick<PlaywrightTestArgs, 'page' | 'request'>;
 /**
  * The data source settings
@@ -183,11 +184,11 @@ export type GetByTestIdOrAriaLabelOptions = {
      */
     startsWith?: boolean;
 };
-export type TriggerQueryOptions = {
+export type TriggerRequestOptions = {
     /**
-     * Set this to true to skip waiting for the response. Defaults to false.
+     * The path to the endpoint to trigger
      */
-    skipWaitForResponse: boolean;
+    path?: string;
 };
 /**
  * Panel visualization types

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@grafana/plugin-e2e",
-  "version": "0.18.0",
+  "version": "0.19.0-canary.769.63a3ce3.0",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "files": [
@@ -46,5 +46,5 @@
     "uuid": "^9.0.1",
     "yaml": "^2.3.4"
   },
-  "gitHead": "01572ad54dd6e60c8f1535b34a43d9a56225f9ef"
+  "gitHead": "63a3ce36bd8cd59be06f1c153939be48d3575545"
 }