feat(ci): parse upload along with persist in print-config commands

Author: matejchalk

packages/ci/src/lib/cli/index.ts

@@ -3,4 +3,8 @@ export { runCompare } from './commands/compare.js';
 export { runMergeDiffs } from './commands/merge-diffs.js';
 export { runPrintConfig } from './commands/print-config.js';
 export { createCommandContext, type CommandContext } from './context.js';
-export { persistedFilesFromConfig } from './persist.js';
+export {
+  parsePersistConfig,
+  persistedFilesFromConfig,
+  type EnhancedPersistConfig,
+} from './persist.js';

packages/ci/src/lib/cli/persist.ts

@@ -7,11 +7,14 @@ import {
   DEFAULT_PERSIST_OUTPUT_DIR,
   type Format,
   persistConfigSchema,
+  uploadConfigSchema,
 } from '@code-pushup/models';
-import { objectFromEntries, stringifyError } from '@code-pushup/utils';
+import { objectFromEntries } from '@code-pushup/utils';
+
+export type EnhancedPersistConfig = Pick<CoreConfig, 'persist' | 'upload'>;
 
 export function persistedFilesFromConfig(
-  config: Pick<CoreConfig, 'persist'>,
+  config: EnhancedPersistConfig,
   { isDiff, directory }: { isDiff?: boolean; directory: string },
 ): Record<Format, string> {
   const {
@@ -36,11 +39,16 @@ export function persistedFilesFromConfig(
 
 export async function parsePersistConfig(
   json: unknown,
-): Promise<Pick<CoreConfig, 'persist'>> {
-  const schema = z.object({ persist: persistConfigSchema.optional() });
+): Promise<EnhancedPersistConfig> {
+  const schema = z.object({
+    persist: persistConfigSchema.optional(),
+    upload: uploadConfigSchema.optional(),
+  });
   const result = await schema.safeParseAsync(json);
   if (result.error) {
-    throw new Error(`Invalid persist config - ${stringifyError(result.error)}`);
+    throw new Error(
+      `Code PushUp config is invalid:\n${z.prettifyError(result.error)}`,
+    );
   }
   return result.data;
 }

packages/ci/src/lib/cli/persist.unit.test.ts

@@ -1,6 +1,10 @@
 import path from 'node:path';
 import type { CoreConfig } from '@code-pushup/models';
-import { parsePersistConfig, persistedFilesFromConfig } from './persist.js';
+import {
+  type EnhancedPersistConfig,
+  parsePersistConfig,
+  persistedFilesFromConfig,
+} from './persist.js';
 
 describe('persistedFilesFromConfig', () => {
   it('should return default report paths when no config is set', () => {
@@ -72,17 +76,47 @@ describe('persistedFilesFromConfig', () => {
 });
 
 describe('parsePersistConfig', () => {
-  it('should validate only persist config', async () => {
+  it('should validate only persist and upload config', async () => {
     await expect(
       parsePersistConfig({
         persist: {
           outputDir: '.code-pushup',
           filename: 'report',
           format: ['json', 'md'],
         },
+        upload: {
+          server: 'https://code-pushup-api.dunder-mifflin.org/graphql',
+          apiKey: 'cp_abcdef0123456789',
+          organization: 'dunder-mifflin',
+          project: 'website',
+        },
         // missing props (slug, etc.)
         plugins: [{ title: 'some plugin', audits: [{ title: 'some audit' }] }],
       } as CoreConfig),
+    ).resolves.toEqual({
+      persist: {
+        outputDir: '.code-pushup',
+        filename: 'report',
+        format: ['json', 'md'],
+      },
+      upload: {
+        server: 'https://code-pushup-api.dunder-mifflin.org/graphql',
+        apiKey: 'cp_abcdef0123456789',
+        organization: 'dunder-mifflin',
+        project: 'website',
+      },
+    } satisfies EnhancedPersistConfig);
+  });
+
+  it('should accept missing upload config', async () => {
+    await expect(
+      parsePersistConfig({
+        persist: {
+          outputDir: '.code-pushup',
+          filename: 'report',
+          format: ['json', 'md'],
+        },
+      }),
     ).resolves.toEqual({
       persist: {
         outputDir: '.code-pushup',
@@ -114,7 +148,20 @@ describe('parsePersistConfig', () => {
     await expect(
       parsePersistConfig({ persist: { format: ['json', 'html'] } }),
     ).rejects.toThrow(
-      /^Invalid persist config - ZodError:.*Invalid option: expected one of \\"json\\"\|\\"md\\"/s,
+      /^Code PushUp config is invalid.*Invalid option: expected one of "json"\|"md".*at persist\.format\[1]/s,
+    );
+  });
+
+  it('should error if upload config is invalid', async () => {
+    await expect(
+      parsePersistConfig({
+        upload: {
+          organization: 'dunder-mifflin',
+          project: 'website',
+        },
+      }),
+    ).rejects.toThrow(
+      /^Code PushUp config is invalid.*Invalid input: expected string, received undefined.*at upload\.server.*at upload\.apiKey/s,
     );
   });
 });

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

@@ -1,12 +1,12 @@
 import { readFile } from 'node:fs/promises';
-import type { CoreConfig } from '@code-pushup/models';
 import {
   type ExcludeNullableProps,
   asyncSequential,
   hasNoNullableProps,
 } from '@code-pushup/utils';
 import {
   type CommandContext,
+  type EnhancedPersistConfig,
   createCommandContext,
   persistedFilesFromConfig,
   runCollect,
@@ -88,7 +88,7 @@ export async function runInMonorepoMode(
 type ProjectReport = {
   project: ProjectConfig;
   reports: OutputFiles;
-  config: Pick<CoreConfig, 'persist'>;
+  config: EnhancedPersistConfig;
   ctx: CommandContext;
 };
 
@@ -125,7 +125,7 @@ async function runProjectsInBulk(
   const hasFormats = allProjectsHaveDefaultPersistFormats(currProjectConfigs);
   logger.debug(
     [
-      `Loaded ${currProjectConfigs.length} persist configs by running print-config command for each project.`,
+      `Loaded ${currProjectConfigs.length} persist and upload configs by running print-config command for each project.`,
       hasFormats
         ? 'Every project has default persist formats.'
         : 'Not all projects have default persist formats.',
@@ -279,7 +279,7 @@ async function collectPreviousReports(
 async function savePreviousProjectReport(args: {
   name: string;
   ctx: CommandContext;
-  config: Pick<CoreConfig, 'persist'>;
+  config: EnhancedPersistConfig;
   settings: Settings;
 }): Promise<[string, ReportData<'previous'>]> {
   const { name, ctx, config, settings } = args;
@@ -320,7 +320,7 @@ async function collectMany(
 }
 
 export function allProjectsHaveDefaultPersistFormats(
-  projects: { config: Pick<CoreConfig, 'persist'> }[],
+  projects: { config: EnhancedPersistConfig }[],
 ): boolean {
   return projects.every(({ config }) => hasDefaultPersistFormats(config));
 }

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

@@ -2,7 +2,6 @@
 import { readFile } from 'node:fs/promises';
 import type { SimpleGit } from 'simple-git';
 import {
-  type CoreConfig,
   DEFAULT_PERSIST_FORMAT,
   type Report,
   type ReportsDiff,
@@ -13,13 +12,14 @@ import {
 } from '@code-pushup/utils';
 import {
   type CommandContext,
+  type EnhancedPersistConfig,
   createCommandContext,
+  parsePersistConfig,
   persistedFilesFromConfig,
   runCollect,
   runCompare,
   runPrintConfig,
 } from './cli/index.js';
-import { parsePersistConfig } from './cli/persist.js';
 import { DEFAULT_SETTINGS } from './constants.js';
 import { listChangedFiles, normalizeGitRef } from './git.js';
 import { type SourceFileIssue, filterRelevantIssues } from './issues.js';
@@ -53,7 +53,7 @@ export type CompareReportsArgs = {
   base: GitBranch;
   currReport: ReportData<'current'>;
   prevReport: ReportData<'previous'>;
-  config: Pick<CoreConfig, 'persist'>;
+  config: EnhancedPersistConfig;
 };
 
 export type BaseReportArgs = {
@@ -114,7 +114,7 @@ export async function runOnProject(
 
   const config = await printPersistConfig(ctx);
   logger.debug(
-    `Loaded persist config from print-config command - ${JSON.stringify(config.persist)}`,
+    `Loaded persist and upload configs from print-config command - ${JSON.stringify(config)}`,
   );
 
   await runCollect(ctx, { hasFormats: hasDefaultPersistFormats(config) });
@@ -300,7 +300,7 @@ export async function runInBaseBranch<T>(
 
 export async function checkPrintConfig(
   args: BaseReportArgs,
-): Promise<Pick<CoreConfig, 'persist'> | null> {
+): Promise<EnhancedPersistConfig | null> {
   const {
     project,
     ctx,
@@ -329,13 +329,13 @@ export async function checkPrintConfig(
 
 export async function printPersistConfig(
   ctx: CommandContext,
-): Promise<Pick<CoreConfig, 'persist'>> {
+): Promise<EnhancedPersistConfig> {
   const json = await runPrintConfig(ctx);
   return parsePersistConfig(json);
 }
 
 export function hasDefaultPersistFormats(
-  config: Pick<CoreConfig, 'persist'>,
+  config: EnhancedPersistConfig,
 ): boolean {
   const formats = config.persist?.format;
   return (