Improve caching for long to install dependencies

src/builder/builder.ts

@@ -29,6 +29,7 @@ export default abstract class Builder {
   private readonly cacheKey: string;
   protected readonly tagZipUri: string;
   protected readonly path: string;
+  protected restored = false;
 
   constructor(specificVersion: PythonTag, arch: string) {
     this.specificVersion = specificVersion.version;
@@ -60,34 +61,53 @@ export default abstract class Builder {
 
   protected abstract CacheKeyOs(): string;
 
+  protected abstract additionalCachePaths(): Promise<string[]>;
+
   abstract postInstall(installedPath: string): Promise<void>;
 
   async restoreCache(): Promise<string | null> {
     core.startGroup('Trying to use cached built version');
     if (!cache.isFeatureAvailable) {
+      core.info('Cache feature is not available on current runner.');
+      core.endGroup();
       return null;
     }
     const restoredPath = path.join(this.path, this.buildSuffix());
+    const restoredPaths = [restoredPath];
+    const additionalPaths = await this.additionalCachePaths();
+    if (additionalPaths.length > 0) {
+      restoredPaths.push(...additionalPaths);
+    }
     core.info(`Restoring cached version with key ${this.cacheKey}...`);
-    const restoredKey = await cache.restoreCache([restoredPath], this.cacheKey);
+    core.debug(`Restoring paths ${restoredPaths}`);
+    const restoredKey = await cache.restoreCache(restoredPaths, this.cacheKey);
     if (restoredKey === undefined) {
       core.info('Cached version not found.');
       core.endGroup();
       return null;
     }
     core.info(`CPython ${this.specificVersion} restored from cache.`);
     core.endGroup();
+    this.restored = true;
     return restoredPath;
   }
 
   async saveCache(): Promise<void> {
     core.startGroup('Caching built files');
     if (!cache.isFeatureAvailable) {
+      core.info('Cache feature is not available on current runner.');
+      core.endGroup();
       return;
     }
     core.info(`Saving built files with key ${this.cacheKey}...`);
     const savePath = path.join(this.path, this.buildSuffix());
-    await cache.saveCache([savePath], this.cacheKey);
+    const savePaths = [savePath];
+    const additionalPaths = await this.additionalCachePaths();
+    if (additionalPaths.length > 0) {
+      savePaths.push(...additionalPaths);
+    }
+    core.debug(`Saving paths: ${savePaths}`);
+    await cache.saveCache(savePaths, this.cacheKey);
     core.info('Files successfully saved in cache.');
     core.endGroup();
   }

src/builder/darwin.ts

@@ -81,10 +81,6 @@ export default class MacOSBuilder extends Builder {
     // Running ./configure
 
     core.startGroup('Configuring makefile');
-    core.info(`Config command: ${configCommand}`);
-    core.info(`CFLAGS: ${process.env['CFLAGS']}`);
-    core.info(`LDFLAGS: ${process.env['LDFLAGS']}`);
-    core.info(`CPPFLAGS: ${process.env['CPPFLAGS']}`);
     await exec.exec(configCommand, [], {cwd: this.path});
     core.endGroup();
 
@@ -199,29 +195,18 @@ export default class MacOSBuilder extends Builder {
 
     await this.installGeneralDependencies();
 
-    // Handle ssl installations
+    // Handle ssl version
 
     if (semver.lt(this.specificVersion, '3.5.0')) {
-      core.info('Detected version <3.5. OpenSSL version 1.0.2 will be used...');
-      if (this.sslPath === '') {
-        await this.installOldSsl(ssl102Url);
-      } else {
-        core.info('OpenSSL version 1.0.2 is already installed.');
-      }
+      core.info('OpenSSL version 1.0.2 is already installed');
     } else if (semver.lt(this.specificVersion, '3.9.0')) {
-      core.info('Detected version <3.9. OpenSSL version 1.1 will be used...');
-      if (this.sslPath === '') {
-        await exec.exec('brew install openssl@1.1');
-      } else {
-        core.info('OpenSSL version 1.1 is already installed.');
-      }
+      core.info(
+        'Detected version <3.9. OpenSSL version 1.1 will be installed...'
+      );
+      await exec.exec('brew install openssl@1.1');
     } else {
-      core.info('Detected version >=3.9. Default OpenSSL will be used...');
-      if (this.sslPath === '') {
-        await exec.exec('brew install openssl');
-      } else {
-        core.info('OpenSSL is already installed.');
-      }
+      core.info('Detected version >=3.9. Default OpenSSL will be installed...');
+      await exec.exec('brew install openssl');
     }
 
     // Create symlinks
@@ -297,4 +282,39 @@ export default class MacOSBuilder extends Builder {
     await exec.exec('brew install sqlite3', [], {ignoreReturnCode: true});
     await exec.exec('brew install readline', [], {ignoreReturnCode: true});
   }
+
+  protected override async additionalCachePaths(): Promise<string[]> {
+    const additionalPaths: string[] = [];
+    if (semver.lt(this.specificVersion, '3.5.0')) {
+      const tempPath = process.env['RUNNER_TEMP'] || os.tmpdir();
+      const ssl = await tc.downloadTool(
+        ssl102Url.url,
+        path.join(tempPath, `${ssl102Url.name}.rb`)
+      );
+      let openssl102Path = '';
+      await exec.exec(`brew --prefix ${ssl102Url.name}.rb`, [], {
+        cwd: tempPath,
+        listeners: {
+          stdout: (buffer: Buffer) => {
+            openssl102Path = openssl102Path.concat(buffer.toString());
+          }
+        },
+        silent: true
+      });
+      let openssl102Cellar = '';
+      await exec.exec(`brew --cellar ${ssl102Url.name}.rb`, [], {
+        cwd: tempPath,
+        listeners: {
+          stdout: (buffer: Buffer) => {
+            openssl102Cellar = openssl102Cellar.concat(buffer.toString());
+          }
+        },
+        silent: true
+      });
+      await io.rmRF(ssl);
+      additionalPaths.push(openssl102Path.trim());
+      additionalPaths.push(openssl102Cellar.trim());
+    }
+    return additionalPaths;
+  }
 }

src/builder/linux.ts

@@ -42,7 +42,7 @@ export default class LinuxBuilder extends Builder {
 
     // Configuring flags
 
-    const flags: string[] = ['--enable-shared'];
+    const flags: string[] = [];
     if (semver.lt(this.specificVersion, '3.0.0')) {
       flags.push('--enable-unicode=ucs4');
     }
@@ -206,4 +206,8 @@ export default class LinuxBuilder extends Builder {
       );
     }
   }
+
+  protected override async additionalCachePaths(): Promise<string[]> {
+    return [];
+  }
 }

src/builder/windows.ts

@@ -249,4 +249,8 @@ export default class WindowsBuilder extends Builder {
 
     core.endGroup();
   }
+
+  protected override async additionalCachePaths(): Promise<string[]> {
+    return [];
+  }
 }