Remove unprincipled sort-by-location

Leave it so that clicking on the Location column goes back to sorting
by location, but reflecting this as looking as the same as the default
'unsorted' view.

Author: jcreedcmu

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

@@ -121,7 +121,7 @@ export interface RawResultsSortState {
 }
 
 export type InterpretedResultsSortColumn =
-  'file-position' | 'alert-message';
+  'alert-message';
 
 export interface InterpretedResultsSortState {
   sortBy: InterpretedResultsSortColumn;

extensions/ql-vscode/src/interface.ts

@@ -87,11 +87,6 @@ export function webviewUriToFileUri(webviewUri: string): Uri {
 }
 
 function sortInterpretedResults(results: Sarif.Result[], sortState: InterpretedResultsSortState | undefined): void {
-  function locToString(locs: Sarif.Location[] | undefined): string {
-    if (locs === undefined) return '';
-    return JSON.stringify(locs[0]) || '';
-  }
-
   if (sortState !== undefined) {
     const direction = sortState.sortDirection === SortDirection.asc ? 1 : -1;
     switch (sortState.sortBy) {
@@ -101,10 +96,6 @@ function sortInterpretedResults(results: Sarif.Result[], sortState: InterpretedR
             b.message.text === undefined ? 0 :
               direction * (a.message.text?.localeCompare(b.message.text)));
         break;
-      case 'file-position':
-        results.sort((a, b) =>
-          direction * locToString(a.locations).localeCompare(locToString(b.locations)));
-        break;
       default:
         assertNever(sortState.sortBy);
     }

extensions/ql-vscode/src/query-results.ts

@@ -118,9 +118,7 @@ export class CompletedQuery implements QueryWithResults {
   }
 
   async updateInterpretedSortState(_server: cli.CodeQLCliServer, sortState: InterpretedResultsSortState | undefined): Promise<void> {
-    if (sortState !== undefined) {
-      this.interpretedResultsSortState = sortState;
-    }
+    this.interpretedResultsSortState = sortState;
   }
 }
 

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

@@ -15,6 +15,8 @@ export interface PathTableState {
   selectedPathNode: undefined | Keys.PathNode;
 }
 
+type InterpretedResultsColumn = InterpretedResultsSortColumn | 'file-position';
+
 export class PathTable extends React.Component<PathTableProps, PathTableState> {
   constructor(props: PathTableProps) {
     super(props);
@@ -54,16 +56,21 @@ export class PathTable extends React.Component<PathTableProps, PathTableState> {
     }
   }
 
-  toggleSortStateForColumn(column: InterpretedResultsSortColumn): void {
+  getNextSortState(column: InterpretedResultsColumn): InterpretedResultsSortState | undefined {
+    if (column === 'file-position') {
+      return undefined;
+    }
     const oldSortState = this.props.resultSet.sortState;
     const prevDirection = oldSortState && oldSortState.sortBy === column ? oldSortState.sortDirection : undefined;
     const nextDirection = nextSortDirection(prevDirection);
-    const sortState: InterpretedResultsSortState | undefined =
-      nextDirection === undefined ? undefined :
-        { sortBy: column, sortDirection: nextDirection };
+    return nextDirection === undefined ? undefined :
+      { sortBy: column, sortDirection: nextDirection };
+  }
+
+  toggleSortStateForColumn(column: InterpretedResultsSortColumn | 'file-position'): void {
     vscode.postMessage({
       t: 'changeInterpretedSort',
-      sortState,
+      sortState: this.getNextSortState(column),
     });
   }
 
@@ -74,7 +81,7 @@ export class PathTable extends React.Component<PathTableProps, PathTableState> {
       <tr>
         <th colSpan={2}></th>
         <th className={this.sortClass('alert-message') + ' vscode-codeql__alert-message-cell'} colSpan={2} onClick={() => this.toggleSortStateForColumn('alert-message')}>Message</th>
-        <th className={this.sortClass('file-position') + ' vscode-codeql__location-cell'} onClick={() => this.toggleSortStateForColumn('file-position')}>Location</th>
+        <th className={'sort-none vscode-codeql__location-cell'} onClick={() => this.toggleSortStateForColumn('file-position')}>Location</th>
       </tr>
     </thead>;