refactor: Swap list filtering with lazy iterations

This commit is contained in:
Thomas A. Christensen II 2024-01-26 15:52:06 -06:00
parent 2f9c53c090
commit 737834224d
2 changed files with 114 additions and 13 deletions

View file

@ -34,20 +34,121 @@ function tag_filter(version: string): (r: NextflowRelease) => Boolean {
return filter return filter
} }
async function get_latest_everything_nextflow_release(
releases: AsyncGenerator<NextflowRelease>
): Promise<NextflowRelease> {
// Need to make sure we aren't in the edge case where a patch release is
// more recent chronologically than the edge release
let latest_release = {} as NextflowRelease
for await (const release of releases) {
// First iteration:
if (Object.keys(latest_release).length === 0) {
// If the most recent release is an edge release, then we have nothing to
// worry about, return it.
if (release.isEdge) {
return release
}
// Ok, so the most recent release is a stable release. We need to keep
// tabs on it
latest_release = release
continue
}
// A larger version number that is older than the "latest" release
// indicates that we've hit an edge release that is more up-to-date
// than a patch release. Return it.
if (semver.gt(release.versionNumber, latest_release.versionNumber, true)) {
return release
}
// A smaller version number that is also an edge release indicates that the
// chronologically most recent release is also the most up-to-date
if (
release.isEdge &&
semver.lt(release.versionNumber, latest_release.versionNumber, true)
) {
return latest_release
}
// Once we've hit the major.minor.0 of the version that is the most recent
// patch, we know that we would have traversed any edge releases along the
// way, so check to see if we've hit that point yet.
const latest_release_major = semver.major(
latest_release.versionNumber,
true
)
const latest_release_minor = semver.minor(
latest_release.versionNumber,
true
)
const latest_release_minver = `${latest_release_major}.${latest_release_minor}.0`
if (semver.eq(release.versionNumber, latest_release_minver, true)) {
return latest_release
}
}
// We should never get here, but just in case
return {} as NextflowRelease
}
async function get_latest_edge_nextflow_release(
releases: AsyncGenerator<NextflowRelease>
): Promise<NextflowRelease> {
// Because we don't have to worry about crossing between edge and stable
// releases, we can just return the first edge release we come across
for await (const release of releases) {
if (release.isEdge) {
return release
}
}
// We should never get here, but just in case
return {} as NextflowRelease
}
async function get_latest_stable_nextflow_release(
releases: AsyncGenerator<NextflowRelease>
): Promise<NextflowRelease> {
// Because we don't have to worry about crossing between edge and stable
// releases, we can just return the first stable release we come across
for await (const release of releases) {
if (!release.isEdge) {
return release
}
}
// We should never get here, but just in case
return {} as NextflowRelease
}
export async function get_nextflow_release( export async function get_nextflow_release(
version: string, version: string,
releases: NextflowRelease[] releases: AsyncGenerator<NextflowRelease>
): Promise<NextflowRelease> { ): Promise<NextflowRelease> {
// Filter the releases // First, check to see if we are using a "latest-*" version system, and return
const filter = tag_filter(version) // early
const matching_releases = releases.filter(filter) if (version === "latest-everything") {
return await get_latest_everything_nextflow_release(releases)
}
if (version === "latest-edge") {
return await get_latest_edge_nextflow_release(releases)
}
if (version === "latest" || version === "latest-stable") {
return await get_latest_stable_nextflow_release(releases)
}
matching_releases.sort((x, y) => { // The releases are sent in reverse chronological order
// HACK IDK why the value flip is necessary with the return // If we are sent a numbered tag, then back through the list until we find
return semver.compare(x.versionNumber, y.versionNumber, true) * -1 // a release that fulfils the requested version number
}) for await (const release of releases) {
if (semver.satisfies(release.versionNumber, version, true)) {
return release
}
}
return matching_releases[0] // We should never get here, but just in case
return {} as NextflowRelease
} }
export async function install_nextflow( export async function install_nextflow(

View file

@ -11,9 +11,9 @@ import {
} from "./functions" } from "./functions"
import { NextflowRelease } from "./nextflow-release" import { NextflowRelease } from "./nextflow-release"
import { import {
pull_releases,
pull_latest_stable_release, pull_latest_stable_release,
setup_octokit setup_octokit,
release_iter
} from "./octokit-wrapper" } from "./octokit-wrapper"
async function run(): Promise<void> { async function run(): Promise<void> {
@ -43,8 +43,8 @@ async function run(): Promise<void> {
if (version === "latest" || version === "latest-stable") { if (version === "latest" || version === "latest-stable") {
release = await pull_latest_stable_release(octokit) release = await pull_latest_stable_release(octokit)
} else { } else {
const releases = await pull_releases(octokit) const release_iterator = release_iter(octokit)
release = await get_nextflow_release(version, releases) release = await get_nextflow_release(version, release_iterator)
} }
resolved_version = release.versionNumber resolved_version = release.versionNumber
core.info( core.info(