Merge pull request #2315 from github/charisk/variant-analysis-store-mappers

Introduce mapping layer for variant analysis history items

Author: charisk

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

@@ -15,20 +15,19 @@ import {
   SortDirectionDto,
 } from "./query-history-local-query-dto";
 import { QueryHistoryItemDto } from "./query-history-dto";
-import { QueryHistoryVariantAnalysisDto } from "./query-history-variant-analysis-dto";
 import {
   RawResultsSortState,
   SortDirection,
   SortedResultSetInfo,
 } from "../../pure/interface-types";
+import { mapQueryHistoryVariantAnalysisToDto } from "./query-history-variant-analysis-domain-mapper";
 
 export function mapQueryHistoryToDto(
   queries: QueryHistoryInfo[],
 ): QueryHistoryItemDto[] {
   return queries.map((q) => {
     if (q.t === "variant-analysis") {
-      const query: QueryHistoryVariantAnalysisDto = q;
-      return query;
+      return mapQueryHistoryVariantAnalysisToDto(q);
     } else if (q.t === "local") {
       return mapLocalQueryInfoToDto(q);
     } else {

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

@@ -5,7 +5,6 @@ import {
 } from "../../query-results";
 import { QueryEvaluationInfo } from "../../run-queries-shared";
 import { QueryHistoryInfo } from "../query-history-info";
-import { VariantAnalysisHistoryItem } from "../variant-analysis-history-item";
 import {
   CompletedQueryInfoDto,
   QueryEvaluationInfoDto,
@@ -23,14 +22,14 @@ import {
   SortDirection,
   SortedResultSetInfo,
 } from "../../pure/interface-types";
+import { mapQueryHistoryVariantAnalysisToDomainModel } from "./query-history-variant-analysis-dto-mapper";
 
 export function mapQueryHistoryToDomainModel(
   queries: QueryHistoryItemDto[],
 ): QueryHistoryInfo[] {
   return queries.map((d) => {
     if (d.t === "variant-analysis") {
-      const query: VariantAnalysisHistoryItem = d;
-      return query;
+      return mapQueryHistoryVariantAnalysisToDomainModel(d);
     } else if (d.t === "local") {
       return mapLocalQueryItemToDomainModel(d);
     }

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

@@ -0,0 +1,235 @@
+import {
+  QueryHistoryVariantAnalysisDto,
+  QueryLanguageDto,
+  QueryStatusDto,
+  VariantAnalysisDto,
+  VariantAnalysisFailureReasonDto,
+  VariantAnalysisRepoStatusDto,
+  VariantAnalysisScannedRepositoryDto,
+  VariantAnalysisSkippedRepositoriesDto,
+  VariantAnalysisSkippedRepositoryDto,
+  VariantAnalysisSkippedRepositoryGroupDto,
+  VariantAnalysisStatusDto,
+} from "./query-history-variant-analysis-dto";
+import {
+  VariantAnalysis,
+  VariantAnalysisFailureReason,
+  VariantAnalysisRepoStatus,
+  VariantAnalysisScannedRepository,
+  VariantAnalysisSkippedRepositories,
+  VariantAnalysisSkippedRepository,
+  VariantAnalysisSkippedRepositoryGroup,
+  VariantAnalysisStatus,
+} from "../../variant-analysis/shared/variant-analysis";
+import { assertNever } from "../../pure/helpers-pure";
+import { QueryLanguage } from "../../common/query-language";
+import { QueryStatus } from "../../query-status";
+import { VariantAnalysisHistoryItem } from "../variant-analysis-history-item";
+
+export function mapQueryHistoryVariantAnalysisToDto(
+  item: VariantAnalysisHistoryItem,
+): QueryHistoryVariantAnalysisDto {
+  return {
+    t: "variant-analysis",
+    failureReason: item.failureReason,
+    resultCount: item.resultCount,
+    status: mapQueryStatusToDto(item.status),
+    completed: item.completed,
+    variantAnalysis: mapVariantAnalysisDtoToDto(item.variantAnalysis),
+    userSpecifiedLabel: item.userSpecifiedLabel,
+  };
+}
+
+function mapVariantAnalysisDtoToDto(
+  variantAnalysis: VariantAnalysis,
+): VariantAnalysisDto {
+  return {
+    id: variantAnalysis.id,
+    controllerRepo: {
+      id: variantAnalysis.controllerRepo.id,
+      fullName: variantAnalysis.controllerRepo.fullName,
+      private: variantAnalysis.controllerRepo.private,
+    },
+    query: {
+      name: variantAnalysis.query.name,
+      filePath: variantAnalysis.query.filePath,
+      language: mapQueryLanguageToDto(variantAnalysis.query.language),
+      text: variantAnalysis.query.text,
+    },
+    databases: {
+      repositories: variantAnalysis.databases.repositories,
+      repositoryLists: variantAnalysis.databases.repositoryLists,
+      repositoryOwners: variantAnalysis.databases.repositoryOwners,
+    },
+    createdAt: variantAnalysis.createdAt,
+    updatedAt: variantAnalysis.updatedAt,
+    executionStartTime: variantAnalysis.executionStartTime,
+    status: mapVariantAnalysisStatusToDto(variantAnalysis.status),
+    completedAt: variantAnalysis.completedAt,
+    actionsWorkflowRunId: variantAnalysis.actionsWorkflowRunId,
+    failureReason:
+      variantAnalysis.failureReason &&
+      mapVariantAnalysisFailureReasonToDto(variantAnalysis.failureReason),
+    scannedRepos:
+      variantAnalysis.scannedRepos &&
+      mapVariantAnalysisScannedRepositoriesToDto(variantAnalysis.scannedRepos),
+    skippedRepos:
+      variantAnalysis.skippedRepos &&
+      mapVariantAnalysisSkippedRepositoriesToDto(variantAnalysis.skippedRepos),
+  };
+}
+
+function mapVariantAnalysisScannedRepositoriesToDto(
+  repos: VariantAnalysisScannedRepository[],
+): VariantAnalysisScannedRepositoryDto[] {
+  return repos.map(mapVariantAnalysisScannedRepositoryToDto);
+}
+
+function mapVariantAnalysisScannedRepositoryToDto(
+  repo: VariantAnalysisScannedRepository,
+): VariantAnalysisScannedRepositoryDto {
+  return {
+    repository: {
+      id: repo.repository.id,
+      fullName: repo.repository.fullName,
+      private: repo.repository.private,
+      stargazersCount: repo.repository.stargazersCount,
+      updatedAt: repo.repository.updatedAt,
+    },
+    analysisStatus: mapVariantAnalysisRepoStatusToDto(repo.analysisStatus),
+    resultCount: repo.resultCount,
+    artifactSizeInBytes: repo.artifactSizeInBytes,
+    failureMessage: repo.failureMessage,
+  };
+}
+
+function mapVariantAnalysisSkippedRepositoriesToDto(
+  repos: VariantAnalysisSkippedRepositories,
+): VariantAnalysisSkippedRepositoriesDto {
+  return {
+    accessMismatchRepos:
+      repos.accessMismatchRepos &&
+      mapVariantAnalysisSkippedRepositoryGroupToDto(repos.accessMismatchRepos),
+    notFoundRepos:
+      repos.notFoundRepos &&
+      mapVariantAnalysisSkippedRepositoryGroupToDto(repos.notFoundRepos),
+    noCodeqlDbRepos:
+      repos.noCodeqlDbRepos &&
+      mapVariantAnalysisSkippedRepositoryGroupToDto(repos.noCodeqlDbRepos),
+    overLimitRepos:
+      repos.overLimitRepos &&
+      mapVariantAnalysisSkippedRepositoryGroupToDto(repos.overLimitRepos),
+  };
+}
+
+function mapVariantAnalysisSkippedRepositoryGroupToDto(
+  repoGroup: VariantAnalysisSkippedRepositoryGroup,
+): VariantAnalysisSkippedRepositoryGroupDto {
+  return {
+    repositoryCount: repoGroup.repositoryCount,
+    repositories: repoGroup.repositories.map(
+      mapVariantAnalysisSkippedRepositoryToDto,
+    ),
+  };
+}
+
+function mapVariantAnalysisSkippedRepositoryToDto(
+  repo: VariantAnalysisSkippedRepository,
+): VariantAnalysisSkippedRepositoryDto {
+  return {
+    id: repo.id,
+    fullName: repo.fullName,
+    private: repo.private,
+    stargazersCount: repo.stargazersCount,
+    updatedAt: repo.updatedAt,
+  };
+}
+
+function mapVariantAnalysisFailureReasonToDto(
+  failureReason: VariantAnalysisFailureReason,
+): VariantAnalysisFailureReasonDto {
+  switch (failureReason) {
+    case VariantAnalysisFailureReason.NoReposQueried:
+      return VariantAnalysisFailureReasonDto.NoReposQueried;
+    case VariantAnalysisFailureReason.ActionsWorkflowRunFailed:
+      return VariantAnalysisFailureReasonDto.ActionsWorkflowRunFailed;
+    case VariantAnalysisFailureReason.InternalError:
+      return VariantAnalysisFailureReasonDto.InternalError;
+    default:
+      assertNever(failureReason);
+  }
+}
+
+function mapVariantAnalysisRepoStatusToDto(
+  status: VariantAnalysisRepoStatus,
+): VariantAnalysisRepoStatusDto {
+  switch (status) {
+    case VariantAnalysisRepoStatus.Pending:
+      return VariantAnalysisRepoStatusDto.Pending;
+    case VariantAnalysisRepoStatus.InProgress:
+      return VariantAnalysisRepoStatusDto.InProgress;
+    case VariantAnalysisRepoStatus.Succeeded:
+      return VariantAnalysisRepoStatusDto.Succeeded;
+    case VariantAnalysisRepoStatus.Failed:
+      return VariantAnalysisRepoStatusDto.Failed;
+    case VariantAnalysisRepoStatus.Canceled:
+      return VariantAnalysisRepoStatusDto.Canceled;
+    case VariantAnalysisRepoStatus.TimedOut:
+      return VariantAnalysisRepoStatusDto.TimedOut;
+    default:
+      assertNever(status);
+  }
+}
+
+function mapVariantAnalysisStatusToDto(
+  status: VariantAnalysisStatus,
+): VariantAnalysisStatusDto {
+  switch (status) {
+    case VariantAnalysisStatus.InProgress:
+      return VariantAnalysisStatusDto.InProgress;
+    case VariantAnalysisStatus.Succeeded:
+      return VariantAnalysisStatusDto.Succeeded;
+    case VariantAnalysisStatus.Failed:
+      return VariantAnalysisStatusDto.Failed;
+    case VariantAnalysisStatus.Canceled:
+      return VariantAnalysisStatusDto.Canceled;
+    default:
+      assertNever(status);
+  }
+}
+
+function mapQueryLanguageToDto(language: QueryLanguage): QueryLanguageDto {
+  switch (language) {
+    case QueryLanguage.CSharp:
+      return QueryLanguageDto.CSharp;
+    case QueryLanguage.Cpp:
+      return QueryLanguageDto.Cpp;
+    case QueryLanguage.Go:
+      return QueryLanguageDto.Go;
+    case QueryLanguage.Java:
+      return QueryLanguageDto.Java;
+    case QueryLanguage.Javascript:
+      return QueryLanguageDto.Javascript;
+    case QueryLanguage.Python:
+      return QueryLanguageDto.Python;
+    case QueryLanguage.Ruby:
+      return QueryLanguageDto.Ruby;
+    case QueryLanguage.Swift:
+      return QueryLanguageDto.Swift;
+    default:
+      assertNever(language);
+  }
+}
+
+function mapQueryStatusToDto(status: QueryStatus): QueryStatusDto {
+  switch (status) {
+    case QueryStatus.InProgress:
+      return QueryStatusDto.InProgress;
+    case QueryStatus.Completed:
+      return QueryStatusDto.Completed;
+    case QueryStatus.Failed:
+      return QueryStatusDto.Failed;
+    default:
+      assertNever(status);
+  }
+}