chore: normalize cache logic

.changeset/ten-dolls-provide.md

@@ -0,0 +1,5 @@
+---
+"@farmfe/core": major
+---
+
+bump version

examples/arco-pro/farm.config.ts

@@ -12,7 +12,7 @@ export default defineConfig((env) => {
       sourcemap: false,
       presetEnv: false,
       concatenateModules: true,
-      persistentCache: false,
+      // persistentCache: false,
       resolve: {
         symlinks: true,
         alias: {

examples/refactor-react/farm.config.ts

@@ -41,25 +41,25 @@ export default defineConfig({
     // compilerPlugin(),
     custom()
   ],
+  server: {
+    port: 4855,
+    appType: "mpa",
+    https: true
+  },
   compilation: {
     input: {
       index: path.resolve(__dirname, "index.html"),
       base: path.resolve(__dirname, 'base.html'),
       about: path.resolve(__dirname, 'about.html'),
     },
     progress: false,
-    persistentCache: false,
+    // persistentCache: false,
     // persistentCache: {
     //   cacheDir: "node_modules/.adny",
     // },
     output: {
       // publicPath: "/aaa/",
     },
-    server: {
-      port: 4855,
-      appType: "mpa",
-      https: true
-    },
   }
 });
 

packages/core/src/config/normalize-config/normalize-persistent-cache.ts

@@ -3,12 +3,14 @@ import { createRequire } from 'node:module';
 import path from 'node:path';
 
 import { RustPlugin } from '../../plugin/index.js';
-import { Config } from '../../types/binding.js';
+import { Config, GlobalBuiltinCacheKeyStrategy } from '../../types/binding.js';
 import { traceDependencies } from '../../utils/trace-dependencies.js';
 import { isDisableCache } from '../env.js';
 import { ResolvedUserConfig } from '../index.js';
 
-const defaultGlobalBuiltinCacheKeyStrategy = {
+const DEFAULT_CACHE_DIR = 'node_modules/.farm/cache';
+const DEFAULT_PACKAGE_JSON = 'package.json';
+const defaultGlobalBuiltinCacheKeyStrategy: GlobalBuiltinCacheKeyStrategy = {
   define: true,
   buildDependencies: true,
   lockfile: true,
@@ -28,33 +30,24 @@ export async function normalizePersistentCache(
     return;
   }
 
-  if (
-    typeof config.persistentCache === 'object' &&
-    config.persistentCache.cacheDir
-  ) {
-    config.persistentCache.cacheDir = path.resolve(
-      config.root,
-      config.persistentCache.cacheDir
-    );
-  }
-
   if (config.persistentCache === true || config.persistentCache == undefined) {
     config.persistentCache = {
       buildDependencies: [],
       moduleCacheKeyStrategy: {},
       envs: {}
     };
   }
+
+  config.persistentCache.cacheDir = path.resolve(
+    config.root,
+    config.persistentCache.cacheDir || DEFAULT_CACHE_DIR
+  );
   // globalCacheKeyStrategy should not be passed to rust
-  let { globalBuiltinCacheKeyStrategy } = config.persistentCache;
-  delete config.persistentCache.globalBuiltinCacheKeyStrategy;
-  if (!globalBuiltinCacheKeyStrategy) {
-    globalBuiltinCacheKeyStrategy = {};
-  }
-  globalBuiltinCacheKeyStrategy = {
+  const globalBuiltinCacheKeyStrategy = {
     ...defaultGlobalBuiltinCacheKeyStrategy,
-    ...globalBuiltinCacheKeyStrategy
+    ...(config.persistentCache?.globalBuiltinCacheKeyStrategy ?? {})
   };
+  delete config.persistentCache.globalBuiltinCacheKeyStrategy;
 
   if (globalBuiltinCacheKeyStrategy.env) {
     config.persistentCache.envs = {
@@ -84,10 +77,7 @@ export async function normalizePersistentCache(
   }
 
   // add type of package.json to envs
-  const packageJsonPath = path.join(
-    config.root ?? process.cwd(),
-    'package.json'
-  );
+  const packageJsonPath = path.join(config.root, DEFAULT_PACKAGE_JSON);
 
   if (globalBuiltinCacheKeyStrategy.packageJson) {
     if (existsSync(packageJsonPath)) {

packages/core/src/types/binding.ts

@@ -323,6 +323,19 @@ export interface CssConfig {
   _viteCssOptions?: any;
 }
 
+export interface GlobalBuiltinCacheKeyStrategy {
+  /** @default true */
+  define?: boolean;
+  /** @default true */
+  buildDependencies?: boolean;
+  /** @default true */
+  lockfile?: boolean;
+  /** @default true */
+  packageJson?: boolean;
+  /** @default true */
+  env?: boolean;
+}
+
 export interface PersistentCacheConfig {
   namespace?: string;
   cacheDir?: string;
@@ -341,18 +354,7 @@ export interface PersistentCacheConfig {
    *  lockfile: false
    * }
    */
-  globalBuiltinCacheKeyStrategy?: {
-    /** @default true */
-    define?: boolean;
-    /** @default true */
-    buildDependencies?: boolean;
-    /** @default true */
-    lockfile?: boolean;
-    /** @default true */
-    packageJson?: boolean;
-    /** @default true */
-    env?: boolean;
-  };
+  globalBuiltinCacheKeyStrategy?: GlobalBuiltinCacheKeyStrategy;
 }
 
 export interface PartialBundlingConfig {

packages/core/src/utils/logger.ts

@@ -271,8 +271,8 @@ export function bootstrap(
     const shortFile = getShortName(config.configFilePath, config.root);
     config.logger.info(`Using config file at ${bold(green(shortFile))}`, true);
   }
-  const usePersistentCache = config.compilation.persistentCache && hasCacheDir;
-  const persistentCacheFlag = usePersistentCache
+  const hasPersistentCache = config.compilation.persistentCache && hasCacheDir;
+  const persistentCacheFlag = hasPersistentCache
     ? colors.bold(PersistentCacheBrand)
     : '';