Merge pull request #945 from ocaml/reduce-api-calls

Don't make heavy API requests multiple times

Author: smorimoto

dist/index.js

@@ -17,21 +17,21 @@ import {
   OPAM_REPOSITORIES,
   OPAM_ROOT,
   PLATFORM,
-  RESOLVED_COMPILER,
 } from "./constants.js";
-import { retrieveLatestOpamRelease } from "./opam.js";
-import { retrieveCygwinVersion } from "./windows.js";
+import { latestOpamRelease } from "./opam.js";
+import { resolvedCompiler } from "./version.js";
+import { cygwinVersion } from "./windows.js";
 
 async function composeCygwinCacheKeys() {
-  const cygwinVersion = await retrieveCygwinVersion();
-  const key = `${CACHE_PREFIX}-setup-ocaml-cygwin-${CYGWIN_MIRROR_ENCODED_URI}-${cygwinVersion}`;
+  const version = await cygwinVersion;
+  const key = `${CACHE_PREFIX}-setup-ocaml-cygwin-${CYGWIN_MIRROR_ENCODED_URI}-${version}`;
   const restoreKeys = [key];
   return { key, restoreKeys };
 }
 
 async function composeDuneCacheKeys() {
   const { workflow, job, runId } = github.context;
-  const ocamlCompiler = await RESOLVED_COMPILER;
+  const ocamlCompiler = await resolvedCompiler;
   const plainKey = [ocamlCompiler, workflow, job].join();
   const hash = crypto.createHash("sha256").update(plainKey).digest("hex");
   const key = `${CACHE_PREFIX}-setup-ocaml-dune-${PLATFORM}-${ARCHITECTURE}-${hash}-${runId}`;
@@ -45,9 +45,9 @@ async function composeDuneCacheKeys() {
 }
 
 async function composeOpamCacheKeys() {
-  const { version: opamVersion } = await retrieveLatestOpamRelease();
+  const { version: opamVersion } = await latestOpamRelease;
   const sandbox = OPAM_DISABLE_SANDBOXING ? "nosandbox" : "sandbox";
-  const ocamlCompiler = await RESOLVED_COMPILER;
+  const ocamlCompiler = await resolvedCompiler;
   const repositoryUrls = OPAM_REPOSITORIES.map(([_, value]) => value).join();
   const osInfo = await system.osInfo();
   const plainKey = [

dist/post/index.js

@@ -3,7 +3,6 @@ import * as path from "node:path";
 import * as process from "node:process";
 import * as core from "@actions/core";
 import * as yaml from "yaml";
-import { resolveCompiler } from "./version.js";
 
 export const ARCHITECTURE = (() => {
   switch (process.arch) {
@@ -99,7 +98,9 @@ export const GITHUB_TOKEN = core.getInput("github-token");
 
 export const DUNE_CACHE = core.getBooleanInput("dune-cache");
 
-const OCAML_COMPILER = core.getInput("ocaml-compiler", { required: true });
+export const OCAML_COMPILER = core.getInput("ocaml-compiler", {
+  required: true,
+});
 
 export const OPAM_DISABLE_SANDBOXING =
   // [TODO] unlock this once sandboxing is supported on Windows
@@ -115,7 +116,3 @@ export const OPAM_REPOSITORIES: [string, string][] = (() => {
   ) as Record<string, string>;
   return Object.entries(repositoriesYaml).reverse();
 })();
-
-export const RESOLVED_COMPILER = (async () => {
-  return await resolveCompiler(OCAML_COMPILER);
-})();

packages/setup-ocaml/src/cache.ts

@@ -18,7 +18,6 @@ import {
   OPAM_REPOSITORIES,
   OPAM_ROOT,
   PLATFORM,
-  RESOLVED_COMPILER,
 } from "./constants.js";
 import { installDune } from "./dune.js";
 import {
@@ -30,6 +29,7 @@ import {
   update,
 } from "./opam.js";
 import { retrieveOpamLocalPackages } from "./packages.js";
+import { resolvedCompiler } from "./version.js";
 import { setupCygwin } from "./windows.js";
 
 export async function installer() {
@@ -75,7 +75,7 @@ export async function installer() {
   if (!opamCacheHit) {
     await repositoryRemoveAll();
     await repositoryAddAll(OPAM_REPOSITORIES);
-    const ocamlCompiler = await RESOLVED_COMPILER;
+    const ocamlCompiler = await resolvedCompiler;
     await installOcaml(ocamlCompiler);
     await saveOpamCache();
   } else {

packages/setup-ocaml/src/constants.ts

@@ -19,7 +19,7 @@ import {
   updateUnixPackageIndexFiles,
 } from "./unix.js";
 
-export async function retrieveLatestOpamRelease() {
+export const latestOpamRelease = (async () => {
   const semverRange = ALLOW_PRERELEASE_OPAM ? "*" : "<2.4.0";
   const octokit = github.getOctokit(GITHUB_TOKEN, undefined, retry);
   const { data: releases } = await octokit.rest.repos.listReleases({
@@ -59,11 +59,11 @@ export async function retrieveLatestOpamRelease() {
     version: latestRelease.tag_name,
     browserDownloadUrl: matchedAssets.browser_download_url,
   };
-}
+})();
 
 async function acquireOpam() {
   await core.group("Installing opam", async () => {
-    const { version, browserDownloadUrl } = await retrieveLatestOpamRelease();
+    const { version, browserDownloadUrl } = await latestOpamRelease;
     const cachedPath = toolCache.find("opam", version, ARCHITECTURE);
     const opam = PLATFORM !== "windows" ? "opam" : "opam.exe";
     if (cachedPath === "") {

packages/setup-ocaml/src/installer.ts

@@ -2,7 +2,7 @@ import * as path from "node:path";
 import * as github from "@actions/github";
 import { retry } from "@octokit/plugin-retry";
 import * as semver from "semver";
-import { GITHUB_TOKEN } from "./constants.js";
+import { GITHUB_TOKEN, OCAML_COMPILER } from "./constants.js";
 
 function isSemverValidRange(semverVersion: string) {
   return semver.validRange(semverVersion, { loose: true }) !== null;
@@ -52,9 +52,9 @@ async function resolveVersion(semverVersion: string) {
   return matchedFullCompilerVersion;
 }
 
-export async function resolveCompiler(compiler: string) {
-  const resolvedCompiler = isSemverValidRange(compiler)
-    ? `ocaml-base-compiler.${await resolveVersion(compiler)}`
-    : compiler;
+export const resolvedCompiler = (async () => {
+  const resolvedCompiler = isSemverValidRange(OCAML_COMPILER)
+    ? `ocaml-base-compiler.${await resolveVersion(OCAML_COMPILER)}`
+    : OCAML_COMPILER;
   return resolvedCompiler;
-}
+})();