cluster-ui: move table details endpoint to use sql-over-http #98326

THardy98 · 2023-03-09T19:18:01Z

Part of: #89429
Resolves: #90264, #90268

This PR migrates our existing admin API table details endpoint to
use sql-over-http in cluster-ui. We change the structure of the table
details response, allowing each field to be a self-contained query
response. The exception here is the stats field, which is comprised of
a couple query responses. Changing the structure scopes errors at the
query-level, instead of the response level. This is important as it
allows us to still make use of partial data on the UI when only a subset
of the queries succeed.

The commit also coalesces the former table stats and table details API
into a single table details API. The only difference/movement here is
that the table details endpoint now fetches span statistics.

The data for table details is populated using 10 queries, which fetch
the table's:

ID
grants
schema details (columns & indexes)
create statement
zone configuration statement
zone configuration
heuristics details (specifically, the timestamp at which table
heuristics were last updated)
span statistics
index usage statistics
replicas

This largely reflects like for like how we fetch data from the existing
admin api endpoint. We can improve upon this (i.e. remove bloating) in
follow up PRs.

Short Demo
https://www.loom.com/share/698c10c5752e439a9edb0ec2301771c1

Release note: None

cockroach-teamcity · 2023-03-09T19:18:18Z

This change is

j82w

Reviewable status: complete! 0 of 0 LGTMs obtained (waiting on @THardy98)

pkg/ui/workspaces/cluster-ui/src/api/tableDetailsApi.ts line 289 at r1 (raw file):

      // and not empty.
      if (
        txn_result.rows[0].database_zone_config_bytes &&

nit: txn_result.rows[0] seems to be accessed a lot in this method. Why not set it to a const and use that everywhere to avoid the long lines of code?

pkg/ui/workspaces/cluster-ui/src/api/tableDetailsApi.ts line 292 at r1 (raw file):

        txn_result.rows[0].database_zone_config_bytes.length !== 0
      ) {
        zoneConfigData.hexString =

Any way to use the sql function encode(column, 'hex') to remove the hex logic?

pkg/ui/workspaces/cluster-ui/src/api/tableDetailsApi.ts line 333 at r1 (raw file):

// Table heuristics details.
type TableHeuristicsDetails = TableHeuristicDetailsRow & {

Any reason you aren't using the new SqlApiResponse for all these types?

pkg/ui/workspaces/cluster-ui/src/api/tableDetailsApi.ts line 420 at r1 (raw file):

    if (!(!txn_result.rows || txn_result.rows?.length === 0)) {
      resp.stats.pebble_data.approximate_disk_bytes =
        txn_result.rows[0].approximate_disk_bytes;

Is there a guarantee that it will always be 1 row? If it is please add a check and log to console if there is more than 1 row. It's very hard to identify and root cause partial results.

pkg/ui/workspaces/cluster-ui/src/api/tableDetailsApi.ts line 518 at r1 (raw file):

        [new Identifier(dbName)],
      ),
      arguments: [escFullTableName.SQLString(), dbName],

Should we get both the name and ids for the dbs/tables to avoid the overhead of the lookup?

pkg/ui/workspaces/cluster-ui/src/api/util.ts line 44 at r1 (raw file):

}

export const stripLeadingHexMarker = (hexString: string): string => {

Should FixFingerprintHexValue be used instead?

THardy98

Reviewable status: complete! 0 of 0 LGTMs obtained (waiting on @j82w)

pkg/ui/workspaces/cluster-ui/src/api/tableDetailsApi.ts line 289 at r1 (raw file):