Rename local query history item DTOs

Author: charisk

extensions/ql-vscode/src/query-history/store/data-mapper.ts

@@ -7,11 +7,11 @@ import { QueryEvaluationInfo } from "../../run-queries-shared";
 import { QueryHistoryInfo } from "../query-history-info";
 import { VariantAnalysisHistoryItem } from "../variant-analysis-history-item";
 import {
-  CompletedQueryInfoData,
-  QueryEvaluationInfoData,
-  InitialQueryInfoData,
-  LocalQueryDataItem,
-} from "./local-query-data-item";
+  CompletedQueryInfoDto,
+  QueryEvaluationInfoDto,
+  InitialQueryInfoDto,
+  QueryHistoryLocalQueryDto,
+} from "./query-history-local-query-dto";
 import { QueryHistoryDataItem } from "./query-history-data";
 
 // Maps Query History Data Models to Domain Models
@@ -36,7 +36,7 @@ export function mapQueryHistoryToDomainModels(
 }
 
 function mapLocalQueryDataItemToDomainModel(
-  localQuery: LocalQueryDataItem,
+  localQuery: QueryHistoryLocalQueryDto,
 ): LocalQueryInfo {
   return new LocalQueryInfo(
     mapInitialQueryInfoDataToDomainModel(localQuery.initialInfo),
@@ -52,7 +52,7 @@ function mapLocalQueryDataItemToDomainModel(
 }
 
 function mapCompletedQueryInfoDataToDomainModel(
-  completedQuery: CompletedQueryInfoData,
+  completedQuery: CompletedQueryInfoDto,
 ): CompletedQueryInfo {
   return new CompletedQueryInfo(
     mapQueryEvaluationInfoDataToDomainModel(completedQuery.query),
@@ -74,7 +74,7 @@ function mapCompletedQueryInfoDataToDomainModel(
 }
 
 function mapInitialQueryInfoDataToDomainModel(
-  initialInfo: InitialQueryInfoData,
+  initialInfo: InitialQueryInfoDto,
 ): InitialQueryInfo {
   return {
     userSpecifiedLabel: initialInfo.userSpecifiedLabel,
@@ -93,7 +93,7 @@ function mapInitialQueryInfoDataToDomainModel(
 }
 
 function mapQueryEvaluationInfoDataToDomainModel(
-  evaluationInfo: QueryEvaluationInfoData,
+  evaluationInfo: QueryEvaluationInfoDto,
 ): QueryEvaluationInfo {
   return new QueryEvaluationInfo(
     evaluationInfo.querySaveDir,

extensions/ql-vscode/src/query-history/store/domain-mapper.ts

@@ -3,10 +3,10 @@ import { LocalQueryInfo, InitialQueryInfo } from "../../query-results";
 import { QueryEvaluationInfo } from "../../run-queries-shared";
 import { QueryHistoryInfo } from "../query-history-info";
 import {
-  LocalQueryDataItem,
-  InitialQueryInfoData,
-  QueryEvaluationInfoData,
-} from "./local-query-data-item";
+  QueryHistoryLocalQueryDto,
+  InitialQueryInfoDto,
+  QueryEvaluationInfoDto,
+} from "./query-history-local-query-dto";
 import { QueryHistoryDataItem } from "./query-history-data";
 import { VariantAnalysisDataItem } from "./variant-analysis-data-item";
 
@@ -29,7 +29,7 @@ export function mapQueryHistoryToDataModels(
 
 function mapLocalQueryInfoToDataModel(
   query: LocalQueryInfo,
-): LocalQueryDataItem {
+): QueryHistoryLocalQueryDto {
   return {
     initialInfo: mapInitialQueryInfoToDataModel(query.initialInfo),
     t: "local",
@@ -59,7 +59,7 @@ function mapLocalQueryInfoToDataModel(
 
 function mapInitialQueryInfoToDataModel(
   localQueryInitialInfo: InitialQueryInfo,
-): InitialQueryInfoData {
+): InitialQueryInfoDto {
   return {
     userSpecifiedLabel: localQueryInitialInfo.userSpecifiedLabel,
     queryText: localQueryInitialInfo.queryText,
@@ -78,7 +78,7 @@ function mapInitialQueryInfoToDataModel(
 
 function mapQueryEvaluationInfoToDataModel(
   queryEvaluationInfo: QueryEvaluationInfo,
-): QueryEvaluationInfoData {
+): QueryEvaluationInfoDto {
   return {
     querySaveDir: queryEvaluationInfo.querySaveDir,
     dbItemPath: queryEvaluationInfo.dbItemPath,

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

@@ -1,7 +1,7 @@
 // Contains models and consts for the data we want to store in the query history store.
 // Changes to these models should be done carefully and account for backwards compatibility of data.
 
-import { LocalQueryDataItem } from "./local-query-data-item";
+import { QueryHistoryLocalQueryDto } from "./query-history-local-query-dto";
 import { VariantAnalysisDataItem } from "./variant-analysis-data-item";
 
 export const ALLOWED_QUERY_HISTORY_VERSIONS = [1, 2];
@@ -11,4 +11,6 @@ export interface QueryHistoryData {
   queries: QueryHistoryDataItem[];
 }
 
-export type QueryHistoryDataItem = LocalQueryDataItem | VariantAnalysisDataItem;
+export type QueryHistoryDataItem =
+  | QueryHistoryLocalQueryDto
+  | VariantAnalysisDataItem;

…y-history/store/local-query-data-item.ts …y/store/query-history-local-query-dto.tsextensions/ql-vscode/src/query-history/store/local-query-data-item.ts renamed to extensions/ql-vscode/src/query-history/store/query-history-local-query-dto.ts extensions/ql-vscode/src/query-history/store/local-query-data-item.ts renamed to extensions/ql-vscode/src/query-history/store/query-history-local-query-dto.ts

@@ -1,66 +1,66 @@
-export interface LocalQueryDataItem {
-  initialInfo: InitialQueryInfoData;
+export interface QueryHistoryLocalQueryDto {
+  initialInfo: InitialQueryInfoDto;
   t: "local";
   evalLogLocation?: string;
   evalLogSummaryLocation?: string;
   jsonEvalLogSummaryLocation?: string;
   evalLogSummarySymbolsLocation?: string;
-  completedQuery?: CompletedQueryInfoData;
+  completedQuery?: CompletedQueryInfoDto;
   failureReason?: string;
 }
 
-export interface InitialQueryInfoData {
+export interface InitialQueryInfoDto {
   userSpecifiedLabel?: string;
   queryText: string;
   isQuickQuery: boolean;
   isQuickEval: boolean;
-  quickEvalPosition?: PositionData;
+  quickEvalPosition?: PositionDto;
   queryPath: string;
-  databaseInfo: DatabaseInfoData;
+  databaseInfo: DatabaseInfoDto;
   start: Date;
   id: string;
 }
 
-interface DatabaseInfoData {
+interface DatabaseInfoDto {
   name: string;
   databaseUri: string;
 }
 
-interface PositionData {
+interface PositionDto {
   line: number;
   column: number;
   endLine: number;
   endColumn: number;
   fileName: string;
 }
 
-export interface CompletedQueryInfoData {
-  query: QueryEvaluationInfoData;
+export interface CompletedQueryInfoDto {
+  query: QueryEvaluationInfoDto;
   message?: string;
   successful?: boolean;
 
   // There once was a typo in the data model, which is why we need to support both
   sucessful?: boolean;
-  result: EvaluationResultData;
+  result: EvaluationResultDto;
   logFileLocation?: string;
   resultCount: number;
-  sortedResultsInfo: Record<string, SortedResultSetInfo>;
-  interpretedResultsSortState?: InterpretedResultsSortState;
+  sortedResultsInfo: Record<string, SortedResultSetInfoDto>;
+  interpretedResultsSortState?: InterpretedResultsSortStateDto;
 }
 
-interface InterpretedResultsSortState {
-  sortBy: InterpretedResultsSortColumn;
+interface InterpretedResultsSortStateDto {
+  sortBy: InterpretedResultsSortColumnDto;
   sortDirection: SortDirection;
 }
 
-type InterpretedResultsSortColumn = "alert-message";
+type InterpretedResultsSortColumnDto = "alert-message";
 
-interface SortedResultSetInfo {
+interface SortedResultSetInfoDto {
   resultsPath: string;
-  sortState: RawResultsSortState;
+  sortState: RawResultsSortStateDto;
 }
 
-interface RawResultsSortState {
+interface RawResultsSortStateDto {
   columnIndex: number;
   sortDirection: SortDirection;
 }
@@ -70,7 +70,7 @@ enum SortDirection {
   desc,
 }
 
-interface EvaluationResultData {
+interface EvaluationResultDto {
   runId: number;
   queryId: number;
   resultType: number;
@@ -79,19 +79,19 @@ interface EvaluationResultData {
   logFileLocation?: string;
 }
 
-export interface QueryEvaluationInfoData {
+export interface QueryEvaluationInfoDto {
   querySaveDir: string;
   dbItemPath: string;
   databaseHasMetadataFile: boolean;
-  quickEvalPosition?: PositionData;
-  metadata?: QueryMetadataData;
+  quickEvalPosition?: PositionDto;
+  metadata?: QueryMetadataDto;
   resultsPaths: {
     resultsPath: string;
     interpretedResultsPath: string;
   };
 }
 
-interface QueryMetadataData {
+interface QueryMetadataDto {
   name?: string;
   description?: string;
   id?: string;