Feature tool-cache for Gleam and rebar3 #223
Conversation
| got = await setupBeam.getOTPVersion(spec, osVersion, hexMirrors) | ||
| got = await setupBeam.getOTPVersion(spec, osVersion) |
There was a problem hiding this comment.
I think hexMirrors was just exposed for testing purposes, which is not required, since we have a way to simulate inputs.
| await installer.installOTP(osVersion, otpVersion, hexMirrors) | ||
| await doWithMirrors({ | ||
| hexMirrors: hexMirrorsInput(), | ||
| actionTitle: `install Erlang/OTP ${otpVersion}`, | ||
| action: async (hexMirror) => { | ||
| await install('otp', { | ||
| osVersion, | ||
| toolVersion: otpVersion, | ||
| hexMirror, | ||
| }) | ||
| }, | ||
| }) |
There was a problem hiding this comment.
This is what we did to replace input hexMirrors with internal function iteration: we declare a function that implements the iteration internally (which hopefully eases maintenance and makes for more consistent behaviour, when required).
| // The installOpts object is composed of supported processPlatform keys | ||
| // (e.g. 'linux', 'win32', or 'all' - in case there's no distinction between platforms) | ||
| // In each of these keys there's an object with keys: | ||
| // * downloadToolURL | ||
| // - where to fetch the downloadable from | ||
| // * extract | ||
| // - if the downloadable is compressed: how to extract it | ||
| // - return ['dir', targetDir] | ||
| // - if the downloadable is not compressed: a filename.ext you want to cache it under | ||
| // - return ['file', filenameWithExt] | ||
| // * postExtract | ||
| // - stuff to execute outside the cache scope (just after it's created) | ||
| // * reportVersion | ||
| /// - configuration elements on how to output the tool version, post-install |
There was a problem hiding this comment.
This (in a gist) explains the major change behind this pull request.
If it's not clear (since this is supposed to explain the "behaviour" required for adding new tool-cached stuff) it can be improved (variables renamed, behaviour made more explicit, etc.).
| async function installTool(opts) { | ||
| const { toolName, versionSpec, installOpts } = opts | ||
| const platformOpts = installOpts[process.platform] || installOpts.all | ||
| let cachePath = tc.find(toolName, versionSpec) | ||
|
|
||
| core.debug(`Checking if ${installOpts.tool} is already cached...`) | ||
| if (cachePath === '') { | ||
| core.debug(" ... it isn't!") | ||
| const downloadToolURL = platformOpts.downloadToolURL() | ||
| const file = await tc.downloadTool(downloadToolURL) | ||
| const [targetElemType, targetElem] = await platformOpts.extract(file) | ||
|
|
||
| if (targetElemType === 'dir') { | ||
| cachePath = await tc.cacheDir(targetElem, toolName, versionSpec) | ||
| } else if (targetElemType === 'file') { | ||
| cachePath = await tc.cacheFile(file, targetElem, toolName, versionSpec) | ||
| } | ||
| } else { | ||
| core.debug(` ... it is, at ${cachePath}`) | ||
| } |
There was a problem hiding this comment.
Along with the comment block shown above, this is the function that implements the generic "behaviour" used, at this moment, for 4 tools in 2 OS types. This has been tested with the addition of Gleam and Rebar3 to tool-cache and retrofitted for Erlang/OTP and Elixir.
|
Force-pushing to resolve conflicts. Flagging this as "Ready for review", too... |
At the same time we fix an error, where we aren't using the mirrors for the OTP build :)
This hopefully eases introduction of new languages at the cost of a bit of abstraction (there's an extensive comment on how to fill in the install options' object) We'll soon test this abstraction by making Gleam and rebar3 cached too
(starting with Gleam on Linux)
Also, gets rid of all .sh
Also, gets rid of all .ps1
And also be consistent when it comes to using fs....Sync vs fs.promise....
|
Rebased on top of |
|
ping @starbelly |
Description
This pull request:
.ps1and.shfilessrc/installer.jsintosrc/setup-beam.jstest/problem-matchers.test.jsintotest/setup-beam.test.jsdoWithMirrors)tool-cacheing -related behaviour callback -based (as explained in an extensive comment in the code)tool-cacheas per the issue it closes*⚠️ is not yet to be merged* I want to get Rework our version matching algorithm #217 approved+merged so as to update this one (I'm sure there'll be merge conflicts)Closes #204.
Callback -based
tool-cacheing -related behaviourAs an example, we show how Gleam is now configured for tool caching, on Linux (simplified here for illustration purposes):