Skip to content

Commit

Permalink
ui: allow stmts page to search across explain plan page
Browse files Browse the repository at this point in the history
Closes: cockroachdb#71615.

Previously, the search functionality for the stmts page only allowed a search
through the statement query. This change adds the statement's Plan as part of
that search.

Release note (ui change): logical plan text included in searchable text for
stmts page.
  • Loading branch information
Gerardo Torres committed Jan 18, 2022
1 parent 28944f9 commit e62728e
Show file tree
Hide file tree
Showing 3 changed files with 128 additions and 7 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@ import {
flattenTreeAttributes,
flattenAttributes,
standardizeKey,
planNodeToString,
planNodeAttrsToString,
} from "./planView";
import IAttr = cockroach.sql.ExplainTreePlanNode.IAttr;

Expand Down Expand Up @@ -260,4 +262,94 @@ describe("planView", () => {
assert.equal(standardizeKey("(anti) hello world"), "helloWorld");
});
});

describe("planNodeAttrsToString", () => {
it("should convert an array of FlatPlanNodeAttribute[] into a string", () => {
const testNodeAttrs: FlatPlanNodeAttribute[] = [
{
key: "Into",
values: ["users(id, city, name, address, credit_card)"],
warn: false,
},
{
key: "Size",
values: ["5 columns, 5 rows"],
warn: false,
},
];

const expectedString =
"Into users(id, city, name, address, credit_card) Size 5 columns, 3 rows";

assert.deepEqual(planNodeAttrsToString(testNodeAttrs), expectedString);
});
});

describe("planNodeToString", () => {
it("should recursively convert a FlatPlanNode into a string.", () => {
const testPlanNode: FlatPlanNode = {
name: "insert fast path",
attrs: [
{
key: "Into",
values: ["users(id, city, name, address, credit_card)"],
warn: false,
},
{
key: "Size",
values: ["5 columns, 5 rows"],
warn: false,
},
],
children: null,
};

const expectedString =
"insert fast path Into users(id, city, name, address, credit_card) Size 5 columns, 5 rows";

assert.deepEqual(planNodeToString(testPlanNode), expectedString);
});

it("should recursively convert a FlatPlanNode (with children) into a string.", () => {
const testPlanNode: FlatPlanNode = {
name: "render",
attrs: [],
children: [
{
name: "group (scalar)",
attrs: [],
children: [
{
name: "filter",
attrs: [
{
key: "filter",
values: ["variable = _"],
warn: false,
},
],
children: [
{
name: "virtual table",
attrs: [
{
key: "table",
values: ["cluster_settings@primary"],
warn: false,
},
],
children: [],
},
],
},
],
},
],
};

const expectedString =
"render group (scalar) filter filter variable = _ virtual table table cluster_settings@primary";
assert.deepEqual(planNodeToString(testPlanNode), expectedString);
});
});
});
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,23 @@ function warnForAttribute(attr: IAttr): boolean {
return false;
}

// planNodeAttrsToString converts an array of FlatPlanNodeAttribute[] into a string.
export function planNodeAttrsToString(attrs: FlatPlanNodeAttribute[]): string {
return attrs.map(attr => `${attr.key} ${attr.values.join(" ")}`).join(" ");
}

// planNodeAttributesToString recursively converts a FlatPlanNode into a string.
export function planNodeToString(plan: FlatPlanNode): string {
const str = `${plan.name} ${planNodeAttrsToString(plan.attrs)}`;

if (plan.children.length > 0) {
return plan.children
.map(child => `${str} ${planNodeToString(child)}`)
.join(" ");
}
return str;
}

// flattenAttributes takes a list of attrs (IAttr[]) and collapses
// all the values for the same key (FlatPlanNodeAttribute). For example,
// if attrs was:
Expand Down
26 changes: 19 additions & 7 deletions pkg/ui/workspaces/cluster-ui/src/statementsPage/statementsPage.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,7 @@ import {
} from "../timeScaleDropdown";

import { commonStyles } from "../common";
import { flattenTreeAttributes, planNodeToString } from "../statementDetails";
const cx = classNames.bind(styles);
const sortableTableCx = classNames.bind(sortableTableStyles);

Expand Down Expand Up @@ -146,6 +147,23 @@ function statementsRequestFromProps(
});
}

// filterBySearchQuery returns true if a search query matches the statement.
function filterBySearchQuery(
statement: AggregateStatistics,
search: string,
): boolean {
const label = statement.label.toLowerCase();
const tree = flattenTreeAttributes(
statement.stats.sensitive_info &&
statement.stats.sensitive_info.most_recent_plan_description,
);
const plan = planNodeToString(tree).toLowerCase();
const matchString = `${label}|${plan}`;
return search
.split(" ")
.every(val => matchString.includes(val.toLowerCase()));
}

export class StatementsPage extends React.Component<
StatementsPageProps,
StatementsPageState
Expand Down Expand Up @@ -409,13 +427,7 @@ export class StatementsPage extends React.Component<
)
.filter(statement => (filters.fullScan ? statement.fullScan : true))
.filter(statement =>
search
? search
.split(" ")
.every(val =>
statement.label.toLowerCase().includes(val.toLowerCase()),
)
: true,
search ? filterBySearchQuery(statement, search) : true,
)
.filter(
statement =>
Expand Down

0 comments on commit e62728e

Please sign in to comment.