ui/cluster-ui: make app name a query search parameter in stmts page

Fixes: cockroachdb#70790

Previously, the selected app was derived from a route param on the
statements page. All other filters are derived from query search
parameters on the page. This commit makes the app name a query search
parameter, as is the case in the transactions page.

Release note: None

pkg/ui/workspaces/cluster-ui/src/queryFilter/filter.tsx

@@ -69,7 +69,7 @@ const timeUnit = [
 ];
 
 export const defaultFilters: Filters = {
-  app: "All",
+  app: "",
   timeNumber: "0",
   timeUnit: "seconds",
   fullScan: false,
@@ -89,15 +89,17 @@ export const defaultFilters: Filters = {
  * @return Filters: the default filters with updated keys existing on
  * queryString
  */
-export const getFiltersFromQueryString = (queryString: string) => {
+export const getFiltersFromQueryString = (
+  queryString: string,
+): Record<string, string> => {
   const searchParams = new URLSearchParams(queryString);
 
   return Object.keys(defaultFilters).reduce(
     (filters, filter: keyof Filters): Filters => {
       const defaultValue = defaultFilters[filter];
       const queryStringFilter = searchParams.get(filter);
       const filterValue =
-        queryStringFilter === null
+        queryStringFilter == null
           ? defaultValue
           : defaultValue.constructor(searchParams.get(filter));
       return { [filter]: filterValue, ...filters };
@@ -114,7 +116,7 @@ export const getFiltersFromQueryString = (queryString: string) => {
  * we want to consider 0 active Filters
  */
 export const inactiveFiltersState: Filters = {
-  app: "All",
+  app: "",
   timeNumber: "0",
   fullScan: false,
   sqlType: "",
@@ -123,7 +125,7 @@ export const inactiveFiltersState: Filters = {
   nodes: "",
 };
 
-export const calculateActiveFilters = (filters: Filters) => {
+export const calculateActiveFilters = (filters: Filters): number => {
   return Object.keys(inactiveFiltersState).reduce(
     (active, filter: keyof Filters) => {
       return inactiveFiltersState[filter] !== filters[filter]
@@ -185,7 +187,19 @@ export class Filter extends React.Component<QueryFilter, FilterState> {
     this.setState({ hide: true });
   };
 
-  handleChange = (event: any, field: string) => {
+  handleSelectChange = (
+    event: { label: string; value: string },
+    field: string,
+  ): void => {
+    this.setState({
+      filters: {
+        ...this.state.filters,
+        [field]: event.value,
+      },
+    });
+  };
+
+  handleChange = (event: any, field: string): void => {
     this.setState({
       filters: {
         ...this.state.filters,
@@ -419,7 +433,7 @@ export class Filter extends React.Component<QueryFilter, FilterState> {
             <div className={filterLabel.top}>App</div>
             <Select
               options={apps}
-              onChange={e => this.handleChange(e, "app")}
+              onChange={e => this.handleSelectChange(e, "app")}
               value={apps.filter(app => app.value === filters.app)}
               placeholder="All"
               styles={customStyles}
@@ -441,7 +455,7 @@ export class Filter extends React.Component<QueryFilter, FilterState> {
               <Select
                 options={timeUnit}
                 value={timeUnit.filter(unit => unit.label == filters.timeUnit)}
-                onChange={e => this.handleChange(e, "timeUnit")}
+                onChange={e => this.handleSelectChange(e, "timeUnit")}
                 className={timePair.timeUnit}
                 styles={customStylesSmall}
               />

pkg/ui/workspaces/cluster-ui/src/statementDetails/statementDetails.selectors.ts

@@ -150,7 +150,11 @@ export const selectStatement = createSelector(
       statement,
       stats: combineStatementStats(results.map(s => s.stats)),
       byNode: coalesceNodeStats(results),
-      app: _.uniq(results.map(s => s.app)),
+      app: _.uniq(
+        results.map(s =>
+          s.app.startsWith(internalAppNamePrefix) ? "(internal)" : s.app,
+        ),
+      ),
       database: queryByName(props.location, databaseAttr),
       distSQL: fractionMatching(results, s => s.distSQL),
       vec: fractionMatching(results, s => s.vec),

pkg/ui/workspaces/cluster-ui/src/statementDetails/statementDetails.tsx

@@ -177,10 +177,12 @@ function AppLink(props: { app: string }) {
     return <span className={cx("app-name", "app-name__unset")}>(unset)</span>;
   }
 
+  const searchParams = new URLSearchParams({ [appAttr]: props.app });
+
   return (
     <Link
       className={cx("app-name")}
-      to={`/statements/${encodeURIComponent(props.app)}`}
+      to={`/statements/?${searchParams.toString()}`}
     >
       {props.app}
     </Link>

pkg/ui/workspaces/cluster-ui/src/statementsPage/statementsPage.selectors.ts

@@ -17,7 +17,7 @@ import {
   ExecutionStatistics,
   flattenStatementStats,
   formatDate,
-  getMatchParamByName,
+  queryByName,
   statementKey,
   StatementStatistics,
   TimestampToMoment,
@@ -144,7 +144,7 @@ export const selectStatements = createSelector(
       return null;
     }
     let statements = flattenStatementStats(state.data.statements);
-    const app = getMatchParamByName(props.match, appAttr);
+    const app = queryByName(props.location, appAttr);
     const isInternal = (statement: ExecutionStatistics) =>
       statement.app.startsWith(state.data.internal_app_name_prefix);
 

pkg/ui/workspaces/cluster-ui/src/statementsPage/statementsPage.tsx

@@ -10,7 +10,7 @@
 
 import React from "react";
 import { RouteComponentProps } from "react-router-dom";
-import { isNil, merge, forIn } from "lodash";
+import { isNil, merge } from "lodash";
 import Helmet from "react-helmet";
 import moment, { Moment } from "moment";
 import classNames from "classnames/bind";
@@ -179,19 +179,19 @@ export class StatementsPage extends React.Component<
     };
   };
 
-  syncHistory = (params: Record<string, string | undefined>) => {
+  syncHistory = (params: Record<string, string | undefined>): void => {
     const { history } = this.props;
-    const currentSearchParams = new URLSearchParams(history.location.search);
+    const nextSearchParams = new URLSearchParams(history.location.search);
 
-    forIn(params, (value, key) => {
+    Object.entries(params).forEach(([key, value]) => {
       if (!value) {
-        currentSearchParams.delete(key);
+        nextSearchParams.delete(key);
       } else {
-        currentSearchParams.set(key, value);
+        nextSearchParams.set(key, value);
       }
     });
 
-    history.location.search = currentSearchParams.toString();
+    history.location.search = nextSearchParams.toString();
     history.replace(history.location);
   };
 
@@ -223,17 +223,6 @@ export class StatementsPage extends React.Component<
     );
   };
 
-  selectApp = (value: string): void => {
-    if (value == "All") value = "";
-    const { history, onFilterChange } = this.props;
-    history.location.pathname = `/statements/${encodeURIComponent(value)}`;
-    history.replace(history.location);
-    this.resetPagination();
-    if (onFilterChange) {
-      onFilterChange(value);
-    }
-  };
-
   resetPagination = (): void => {
     this.setState(prevState => {
       return {
@@ -307,7 +296,6 @@ export class StatementsPage extends React.Component<
       regions: filters.regions,
       nodes: filters.nodes,
     });
-    this.selectApp(filters.app);
   };
 
   onClearSearchField = (): void => {
@@ -334,7 +322,6 @@ export class StatementsPage extends React.Component<
       regions: undefined,
       nodes: undefined,
     });
-    this.selectApp("");
   };
 
   filteredStatementsData = (): AggregateStatistics[] => {
@@ -422,8 +409,8 @@ export class StatementsPage extends React.Component<
     const {
       statements,
       databases,
-      match,
       lastReset,
+      location,
       onDiagnosticsReportDownload,
       onStatementClick,
       resetSQLStats,
@@ -432,9 +419,9 @@ export class StatementsPage extends React.Component<
       nodeRegions,
       isTenant,
     } = this.props;
-    const appAttrValue = getMatchParamByName(match, appAttr);
+    const appAttrValue = queryByName(location, appAttr);
     const selectedApp = appAttrValue || "";
-    const appOptions = [{ value: "all", label: "All" }];
+    const appOptions = [{ value: "", label: "All" }];
     this.props.apps.forEach(app => appOptions.push({ value: app, label: app }));
     const data = this.filteredStatementsData();
     const totalWorkload = calculateTotalWorkload(data);

pkg/ui/workspaces/db-console/src/app.tsx

@@ -179,10 +179,10 @@ export const App: React.FC<AppProps> = (props: AppProps) => {
 
                 {/* statement statistics */}
                 <Route exact path="/statements" component={StatementsPage} />
-                <Route
+                <Redirect
                   exact
-                  path={`/statements/:${appAttr}`}
-                  component={StatementsPage}
+                  from={`/statements/:${appAttr}`}
+                  to={`/statements?${appAttr}=:${appAttr}`}
                 />
                 <Route
                   exact

pkg/ui/workspaces/db-console/src/views/statements/statementDetails.tsx

@@ -184,7 +184,11 @@ export const selectStatement = createSelector(
       statement,
       stats: combineStatementStats(results.map(s => s.stats)),
       byNode: coalesceNodeStats(results),
-      app: _.uniq(results.map(s => s.app)),
+      app: _.uniq(
+        results.map(s =>
+          s.app.startsWith(internalAppNamePrefix) ? "(internal)" : s.app,
+        ),
+      ),
       database: queryByName(props.location, databaseAttr),
       distSQL: fractionMatching(results, s => s.distSQL),
       vec: fractionMatching(results, s => s.vec),

pkg/ui/workspaces/db-console/src/views/statements/statements.spec.tsx

@@ -445,7 +445,8 @@ describe("selectStatement", () => {
 
     assert.equal(result.statement, stmtA.key.key_data.query);
     assert.equal(result.stats.count.toNumber(), stmtA.stats.count.toNumber());
-    assert.deepEqual(result.app, [stmtA.key.key_data.app]);
+    // Statements with internal app prefix should have "(internal)" as app name
+    assert.deepEqual(result.app, ["(internal)"]);
     assert.deepEqual(result.distSQL, { numerator: 0, denominator: 1 });
     assert.deepEqual(result.vec, { numerator: 0, denominator: 1 });
     assert.deepEqual(result.opt, { numerator: 0, denominator: 1 });
@@ -596,6 +597,21 @@ function makeRoutePropsWithParams(params: { [key: string]: string }) {
   };
 }
 
+function makeRoutePropsWithSearchParams(params: { [key: string]: string }) {
+  const history = H.createHashHistory();
+  history.location.search = new URLSearchParams(params).toString();
+  return {
+    location: history.location,
+    history,
+    match: {
+      url: "",
+      path: history.location.pathname,
+      isExact: false,
+      params: {},
+    },
+  };
+}
+
 function makeEmptyRouteProps(): RouteComponentProps<any> {
   const history = H.createHashHistory();
   return {
@@ -611,7 +627,7 @@ function makeEmptyRouteProps(): RouteComponentProps<any> {
 }
 
 function makeRoutePropsWithApp(app: string) {
-  return makeRoutePropsWithParams({
+  return makeRoutePropsWithSearchParams({
     [appAttr]: app,
   });
 }

pkg/ui/workspaces/db-console/src/views/statements/statementsPage.tsx

@@ -34,7 +34,7 @@ import { PrintTime } from "src/views/reports/containers/range/print";
 import { selectDiagnosticsReportsPerStatement } from "src/redux/statements/statementsSelectors";
 import { createStatementDiagnosticsAlertLocalSetting } from "src/redux/alerts";
 import { statementsDateRangeLocalSetting } from "src/redux/statementsDateRange";
-import { getMatchParamByName } from "src/util/query";
+import { queryByName } from "src/util/query";
 
 import { StatementsPage, AggregateStatistics } from "@cockroachlabs/cluster-ui";
 import {
@@ -79,7 +79,7 @@ export const selectStatements = createSelector(
       return null;
     }
     let statements = flattenStatementStats(state.data.statements);
-    const app = getMatchParamByName(props.match, appAttr);
+    const app = queryByName(props.location, appAttr);
     const isInternal = (statement: ExecutionStatistics) =>
       statement.app.startsWith(state.data.internal_app_name_prefix);