Reduce dependencies on semmle-bqrs.

Eliminate references to types in library semmle-bqrs in favor of a
local copy of those same types in bqrs-types.ts.

Author: jcreedcmu

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 @@
+/**
+ * Types in this file are deprecated, and uses of them should be
+ * migrated to the corresponding 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/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,9 +16,11 @@ import {
   FivePartLocation,
   LocationStyle,
   LocationValue,
-  tryGetResolvableLocation,
   WholeFileLocation,
   ResolvableLocationValue,
+} from './bqrs-types';
+import {
+  tryGetResolvableLocation,
 } from 'semmle-bqrs';
 import { DatabaseItem, DatabaseManager } from './databases';
 import { ViewSourceFileMsg } from './interface-types';

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

@@ -1,6 +1,6 @@
 import * as Sarif from 'sarif';
 import * as path from 'path';
-import { LocationStyle, ResolvableLocationValue } from 'semmle-bqrs';
+import { LocationStyle, ResolvableLocationValue } from './bqrs-types';
 
 export interface SarifLink {
   dest: number;

extensions/ql-vscode/src/view/RawTableHeader.tsx

@@ -3,7 +3,7 @@ import * as React from 'react';
 import { vscode } from './vscode-api';
 import { RawResultsSortState, SortDirection } from '../interface-types';
 import { nextSortDirection } from './result-table-utils';
-import { ColumnSchema } from 'semmle-bqrs';
+import { ColumnSchema } from '../bqrs-types';
 
 interface Props {
   readonly columns: readonly ColumnSchema[];

extensions/ql-vscode/src/view/alert-table.tsx

@@ -2,7 +2,7 @@ import * as path from 'path';
 import * as React from 'react';
 import * as Sarif from 'sarif';
 import * as Keys from '../result-keys';
-import { LocationStyle } from 'semmle-bqrs';
+import { LocationStyle } from '../bqrs-types';
 import * as octicons from './octicons';
 import { className, renderLocation, ResultTableProps, zebraStripe, selectableZebraStripe, jumpToLocation, nextSortDirection } from './result-table-utils';
 import { onNavigation, NavigationEvent } from './results';

extensions/ql-vscode/src/view/result-table-utils.tsx

@@ -1,5 +1,6 @@
 import * as React from 'react';
-import { LocationValue, ResolvableLocationValue, tryGetResolvableLocation } from 'semmle-bqrs';
+import { LocationValue, ResolvableLocationValue } from '../bqrs-types';
+import { tryGetResolvableLocation } from 'semmle-bqrs';
 import { RawResultsSortState, QueryMetadata, SortDirection } from '../interface-types';
 import { assertNever } from '../helpers-pure';
 import { ResultSet } from '../interface-types';

extensions/ql-vscode/src/vscode-tests/no-workspace/interface-utils.test.ts

@@ -9,7 +9,7 @@ import {
   tryResolveLocation,
 } from '../../interface-utils';
 import { getDefaultResultSetName } from '../../interface-types';
-import { LocationStyle } from 'semmle-bqrs';
+import { LocationStyle } from '../../bqrs-types';
 import { DatabaseItem } from '../../databases';
 
 describe('interface-utils', () => {

extensions/ql-vscode/test/pure-tests/location.test.ts

@@ -1,6 +1,7 @@
 import { expect } from 'chai';
 import 'mocha';
-import { LocationStyle, StringLocation, tryGetResolvableLocation } from 'semmle-bqrs';
+import { LocationStyle, StringLocation } from '../../src/bqrs-types';
+import { tryGetResolvableLocation } from 'semmle-bqrs';
 
 describe('processing string locations', function () {
   it('should detect Windows whole-file locations', function () {