Remove WebAPI support

Author: lpetrora

.github/workflows/ci.yml

@@ -46,7 +46,7 @@ jobs:
         run: npm ci --prefer-offline
 
       - name: Run prettier
-        run: npm run pretty:check
+        run: npm run pretty
 
       - name: Check types
         run: npm run typecheck

.prettierignore

@@ -1 +1,2 @@
 dist/
+src/plugin.json

DEVELOPMENT.md

@@ -39,7 +39,7 @@ https://grafana.com/developers/plugin-tools/migration-guides/update-create-plugi
 npx @grafana/create-plugin@latest update
 npm install
 npx npm-check-updates -i --format group
-npm run pretty
+npm run pretty:fix
 ```
 
 ## Release

README.md

@@ -18,7 +18,7 @@ To make use of the plugin, you need to take care the correct versions are instal
 
 - **Grafana 9.5.15 or higher** Current and previous major version of Grafana
 - **Checkmk Cloud or Checkmk MSP 2.2.0 or higher** for the signed plugin available from [Grafana][6]
-- **Checkmk 2.1.0 or higher** for the unsigned plugin available from [Github][8]
+- **Checkmk 2.2.0 or higher** for the unsigned plugin available from [Github][8]
 
 ## Installing the plug-in
 

package.json

@@ -11,8 +11,8 @@
     "typecheck": "tsc --noEmit",
     "lint": "eslint --cache --ignore-path ./.gitignore --ext .js,.jsx,.ts,.tsx .",
     "lint:fix": "npm run lint --fix",
-    "pretty": "prettier -w '{**/*,*}.{js,ts,jsx,tsx,json,yml}'",
-    "pretty:check": "prettier -c '{**/*,*}.{js,ts,jsx,tsx,json,yml}'",
+    "pretty": "prettier -c '{**/*,*}.{js,ts,jsx,tsx,json,yml}'",
+    "pretty:fix": "prettier -w '{**/*,*}.{js,ts,jsx,tsx,json,yml}'",
     "server": "docker-compose up --build",
     "start": "npm run watch",
     "sign": "npx --yes @grafana/sign-plugin@latest",

playwright.config.ts

@@ -11,8 +11,9 @@ export default defineConfig<PluginOptions>({
   /* Reporter to use. See https://playwright.dev/docs/test-reporters */
   reporter: 'list',
   use: {
-    trace: 'on',
-    video: 'on',
+    trace: 'retain-on-failure',
+    video: 'retain-on-failure',
+    screenshot: 'only-on-failure',
     viewport: { width: 1920, height: 1080 },
   },
   projects: [

src/DataSource.ts

@@ -11,61 +11,40 @@ import { replaceVariables } from 'utils';
 
 import { MetricFindQuery, RequestSpec } from './RequestSpec';
 import RestApiBackend from './backend/rest';
-import { BACKEND_TYPE, Backend } from './backend/types';
-import WebApiBackend from './backend/web';
 import { Settings } from './settings';
-import { Backend as BackendType, CmkQuery, DataSourceOptions, Edition, ResponseDataAutocomplete } from './types';
+import { CmkQuery, DataSourceOptions, Edition, ResponseDataAutocomplete, type WebApiResponse } from './types';
 import { AutoCompleteParams } from './ui/autocomplete';
 import { createCmkContext } from './utils';
-import { WebApiResponse } from './webapi';
 
 export class DataSource extends DataSourceApi<CmkQuery> {
-  webBackend: WebApiBackend;
   restBackend: RestApiBackend;
   settings: Settings;
-  autocompleteBackend: BACKEND_TYPE | null = null;
 
   constructor(private instanceSettings: DataSourceInstanceSettings<DataSourceOptions>) {
     super(instanceSettings);
-    this.webBackend = new WebApiBackend(this);
     this.restBackend = new RestApiBackend(this);
     this.settings = new Settings(instanceSettings.jsonData);
   }
 
-  protected async setAutocompleteBackend() {
-    this.autocompleteBackend = await this.getBackend().getAutocompleteBackend();
-  }
-
   async query(dataQueryRequest: DataQueryRequest<CmkQuery>): Promise<DataQueryResponse> {
     for (const target of dataQueryRequest.targets) {
       target.requestSpec = replaceVariables(target.requestSpec, dataQueryRequest.scopedVars);
     }
-    return this.getBackend().query(dataQueryRequest);
+    return this.restBackend.query(dataQueryRequest);
   }
 
   async metricFindQuery(query: MetricFindQuery, options?: unknown): Promise<MetricFindValue[]> {
-    if (query.objectType === 'site') {
-      // rest-api site endpoint were added in 2.2.0 so we have to use the web-api here
-      // TODO: clean up (remove filterSites from Backend) with end of 2.1.0
-      return await this.getBackend().listSites();
-    }
-    // we use the rest backend for both web and rest backend, because those endpoints are already implement in 2.1.0
     return await this.restBackend.metricFindQuery(query);
   }
+
   async testDatasource(): Promise<TestDataSourceResponse> {
-    return this.getBackend().testDatasource();
+    return this.restBackend.testDatasource();
   }
 
   async autocompleterRequest(
     api_url: string,
     data: unknown
   ): Promise<FetchResponse<WebApiResponse<ResponseDataAutocomplete>>> {
-    this.autocompleteBackend === null && (await this.setAutocompleteBackend());
-
-    if (this.autocompleteBackend === BACKEND_TYPE.WEB) {
-      return this.webBackend.autocompleterRequest(api_url, data);
-    }
-
     return this.restBackend.autocompleterRequest(api_url, data);
   }
 
@@ -75,26 +54,8 @@ export class DataSource extends DataSourceApi<CmkQuery> {
     prefix: string,
     params: Partial<AutoCompleteParams>
   ): Promise<Array<{ value: string; label: string; isDisabled: boolean }>> {
-    if (ident === 'label' && this.getBackendType() === 'web') {
-      // we have a 2.1.0 version without werk #15074 so label autocompleter is a special edge case
-      // can be removed after we stop supporting 2.1.0
-      const response = await this.webBackend.autocompleterRequest<Array<{ value: string }>>(
-        'ajax_autocomplete_labels.py',
-        {
-          world: params.world,
-          search_label: prefix,
-        }
-      );
-      return response.data.result.map((val: { value: string }) => ({
-        value: val.value,
-        label: val.value,
-        isDisabled: false,
-      }));
-    }
-    const context = createCmkContext(
-      replaceVariables(partialRequestSpec),
-      this.getBackendType() === 'rest' ? 'latest' : '2.1.0'
-    );
+    const context = createCmkContext(replaceVariables(partialRequestSpec));
+
     const response = await this.autocompleterRequest('ajax_vs_autocomplete.py', {
       ident,
       value: prefix,
@@ -118,17 +79,6 @@ export class DataSource extends DataSourceApi<CmkQuery> {
     return this.settings.edition;
   }
 
-  getBackendType(): BackendType {
-    return this.settings.backend;
-  }
-
-  getBackend(): Backend {
-    if (this.getBackendType() === 'web') {
-      return this.webBackend as Backend;
-    }
-    return this.restBackend as Backend;
-  }
-
   getUsername(): string {
     return this.settings.username;
   }

src/webapi.ts src/api_utils.tssrc/webapi.ts renamed to src/api_utils.ts

@@ -19,8 +19,8 @@ import { lastValueFrom } from 'rxjs';
 import { Aggregation, GraphType, MetricFindQuery } from '../RequestSpec';
 import { CmkQuery, ResponseDataAutocomplete } from '../types';
 import { createCmkContext, replaceVariables, toLiveStatusQuery, updateMetricTitles, updateQuery } from '../utils';
-import { WebApiResponse } from './../webapi';
-import { BACKEND_TYPE, Backend, DatasourceOptions } from './types';
+import { type WebApiResponse } from './../types';
+import { Backend, DatasourceOptions } from './types';
 import { validateRequestSpec } from './validate';
 
 type RestApiError = {
@@ -179,15 +179,8 @@ export default class RestApiBackend implements Backend {
       method: 'GET',
     });
     const checkMkVersion: string = result.data.versions.checkmk;
-    if (checkMkVersion.startsWith('2.0') || checkMkVersion.startsWith('1.')) {
-      throw new Error(
-        `A Checkmk version below 2.1.0 is not supported for this plugin, but you can set the backend to the '< 2.2' version and use at your own risk.`
-      );
-    }
-    if (checkMkVersion.startsWith('2.1')) {
-      throw new Error(
-        `Checkmk version 2.1.0 has been detected, but this plugin is configured to use version 2.2.0 and above. Please set the backend option to '< 2.2'.`
-      );
+    if (checkMkVersion.startsWith('2.0') || checkMkVersion.startsWith('2.1') || checkMkVersion.startsWith('1.')) {
+      throw new Error(`A Checkmk version below 2.2.0 is not supported for this plugin.`);
     }
     if (this.datasource.getEdition() !== 'RAW' && result.data.edition === 'cre') {
       throw new Error(
@@ -380,20 +373,6 @@ export default class RestApiBackend implements Backend {
     }
   }
 
-  async getAutocompleteBackend(): Promise<BACKEND_TYPE> {
-    return this.api<RestApiAutocompleteResponse>({
-      url: `/objects/autocomplete/sites`,
-      method: 'POST',
-      data: { value: '', parameters: {} },
-    })
-      .then(() => {
-        return BACKEND_TYPE.REST;
-      })
-      .catch(() => {
-        return BACKEND_TYPE.WEB;
-      });
-  }
-
   async autocompleterRequest(
     api_url = '',
     data: unknown

src/backend/rest.ts

@@ -3,21 +3,14 @@ import { DataQueryRequest, DataQueryResponse, MetricFindValue, TestDataSourceRes
 import { MetricFindQuery } from '../RequestSpec';
 import { CmkQuery, Edition } from '../types';
 
-export enum BACKEND_TYPE {
-  REST = 'rest',
-  WEB = 'web',
-}
-
 export interface Backend {
   query: (options: DataQueryRequest<CmkQuery>) => Promise<DataQueryResponse>;
   testDatasource: () => Promise<TestDataSourceResponse>;
   metricFindQuery: (query: MetricFindQuery) => Promise<MetricFindValue[]>;
   listSites: () => Promise<MetricFindValue[]>;
-  getAutocompleteBackend: () => Promise<BACKEND_TYPE>;
 }
 
 export interface DatasourceOptions {
-  getBackend: () => Backend;
   getEdition: () => Edition;
   getUrl: () => string | undefined;
   getUsername(): string;