[ENG-9500] Don't mix cacheManager with dynamic cache manager

expo · Mar 5, 2024 · db0ebe4 · db0ebe4
1 parent aa79fe4
commit db0ebe4
Show file tree

Hide file tree

Showing 14 changed files with 89 additions and 231 deletions.
diff --git a/packages/build-tools/src/builders/android.ts b/packages/build-tools/src/builders/android.ts
@@ -59,10 +59,7 @@ async function buildAsync(ctx: BuildContext<Android.Job>): Promise<void> {
   });
 
   await ctx.runBuildPhase(BuildPhase.RESTORE_CACHE, async () => {
-    await ctx.cacheManager?.restoreCache(
-      { global: ctx, logger: ctx.logger, workingdir: ctx.workingdir },
-      ctx.job.cache
-    );
+    await ctx.cacheManager?.restoreCache(ctx);
   });
 
   await ctx.runBuildPhase(BuildPhase.POST_INSTALL_HOOK, async () => {
@@ -98,10 +95,7 @@ async function buildAsync(ctx: BuildContext<Android.Job>): Promise<void> {
   });
 
   await ctx.runBuildPhase(BuildPhase.SAVE_CACHE, async () => {
-    await ctx.cacheManager?.saveCache(
-      { global: ctx, logger: ctx.logger, workingdir: ctx.workingdir },
-      ctx.job.cache
-    );
+    await ctx.cacheManager?.saveCache(ctx);
   });
 
   await ctx.runBuildPhase(BuildPhase.UPLOAD_APPLICATION_ARCHIVE, async () => {

diff --git a/packages/build-tools/src/builders/ios.ts b/packages/build-tools/src/builders/ios.ts
@@ -63,10 +63,7 @@ async function buildAsync(ctx: BuildContext<Ios.Job>): Promise<void> {
     });
 
     await ctx.runBuildPhase(BuildPhase.RESTORE_CACHE, async () => {
-      await ctx.cacheManager?.restoreCache(
-        { global: ctx, logger: ctx.logger, workingdir: ctx.workingdir },
-        ctx.job.cache
-      );
+      await ctx.cacheManager?.restoreCache(ctx);
     });
 
     await ctx.runBuildPhase(BuildPhase.INSTALL_PODS, async () => {
@@ -109,10 +106,7 @@ async function buildAsync(ctx: BuildContext<Ios.Job>): Promise<void> {
   });
 
   await ctx.runBuildPhase(BuildPhase.SAVE_CACHE, async () => {
-    await ctx.cacheManager?.saveCache(
-      { global: ctx, logger: ctx.logger, workingdir: ctx.workingdir },
-      ctx.job.cache
-    );
+    await ctx.cacheManager?.saveCache(ctx);
   });
 
   await ctx.runBuildPhase(BuildPhase.UPLOAD_APPLICATION_ARCHIVE, async () => {

diff --git a/packages/build-tools/src/context.ts b/packages/build-tools/src/context.ts
@@ -17,15 +17,14 @@ import {
 } from '@expo/eas-build-job';
 import { BuildTrigger } from '@expo/eas-build-job/dist/common';
 import { bunyan } from '@expo/logger';
-import { CacheManager } from '@expo/steps';
 import { SpawnOptions, SpawnPromise, SpawnResult } from '@expo/turtle-spawn';
 import fs from 'fs-extra';
+import { DynamicCacheManager } from '@expo/steps';
 
 import { resolveBuildPhaseErrorAsync } from './buildErrors/detectError';
 import { readAppConfig } from './utils/appConfig';
 import { createTemporaryEnvironmentSecretFile } from './utils/environmentSecrets';
 import { PackageManager, resolvePackageManager } from './utils/packageManager';
-export { CacheManager } from '@expo/steps';
 
 export type Artifacts = Partial<Record<ManagedArtifactType, string>>;
 
@@ -56,6 +55,7 @@ export interface BuildContextOptions {
   logBuffer: LogBuffer;
   env: Env;
   cacheManager?: CacheManager;
+  dynamicCacheManager?: DynamicCacheManager;
   /**
    * @deprecated
    */
@@ -82,6 +82,7 @@ export class BuildContext<TJob extends Job> {
   public logger: bunyan;
   public readonly logBuffer: LogBuffer;
   public readonly cacheManager?: CacheManager;
+  public readonly dynamicCacheManager?: DynamicCacheManager;
   /**
    * @deprecated
    */
@@ -115,6 +116,7 @@ export class BuildContext<TJob extends Job> {
     this.logger = this.defaultLogger;
     this.logBuffer = options.logBuffer;
     this.cacheManager = options.cacheManager;
+    this.dynamicCacheManager = options.dynamicCacheManager;
     this.runGlobalExpoCliCommand = options.runGlobalExpoCliCommand;
     this._uploadArtifact = options.uploadArtifact;
     this.reportError = options.reportError;

diff --git a/packages/build-tools/src/customBuildContext.ts b/packages/build-tools/src/customBuildContext.ts
@@ -10,9 +10,13 @@ import {
   Platform,
 } from '@expo/eas-build-job';
 import { bunyan } from '@expo/logger';
-import { ExternalBuildContextProvider, BuildRuntimePlatform, CacheManager } from '@expo/steps';
+import {
+  ExternalBuildContextProvider,
+  BuildRuntimePlatform,
+  DynamicCacheManager,
+} from '@expo/steps';
 
-import { ArtifactToUpload, BuildContext } from './context';
+import { ArtifactToUpload, BuildContext, CacheManager } from './context';
 
 const platformToBuildRuntimePlatform: Record<Platform, BuildRuntimePlatform> = {
   [Platform.ANDROID]: BuildRuntimePlatform.LINUX,
@@ -21,6 +25,7 @@ const platformToBuildRuntimePlatform: Record<Platform, BuildRuntimePlatform> = {
 
 export interface BuilderRuntimeApi {
   uploadArtifact: (spec: { artifact: ArtifactToUpload; logger: bunyan }) => Promise<void>;
+  cacheManager?: DynamicCacheManager;
 }
 
 export class CustomBuildContext implements ExternalBuildContextProvider {
@@ -66,6 +71,7 @@ export class CustomBuildContext implements ExternalBuildContextProvider {
     this.buildLogsDirectory = path.join(buildCtx.workingdir, 'logs');
     this.runtimeApi = {
       uploadArtifact: (...args) => buildCtx['uploadArtifact'](...args),
+      cacheManager: buildCtx.dynamicCacheManager,
     };
     this.cacheManager = buildCtx.cacheManager;
     this.buildDirectory = buildCtx.buildDirectory;

diff --git a/packages/build-tools/src/steps/easFunctions.ts b/packages/build-tools/src/steps/easFunctions.ts
@@ -33,8 +33,8 @@ export function getEasFunctions(ctx: CustomBuildContext): BuildFunction[] {
     createInstallNodeModulesBuildFunction(),
     createPrebuildBuildFunction(),
     createFindAndUploadBuildArtifactsBuildFunction(ctx),
-    createSaveCacheBuildFunction(),
-    createRestoreCacheBuildFunction(),
+    createSaveCacheBuildFunction(ctx),
+    createRestoreCacheBuildFunction(ctx),
     configureEASUpdateIfInstalledFunction(),
     injectAndroidCredentialsFunction(),
     configureAndroidVersionFunction(),

diff --git a/packages/build-tools/src/steps/functions/__tests__/cache.test.ts b/packages/build-tools/src/steps/functions/__tests__/cache.test.ts
@@ -2,47 +2,65 @@ import fs from 'fs/promises';
 import os from 'os';
 import path from 'path';
 
+import { Job, Metadata } from '@expo/eas-build-job';
 import {
   BuildRuntimePlatform,
   BuildStepGlobalContext,
+  Cache,
+  DynamicCacheManager,
   ExternalBuildContextProvider,
-  CacheManager,
 } from '@expo/steps';
 import { anything, capture, instance, mock, reset, verify, when } from 'ts-mockito';
 
 import { createLogger } from '../../../__mocks__/@expo/logger';
+import { createTestIosJob } from '../../../__tests__/utils/job';
+import { createMockLogger } from '../../../__tests__/utils/logger';
+import { BuildContext } from '../../../context';
+import { CustomBuildContext } from '../../../customBuildContext';
 import { createRestoreCacheBuildFunction, createSaveCacheBuildFunction } from '../cache';
 
-const cacheSaveBuildFunction = createSaveCacheBuildFunction();
-const cacheRestoreBuildFunction = createRestoreCacheBuildFunction();
+const dynamicCacheManagerMock = mock<DynamicCacheManager>();
+const dynamicCacheManager = instance(dynamicCacheManagerMock);
+
+const buildCtx = new BuildContext(createTestIosJob({}), {
+  env: {},
+  logBuffer: { getLogs: () => [], getPhaseLogs: () => [] },
+  logger: createMockLogger(),
+  uploadArtifact: jest.fn(),
+  workingdir: '',
+  dynamicCacheManager,
+  runGlobalExpoCliCommand: jest.fn(),
+});
+const customContext = new CustomBuildContext(buildCtx);
+
+const cacheSaveBuildFunction = createSaveCacheBuildFunction(customContext);
+const cacheRestoreBuildFunction = createRestoreCacheBuildFunction(customContext);
 
 const providerMock = mock<ExternalBuildContextProvider>();
-const cacheManagerMock = mock<CacheManager>();
 
-const cacheManager = instance(cacheManagerMock);
-const initialCache = { downloadUrls: {} };
+const initialCache: Cache = { disabled: false, clear: false, paths: [] };
 
 const provider = instance(providerMock);
 
 let ctx: BuildStepGlobalContext;
 
-const existingKey =
-  'c7d8e33243968f8675ec0463ad89e11c1e754723695ab9b23dfb8f9ddd389a28-value-8b6e2366e2a2ff8b43556a1dcc5f1cf97ddcf4cdf3c8f9a6d54e0efe2e747922';
-
 describe('cache functions', () => {
   let key: string;
   let paths: string[];
   beforeEach(async () => {
     key = '${ hashFiles("./src/*")  }-value';
     paths = ['path1', 'path2'];
-    reset(cacheManagerMock);
+    reset(dynamicCacheManagerMock);
     reset(providerMock);
 
     const projectSourceDirectory = await fs.mkdtemp(path.join(os.tmpdir(), 'project-'));
     when(providerMock.logger).thenReturn(createLogger());
     when(providerMock.runtimePlatform).thenReturn(BuildRuntimePlatform.LINUX);
-    when(providerMock.staticContext()).thenReturn({ some: 'key', job: { cache: initialCache } });
-    when(providerMock.cacheManager).thenReturn(cacheManager);
+    when(providerMock.staticContext()).thenReturn({
+      metadata: {} as Metadata,
+      env: {},
+      job: { cache: initialCache } as Job,
+    });
     when(providerMock.projectSourceDirectory).thenReturn(projectSourceDirectory);
     when(providerMock.defaultWorkingDirectory).thenReturn(projectSourceDirectory);
     when(providerMock.projectTargetDirectory).thenReturn(projectSourceDirectory);
@@ -62,9 +80,6 @@ describe('cache functions', () => {
     });
 
     test('restores cache if it exists', async () => {
-      when(cacheManagerMock.restoreCache(anything(), anything()));
-      initialCache.downloadUrls = { [existingKey]: 'url' };
-
       const buildStep = cacheRestoreBuildFunction.createBuildStepFromFunctionCall(ctx, {
         callInputs: { key, paths },
       });
@@ -73,25 +88,12 @@ describe('cache functions', () => {
 
       await buildStep.executeAsync();
 
-      verify(cacheManagerMock.restoreCache(anything(), anything())).once();
+      verify(dynamicCacheManagerMock.restoreCache(anything(), anything())).once();
 
-      const [, cache] = capture(cacheManagerMock.restoreCache).first();
+      const [, cache] = capture(dynamicCacheManagerMock.restoreCache).first();
       expect(cache.key).toMatch(/^\w+-value/);
       expect(cache.paths).toStrictEqual(paths);
     });
-
-    test("doesn't restore cache if it doesn't exist", async () => {
-      when(cacheManagerMock.restoreCache(anything(), anything()));
-      initialCache.downloadUrls = { invalidkey: 'url' };
-
-      const buildStep = cacheRestoreBuildFunction.createBuildStepFromFunctionCall(ctx, {
-        callInputs: { key, paths },
-      });
-
-      await buildStep.executeAsync();
-
-      verify(cacheManagerMock.restoreCache(anything(), anything())).never();
-    });
   });
 
   describe('cacheSaveBuildFunction', () => {
@@ -102,35 +104,16 @@ describe('cache functions', () => {
     });
 
     test('saves cache if it does not exist', async () => {
-      when(cacheManagerMock.restoreCache(anything(), anything()));
-
-      initialCache.downloadUrls = {};
-
       const buildStep = cacheSaveBuildFunction.createBuildStepFromFunctionCall(ctx, {
         callInputs: { key, paths },
       });
 
       await buildStep.executeAsync();
 
-      verify(cacheManagerMock.saveCache(anything(), anything())).once();
+      verify(dynamicCacheManagerMock.saveCache(anything(), anything())).once();
 
-      const [, cache] = capture(cacheManagerMock.saveCache).first();
+      const [, cache] = capture(dynamicCacheManagerMock.saveCache).first();
       expect(cache?.key).toMatch(/^\w+-value/);
-      expect(cache?.paths).toStrictEqual(paths);
-    });
-
-    test("doesn't save cache if it exists", async () => {
-      when(cacheManagerMock.restoreCache(anything(), anything()));
-
-      initialCache.downloadUrls = { [existingKey]: 'url' };
-
-      const buildStep = cacheSaveBuildFunction.createBuildStepFromFunctionCall(ctx, {
-        callInputs: { key, paths },
-      });
-
-      await buildStep.executeAsync();
-
-      verify(cacheManagerMock.saveCache(anything(), anything())).never();
     });
   });
 });