cluster-ui: handle partial response errors on the database details page

Part of: #102386

This change applies the same error handling ideas from #109245 to the
database details page, enabling non-admin users to use the database
details page and providing better transparency to data fetching issues.

Errors encountered while fetching table details can be viewed via the
tooltip provided by the `Caution` icon at the table's name.
`unavailable` cells also provide a tooltip that displays the error
impacting that exact cell.

Release note (ui change): Non-admin users are able to use the database
details page.

pkg/ui/workspaces/cluster-ui/src/api/sqlApi.ts

@@ -146,7 +146,7 @@ export function isUpgradeError(message: string): boolean {
 }
 
 /**
- * errorMessage cleans the error message returned by the sqlApi,
+ * sqlApiErrorMessage cleans the error message returned by the sqlApi,
  * removing information not useful for the user.
  * e.g. the error message
  * "$executing stmt 1: run-query-via-api: only users with either MODIFYCLUSTERSETTING
@@ -166,9 +166,8 @@ export function sqlApiErrorMessage(message: string): string {
 
   message = message.replace("run-query-via-api: ", "");
   if (message.includes(":")) {
-    return message.split(":")[1];
+    return message.substring(message.indexOf(":"));
   }
-
   return message;
 }
 

pkg/ui/workspaces/cluster-ui/src/api/tableDetailsApi.ts

@@ -9,6 +9,7 @@
 // licenses/APL.txt.
 
 import {
+  combineQueryErrors,
   executeInternalSql,
   formatApiResult,
   LARGE_RESULT_SIZE,
@@ -111,7 +112,7 @@ const getTableId: TableDetailsQuery<TableIdRow> = {
 };
 
 // Table create statement.
-type TableCreateStatementRow = { create_statement: string };
+export type TableCreateStatementRow = { create_statement: string };
 
 const getTableCreateStatement: TableDetailsQuery<TableCreateStatementRow> = {
   createStmt: (dbName, tableName) => {
@@ -129,22 +130,22 @@ const getTableCreateStatement: TableDetailsQuery<TableCreateStatementRow> = {
     txn_result: SqlTxnResult<TableCreateStatementRow>,
     resp: TableDetailsResponse,
   ) => {
+    if (txn_result.error) {
+      resp.createStmtResp.error = txn_result.error;
+    }
     if (!txnResultIsEmpty(txn_result)) {
       resp.createStmtResp.create_statement =
         txn_result.rows[0].create_statement;
-    } else {
+    } else if (!txn_result.error) {
       txn_result.error = new Error(
         "getTableCreateStatement: unexpected empty results",
       );
     }
-    if (txn_result.error) {
-      resp.createStmtResp.error = txn_result.error;
-    }
   },
 };
 
 // Table grants.
-type TableGrantsResponse = {
+export type TableGrantsResponse = {
   grants: TableGrantsRow[];
 };
 
@@ -181,7 +182,7 @@ const getTableGrants: TableDetailsQuery<TableGrantsRow> = {
 };
 
 // Table schema details.
-type TableSchemaDetailsRow = {
+export type TableSchemaDetailsRow = {
   columns: string[];
   indexes: string[];
 };
@@ -332,7 +333,7 @@ const getTableZoneConfig: TableDetailsQuery<TableZoneConfigRow> = {
 };
 
 // Table heuristics details.
-type TableHeuristicDetailsRow = {
+export type TableHeuristicDetailsRow = {
   stats_last_created_at: moment.Moment;
 };
 
@@ -371,7 +372,7 @@ type TableDetailsStats = {
 };
 
 // Table span stats.
-type TableSpanStatsRow = {
+export type TableSpanStatsRow = {
   approximate_disk_bytes: number;
   live_bytes: number;
   total_bytes: number;
@@ -418,7 +419,7 @@ const getTableSpanStats: TableDetailsQuery<TableSpanStatsRow> = {
   },
 };
 
-type TableReplicaData = SqlApiQueryResponse<{
+export type TableReplicaData = SqlApiQueryResponse<{
   nodeIDs: number[];
   nodeCount: number;
   replicaCount: number;
@@ -471,7 +472,7 @@ const getTableReplicas: TableDetailsQuery<TableReplicasRow> = {
 };
 
 // Table index usage stats.
-type TableIndexUsageStats = {
+export type TableIndexUsageStats = {
   has_index_recommendations: boolean;
 };
 
@@ -568,6 +569,7 @@ export function createTableDetailsReq(
     max_result_size: LARGE_RESULT_SIZE,
     timeout: LONG_TIMEOUT,
     database: dbName,
+    separate_txns: true,
   };
 }
 
@@ -604,19 +606,24 @@ async function fetchTableDetails(
     csIndexUnusedDuration,
   );
   const resp = await executeInternalSql<TableDetailsRow>(req);
+  const errs: Error[] = [];
   resp.execution.txn_results.forEach(txn_result => {
-    if (txn_result.rows) {
-      const query: TableDetailsQuery<TableDetailsRow> =
-        tableDetailQueries[txn_result.statement - 1];
-      query.addToTableDetail(txn_result, detailsResponse);
+    if (txn_result.error) {
+      errs.push(txn_result.error);
     }
+    const query: TableDetailsQuery<TableDetailsRow> =
+      tableDetailQueries[txn_result.statement - 1];
+    query.addToTableDetail(txn_result, detailsResponse);
   });
   if (resp.error) {
     detailsResponse.error = resp.error;
   }
+
+  detailsResponse.error = combineQueryErrors(errs, detailsResponse.error);
   return formatApiResult<TableDetailsResponse>(
     detailsResponse,
     detailsResponse.error,
-    "retrieving table details information",
+    `retrieving table details information for table '${tableName}'`,
+    false,
   );
 }

pkg/ui/workspaces/cluster-ui/src/databaseDetailsPage/databaseDetailsConnected.ts

@@ -37,7 +37,7 @@ import {
   selectDatabaseDetailsTablesSortSetting,
   selectDatabaseDetailsViewModeSetting,
 } from "../store/databaseDetails/databaseDetails.selectors";
-import { combineLoadingErrors, deriveTableDetailsMemoized } from "../databases";
+import { deriveTableDetailsMemoized } from "../databases";
 import {
   selectDropUnusedIndexDuration,
   selectIndexRecommendationsEnabled,
@@ -56,11 +56,8 @@ const mapStateToProps = (
   return {
     loading: !!databaseDetails[database]?.inFlight,
     loaded: !!databaseDetails[database]?.valid,
-    lastError: combineLoadingErrors(
-      databaseDetails[database]?.lastError,
-      databaseDetails[database]?.data?.maxSizeReached,
-      null,
-    ),
+    requestError: databaseDetails[database]?.lastError,
+    queryError: databaseDetails[database]?.data?.results?.error,
     name: database,
     showNodeRegionsColumn: Object.keys(nodeRegions).length > 1 && !isTenant,
     viewMode: selectDatabaseDetailsViewModeSetting(state),

pkg/ui/workspaces/cluster-ui/src/databaseDetailsPage/databaseDetailsPage.stories.tsx

@@ -33,7 +33,8 @@ const history = H.createHashHistory();
 const withLoadingIndicator: DatabaseDetailsPageProps = {
   loading: true,
   loaded: false,
-  lastError: undefined,
+  requestError: undefined,
+  queryError: undefined,
   showIndexRecommendations: false,
   csIndexUnusedDuration: "168h",
   name: randomName(),
@@ -67,7 +68,8 @@ const withLoadingIndicator: DatabaseDetailsPageProps = {
 const withoutData: DatabaseDetailsPageProps = {
   loading: false,
   loaded: true,
-  lastError: null,
+  requestError: null,
+  queryError: undefined,
   showIndexRecommendations: false,
   csIndexUnusedDuration: "168h",
   name: randomName(),
@@ -107,7 +109,8 @@ function createTable(): DatabaseDetailsPageDataTable {
   return {
     loading: false,
     loaded: true,
-    lastError: null,
+    requestError: null,
+    queryError: undefined,
     name: randomName(),
     details: {
       columnCount: _.random(5, 42),