@roots/bud-cache 6.21.0 → 6.22.0

package/README.md

@@ -76,9 +76,6 @@ However, the amount of effort needed to maintain and develop new features and pr
 <a href="https://worksitesafety.ca/careers/">
 <img src="https://cdn.roots.io/app/uploads/worksite-safety.svg" alt="Worksite Safety" width="200" height="150"/>
 </a>
-<a href="https://www.copiadigital.com/">
-<img src="https://cdn.roots.io/app/uploads/copia-digital.svg" alt="Copia Digital" width="200" height="150"/>
-</a>
-<a href="https://www.freave.com/">
-<img src="https://cdn.roots.io/app/uploads/freave.svg" alt="Freave" width="200" height="150"/>
+<a href="https://www.itineris.co.uk/">
+<img src="https://cdn.roots.io/app/uploads/itineris.svg" alt="Itineris" width="200" height="150"/>
 </a>

package/lib/helpers.d.ts

@@ -1,2 +1,3 @@
 import type { File } from '@roots/bud-framework/context';
 export declare const isBuildDependency: (file: File) => boolean;
+export declare const isBudConfig: (file: File) => boolean;

package/lib/helpers.js

@@ -6,4 +6,5 @@ export const isBuildDependency = (file) => [
     `package`,
     `pnpm-workspace`,
     `tsconfig`,
-].includes(file.name) || file.bud;
+].some(match => file.name.includes(match));
+export const isBudConfig = (file) => file.name.includes(`bud`);

package/lib/service.d.ts

@@ -19,7 +19,7 @@ export default class Cache extends Service implements BudCache {
      *{@link BudCache.buildDependencies}
      */
     get buildDependencies(): FileCacheOptions[`buildDependencies`];
-    set buildDependencies(dependencies: Callback<FileCacheOptions[`buildDependencies`]>);
+    set buildDependencies(dependencies: Callback<FileCacheOptions[`buildDependencies`]> | FileCacheOptions[`buildDependencies`]);
     /**
      * {@link BudCache.cacheDirectory}
      */
@@ -71,10 +71,6 @@ export default class Cache extends Service implements BudCache {
      * Get {@link BudCache.type}
      */
     getType(): "filesystem" | "memory";
-    /**
-     * {@link BudCache.register}
-     */
-    register?(bud: Bud): Promise<void>;
     /**
      * Set {@link BudCache.allowCollectingMemory}
      */

package/lib/service.js

@@ -1,6 +1,6 @@
 import { __decorate } from "tslib";
 import { join } from 'node:path';
-import { isBuildDependency } from '@roots/bud-cache/helpers';
+import { isBudConfig, isBuildDependency } from '@roots/bud-cache/helpers';
 import { Service } from '@roots/bud-framework/service';
 import { bind } from '@roots/bud-support/decorators/bind';
 /**
@@ -11,7 +11,7 @@ export default class Cache extends Service {
      * {@link BudCache.allowCollectingMemory}
      */
     get allowCollectingMemory() {
-        const fallback = true;
+        const fallback = false;
         const value = this.app.hooks.filter(`build.cache.allowCollectingMemory`, fallback);
         return typeof value === `boolean` ? value : fallback;
     }
@@ -22,17 +22,7 @@ export default class Cache extends Service {
      *{@link BudCache.buildDependencies}
      */
     get buildDependencies() {
-        const projectDependencies = new Set([
-            this.app.context.files[`package`]?.path,
-            ...Object.values(this.app.context.files)
-                .filter(isBuildDependency)
-                .map(({ path }) => path),
-        ]);
-        const records = {
-            project: [...projectDependencies].filter(Boolean),
-        };
-        return (this.app.hooks.filter(`build.cache.buildDependencies`, records) ??
-            records);
+        return this.app.hooks.filter(`build.cache.buildDependencies`);
     }
     set buildDependencies(dependencies) {
         this.app.hooks.on(`build.cache.buildDependencies`, dependencies);
@@ -85,32 +75,58 @@ export default class Cache extends Service {
             await this.flush();
         }
         this.enabled = bud.context.cache !== false;
+        this.setBuildDependencies(deps => ({
+            ...(deps ?? {}),
+            config: [
+                ...new Set([
+                    ...Object.values(this.app.context.files)
+                        .filter(isBudConfig)
+                        .map(({ path }) => path),
+                    ...(deps?.config ?? []),
+                ]),
+            ].filter(Boolean),
+            project: [
+                ...new Set([
+                    ...Object.values(this.app.context.files)
+                        .filter(isBuildDependency)
+                        .map(({ path }) => path),
+                    ...(deps?.project ?? []),
+                ]),
+            ].filter(Boolean),
+        }));
     }
     /**
      * {@link BudCache.configuration}
      * @readonly
      */
     get configuration() {
-        if (this.enabled !== true)
+        if (this.enabled !== true) {
+            this.logger.log(`Cache: disabled`);
             return false;
-        if (this.type === `memory`)
+        }
+        if (this.type === `memory`) {
+            this.logger.log(`Cache: memory`);
             return {
                 cacheUnaffected: true,
                 maxGenerations: Infinity,
                 type: `memory`,
             };
+        }
+        this.logger.log(`Cache: filesystem`);
         return {
             allowCollectingMemory: this.allowCollectingMemory,
             buildDependencies: this.buildDependencies,
             cacheDirectory: this.cacheDirectory,
-            compression: this.app.isDevelopment ? false : `brotli`,
+            compression: false,
             hashAlgorithm: `xxhash64`,
-            idleTimeout: 100,
+            idleTimeout: 10000,
             idleTimeoutForInitialStore: 0,
-            managedPaths: [this.cacheDirectory, this.app.path(`@modules`)],
-            maxMemoryGenerations: Infinity,
+            managedPaths: [this.app.path(`@modules`)],
+            maxMemoryGenerations: this.app.isDevelopment ? 10 : Infinity,
+            memoryCacheUnaffected: true,
             name: this.name,
             profile: this.app.context.debug === true,
+            readonly: this.app.env.isTrue(`CI`),
             store: `pack`,
             type: this.type,
         };
@@ -145,13 +161,6 @@ export default class Cache extends Service {
     getType() {
         return this.type;
     }
-    /**
-     * {@link BudCache.register}
-     */
-    async register(bud) {
-        this.enabled = bud.context.cache !== false;
-        this.version = bud.context.bud.version;
-    }
     /**
      * Set {@link BudCache.allowCollectingMemory}
      */
@@ -187,6 +196,3 @@ __decorate([
 __decorate([
     bind
 ], Cache.prototype, "flush", null);
-__decorate([
-    bind
-], Cache.prototype, "register", null);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@roots/bud-cache",
-  "version": "6.21.0",
+  "version": "6.22.0",
   "description": "Config caching",
   "engines": {
     "node": ">=16"
@@ -72,8 +72,8 @@
     "@skypack/package-check": "0.2.2"
   },
   "dependencies": {
-    "@roots/bud-framework": "6.21.0",
-    "@roots/bud-support": "6.21.0",
+    "@roots/bud-framework": "6.22.0",
+    "@roots/bud-support": "6.22.0",
     "strip-ansi": "7.1.0",
     "tslib": "2.6.2"
   },

package/src/helpers.ts

@@ -9,4 +9,7 @@ export const isBuildDependency = (file: File): boolean =>
     `package`,
     `pnpm-workspace`,
     `tsconfig`,
-  ].includes(file.name) || file.bud
+  ].some(match => file.name.includes(match))
+
+export const isBudConfig = (file: File): boolean =>
+  file.name.includes(`bud`)

package/src/service.ts

@@ -10,7 +10,7 @@ import type {
 
 import {join} from 'node:path'
 
-import {isBuildDependency} from '@roots/bud-cache/helpers'
+import {isBudConfig, isBuildDependency} from '@roots/bud-cache/helpers'
 import {Service} from '@roots/bud-framework/service'
 import {bind} from '@roots/bud-support/decorators/bind'
 
@@ -22,11 +22,12 @@ export default class Cache extends Service implements BudCache {
    * {@link BudCache.enabled}
    */
   public declare enabled: boolean
+
   /**
    * {@link BudCache.allowCollectingMemory}
    */
   public get allowCollectingMemory(): FileCacheOptions[`allowCollectingMemory`] {
-    const fallback = true
+    const fallback = false
 
     const value = this.app.hooks.filter(
       `build.cache.allowCollectingMemory`,
@@ -44,23 +45,13 @@ export default class Cache extends Service implements BudCache {
    *{@link BudCache.buildDependencies}
    */
   public get buildDependencies(): FileCacheOptions[`buildDependencies`] {
-    const projectDependencies = new Set([
-      this.app.context.files[`package`]?.path,
-      ...Object.values(this.app.context.files)
-        .filter(isBuildDependency)
-        .map(({path}) => path),
-    ])
-    const records = {
-      project: [...projectDependencies].filter(Boolean),
-    }
-
-    return (
-      this.app.hooks.filter(`build.cache.buildDependencies`, records) ??
-      records
-    )
+    return this.app.hooks.filter(`build.cache.buildDependencies`)
   }
+
   public set buildDependencies(
-    dependencies: Callback<FileCacheOptions[`buildDependencies`]>,
+    dependencies:
+      | Callback<FileCacheOptions[`buildDependencies`]>
+      | FileCacheOptions[`buildDependencies`],
   ) {
     this.app.hooks.on(`build.cache.buildDependencies`, dependencies)
   }
@@ -132,6 +123,26 @@ export default class Cache extends Service implements BudCache {
       await this.flush()
     }
     this.enabled = bud.context.cache !== false
+
+    this.setBuildDependencies(deps => ({
+      ...(deps ?? {}),
+      config: [
+        ...new Set([
+          ...Object.values(this.app.context.files)
+            .filter(isBudConfig)
+            .map(({path}) => path),
+          ...(deps?.config ?? []),
+        ]),
+      ].filter(Boolean),
+      project: [
+        ...new Set([
+          ...Object.values(this.app.context.files)
+            .filter(isBuildDependency)
+            .map(({path}) => path),
+          ...(deps?.project ?? []),
+        ]),
+      ].filter(Boolean),
+    }))
   }
 
   /**
@@ -139,26 +150,34 @@ export default class Cache extends Service implements BudCache {
    * @readonly
    */
   public get configuration(): Configuration[`cache`] {
-    if (this.enabled !== true) return false
-    if (this.type === `memory`)
+    if (this.enabled !== true) {
+      this.logger.log(`Cache: disabled`)
+      return false
+    }
+    if (this.type === `memory`) {
+      this.logger.log(`Cache: memory`)
       return {
         cacheUnaffected: true,
         maxGenerations: Infinity,
         type: `memory`,
       }
+    }
 
+    this.logger.log(`Cache: filesystem`)
     return {
       allowCollectingMemory: this.allowCollectingMemory,
       buildDependencies: this.buildDependencies,
       cacheDirectory: this.cacheDirectory,
-      compression: this.app.isDevelopment ? false : `brotli`,
+      compression: false,
       hashAlgorithm: `xxhash64`,
-      idleTimeout: 100,
+      idleTimeout: 10000,
       idleTimeoutForInitialStore: 0,
-      managedPaths: [this.cacheDirectory, this.app.path(`@modules`)],
-      maxMemoryGenerations: Infinity,
+      managedPaths: [this.app.path(`@modules`)],
+      maxMemoryGenerations: this.app.isDevelopment ? 10 : Infinity,
+      memoryCacheUnaffected: true,
       name: this.name,
       profile: this.app.context.debug === true,
+      readonly: this.app.env.isTrue(`CI`),
       store: `pack`,
       type: this.type,
     }
@@ -197,14 +216,6 @@ export default class Cache extends Service implements BudCache {
     return this.type
   }
 
-  /**
-   * {@link BudCache.register}
-   */
-  @bind
-  public override async register?(bud: Bud) {
-    this.enabled = bud.context.cache !== false
-    this.version = bud.context.bud.version
-  }
   /**
    * Set {@link BudCache.allowCollectingMemory}
    */