Merge branch 'main' into aeisenberg/ast-viewer

Author: jcreedcmu

extensions/ql-vscode/CHANGELOG.md

@@ -3,6 +3,7 @@
 ## [Unreleased]
 
 - Add the AST Viewer to inspect the QL AST of a source file in a database. Currently, only available for C/C++ sources.
+- Fix error with choosing qlpack search path.
 
 ## 1.3.1 - 7 July 2020
 

extensions/ql-vscode/gulpfile.js/webpack.config.ts

@@ -20,6 +20,9 @@ export const config: webpack.Configuration = {
       {
         test: /\.(ts|tsx)$/,
         loader: 'ts-loader',
+        options: {
+          configFile: 'src/view/tsconfig.json',
+        }
       },
       {
         test: /\.less$/,

extensions/ql-vscode/package.json

@@ -654,8 +654,6 @@
     "node-fetch": "~2.6.0",
     "react": "^16.8.6",
     "react-dom": "^16.8.6",
-    "semmle-bqrs": "^0.0.1",
-    "semmle-io-node": "^0.0.1",
     "@github/codeql-vscode-utils": "^0.0.4",
     "tmp": "^0.1.0",
     "tree-kill": "~1.2.2",

extensions/ql-vscode/src/adapt.ts

@@ -1,5 +1,5 @@
 import { DecodedBqrsChunk, ResultSetSchema, ColumnKind, Column, ColumnValue } from './bqrs-cli-types';
-import { LocationValue, ResultSetSchema as AdaptedSchema, ColumnSchema, ColumnType, LocationStyle } from 'semmle-bqrs';
+import { LocationValue, ResultSetSchema as AdaptedSchema, ColumnSchema, ColumnType, LocationStyle } from './bqrs-types';
 import { ResultSet } from './interface-types';
 
 // FIXME: This is a temporary bit of impedance matching to convert

extensions/ql-vscode/src/bqrs-types.ts

@@ -0,0 +1,102 @@
+/**
+ * TODO: Types in this file are deprecated, and uses of them should be
+ * migrated to the analogous types in bqrs-cli-types.
+ */
+
+export enum LocationStyle {
+  None = 0,
+  String,
+  FivePart,
+  /** Does not occur in BQRS files. Used only to distinguish whole-file locations in client code. */
+  WholeFile
+}
+
+/**
+ * A primitive type (any type other than an element).
+ */
+export type PrimitiveTypeKind = 's' | 'b' | 'i' | 'f' | 'd' | 'u';
+
+/**
+ * A kind of type that a column may have.
+ */
+export type ColumnTypeKind = PrimitiveTypeKind | 'e';
+
+/**
+ * A column type that is a primitive type.
+ */
+export interface PrimitiveColumnType {
+  type: PrimitiveTypeKind;
+}
+
+/**
+ * A column type that is an element type.
+ */
+export interface ElementColumnType {
+  type: 'e';
+  primitiveType: PrimitiveTypeKind;
+  locationStyle: LocationStyle;
+  hasLabel: boolean;
+}
+
+/**
+ * The type of a column.
+ */
+export type ColumnType = PrimitiveColumnType | ElementColumnType;
+
+/**
+ * The schema describing a single column in a `ResultSet`.
+ */
+export interface ColumnSchema {
+  readonly name: string;
+  readonly type: ColumnType;
+}
+
+/**
+ * The schema of a single `ResultSet` in a BQRS file.
+ */
+export interface ResultSetSchema {
+  readonly version: number;
+  readonly name: string;
+  readonly tupleCount: number;
+  readonly columns: readonly ColumnSchema[];
+}
+
+/**
+ * The schema describing the contents of a BQRS file.
+ */
+export interface ResultSetsSchema {
+  readonly version: number;
+  readonly stringPoolSize: number;
+  readonly resultSets: readonly ResultSetSchema[];
+}
+
+// See https://help.semmle.com/QL/learn-ql/ql/locations.html for how these are used.
+export interface FivePartLocation {
+  t: LocationStyle.FivePart;
+  file: string;
+  lineStart: number;
+  colStart: number;
+  lineEnd: number;
+  colEnd: number;
+}
+
+export interface StringLocation {
+  t: LocationStyle.String;
+  loc: string;
+}
+
+/**
+ * A location representing an entire filesystem resource.
+ * This is usually derived from a `StringLocation` with the entire filesystem URL.
+ */
+export interface WholeFileLocation {
+  t: LocationStyle.WholeFile;
+  file: string;
+}
+
+export type RawLocationValue = FivePartLocation | StringLocation;
+
+export type LocationValue = RawLocationValue | WholeFileLocation;
+
+/** A location that may be resolved to a source code element. */
+export type ResolvableLocationValue = FivePartLocation | WholeFileLocation;

extensions/ql-vscode/src/bqrs-utils.ts

@@ -0,0 +1,64 @@
+import { StringLocation, LocationValue, LocationStyle, ResolvableLocationValue } from './bqrs-types';
+
+/**
+ * The CodeQL filesystem libraries use this pattern in `getURL()` predicates
+ * to describe the location of an entire filesystem resource.
+ * Such locations appear as `StringLocation`s instead of `FivePartLocation`s.
+ *
+ * Folder resources also get similar URLs, but with the `folder` scheme.
+ * They are deliberately ignored here, since there is no suitable location to show the user.
+ */
+const FILE_LOCATION_REGEX = /file:\/\/(.+):([0-9]+):([0-9]+):([0-9]+):([0-9]+)/;
+/**
+ * Gets a resolvable source file location for the specified `LocationValue`, if possible.
+ * @param loc The location to test.
+ */
+export function tryGetResolvableLocation(
+  loc: LocationValue | undefined
+): ResolvableLocationValue | undefined {
+  if (loc === undefined) {
+    return undefined;
+  } else if (loc.t === LocationStyle.FivePart && loc.file) {
+    return loc;
+  } else if (loc.t === LocationStyle.WholeFile && loc.file) {
+    return loc;
+  } else if (loc.t === LocationStyle.String && loc.loc) {
+    return tryGetLocationFromString(loc);
+  } else {
+    return undefined;
+  }
+}
+
+export function tryGetLocationFromString(
+  loc: StringLocation
+): ResolvableLocationValue | undefined {
+  const matches = FILE_LOCATION_REGEX.exec(loc.loc);
+  if (matches && matches.length > 1 && matches[1]) {
+    if (isWholeFileMatch(matches)) {
+      return {
+        t: LocationStyle.WholeFile,
+        file: matches[1],
+      };
+    } else {
+      return {
+        t: LocationStyle.FivePart,
+        file: matches[1],
+        lineStart: Number(matches[2]),
+        colStart: Number(matches[3]),
+        lineEnd: Number(matches[4]),
+        colEnd: Number(matches[5]),
+      };
+    }
+  } else {
+    return undefined;
+  }
+}
+
+function isWholeFileMatch(matches: RegExpExecArray): boolean {
+  return (
+    matches[2] === '0' &&
+    matches[3] === '0' &&
+    matches[4] === '0' &&
+    matches[5] === '0'
+  );
+}

extensions/ql-vscode/src/cli.ts

@@ -604,7 +604,7 @@ export class CodeQLCliServer implements Disposable {
    */
   resolveQlpacks(additionalPacks: string[], searchPath?: string[]): Promise<QlpacksInfo> {
     const args = ['--additional-packs', additionalPacks.join(path.delimiter)];
-    if (searchPath !== undefined) {
+    if (searchPath?.length) {
       args.push('--search-path', path.join(...searchPath));
     }
 

extensions/ql-vscode/src/compare/view/tsconfig.json

@@ -10,15 +10,14 @@
     ],
     "jsx": "react",
     "sourceMap": true,
-    "rootDir": "../..",
+    "rootDir": "..",
     "strict": true,
     "noUnusedLocals": true,
     "noImplicitReturns": true,
     "noFallthroughCasesInSwitch": true,
-    "experimentalDecorators": true,
-    "typeRoots" : ["./typings"]
+    "experimentalDecorators": true
   },
   "exclude": [
     "node_modules"
   ]
-}
+}

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

@@ -3,7 +3,7 @@ import {
   ResolvableLocationValue,
   ColumnSchema,
   ResultSetSchema,
-} from 'semmle-bqrs';
+} from './bqrs-types';
 import { ResultRow, ParsedResultSets, RawResultSet } from './adapt';
 
 /**

extensions/ql-vscode/src/interface-utils.ts

@@ -16,10 +16,12 @@ import {
   FivePartLocation,
   LocationStyle,
   LocationValue,
-  tryGetResolvableLocation,
   WholeFileLocation,
   ResolvableLocationValue,
-} from 'semmle-bqrs';
+} from './bqrs-types';
+import {
+  tryGetResolvableLocation,
+} from './bqrs-utils';
 import { DatabaseItem, DatabaseManager } from './databases';
 import { ViewSourceFileMsg } from './interface-types';
 import { Logger } from './logging';