Merge pull request #1600 from github/shati-patel/query-history-info

Move `QueryHistoryInfo` type to separate file

Author: shati-patel

extensions/ql-vscode/src/history-item-label-provider.ts

@@ -1,7 +1,8 @@
 import { env } from 'vscode';
 import * as path from 'path';
 import { QueryHistoryConfig } from './config';
-import { LocalQueryInfo, QueryHistoryInfo } from './query-results';
+import { LocalQueryInfo } from './query-results';
+import { getRawQueryName, QueryHistoryInfo } from './query-history-info';
 import { RemoteQueryHistoryItem } from './remote-queries/remote-query-history-item';
 import { pluralize } from './helpers';
 import { VariantAnalysisHistoryItem } from './remote-queries/variant-analysis-history-item';
@@ -50,20 +51,9 @@ export class HistoryItemLabelProvider {
    * @returns the name of the query, unless there is a custom label for this query.
    */
   getShortLabel(item: QueryHistoryInfo): string {
-    if (item.userSpecifiedLabel) {
-      return this.getLabel(item);
-    } else {
-      switch (item.t) {
-        case 'local':
-          return item.getQueryName();
-        case 'remote':
-          return item.remoteQuery.queryName;
-        case 'variant-analysis':
-          return item.variantAnalysis.query.name;
-        default:
-          assertNever(item);
-      }
-    }
+    return item.userSpecifiedLabel
+      ? this.getLabel(item)
+      : getRawQueryName(item);
   }
 
 

extensions/ql-vscode/src/log-insights/log-scanner-service.ts

@@ -1,7 +1,7 @@
 import { Diagnostic, DiagnosticSeverity, languages, Range, Uri } from 'vscode';
 import { DisposableObject } from '../pure/disposable-object';
 import { QueryHistoryManager } from '../query-history';
-import { QueryHistoryInfo } from '../query-results';
+import { QueryHistoryInfo } from '../query-history-info';
 import { EvaluationLogProblemReporter, EvaluationLogScannerSet } from './log-scanner';
 import { PipelineInfo, SummarySymbols } from './summary-parser';
 import * as fs from 'fs-extra';

extensions/ql-vscode/src/query-history-info.ts

@@ -0,0 +1,19 @@
+import { RemoteQueryHistoryItem } from './remote-queries/remote-query-history-item';
+import { VariantAnalysisHistoryItem } from './remote-queries/variant-analysis-history-item';
+import { LocalQueryInfo } from './query-results';
+import { assertNever } from './pure/helpers-pure';
+
+export type QueryHistoryInfo = LocalQueryInfo | RemoteQueryHistoryItem | VariantAnalysisHistoryItem;
+
+export function getRawQueryName(item: QueryHistoryInfo): string {
+  switch (item.t) {
+    case 'local':
+      return item.getQueryName();
+    case 'remote':
+      return item.remoteQuery.queryName;
+    case 'variant-analysis':
+      return item.variantAnalysis.query.name;
+    default:
+      assertNever(item);
+  }
+}

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

@@ -30,7 +30,8 @@ import { DisposableObject } from './pure/disposable-object';
 import { commandRunner } from './commandRunner';
 import { ONE_HOUR_IN_MS, TWO_HOURS_IN_MS } from './pure/time';
 import { assertNever, getErrorMessage, getErrorStack } from './pure/helpers-pure';
-import { CompletedLocalQueryInfo, LocalQueryInfo as LocalQueryInfo, QueryHistoryInfo } from './query-results';
+import { CompletedLocalQueryInfo, LocalQueryInfo } from './query-results';
+import { QueryHistoryInfo } from './query-history-info';
 import { DatabaseManager } from './databases';
 import { registerQueryHistoryScrubber } from './query-history-scrubber';
 import { QueryStatus } from './query-status';

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

@@ -16,10 +16,8 @@ import {
 } from './pure/interface-types';
 import { DatabaseInfo } from './pure/interface-types';
 import { QueryStatus } from './query-status';
-import { RemoteQueryHistoryItem } from './remote-queries/remote-query-history-item';
 import { QueryEvaluationInfo, QueryWithResults } from './run-queries-shared';
 import { formatLegacyMessage } from './legacy-query-server/run-queries';
-import { VariantAnalysisHistoryItem } from './remote-queries/variant-analysis-history-item';
 
 /**
  * query-results.ts
@@ -208,8 +206,6 @@ export type CompletedLocalQueryInfo = LocalQueryInfo & {
   completedQuery: CompletedQueryInfo
 };
 
-export type QueryHistoryInfo = LocalQueryInfo | RemoteQueryHistoryItem | VariantAnalysisHistoryItem;
-
 export class LocalQueryInfo {
   readonly t = 'local';
 

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

@@ -3,7 +3,8 @@ import * as path from 'path';
 
 import { showAndLogErrorMessage } from './helpers';
 import { asyncFilter, getErrorMessage, getErrorStack } from './pure/helpers-pure';
-import { CompletedQueryInfo, LocalQueryInfo, QueryHistoryInfo } from './query-results';
+import { CompletedQueryInfo, LocalQueryInfo } from './query-results';
+import { QueryHistoryInfo } from './query-history-info';
 import { QueryStatus } from './query-status';
 import { QueryEvaluationInfo } from './run-queries-shared';
 

extensions/ql-vscode/src/vscode-tests/no-workspace/history-item-label-provider.test.ts

@@ -2,7 +2,8 @@ import { env } from 'vscode';
 import { expect } from 'chai';
 import { QueryHistoryConfig } from '../../config';
 import { HistoryItemLabelProvider } from '../../history-item-label-provider';
-import { CompletedLocalQueryInfo, CompletedQueryInfo, InitialQueryInfo, QueryHistoryInfo } from '../../query-results';
+import { CompletedLocalQueryInfo, CompletedQueryInfo, InitialQueryInfo } from '../../query-results';
+import { QueryHistoryInfo } from '../../query-history-info';
 import { RemoteQueryHistoryItem } from '../../remote-queries/remote-query-history-item';