fix: adjust caching tests and types

Author: BioPhoton

packages/core/src/lib/implementation/collect.ts

@@ -25,9 +25,9 @@ export async function collect(options: CollectOptions): Promise<Report> {
   const pluginOutputs = await executePlugins(
     {
       plugins,
-      persist: { ...persist, outputDir: DEFAULT_PERSIST_OUTPUT_DIR },
+      persist: { outputDir: DEFAULT_PERSIST_OUTPUT_DIR, ...persist },
       // implement together with CLI option
-      cache: {},
+      cache: { read: false, write: false },
     },
     otherOptions,
   );

packages/core/src/lib/implementation/execute-plugin.ts

@@ -3,7 +3,7 @@ import type {
   Audit,
   AuditOutput,
   AuditReport,
-  CacheConfig,
+  CacheConfigObject,
   PersistConfig,
   PluginConfig,
   PluginReport,
@@ -46,7 +46,7 @@ import {
 export async function executePlugin(
   pluginConfig: PluginConfig,
   opt: {
-    cache?: CacheConfig;
+    cache: CacheConfigObject;
     persist: Required<Pick<PersistConfig, 'outputDir'>>;
   },
 ): Promise<PluginReport> {
@@ -59,7 +59,7 @@ export async function executePlugin(
     groups,
     ...pluginMeta
   } = pluginConfig;
-  const { write: cacheWrite = false, read: cacheRead = false } = cache ?? {};
+  const { write: cacheWrite = false, read: cacheRead = false } = cache;
   const { outputDir } = persist;
 
   const { audits, ...executionMeta } = cacheRead
@@ -101,7 +101,7 @@ const wrapProgress = async (
   cfg: {
     plugin: PluginConfig;
     persist: Required<Pick<PersistConfig, 'outputDir'>>;
-    cache: CacheConfig;
+    cache: CacheConfigObject;
   },
   steps: number,
   progressBar: ProgressBar | null,
@@ -127,7 +127,7 @@ const wrapProgress = async (
 /**
  * Execute multiple plugins and aggregates their output.
  * @public
- * @param plugins array of {@link PluginConfig} objects
+ * @param cfg
  * @param {Object} [options] execution options
  * @param {boolean} options.progress show progress bar
  * @returns {Promise<PluginReport[]>} plugin report
@@ -149,7 +149,7 @@ export async function executePlugins(
   cfg: {
     plugins: PluginConfig[];
     persist: Required<Pick<PersistConfig, 'outputDir'>>;
-    cache: CacheConfig;
+    cache: CacheConfigObject;
   },
   options?: { progress?: boolean },
 ): Promise<PluginReport[]> {

packages/core/src/lib/implementation/execute-plugin.unit.test.ts

@@ -22,7 +22,7 @@ describe('executePlugin', () => {
     await expect(
       executePlugin(MINIMAL_PLUGIN_CONFIG_MOCK, {
         persist: { outputDir: '' },
-        cache: {},
+        cache: { read: false, write: false },
       }),
     ).resolves.toStrictEqual({
       slug: 'node',
@@ -60,7 +60,7 @@ describe('executePlugin', () => {
     await expect(
       executePlugin(MINIMAL_PLUGIN_CONFIG_MOCK, {
         persist: { outputDir: 'dummy-path-result-is-mocked' },
-        cache: { read: true },
+        cache: { read: true, write: false },
       }),
     ).resolves.toStrictEqual({
       slug: 'node',
@@ -103,7 +103,7 @@ describe('executePlugin', () => {
     await expect(
       executePlugin(MINIMAL_PLUGIN_CONFIG_MOCK, {
         persist: { outputDir: 'dummy-path-result-is-mocked' },
-        cache: { read: true },
+        cache: { read: true, write: false },
       }),
     ).resolves.toStrictEqual({
       slug: 'node',
@@ -138,7 +138,7 @@ describe('executePlugins', () => {
           },
         ],
         persist: { outputDir: '.code-pushup' },
-        cache: {},
+        cache: { read: false, write: false },
       },
       { progress: false },
     );
@@ -170,7 +170,7 @@ describe('executePlugins', () => {
             },
           ] satisfies PluginConfig[],
           persist: { outputDir: '.code-pushup' },
-          cache: {},
+          cache: { read: false, write: false },
         },
         { progress: false },
       ),
@@ -202,7 +202,7 @@ describe('executePlugins', () => {
             },
           ] satisfies PluginConfig[],
           persist: { outputDir: '.code-pushup' },
-          cache: {},
+          cache: { read: false, write: false },
         },
         { progress: false },
       ),
@@ -243,7 +243,7 @@ describe('executePlugins', () => {
             },
           ] satisfies PluginConfig[],
           persist: { outputDir: '.code-pushup' },
-          cache: {},
+          cache: { read: false, write: false },
         },
         { progress: false },
       ),
@@ -285,7 +285,7 @@ describe('executePlugins', () => {
             },
           ] satisfies PluginConfig[],
           persist: { outputDir: '.code-pushup' },
-          cache: {},
+          cache: { read: false, write: false },
         },
         { progress: false },
       ),
@@ -338,7 +338,7 @@ describe('executePlugins', () => {
           },
         ],
         persist: { outputDir: '.code-pushup' },
-        cache: {},
+        cache: { read: false, write: false },
       },
       { progress: false },
     );

packages/models/src/lib/cache-config.ts

@@ -22,7 +22,8 @@ export const cacheConfigShorthandSchema = z
 export type CacheConfigShorthand = z.infer<typeof cacheConfigShorthandSchema>;
 
 export const cacheConfigSchema = z
-  .union(cacheConfigShorthandSchema, cacheConfigObjectSchema)
-  .describe('Cache configuration for read and write operations');
+  .union([cacheConfigShorthandSchema, cacheConfigObjectSchema])
+  .describe('Cache configuration for read and write operations')
+  .default(false);
 
 export type CacheConfig = z.infer<typeof cacheConfigSchema>;