Revision control
Copy as Markdown
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
import org.gradle.api.Plugin
import org.gradle.api.Project
import org.gradle.api.initialization.Settings
import java.io.File
import java.text.SimpleDateFormat
import java.time.LocalDateTime
import java.util.Date
import java.util.Locale
import java.util.concurrent.TimeUnit
class ConfigPlugin : Plugin<Settings> {
override fun apply(settings: Settings) = Unit
}
object Config {
@JvmStatic
private fun generateDebugVersionName(): String {
val today = Date()
// Append the year (2 digits) and week in year (2 digits). This will make it easier to distinguish versions and
// identify ancient versions when debugging issues. However this will still keep the same version number during
// the week so that we do not end up with a lot of versions in tools like Sentry. As an extra this matches the
// sections we use in the changelog (weeks).
return SimpleDateFormat("1.0.yyww", Locale.US).format(today)
}
@JvmStatic
fun releaseVersionName(project: Project): String? {
// Note: release builds must have the `versionName` set. However, the gradle ecosystem makes this hard to
// ergonomically validate (sometimes IDEs default to a release variant and mysteriously fail due to the
// validation, sometimes devs just need a release build and specifying project properties is annoying in IDEs),
// so instead we'll allow the `versionName` to silently default to an empty string.
return if (project.hasProperty("versionName")) project.property("versionName") as String else null
}
@JvmStatic
fun nightlyVersionName(): String {
// Nightly versions will use the version from "version.txt".
return readVersionFromFile()
}
@JvmStatic
fun readVersionFromFile(): String {
return File("../version.txt").useLines { it.firstOrNull() ?: "" }
}
@JvmStatic
fun majorVersion(): String {
return readVersionFromFile().split(".")[0]
}
/**
* Generate a build date that follows the ISO-8601 format
*/
@JvmStatic
fun generateBuildDate(): String {
return LocalDateTime.now().toString()
}
private val fennecBaseVersionCode by lazy {
val format = SimpleDateFormat("yyyyMMddHHmmss", Locale.US)
val cutoff = format.parse("20141228000000")
val build = Date()
Math.floor((build.time - cutoff.time) / (1000.0 * 60.0 * 60.0)).toInt()
}
/**
* Generates a versionCode that follows the same rules like legacy Fennec builds.
* Adapted from:
*
* There is a discrepancy between the epoch date used here (20141228)
* and the epoch used in Fennec (20150801) for historical reasons. We keep
* this discrepancy to avoid having Fenix version codes decrease.
* Note that the original Fennec implementation also had an inconsistency in
* the documented epoch date (20150901) and the effective epoch date (20150801).
*/
@JvmStatic
fun generateFennecVersionCode(abi: String, aab: Boolean): Int {
// The important consideration is that version codes be monotonically
// increasing (per Android package name) for all published builds. The input
// build IDs are based on timestamps and hence are always monotonically
// increasing.
//
// The generated v1 version codes look like (in binary):
//
// 0111 1000 0010 tttt tttt tttt tttt txpg
//
// The 17 bits labelled 't' represent the number of hours since midnight on
// December 28, 2014. (2014122800 in yyyyMMddHH format.) This yields a
// little under 15 years worth of hourly build identifiers, since 2**17 / (366
// * 24) =~ 14.92.
//
// The bits labelled 'x', 'p', and 'g' are feature flags.
//
// The bit labelled 'x' is 1 if the build is for an x86 or x86-64 architecture,
// and 0 otherwise, which means the build is for an ARM or ARM64 architecture.
// (Fennec no longer supports ARMv6, so ARM is equivalent to ARMv7.
//
// ARM64 is also known as AArch64; it is logically ARMv8.)
//
// For the same release, x86 and x86_64 builds have higher version codes and
// take precedence over ARM builds, so that they are preferred over ARM on
// devices that have ARM emulation.
//
// The bit labelled 'p' is 1 if the build is for a 64-bit architecture (x86-64
// or ARM64), and 0 otherwise, which means the build is for a 32-bit
// architecture (x86 or ARM). 64-bit builds have higher version codes so
// they take precedence over 32-bit builds on devices that support 64-bit.
//
// The bit labelled 'g' was once used for APK splits. Today, it is 0 for
// APK builds, or 1 for AAB builds.
//
// We throw an explanatory exception when we are within one calendar year of
// running out of build events. This gives lots of time to update the version
// scheme. The responsible individual should then bump the range (to allow
// builds to continue) and use the time remaining to update the version scheme
// via the reserved high order bits.
//
// N.B.: the reserved 0 bit to the left of the highest order 't' bit can,
// sometimes, be used to bump the version scheme. In addition, by reducing the
// granularity of the build identifiers (for example, moving to identifying
// builds every 2 or 4 hours), the version scheme may be adjusted further still
// without losing a (valuable) high order bit.
val base = fennecBaseVersionCode
when {
base < 0 -> throw RuntimeException("Cannot calculate versionCode. Hours underflow.")
base > 0x20000 /* 2^17 */ -> throw RuntimeException("Cannot calculate versionCode. Hours overflow.")
base > 0x20000 - (366 * 24) ->
// You have one year to update the version scheme...
throw RuntimeException("Running out of low order bits calculating versionCode.")
}
var version = 0x78200000 // 1111000001000000000000000000000
// We reserve 1 "middle" high order bit for the future, and 3 low order bits
// for architecture and APK splits.
version = version or (base shl 3)
// 'x' bit is 1 for x86/x86-64 architectures
if (aab || abi == "x86_64" || abi == "x86") {
version = version or (1 shl 2)
}
// 'p' bit is 1 for 64-bit architectures.
if (aab || abi == "arm64-v8a" || abi == "x86_64") {
version = version or (1 shl 1)
}
// 'g' bit is 0 for APK, 1 for AAB
if (aab) {
version = version or (1 shl 0)
}
return version
}
/**
* Returns the git hash of the currently checked out revision. If there are uncommitted changes,
* a "+" will be appended to the hash, e.g. "c8ba05ad0+".
*/
@JvmStatic
fun getGitHash(): String {
val revisionCmd = arrayOf("git", "rev-parse", "--short", "HEAD")
val revision = execReadStandardOutOrThrow(revisionCmd)
// Append "+" if there are uncommitted changes in the working directory.
val statusCmd = arrayOf("git", "status", "--porcelain=v2")
val status = execReadStandardOutOrThrow(statusCmd)
val hasUnstagedChanges = status.isNotBlank()
val statusSuffix = if (hasUnstagedChanges) "+" else ""
return "$revision$statusSuffix"
}
/**
* Executes the given command with [Runtime.exec], throwing if the command returns a non-zero exit
* code or times out. If successful, returns the command's stdout.
*
* @return stdout of the command
* @throws [IllegalStateException] if the command returns a non-zero exit code or times out.
*/
private fun execReadStandardOutOrThrow(cmd: Array<String>, timeoutSeconds: Long = 30): String {
val process = Runtime.getRuntime().exec(cmd)
check(
process.waitFor(
timeoutSeconds,
TimeUnit.SECONDS,
),
) { "command unexpectedly timed out: `$cmd`" }
check(process.exitValue() == 0) {
val stderr = process.errorStream.bufferedReader().readText().trim()
"""command exited with non-zero exit value: ${process.exitValue()}.
|cmd: ${cmd.joinToString(separator = " ")}
|stderr:
|$stderr"""
.trimMargin()
}
return process.inputStream.bufferedReader().readText().trim()
}
}