Skip to content

Commit

Permalink
improvement: using a new release endpoint for self-update (#5229)
Browse files Browse the repository at this point in the history 
* improvement: using a new release endpoint for self-update

* test: fixed self-update tests to mock the release endpoint

* docs: architecture flag in self-update command

* improvement: better error handling when retrieving releases

* test: releases endpoint failure and clarifying comments on desired version

---------

Co-authored-by: Anna Mager <[email protected]>
  • Loading branch information
@mkhq @twelvemo
mkhq and twelvemo committed Oct 15, 2023
1 parent 4fd858a commit 60fffc6
Show file tree
Hide file tree
Showing 5 changed files with 272 additions and 100 deletions.
4 changes: 2 additions & 2 deletions core/src/cli/helpers.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ import { ParameterValues, Parameter, Parameters } from "./params"
import { InternalError, ParameterError } from "../exceptions"
import { getPackageVersion, removeSlice } from "../util/util"
import { LogEntry } from "../logger/log-entry"
import { STATIC_DIR, VERSION_CHECK_URL, gardenEnv } from "../constants"
import { STATIC_DIR, gardenEnv } from "../constants"
import { printWarningMessage } from "../logger/util"
import { GlobalConfigStore, globalConfigKeys } from "../config-store"
import { got } from "../util/http"
Expand Down Expand Up @@ -98,7 +98,7 @@ export async function checkForUpdates(config: GlobalConfigStore, logger: LogEntr
headers["X-ci-name"] = ci.name
}

const res = await got(`${VERSION_CHECK_URL}?${qs.stringify(query)}`, { headers }).json<any>()
const res = await got(`${gardenEnv.GARDEN_VERSION_CHECK_ENDPOINT}?${qs.stringify(query)}`, { headers }).json<any>()
const configObj = await config.get()
const showMessage =
configObj.lastVersionCheck && moment().subtract(1, "days").isAfter(moment(configObj.lastVersionCheck.lastRun))
Expand Down
203 changes: 117 additions & 86 deletions core/src/commands/self-update.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import tar from "tar"
import { Command, CommandParams, CommandResult } from "./base"
import { printHeader } from "../logger/util"
import { BooleanParameter, ChoicesParameter, GlobalOptions, ParameterValues, StringParameter } from "../cli/params"
import { dedent } from "../util/string"
import { dedent, deline } from "../util/string"
import { basename, dirname, join, resolve } from "path"
import chalk from "chalk"
import { getPackageVersion, getPlatform } from "../util/util"
Expand All @@ -20,8 +20,10 @@ import { createReadStream, createWriteStream } from "fs"
import { copy, mkdirp, move, readdir, remove } from "fs-extra"
import { got } from "../util/http"
import { promisify } from "node:util"
import { gardenEnv } from "../constants"
import semver from "semver"
import stream from "stream"
import { LogEntry } from "../logger/log-entry"

const selfUpdateArgs = {
version: new StringParameter({
Expand Down Expand Up @@ -90,96 +92,119 @@ interface SelfUpdateResult {
/**
* Utilities and wrappers on top of GitHub REST API.
*/
export namespace GitHubReleaseApi {
export type Pagination = { pageNumber: number; pageSize: number }

export async function fetchReleases({ pageNumber, pageSize }: Pagination) {
const results: any[] = await got(
`https://api.github.com/repos/garden-io/garden/releases?page=${pageNumber}&per_page=${[pageSize]}`
).json()
return results
}
export type Pagination = { pageNumber: number; pageSize: number }

/**
* Traverse the Garden releases on GitHub and get the first one matching the given predicate.
*
* @param primaryPredicate the primary predicate to identify the wanted release
* @param fallbackPredicates the list of fallback predicates to be used if the primary one returns no result
* @param fetcher the optional function to override the default release fetching machinery
*/
export async function findRelease({
primaryPredicate,
fallbackPredicates = [],
fetcher = fetchReleases,
}: {
primaryPredicate: (any: any) => boolean
fallbackPredicates?: ((any: any) => boolean)[]
fetcher?: (pagination: Pagination) => Promise<any[]>
}) {
const pageSize = 100
let pageNumber = 1
let fetchedReleases: any[]
export async function fetchReleases({ pageNumber, pageSize }: Pagination) {
const results: any[] = await got(
`${gardenEnv.GARDEN_RELEASES_ENDPOINT}?page=${pageNumber}&per_page=${[pageSize]}`
).json()
return results
}

/**
* Traverse the Garden releases on GitHub and get the first one matching the given predicate.
*
* @param primaryPredicate the primary predicate to identify the wanted release
* @param fallbackPredicates the list of fallback predicates to be used if the primary one returns no result
* @param fetcher the optional function to override the default release fetching machinery
*/
export async function findRelease({
primaryPredicate,
fallbackPredicates = [],
fetcher = fetchReleases,
}: {
primaryPredicate: (any: any) => boolean
fallbackPredicates?: ((any: any) => boolean)[]
fetcher?: (pagination: Pagination) => Promise<any[]>
}) {
const pageSize = 100
let pageNumber = 1
let fetchedReleases: any[]
/*
Stores already fetched releases. This will be used with the fallback predicates.
It is a memory consumer, but also a trade-off to avoid GitHub API rate limit errors.
This will not eat gigs of RAM.
*/
let allReleases: any[] = []
do {
/*
Stores already fetched releases. This will be used with the fallback predicates.
It is a memory consumer, but also a trade-off to avoid GitHub API rate limit errors.
This will not eat gigs of RAM.
This returns the releases ordered by 'published_at' field.
It means that there are 2 ordered subsequences of 0.12.x and 0.13.x releases in the result list,
but the list itself is not properly ordered.
*/
let allReleases: any[] = []
do {
/*
This returns the releases ordered by 'published_at' field.
It means that there are 2 ordered subsequences of 0.12.x and 0.13.x releases in the result list,
but the list itself is not properly ordered.
*/
fetchedReleases = await fetcher({ pageNumber, pageSize })
for (const release of fetchedReleases) {
if (primaryPredicate(release)) {
return release
}
fetchedReleases = await fetcher({ pageNumber, pageSize })
for (const release of fetchedReleases) {
if (primaryPredicate(release)) {
return release
}
allReleases.push(...fetchedReleases)
pageNumber++
} while (fetchedReleases.length > 0)

for (const fallbackPredicate of fallbackPredicates) {
for (const release of allReleases) {
if (fallbackPredicate(release)) {
return release
}
}
allReleases.push(...fetchedReleases)
pageNumber++
} while (fetchedReleases.length > 0)

for (const fallbackPredicate of fallbackPredicates) {
for (const release of allReleases) {
if (fallbackPredicate(release)) {
return release
}
}
}

return undefined
return undefined
}

/**
* @return the latest version tag
* @throws {RuntimeError} if the latest version cannot be detected
*/
export async function getLatestVersion(log: LogEntry): Promise<string> {
let latestVersion: string | undefined = undefined
const endpoint = `${gardenEnv.GARDEN_RELEASES_ENDPOINT}/latest`

try {
const latestVersionRes: any = await got(endpoint).json()
latestVersion = latestVersionRes.tag_name
} catch (err) {
log.debug(`Retrieving the latest Garden version from ${endpoint} failed with error ${err}.`)
}

/**
* @return the latest version tag
* @throws {RuntimeError} if the latest version cannot be detected
*/
export async function getLatestVersion(): Promise<string> {
const latestVersionRes: any = await got("https://api.github.com/repos/garden-io/garden/releases/latest").json()
const latestVersion = latestVersionRes.tag_name
if (!latestVersion) {
throw new RuntimeError(`Unable to detect the latest Garden version: ${latestVersionRes}`, {
response: latestVersionRes,
})
}
if (!latestVersion) {
throw new RuntimeError(
deline`Unable to retrieve the latest Garden release version.
This could be a temporary service error, please try again later.`,
{}
)
}

return latestVersion
}

return latestVersion
export async function getLatestVersions(numOfStableVersions: number, log: LogEntry) {
let releasesResponse: any | undefined = undefined
const endpoint = `${gardenEnv.GARDEN_RELEASES_ENDPOINT}`

try {
releasesResponse = await got(`${endpoint}?per_page=100`).json()
} catch (err) {
log.debug(`Retrieving the latest Garden releases from ${endpoint} failed with error ${err}.`)
}

export async function getLatestVersions(numOfStableVersions: number) {
const res: any = await got("https://api.github.com/repos/garden-io/garden/releases?per_page=100").json()

return [
chalk.cyan("edge-acorn"),
chalk.cyan("edge-bonsai"),
...res
.filter((r: any) => !r.prerelease && !r.draft)
.map((r: any) => chalk.cyan(r.name))
.slice(0, numOfStableVersions),
]
if (!releasesResponse) {
throw new RuntimeError(
deline`Unable to retrieve the list of Garden releases.
This could be a temporary service error, please try again later.`,
{}
)
}

return [
chalk.cyan("edge-acorn"),
chalk.cyan("edge-bonsai"),
...releasesResponse
.filter((r: any) => !r.prerelease && !r.draft)
.map((r: any) => chalk.cyan(r.name))
.slice(0, numOfStableVersions),
]
}

export class SelfUpdateCommand extends Command<SelfUpdateArgs, SelfUpdateOpts> {
Expand Down Expand Up @@ -248,11 +273,11 @@ export class SelfUpdateCommand extends Command<SelfUpdateArgs, SelfUpdateOpts> {
installationDirectory = resolve(installationDirectory)

log.info(chalk.white("Checking for target and latest versions..."))
const latestVersion = await GitHubReleaseApi.getLatestVersion()
const latestVersion = await getLatestVersion(log)

if (!desiredVersion) {
const versionScope = getVersionScope(opts)
desiredVersion = await this.findTargetVersion(currentVersion, versionScope)
desiredVersion = await this.findTargetVersion(currentVersion, versionScope, latestVersion)
}

log.info(chalk.white("Current Garden version: ") + chalk.cyan(currentVersion))
Expand Down Expand Up @@ -322,12 +347,14 @@ export class SelfUpdateCommand extends Command<SelfUpdateArgs, SelfUpdateOpts> {

// Print the latest available stable versions
try {
const latestVersions = await GitHubReleaseApi.getLatestVersions(10)
const latestVersions = await getLatestVersions(10, log)

log.info(
chalk.white.bold(`Here are the latest available versions: `) + latestVersions.join(chalk.white(", "))
)
} catch {}
} catch (err) {
log.debug(`Could not retrieve the latest available versions, ${err}`)
}

return {
result: {
Expand Down Expand Up @@ -441,14 +468,18 @@ export class SelfUpdateCommand extends Command<SelfUpdateArgs, SelfUpdateOpts> {
* @throws {RuntimeError} if the desired version cannot be detected,
* or if the current version cannot be recognized as a valid release version
*/
private async findTargetVersion(currentVersion: string, versionScope: VersionScope): Promise<string> {
private async findTargetVersion(
currentVersion: string,
versionScope: VersionScope,
latestVersion: string
): Promise<string> {
if (isEdgeVersion(currentVersion)) {
return GitHubReleaseApi.getLatestVersion()
return latestVersion
}

const currentSemVer = semver.parse(currentVersion)
if (isPreReleaseVersion(currentSemVer)) {
return GitHubReleaseApi.getLatestVersion()
return latestVersion
}

// The current version is necessary, it's not possible to proceed without its value
Expand All @@ -464,7 +495,7 @@ export class SelfUpdateCommand extends Command<SelfUpdateArgs, SelfUpdateOpts> {
const fallbackVersionPredicate = this.getTargetVersionPredicate(currentSemVer, "patch")
// Currently we support only semver minor and patch versions, so we use patch as a fallback predicate.
// TODO Core 1.0 implement proper fallback predicates for all semver version parts.
const targetRelease = await GitHubReleaseApi.findRelease({
const targetRelease = await findRelease({
primaryPredicate: targetVersionPredicate,
fallbackPredicates: [fallbackVersionPredicate],
})
Expand Down
13 changes: 11 additions & 2 deletions core/src/constants.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,7 @@ export const SUPPORTED_ARCHITECTURES: SupportedArchitecture[] = ["x64", "arm64"]
export const SEGMENT_DEV_API_KEY = "D3DUZ3lBSDO3krnuIO7eYDdtlDAjooKW" // ggignore
export const SEGMENT_PROD_API_KEY = "b6ovUD9A0YjQqT3ZWetWUbuZ9OmGxKMa" // ggignore

export const DOCS_BASE_URL = "https://docs.garden.io/v/acorn-0.12"
export const VERSION_CHECK_URL = "https://get.garden.io/version"
export const DOCS_BASE_URL = "https://docs.garden.io"

export const DEFAULT_GARDEN_CLOUD_DOMAIN = "https://app.garden.io"

Expand Down Expand Up @@ -83,4 +82,14 @@ export const gardenEnv = {
// issues on terminals we haven't tested. We can remove again in v0.13.
GARDEN_LEGACY_FANCY_LOG_RENDER: env.get("GARDEN_LEGACY_FANCY_LOG_RENDER").required(false).asBool(),
GARDEN_CLOUD_DOMAIN: env.get("GARDEN_CLOUD_DOMAIN").required(false).asUrlString(),
GARDEN_VERSION_CHECK_ENDPOINT: env
.get("GARDEN_VERSION_CHECK_ENDPOINT")
.required(false)
.default("https://get.garden.io/version")
.asUrlString(),
GARDEN_RELEASES_ENDPOINT: env
.get("GARDEN_RELEASES_ENDPOINT")
.required(false)
.default("https://get.garden.io/releases")
.asUrlString(),
}
Loading

0 comments on commit 60fffc6

Please sign in to comment.