PMM-12710: API breaking changes (#1594)

* Action service, QAN service API changes * PMM-12710 Update actions endpoints * PMM-12710 fix lint issue * PMM-12710 Update settings endpoint * PMM-12710 Update api request body * PMM-12710 fix api paths * PMM-12710 fix actions according to updated response * PMM-12710 Update mysql api functions * PMM-12710 Update method names --------- Co-authored-by: Yash Sartanpara <[email protected]> Co-authored-by: Yash Sartanpara <[email protected]> Co-authored-by: Matej Kubinec <[email protected]>
percona · Jul 18, 2024 · 50ca07e · 50ca07e
1 parent 7d7d299
commit 50ca07e
Show file tree

Hide file tree

Showing 19 changed files with 61 additions and 49 deletions.
diff --git a/pmm-app/src/pmm-qan/panel/components/Details/Details.service.ts b/pmm-app/src/pmm-qan/panel/components/Details/Details.service.ts
@@ -14,7 +14,7 @@ const getExample = async ({
     tables,
   };
 
-  return apiRequestQAN.post<QueryExampleResponse, any>('/ObjectDetails/GetQueryExample', data);
+  return apiRequestQAN.post<QueryExampleResponse, any>('/query:getExample', data);
 };
 
 export default {

diff --git a/pmm-app/src/pmm-qan/panel/components/Details/Explain/Explain.tools.ts b/pmm-app/src/pmm-qan/panel/components/Details/Explain/Explain.tools.ts
@@ -80,7 +80,7 @@ export const fetchExplains = async (
       };
 
       const [classicResult, jsonResult] = await Promise.all([
-        mysqlMethods.getExplainTraditional(payload).then(getActionResult),
+        mysqlMethods.getExplain(payload).then(getActionResult),
         mysqlMethods.getExplainJSON(payload).then(getActionResult),
       ]);
 

diff --git a/pmm-app/src/pmm-qan/panel/components/Details/Metrics/Metrics.service.ts b/pmm-app/src/pmm-qan/panel/components/Details/Metrics/Metrics.service.ts
@@ -1,4 +1,4 @@
-import { apiRequestQAN } from 'shared/components/helpers/api';
+import { apiRequest } from 'shared/components/helpers/api';
 import { getLabelQueryParams } from 'pmm-qan/panel/QueryAnalytics.tools';
 import { HistogramRequest, HistogramResponse } from './Metrics.types';
 
@@ -15,7 +15,7 @@ export const getMetrics = async ({
     totals,
   };
 
-  return apiRequestQAN.post<any, any>('/ObjectDetails/GetMetrics', body);
+  return apiRequest.post<any, any>('/v1/qan:getMetrics', body);
 };
 
 export const getHistogram = async ({
@@ -28,7 +28,7 @@ export const getHistogram = async ({
     period_start_to: to,
   };
 
-  return apiRequestQAN.post<HistogramResponse, HistogramRequest>('/ObjectDetails/GetHistogram', body);
+  return apiRequest.post<HistogramResponse, HistogramRequest>('/v1/qan:getHistogram', body);
 };
 
 export default {

diff --git a/pmm-app/src/pmm-qan/panel/components/Details/Plan/Plan.service.ts b/pmm-app/src/pmm-qan/panel/components/Details/Plan/Plan.service.ts
@@ -8,7 +8,7 @@ export const PlanService = {
     };
 
     return apiRequestQAN
-      .post<QueryPlanResponse, QueryPlanRequest>('/ObjectDetails/GetQueryPlan', body)
+      .get<QueryPlanResponse, QueryPlanRequest>(`/query/${body.queryid}/plan`)
       .then(({ planid, query_plan }) => (
         planid && query_plan ? { id: planid, plan: query_plan } : undefined
       ));

diff --git a/pmm-app/src/pmm-qan/panel/components/Details/database-models/mongodb/mongodb.ts b/pmm-app/src/pmm-qan/panel/components/Details/database-models/mongodb/mongodb.ts
@@ -9,7 +9,7 @@ export const mongodbMethods = {
         query: example.example,
       });
 
-      return result.action_id;
+      return result.mongodb_explain.action_id;
     } catch (e) {
       console.error(e);
 

diff --git a/pmm-app/src/pmm-qan/panel/components/Details/database-models/mongodb/service.ts b/pmm-app/src/pmm-qan/panel/components/Details/database-models/mongodb/service.ts
@@ -1,7 +1,9 @@
-import { apiRequestManagement } from 'shared/components/helpers/api';
+import { apiRequest } from 'shared/components/helpers/api';
 
 export default {
   getTraditionalExplainJSONMongo(body) {
-    return apiRequestManagement.post<any, any>('/Actions/StartMongoDBExplain', body);
+    const requestBody = { mongodb_explain: body };
+
+    return apiRequest.post<any, any>('/v1/actions:startServiceAction', requestBody);
   },
 };
diff --git a/pmm-app/src/pmm-qan/panel/components/Details/database-models/mysql/mysql.ts b/pmm-app/src/pmm-qan/panel/components/Details/database-models/mysql/mysql.ts
@@ -13,7 +13,7 @@ export const mysqlMethods = {
       service_id: example.service_id,
     });
 
-    return result.action_id;
+    return result.mysql_show_create_table.action_id;
   },
 
   getIndexes: async ({ example, tableName, database }) => {
@@ -27,7 +27,7 @@ export const mysqlMethods = {
       service_id: example.service_id,
     });
 
-    return result.action_id;
+    return result.mysql_show_index.action_id;
   },
 
   getStatuses: async ({ example, tableName, database }) => {
@@ -41,30 +41,30 @@ export const mysqlMethods = {
       service_id: example.service_id,
     });
 
-    return result.action_id;
+    return result.mysql_show_table_status.action_id;
   },
 
   getExplainJSON: async ({ example, queryId, placeholders }) => {
     try {
       const payload = getExplainPayload(example, queryId, placeholders);
 
-      const result = await MysqlDatabaseService.getTraditionalExplainJSONMysql(payload);
+      const result = await MysqlDatabaseService.getExplainJSON(payload);
 
-      return result.action_id;
+      return result.mysql_explain_json.action_id;
     } catch (e) {
       console.error(e);
 
       return null;
     }
   },
 
-  getExplainTraditional: async ({ example, queryId, placeholders }) => {
+  getExplain: async ({ example, queryId, placeholders }) => {
     try {
       const payload = getExplainPayload(example, queryId, placeholders);
 
-      const result = await MysqlDatabaseService.getTraditionalExplainMysql(payload);
+      const result = await MysqlDatabaseService.getExplain(payload);
 
-      return result.action_id;
+      return result.mysql_explain.action_id;
     } catch (e) {
       console.error(e);
 

diff --git a/pmm-app/src/pmm-qan/panel/components/Details/database-models/mysql/service.ts b/pmm-app/src/pmm-qan/panel/components/Details/database-models/mysql/service.ts
@@ -1,23 +1,33 @@
-import { apiRequestManagement } from 'shared/components/helpers/api';
+import { apiRequest } from 'shared/components/helpers/api';
 
 export default {
   getShowCreateTableMySQL(body) {
-    return apiRequestManagement.post<any, any>('/Actions/StartMySQLShowCreateTable', body);
+    const requestBody = { mysql_show_create_table: body };
+
+    return apiRequest.post<any, any>('/v1/actions:startServiceAction', requestBody);
   },
 
   getMysqlTableStatus(body) {
-    return apiRequestManagement.post<any, any>('/Actions/StartMySQLShowTableStatus', body);
+    const requestBody = { mysql_show_table_status: body };
+
+    return apiRequest.post<any, any>('/v1/actions:startServiceAction', requestBody);
   },
 
   getMysqlIndex(body) {
-    return apiRequestManagement.post<any, any>('/Actions/StartMySQLShowIndex', body);
+    const requestBody = { mysql_show_index: body };
+
+    return apiRequest.post<any, any>('/v1/actions:startServiceAction', requestBody);
   },
 
-  getTraditionalExplainJSONMysql(body) {
-    return apiRequestManagement.post<any, any>('/Actions/StartMySQLExplainJSON', body);
+  getExplainJSON(body) {
+    const requestBody = { mysql_explain_json: body };
+
+    return apiRequest.post<any, any>('/v1/actions:startServiceAction', requestBody);
   },
 
-  getTraditionalExplainMysql(body) {
-    return apiRequestManagement.post<any, any>('/Actions/StartMySQLExplain', body);
+  getExplain(body) {
+    const requestBody = { mysql_explain: body };
+
+    return apiRequest.post<any, any>('/v1/actions:startServiceAction', requestBody);
   },
 };
diff --git a/pmm-app/src/pmm-qan/panel/components/Details/database-models/postgresql/postgresql.ts b/pmm-app/src/pmm-qan/panel/components/Details/database-models/postgresql/postgresql.ts
@@ -12,7 +12,7 @@ export const postgresqlMethods = {
       database,
     });
 
-    return result.action_id;
+    return result.postgresql_show_create_table.action_id;
   },
   getIndexes: async ({ example, tableName, database }) => {
     if (!tableName) {
@@ -25,6 +25,6 @@ export const postgresqlMethods = {
       database,
     });
 
-    return result.action_id;
+    return result.postgresql_show_index.action_id;
   },
 };
diff --git a/pmm-app/src/pmm-qan/panel/components/Details/database-models/postgresql/service.ts b/pmm-app/src/pmm-qan/panel/components/Details/database-models/postgresql/service.ts
@@ -1,10 +1,14 @@
-import { apiRequestManagement } from 'shared/components/helpers/api';
+import { apiRequest } from 'shared/components/helpers/api';
 
 export default {
   getPostgreSQLIndex(body) {
-    return apiRequestManagement.post<any, any>('/Actions/StartPostgreSQLShowIndex', body);
+    const requestBody = { postgres_show_index: body };
+
+    return apiRequest.post<any, any>('/v1/actions:startServiceAction', requestBody);
   },
   getShowCreateTablePostgreSQL(body) {
-    return apiRequestManagement.post<any, any>('/Actions/StartPostgreSQLShowCreateTable', body);
+    const requestBody = { postgres_show_create_table: body };
+
+    return apiRequest.post<any, any>('/v1/actions:startServiceAction', requestBody);
   },
 };
diff --git a/pmm-app/src/pmm-qan/panel/components/Filters/Filters.service.ts b/pmm-app/src/pmm-qan/panel/components/Filters/Filters.service.ts
@@ -29,7 +29,7 @@ export const markCheckedLabels = (labels, paramLabels) => {
 
 export default {
   getQueryOverviewFiltersList: async (paramLabels, from, to, mainMetric) => {
-    const { labels } = await apiRequestQAN.post<any, any>('/Filters/Get', {
+    const { labels } = await apiRequestQAN.post<any, any>('/metrics:getFilters', {
       labels: getLabelQueryParams(paramLabels),
       main_metric_name: mainMetric,
       period_start_from: from,

diff --git a/pmm-app/src/pmm-qan/panel/components/Overview/Overview.service.ts b/pmm-app/src/pmm-qan/panel/components/Overview/Overview.service.ts
@@ -20,6 +20,6 @@ export default {
       search: body.dimensionSearchText,
     };
 
-    return apiRequestQAN.post<any, any>('/GetReport', request);
+    return apiRequestQAN.post<any, any>('/metrics:getReport', request);
   },
 };
diff --git a/pmm-app/src/shared/components/Actions/Actions.service.ts b/pmm-app/src/shared/components/Actions/Actions.service.ts
@@ -1,8 +1,8 @@
-import { apiRequestManagement } from '../helpers/api';
+import { apiRequest } from '../helpers/api';
 import { ActionRequest, ActionResponse } from './Actions.types';
 
 export const ActionsService = {
   getActionResult(body: ActionRequest): Promise<ActionResponse> {
-    return apiRequestManagement.post<any, any>('/Actions/Get', body);
+    return apiRequest.get<any, any>(`/v1/actions/${body.action_id}`);
   },
 };
diff --git a/pmm-app/src/shared/components/helpers/api.ts b/pmm-app/src/shared/components/helpers/api.ts
@@ -60,7 +60,7 @@ export class ApiRequest {
 }
 
 export const apiRequest = new ApiRequest({});
-export const apiRequestQAN = new ApiRequest({ baseURL: '/v0/qan' });
+export const apiRequestQAN = new ApiRequest({ baseURL: '/v1/qan' });
 export const apiRequestManagement = new ApiRequest({ baseURL: '/v1/management' });
 export const apiRequestInventory = new ApiRequest({ baseURL: '/v1/inventory' });
 export const apiRequestSettings = new ApiRequest({ baseURL: '/v1/Settings' });
diff --git a/pmm-app/src/shared/core/Settings.service.ts b/pmm-app/src/shared/core/Settings.service.ts
@@ -3,13 +3,13 @@ import { API } from './constants';
 import { Settings, SettingsAPIResponse, SettingsPayload } from './types';
 
 export const SettingsService = {
-  async getSettings(disableNotifications = false): Promise<Settings> {
-    const { settings } = await apiRequest.post(API.SETTINGS, {}, disableNotifications) as SettingsAPIResponse;
+  async getSettings(): Promise<Settings> {
+    const { settings } = await apiRequest.get(API.SETTINGS) as SettingsAPIResponse;
 
     return toModel(settings);
   },
 };
 
 const toModel = (response: SettingsPayload): Settings => ({
-  updatesDisabled: response.updates_disabled,
+  updatesEnabled: response.updates_enabled,
 });
diff --git a/pmm-app/src/shared/core/__mocks__/Settings.service.ts b/pmm-app/src/shared/core/__mocks__/Settings.service.ts
@@ -2,6 +2,6 @@ import { Settings } from '../types';
 
 export const SettingsService = {
   async getSettings(): Promise<Settings> {
-    return Promise.resolve({ updatesDisabled: false });
+    return Promise.resolve({ updatesEnabled: true });
   },
 };
diff --git a/pmm-app/src/shared/core/constants.ts b/pmm-app/src/shared/core/constants.ts
@@ -1,8 +1,7 @@
 import { Databases } from './types';
 
 export const API = {
-  ALERTMANAGER: '/alertmanager/api/v2',
-  SETTINGS: '/v1/Settings/Get',
+  SETTINGS: '/v1/server/settings',
 };
 
 export const DATABASE_LABELS = {

diff --git a/pmm-app/src/shared/core/types.ts b/pmm-app/src/shared/core/types.ts
@@ -7,15 +7,15 @@ export enum Databases {
 }
 
 export interface Settings {
-  updatesDisabled?: boolean;
+  updatesEnabled?: boolean;
 }
 
 export interface SettingsAPIResponse {
   settings: SettingsPayload;
 }
 
 export interface SettingsPayload {
-  updates_disabled: boolean;
+  updates_enabled: boolean;
 }
 
 export interface PaginatedPayload {

diff --git a/setup-page/src/App.jsx b/setup-page/src/App.jsx
@@ -16,16 +16,13 @@ export function App() {
     setLoading(true);
 
     try {
-      const response = await fetch('/v1/AWSInstanceCheck', {
-        method: 'POST',
+      const response = await fetch(`/v1/server/AWSInstance?instance_id${instanceId.trim()}`, {
+        method: 'GET',
         credentials: "include",
         cache: "no-cache",
         headers: {
           "Content-Type": "application/json",
-        },
-        body: JSON.stringify({
-          instance_id: instanceId.trim(),
-        }),
+        }
       });
 
       if (!response.ok) {