feat(ci): download previous report from portal if available

Author: matejchalk

packages/ci/src/lib/portal/download.ts

@@ -1,3 +1,5 @@
+import { mkdir, writeFile } from 'node:fs/promises';
+import path from 'node:path';
 import {
   type PortalDownloadArgs,
   downloadFromPortal,
@@ -6,11 +8,23 @@ import { transformGQLReport } from './transform.js';
 
 export async function downloadReportFromPortal(
   args: PortalDownloadArgs,
-): Promise<string | undefined> {
+): Promise<string | null> {
   const gqlReport = await downloadFromPortal(args);
   if (!gqlReport) {
-    return undefined;
+    return null;
   }
+
   const report = transformGQLReport(gqlReport);
-  return JSON.stringify(report, null, 2);
+
+  const outputFile = path.join(
+    'tmp',
+    'code-pushup',
+    'portal',
+    args.parameters.organization,
+    args.parameters.project,
+    'report.json',
+  );
+  await mkdir(path.dirname(outputFile), { recursive: true });
+  await writeFile(outputFile, JSON.stringify(report, null, 2));
+  return outputFile;
 }

packages/ci/src/lib/run-monorepo.ts

@@ -163,7 +163,7 @@ async function compareProjectsInBulk(
 ): Promise<ProjectRunResult[]> {
   const projectReportsWithCache = await Promise.all(
     currProjectReports.map(async ({ project, ctx, reports, config }) => {
-      const args = { project, base, ctx, env };
+      const args = { project, config, base, ctx, env };
       const [currReport, prevReport] = await Promise.all([
         readFile(reports.json, 'utf8').then(
           (content): ReportData<'current'> => ({

packages/ci/src/lib/run-utils.ts

@@ -34,6 +34,7 @@ import type {
 } from './models.js';
 import type { ProjectConfig } from './monorepo/index.js';
 import { saveOutputFiles } from './output-files.js';
+import { downloadReportFromPortal } from './portal/download.js';
 
 export type RunEnv = {
   refs: NormalizedGitRefs;
@@ -58,6 +59,7 @@ export type CompareReportsArgs = {
 
 export type BaseReportArgs = {
   project: ProjectConfig | null;
+  config: EnhancedPersistConfig;
   env: RunEnv;
   base: GitBranch;
   ctx: CommandContext;
@@ -139,7 +141,8 @@ export async function runOnProject(
     `PR/MR detected, preparing to compare base branch ${base.ref} to head ${head.ref}`,
   );
 
-  const prevReport = await collectPreviousReport({ project, env, base, ctx });
+  const baseArgs: BaseReportArgs = { project, env, base, config, ctx };
+  const prevReport = await collectPreviousReport(baseArgs);
   if (!prevReport) {
     return noDiffOutput;
   }
@@ -243,37 +246,89 @@ export async function loadCachedBaseReport(
 ): Promise<ReportData<'previous'> | null> {
   const {
     project,
+    env: { settings },
+  } = args;
+
+  const cachedBaseReport =
+    (await loadCachedBaseReportFromPortal(args)) ??
+    (await loadCachedBaseReportFromArtifacts(args));
+
+  if (!cachedBaseReport) {
+    return null;
+  }
+  return saveReportFiles({
+    project,
+    type: 'previous',
+    files: { json: cachedBaseReport },
+    settings,
+  });
+}
+
+async function loadCachedBaseReportFromArtifacts(
+  args: BaseReportArgs,
+): Promise<string | null> {
+  const {
     env: { api, settings },
+    project,
   } = args;
   const { logger } = settings;
 
-  const cachedBaseReport = await api
-    .downloadReportArtifact?.(project?.name)
+  if (api.downloadReportArtifact == null) {
+    return null;
+  }
+
+  const reportPath = await api
+    .downloadReportArtifact(project?.name)
     .catch((error: unknown) => {
       logger.warn(
         `Error when downloading previous report artifact, skipping - ${stringifyError(error)}`,
       );
+      return null;
     });
-  if (api.downloadReportArtifact != null) {
-    logger.info(
-      `Previous report artifact ${cachedBaseReport ? 'found' : 'not found'}`,
-    );
-    if (cachedBaseReport) {
-      logger.debug(
-        `Previous report artifact downloaded to ${cachedBaseReport}`,
-      );
-    }
+
+  logger.info(`Previous report artifact ${reportPath ? 'found' : 'not found'}`);
+  if (reportPath) {
+    logger.debug(`Previous report artifact downloaded to ${reportPath}`);
   }
 
-  if (!cachedBaseReport) {
+  return reportPath;
+}
+
+async function loadCachedBaseReportFromPortal(
+  args: BaseReportArgs,
+): Promise<string | null> {
+  const {
+    config,
+    env: { settings },
+  } = args;
+  const { logger } = settings;
+
+  if (!config.upload) {
     return null;
   }
-  return saveReportFiles({
-    project,
-    type: 'previous',
-    files: { json: cachedBaseReport },
-    settings,
+
+  const reportPath = await downloadReportFromPortal({
+    server: config.upload.server,
+    apiKey: config.upload.apiKey,
+    parameters: {
+      organization: config.upload.organization,
+      project: config.upload.project,
+    },
+  }).catch((error: unknown) => {
+    logger.warn(
+      `Error when downloading previous report from portal, skipping - ${stringifyError(error)}`,
+    );
+    return null;
   });
+
+  logger.info(
+    `Previous report ${reportPath ? 'found' : 'not found'} in Code PushUp portal`,
+  );
+  if (reportPath) {
+    logger.debug(`Previous report downloaded from portal to ${reportPath}`);
+  }
+
+  return reportPath;
 }
 
 export async function runInBaseBranch<T>(