Merge pull request #3669 from github/dbartol/provenance

Display path provenance information in results view

Author: Dave Bartolomeo

extensions/ql-vscode/src/common/interface-types.ts

@@ -147,6 +147,21 @@ interface SetStateMsg {
   parsedResultSets: ParsedResultSets;
 }
 
+export interface UserSettings {
+  /** Whether to display links to the dataflow models that generated particular nodes in a flow path. */
+  shouldShowProvenance: boolean;
+}
+
+export const DEFAULT_USER_SETTINGS: UserSettings = {
+  shouldShowProvenance: false,
+};
+
+/** Message indicating that the user's configuration settings have changed. */
+interface SetUserSettingsMsg {
+  t: "setUserSettings";
+  userSettings: UserSettings;
+}
+
 /**
  * Message indicating that the results view should display interpreted
  * results.
@@ -191,6 +206,7 @@ interface UntoggleShowProblemsMsg {
 export type IntoResultsViewMsg =
   | ResultsUpdatingMsg
   | SetStateMsg
+  | SetUserSettingsMsg
   | ShowInterpretedPageMsg
   | NavigateMsg
   | UntoggleShowProblemsMsg;
@@ -208,13 +224,15 @@ export type FromResultsViewMsg =
   | OpenFileMsg;
 
 /**
- * Message from the results view to open a database source
+ * Message from the results view to open a source
  * file at the provided location.
  */
 interface ViewSourceFileMsg {
   t: "viewSourceFile";
   loc: UrlValueResolvable;
-  databaseUri: string;
+  /** URI of the database whose source archive contains the file, or `undefined` to open a file from
+   * the local disk. The latter case is used for opening links to data extension model files. */
+  databaseUri: string | undefined;
 }
 
 /**
@@ -341,7 +359,8 @@ interface ChangeCompareMessage {
 
 export type ToCompareViewMessage =
   | SetComparisonQueryInfoMessage
-  | SetComparisonsMessage;
+  | SetComparisonsMessage
+  | SetUserSettingsMsg;
 
 /**
  * Message to the compare view that sets the metadata of the compared queries.

extensions/ql-vscode/src/common/sarif-parser.ts

@@ -1,18 +1,20 @@
-import type { Log, Tool } from "sarif";
+import type { Log } from "sarif";
 import { createReadStream } from "fs-extra";
 import { connectTo } from "stream-json/Assembler";
 import { getErrorMessage } from "./helpers-pure";
-import { withParser } from "stream-json/filters/Pick";
-
-const DUMMY_TOOL: Tool = { driver: { name: "" } };
+import { withParser } from "stream-json/filters/Ignore";
 
 export async function sarifParser(
   interpretedResultsPath: string,
 ): Promise<Log> {
   try {
-    // Parse the SARIF file into token streams, filtering out only the results array.
+    // Parse the SARIF file into token streams, filtering out some of the larger subtrees that we
+    // don't need.
     const pipeline = createReadStream(interpretedResultsPath).pipe(
-      withParser({ filter: "runs.0.results" }),
+      withParser({
+        // We don't need to run's `artifacts` property, nor the driver's `notifications` property.
+        filter: /^runs\.\d+\.(artifacts|tool\.driver\.notifications)/,
+      }),
     );
 
     // Creates JavaScript objects from the token stream
@@ -38,15 +40,17 @@ export async function sarifParser(
       });
 
       asm.on("done", (asm) => {
-        const log: Log = {
-          version: "2.1.0",
-          runs: [
-            {
-              tool: DUMMY_TOOL,
-              results: asm.current ?? [],
-            },
-          ],
-        };
+        const log = asm.current;
+
+        // Do some trivial validation. This isn't a full validation of the SARIF file, but it's at
+        // least enough to ensure that we're not trying to parse complete garbage later.
+        if (log.runs === undefined || log.runs.length < 1) {
+          reject(
+            new Error(
+              "Invalid SARIF file: expecting at least one run with result.",
+            ),
+          );
+        }
 
         resolve(log);
         alreadyDone = true;

extensions/ql-vscode/src/compare/compare-view.ts

@@ -33,6 +33,7 @@ import {
   getResultSetNames,
 } from "./result-set-names";
 import { compareInterpretedResults } from "./interpreted-results";
+import { isCanary } from "../config";
 
 interface ComparePair {
   from: CompletedLocalQueryInfo;
@@ -116,6 +117,13 @@ export class CompareView extends AbstractWebview<
     panel.reveal(undefined, true);
     await this.waitForPanelLoaded();
 
+    await this.postMessage({
+      t: "setUserSettings",
+      userSettings: {
+        shouldShowProvenance: isCanary(),
+      },
+    });
+
     await this.postMessage({
       t: "setComparisonQueryInfo",
       stats: {

extensions/ql-vscode/src/databases/local-databases/locations.ts

@@ -37,11 +37,12 @@ export const shownLocationLineDecoration =
 /**
  * Resolves the specified CodeQL location to a URI into the source archive.
  * @param loc CodeQL location to resolve. Must have a non-empty value for `loc.file`.
- * @param databaseItem Database in which to resolve the file location.
+ * @param databaseItem Database in which to resolve the file location, or `undefined` to resolve
+ *   from the local file system.
  */
 function resolveFivePartLocation(
   loc: UrlValueLineColumnLocation,
-  databaseItem: DatabaseItem,
+  databaseItem: DatabaseItem | undefined,
 ): Location {
   // `Range` is a half-open interval, and is zero-based. CodeQL locations are closed intervals, and
   // are one-based. Adjust accordingly.
@@ -52,7 +53,10 @@ function resolveFivePartLocation(
     Math.max(1, loc.endColumn),
   );
 
-  return new Location(databaseItem.resolveSourceFile(loc.uri), range);
+  return new Location(
+    databaseItem?.resolveSourceFile(loc.uri) ?? Uri.parse(loc.uri),
+    range,
+  );
 }
 
 /**
@@ -62,22 +66,26 @@ function resolveFivePartLocation(
  */
 function resolveWholeFileLocation(
   loc: UrlValueWholeFileLocation,
-  databaseItem: DatabaseItem,
+  databaseItem: DatabaseItem | undefined,
 ): Location {
   // A location corresponding to the start of the file.
   const range = new Range(0, 0, 0, 0);
-  return new Location(databaseItem.resolveSourceFile(loc.uri), range);
+  return new Location(
+    databaseItem?.resolveSourceFile(loc.uri) ?? Uri.parse(loc.uri),
+    range,
+  );
 }
 
 /**
  * Try to resolve the specified CodeQL location to a URI into the source archive. If no exact location
  * can be resolved, returns `undefined`.
  * @param loc CodeQL location to resolve
- * @param databaseItem Database in which to resolve the file location.
+ * @param databaseItem Database in which to resolve the file location, or `undefined` to resolve
+ *   from the local file system.
  */
 export function tryResolveLocation(
   loc: UrlValueResolvable | undefined,
-  databaseItem: DatabaseItem,
+  databaseItem: DatabaseItem | undefined,
 ): Location | undefined {
   if (!loc) {
     return;
@@ -95,7 +103,7 @@ export function tryResolveLocation(
 
 export async function showResolvableLocation(
   loc: UrlValueResolvable,
-  databaseItem: DatabaseItem,
+  databaseItem: DatabaseItem | undefined,
   logger: Logger,
 ): Promise<void> {
   try {
@@ -151,13 +159,14 @@ export async function showLocation(location?: Location) {
 }
 
 export async function jumpToLocation(
-  databaseUri: string,
+  databaseUri: string | undefined,
   loc: UrlValueResolvable,
   databaseManager: DatabaseManager,
   logger: Logger,
 ) {
-  const databaseItem = databaseManager.findDatabaseItem(Uri.parse(databaseUri));
-  if (databaseItem !== undefined) {
-    await showResolvableLocation(loc, databaseItem, logger);
-  }
+  const databaseItem =
+    databaseUri !== undefined
+      ? databaseManager.findDatabaseItem(Uri.parse(databaseUri))
+      : undefined;
+  await showResolvableLocation(loc, databaseItem, logger);
 }

extensions/ql-vscode/src/local-queries/results-view.ts

@@ -537,6 +537,14 @@ export class ResultsView extends AbstractWebview<
       resultSetNames,
     };
 
+    await this.postMessage({
+      t: "setUserSettings",
+      userSettings: {
+        // Only show provenance info in canary mode for now.
+        shouldShowProvenance: isCanary(),
+      },
+    });
+
     await this.postMessage({
       t: "setState",
       interpretation: interpretationPage,

extensions/ql-vscode/src/view/compare/Compare.tsx

@@ -5,7 +5,9 @@ import type {
   ToCompareViewMessage,
   SetComparisonsMessage,
   SetComparisonQueryInfoMessage,
+  UserSettings,
 } from "../../common/interface-types";
+import { DEFAULT_USER_SETTINGS } from "../../common/interface-types";
 import CompareSelector from "./CompareSelector";
 import { vscode } from "../vscode-api";
 import CompareTable from "./CompareTable";
@@ -31,6 +33,9 @@ export function Compare(_: Record<string, never>): React.JSX.Element {
   const [comparison, setComparison] = useState<SetComparisonsMessage | null>(
     null,
   );
+  const [userSettings, setUserSettings] = useState<UserSettings>(
+    DEFAULT_USER_SETTINGS,
+  );
 
   const message = comparison?.message || "Empty comparison";
   const hasRows =
@@ -48,6 +53,9 @@ export function Compare(_: Record<string, never>): React.JSX.Element {
           case "setComparisons":
             setComparison(msg);
             break;
+          case "setUserSettings":
+            setUserSettings(msg.userSettings);
+            break;
           default:
             assertNever(msg);
         }
@@ -85,6 +93,7 @@ export function Compare(_: Record<string, never>): React.JSX.Element {
           <CompareTable
             queryInfo={queryInfo}
             comparison={comparison}
+            userSettings={userSettings}
           ></CompareTable>
         ) : (
           <Message>{message}</Message>

extensions/ql-vscode/src/view/compare/CompareTable.tsx

@@ -1,6 +1,7 @@
 import type {
   SetComparisonQueryInfoMessage,
   SetComparisonsMessage,
+  UserSettings,
 } from "../../common/interface-types";
 import { className } from "../results/result-table-utils";
 import { vscode } from "../vscode-api";
@@ -12,6 +13,7 @@ import { InterpretedCompareResultTable } from "./InterpretedCompareResultTable";
 interface Props {
   queryInfo: SetComparisonQueryInfoMessage;
   comparison: SetComparisonsMessage;
+  userSettings: UserSettings;
 }
 
 const OpenButton = styled(TextButton)`
@@ -29,7 +31,11 @@ const Table = styled.table`
   }
 `;
 
-export default function CompareTable({ queryInfo, comparison }: Props) {
+export default function CompareTable({
+  queryInfo,
+  comparison,
+  userSettings,
+}: Props) {
   const result = comparison.result!;
 
   async function openQuery(kind: "from" | "to") {
@@ -78,6 +84,7 @@ export default function CompareTable({ queryInfo, comparison }: Props) {
             {result.kind === "interpreted" && (
               <InterpretedCompareResultTable
                 results={result.from}
+                userSettings={userSettings}
                 databaseUri={queryInfo.databaseUri}
                 sourceLocationPrefix={result.sourceLocationPrefix}
               />
@@ -96,6 +103,7 @@ export default function CompareTable({ queryInfo, comparison }: Props) {
             {result.kind === "interpreted" && (
               <InterpretedCompareResultTable
                 results={result.to}
+                userSettings={userSettings}
                 databaseUri={queryInfo.databaseUri}
                 sourceLocationPrefix={result.sourceLocationPrefix}
               />

extensions/ql-vscode/src/view/compare/InterpretedCompareResultTable.tsx

@@ -1,27 +1,32 @@
-import type { Result } from "sarif";
+import type { Result, Run } from "sarif";
 import { AlertTable } from "../results/AlertTable";
+import type { UserSettings } from "../../common/interface-types";
 
 type Props = {
   results: Result[];
   databaseUri: string;
   sourceLocationPrefix: string;
+  run?: Run;
+  userSettings: UserSettings;
 };
 
 export const InterpretedCompareResultTable = ({
   results,
   databaseUri,
   sourceLocationPrefix,
+  userSettings,
 }: Props) => {
   return (
     <AlertTable
       results={results}
+      userSettings={userSettings}
       databaseUri={databaseUri}
       sourceLocationPrefix={sourceLocationPrefix}
       header={
         <thead>
           <tr>
             <th colSpan={2}></th>
-            <th className={`vscode-codeql__alert-message-cell`} colSpan={3}>
+            <th className={`vscode-codeql__alert-message-cell`} colSpan={4}>
               Message
             </th>
           </tr>

extensions/ql-vscode/src/view/results/AlertTable.tsx

@@ -1,4 +1,4 @@
-import type { Location, Result } from "sarif";
+import type { Location, Result, Run } from "sarif";
 import type {
   PathNode,
   Result as ResultKeysResult,
@@ -7,7 +7,7 @@ import type {
 import { getPath, getPathNode, getResult, keyToString } from "./result-keys";
 import { className, jumpToLocation } from "./result-table-utils";
 import { onNavigation } from "./navigation";
-import type { NavigateMsg } from "../../common/interface-types";
+import type { NavigateMsg, UserSettings } from "../../common/interface-types";
 import { NavigationDirection } from "../../common/interface-types";
 import { isNoLocation, parseSarifLocation } from "../../common/sarif-utils";
 import { sendTelemetry } from "../common/telemetry";
@@ -21,6 +21,8 @@ type Props = {
   results: Result[];
   databaseUri: string;
   sourceLocationPrefix: string;
+  run?: Run;
+  userSettings: UserSettings;
   numTruncatedResults?: number;
 
   header: ReactNode;
@@ -31,6 +33,8 @@ export function AlertTable({
   results,
   databaseUri,
   sourceLocationPrefix,
+  run,
+  userSettings,
   numTruncatedResults,
   header,
   noResults,
@@ -202,6 +206,8 @@ export function AlertTable({
             selectedItem={selectedItem}
             selectedItemRef={selectedItemRef}
             databaseUri={databaseUri}
+            run={run}
+            userSettings={userSettings}
             sourceLocationPrefix={sourceLocationPrefix}
             updateSelectionCallback={updateSelectionCallback}
             toggleExpanded={toggle}