feat(core): add support for community remote caching

Jordan-Hall · Nov 24, 2024 · d660dbd · d660dbd
1 parent 93daca5
commit d660dbd
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 3 deletions.
diff --git a/packages/nx/src/adapter/compat.ts b/packages/nx/src/adapter/compat.ts
@@ -81,6 +81,7 @@ export const allowedWorkspaceExtensions = [
   'neverConnectToCloud',
   'sync',
   'useLegacyCache',
+  'remoteCache',
 ] as const;
 
 if (!patched) {

diff --git a/packages/nx/src/config/nx-json.ts b/packages/nx/src/config/nx-json.ts
@@ -520,6 +520,11 @@ export interface NxJsonConfiguration<T = '*' | string[]> {
    * Use the legacy file system cache instead of the db cache
    */
   useLegacyCache?: boolean;
+
+  /**
+   * community support for custom cache
+   */
+  remoteCache?: string;
 }
 
 export type PluginConfiguration = string | ExpandedPluginConfiguration;

diff --git a/packages/nx/src/tasks-runner/cache.ts b/packages/nx/src/tasks-runner/cache.ts
@@ -156,6 +156,7 @@ export class DbCache {
       }
     } else {
       return (
+        (await this.getCustomCache(nxJson.remoteCache)) ??
         (await this.getPowerpackS3Cache()) ??
         (await this.getPowerpackSharedCache()) ??
         null
@@ -164,14 +165,14 @@ export class DbCache {
   }
 
   private getPowerpackS3Cache(): Promise<RemoteCacheV2 | null> {
-    return this.getPowerpackCache('@nx/powerpack-s3-cache');
+    return this.getCustomCache('@nx/powerpack-s3-cache');
   }
 
   private getPowerpackSharedCache(): Promise<RemoteCacheV2 | null> {
-    return this.getPowerpackCache('@nx/powerpack-shared-fs-cache');
+    return this.getCustomCache('@nx/powerpack-shared-fs-cache');
   }
 
-  private async getPowerpackCache(pkg: string): Promise<RemoteCacheV2 | null> {
+  private async getCustomCache(pkg: string): Promise<RemoteCacheV2 | null> {
     let getRemoteCache = null;
     try {
       getRemoteCache = (await import(this.resolvePackage(pkg))).getRemoteCache;