mrva/vscode-codeql
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

Merge pull request #3102 from github/koesie10/refactor-compare-view

Browse Source 
Refactor compare view
This commit is contained in:
Koen Vlaswinkel
2023-12-05 16:49:45 +01:00
committed by GitHub
parent 3020bf711b b1289a4598
commit 9c200e036a
7 changed files with 121 additions and 86 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
extensions/ql-vscode/src/common/bqrs-cli-types.ts
View File

@@ -21,7 +21,7 @@ type ColumnKind =
| typeof ColumnKindCode.DATE
| typeof ColumnKindCode.ENTITY;
export interface Column {
interface Column {
name?: string;
kind: ColumnKind;
}
@@ -112,7 +112,7 @@ export type BqrsKind =
| "Date"
| "Entity";
interface BqrsColumn {
export interface BqrsColumn {
name?: string;
kind: BqrsKind;
}

4
extensions/ql-vscode/src/common/interface-types.ts
View File

@@ -3,8 +3,8 @@ import {
RawResultSet,
ResultRow,
ResultSetSchema,
Column,
ResolvableLocationValue,
BqrsColumn,
} from "../common/bqrs-cli-types";
import {
VariantAnalysis,
@@ -353,7 +353,7 @@ export interface SetComparisonsMessage {
time: string;
};
};
readonly columns: readonly Column[];
readonly columns: readonly BqrsColumn[];
readonly commonResultSetNames: string[];
readonly currentResultSetName: string;
readonly rows: QueryCompareResult | undefined;

125
extensions/ql-vscode/src/compare/compare-view.ts
View File

@@ -2,19 +2,15 @@ import { ViewColumn } from "vscode";
import {
FromCompareViewMessage,
ToCompareViewMessage,
QueryCompareResult,
ToCompareViewMessage,
} from "../common/interface-types";
import { Logger, showAndLogExceptionWithTelemetry } from "../common/logging";
import { extLogger } from "../common/logging/vscode";
import { CodeQLCliServer } from "../codeql-cli/cli";
import { DatabaseManager } from "../databases/local-databases";
import { jumpToLocation } from "../databases/local-databases/locations";
import {
transformBqrsResultSet,
RawResultSet,
BQRSInfo,
} from "../common/bqrs-cli-types";
import { BQRSInfo, DecodedBqrsChunk } from "../common/bqrs-cli-types";
import resultsDiff from "./resultsDiff";
import { CompletedLocalQueryInfo } from "../query-results";
import { assertNever, getErrorMessage } from "../common/helpers-pure";
@@ -26,10 +22,13 @@ import {
import { telemetryListener } from "../common/vscode/telemetry";
import { redactableError } from "../common/errors";
import { App } from "../common/app";
import { findResultSetNames } from "./result-set-names";
interface ComparePair {
from: CompletedLocalQueryInfo;
fromSchemas: BQRSInfo;
to: CompletedLocalQueryInfo;
toSchemas: BQRSInfo;
}
export class CompareView extends AbstractWebview<
@@ -56,18 +55,44 @@ export class CompareView extends AbstractWebview<
to: CompletedLocalQueryInfo,
selectedResultSetName?: string,
) {
this.comparePair = { from, to };
const fromSchemas = await this.cliServer.bqrsInfo(
from.completedQuery.query.resultsPaths.resultsPath,
);
const toSchemas = await this.cliServer.bqrsInfo(
to.completedQuery.query.resultsPaths.resultsPath,
);
this.comparePair = {
from,
fromSchemas,
to,
toSchemas,
};
await this.showResultsInternal(selectedResultSetName);
}
private async showResultsInternal(selectedResultSetName?: string) {
if (!this.comparePair) {
return;
}
const { from, to } = this.comparePair;
const panel = await this.getPanel();
panel.reveal(undefined, true);
await this.waitForPanelLoaded();
const [
const {
commonResultSetNames,
currentResultSetName,
currentResultSetDisplayName,
fromResultSet,
toResultSet,
] = await this.findCommonResultSetNames(from, to, selectedResultSetName);
if (currentResultSetName) {
} = await this.findResultSetsToCompare(
this.comparePair,
selectedResultSetName,
);
if (currentResultSetDisplayName) {
let rows: QueryCompareResult | undefined;
let message: string | undefined;
try {
@@ -93,9 +118,9 @@ export class CompareView extends AbstractWebview<
time: to.startTime,
},
},
columns: fromResultSet.schema.columns,
columns: fromResultSet.columns,
commonResultSetNames,
currentResultSetName,
currentResultSetName: currentResultSetDisplayName,
rows,
message,
databaseUri: to.initialInfo.databaseInfo.databaseUri,
@@ -165,92 +190,56 @@ export class CompareView extends AbstractWebview<
}
}
private async findCommonResultSetNames(
from: CompletedLocalQueryInfo,
to: CompletedLocalQueryInfo,
private async findResultSetsToCompare(
{ from, fromSchemas, to, toSchemas }: ComparePair,
selectedResultSetName: string | undefined,
): Promise<[string[], string, RawResultSet, RawResultSet]> {
const fromSchemas = await this.cliServer.bqrsInfo(
from.completedQuery.query.resultsPaths.resultsPath,
);
const toSchemas = await this.cliServer.bqrsInfo(
to.completedQuery.query.resultsPaths.resultsPath,
);
const fromSchemaNames = fromSchemas["result-sets"].map(
(schema) => schema.name,
);
const toSchemaNames = toSchemas["result-sets"].map((schema) => schema.name);
const commonResultSetNames = fromSchemaNames.filter((name) =>
toSchemaNames.includes(name),
);
) {
const {
commonResultSetNames,
currentResultSetDisplayName,
fromResultSetName,
toResultSetName,
} = await findResultSetNames(fromSchemas, toSchemas, selectedResultSetName);
// Fall back on the default result set names if there are no common ones.
const defaultFromResultSetName = fromSchemaNames.find((name) =>
name.startsWith("#"),
);
const defaultToResultSetName = toSchemaNames.find((name) =>
name.startsWith("#"),
);
if (
commonResultSetNames.length === 0 &&
!(defaultFromResultSetName || defaultToResultSetName)
) {
throw new Error(
"No common result sets found between the two queries. Please check that the queries are compatible.",
);
}
const currentResultSetName =
selectedResultSetName || commonResultSetNames[0];
const fromResultSet = await this.getResultSet(
fromSchemas,
currentResultSetName || defaultFromResultSetName!,
fromResultSetName,
from.completedQuery.query.resultsPaths.resultsPath,
);
const toResultSet = await this.getResultSet(
toSchemas,
currentResultSetName || defaultToResultSetName!,
toResultSetName,
to.completedQuery.query.resultsPaths.resultsPath,
);
return [
return {
commonResultSetNames,
currentResultSetName ||
`${defaultFromResultSetName} <-> ${defaultToResultSetName}`,
currentResultSetDisplayName,
fromResultSet,
toResultSet,
];
};
}
private async changeTable(newResultSetName: string) {
if (!this.comparePair?.from || !this.comparePair.to) {
return;
}
await this.showResults(
this.comparePair.from,
this.comparePair.to,
newResultSetName,
);
await this.showResultsInternal(newResultSetName);
}
private async getResultSet(
bqrsInfo: BQRSInfo,
resultSetName: string,
resultsPath: string,
): Promise<RawResultSet> {
): Promise<DecodedBqrsChunk> {
const schema = bqrsInfo["result-sets"].find(
(schema) => schema.name === resultSetName,
);
if (!schema) {
throw new Error(`Schema ${resultSetName} not found.`);
}
const chunk = await this.cliServer.bqrsDecode(resultsPath, resultSetName);
return transformBqrsResultSet(schema, chunk);
return await this.cliServer.bqrsDecode(resultsPath, resultSetName);
}
private compareResults(
fromResults: RawResultSet,
toResults: RawResultSet,
fromResults: DecodedBqrsChunk,
toResults: DecodedBqrsChunk,
): QueryCompareResult {
// Only compare columns that have the same name
return resultsDiff(fromResults, toResults);

45
extensions/ql-vscode/src/compare/result-set-names.ts Normal file
View File

@@ -0,0 +1,45 @@
import { BQRSInfo } from "../common/bqrs-cli-types";
export async function findResultSetNames(
fromSchemas: BQRSInfo,
toSchemas: BQRSInfo,
selectedResultSetName: string | undefined,
) {
const fromSchemaNames = fromSchemas["result-sets"].map(
(schema) => schema.name,
);
const toSchemaNames = toSchemas["result-sets"].map((schema) => schema.name);
const commonResultSetNames = fromSchemaNames.filter((name) =>
toSchemaNames.includes(name),
);
// Fall back on the default result set names if there are no common ones.
const defaultFromResultSetName = fromSchemaNames.find((name) =>
name.startsWith("#"),
);
const defaultToResultSetName = toSchemaNames.find((name) =>
name.startsWith("#"),
);
if (
commonResultSetNames.length === 0 &&
!(defaultFromResultSetName || defaultToResultSetName)
) {
throw new Error(
"No common result sets found between the two queries. Please check that the queries are compatible.",
);
}
const currentResultSetName = selectedResultSetName || commonResultSetNames[0];
const fromResultSetName = currentResultSetName || defaultFromResultSetName!;
const toResultSetName = currentResultSetName || defaultToResultSetName!;
return {
commonResultSetNames,
currentResultSetDisplayName:
currentResultSetName ||
`${defaultFromResultSetName} <-> ${defaultToResultSetName}`,
fromResultSetName,
toResultSetName,
};
}

20
extensions/ql-vscode/src/compare/resultsDiff.ts
View File

@@ -1,4 +1,4 @@
import { RawResultSet } from "../common/bqrs-cli-types";
import { DecodedBqrsChunk } from "../common/bqrs-cli-types";
import { QueryCompareResult } from "../common/interface-types";
/**
@@ -20,29 +20,29 @@ import { QueryCompareResult } from "../common/interface-types";
* 3. If the queries are 100% disjoint
*/
export default function resultsDiff(
fromResults: RawResultSet,
toResults: RawResultSet,
fromResults: DecodedBqrsChunk,
toResults: DecodedBqrsChunk,
): QueryCompareResult {
if (fromResults.schema.columns.length !== toResults.schema.columns.length) {
if (fromResults.columns.length !== toResults.columns.length) {
throw new Error("CodeQL Compare: Columns do not match.");
}
if (!fromResults.rows.length) {
if (!fromResults.tuples.length) {
throw new Error("CodeQL Compare: Source query has no results.");
}
if (!toResults.rows.length) {
if (!toResults.tuples.length) {
throw new Error("CodeQL Compare: Target query has no results.");
}
const results = {
from: arrayDiff(fromResults.rows, toResults.rows),
to: arrayDiff(toResults.rows, fromResults.rows),
from: arrayDiff(fromResults.tuples, toResults.tuples),
to: arrayDiff(toResults.tuples, fromResults.tuples),
};
if (
fromResults.rows.length === results.from.length &&
toResults.rows.length === results.to.length
fromResults.tuples.length === results.from.length &&
toResults.tuples.length === results.to.length
) {
throw new Error("CodeQL Compare: No overlap between the selected queries.");
}

4
extensions/ql-vscode/src/stories/compare/CompareTable.stories.tsx
View File

@@ -32,8 +32,8 @@ CompareTable.args = {
},
},
columns: [
{ name: "a", kind: "e" },
{ name: "b", kind: "e" },
{ name: "a", kind: "Entity" },
{ name: "b", kind: "Entity" },
],
commonResultSetNames: ["edges", "nodes", "subpaths", "#select"],
currentResultSetName: "edges",

5
extensions/ql-vscode/src/view/results/RawTableHeader.tsx
View File

@@ -6,10 +6,11 @@ import {
SortDirection,
} from "../../common/interface-types";
import { nextSortDirection } from "./result-table-utils";
import { Column } from "../../common/bqrs-cli-types";
interface Props {
readonly columns: readonly Column[];
readonly columns: ReadonlyArray<{
name?: string;
}>;
readonly schemaName: string;
readonly sortState?: RawResultsSortState;
readonly preventSort?: boolean;