build: inject version via environment variable to reduce rebuilds

Author: Defelo

Cargo.lock

@@ -36,6 +36,7 @@ academy_persistence_postgres.workspace = true
 academy_shared_contracts.workspace = true
 academy_shared_impl.workspace = true
 academy_templates_impl.workspace = true
+academy_utils.workspace = true
 anyhow.workspace = true
 chrono.workspace = true
 clap.workspace = true

academy/Cargo.toml

@@ -2,6 +2,7 @@ use academy::commands::{
     admin::AdminCommand, email::EmailCommand, jwt::JwtCommand, migrate::MigrateCommand,
     serve::serve, tasks::TaskCommand,
 };
+use academy_utils::academy_version;
 use anyhow::Context;
 use clap::{CommandFactory, Parser, Subcommand};
 use clap_complete::Shell;
@@ -31,7 +32,7 @@ async fn main() -> anyhow::Result<()> {
         sentry::init((
             sentry_config.dsn.as_str(),
             sentry::ClientOptions {
-                release: Some(env!("CARGO_PKG_VERSION").into()),
+                release: Some(academy_version().into()),
                 attach_stacktrace: true,
                 ..Default::default()
             },
@@ -55,7 +56,7 @@ async fn main() -> anyhow::Result<()> {
 }
 
 #[derive(Debug, Parser)]
-#[command(version)]
+#[command(version = academy_version())]
 struct Cli {
     #[command(subcommand)]
     command: Command,

academy/src/main.rs

@@ -13,7 +13,7 @@ use academy_core_session_contracts::SessionFeatureService;
 use academy_core_user_contracts::UserFeatureService;
 use academy_di::Build;
 use academy_models::auth::{AccessToken, InternalToken};
-use academy_utils::Apply;
+use academy_utils::{academy_version, Apply};
 use aide::{
     axum::ApiRouter,
     openapi::{Components, Info, OpenApi, ReferenceOr, SecurityScheme, Tag},
@@ -82,7 +82,7 @@ where
         let mut api = OpenApi {
             info: Info {
                 title: "Bootstrap Academy Backend".into(),
-                version: env!("CARGO_PKG_VERSION").into(),
+                version: academy_version().into(),
                 description: Some(format!("GitHub: [{0}]({0})", env!("CARGO_PKG_REPOSITORY"))),
                 ..Default::default()
             },

academy_api/rest/src/lib.rs

@@ -1,19 +1,18 @@
-use std::ops::Deref;
-
-pub const USER_AGENT: &str = concat!(
-    "Bootstrap Academy Backend (",
-    env!("CARGO_PKG_HOMEPAGE"),
-    ", ",
-    env!("CARGO_PKG_REPOSITORY"),
-    ", Version ",
-    env!("CARGO_PKG_VERSION"),
-    ")"
-);
+use std::{ops::Deref, sync::LazyLock};
+
+use academy_utils::academy_version;
+
+pub static USER_AGENT: LazyLock<String> = LazyLock::new(|| {
+    let homepage = env!("CARGO_PKG_HOMEPAGE");
+    let repository = env!("CARGO_PKG_REPOSITORY");
+    let version = academy_version();
+
+    format!("Bootstrap Academy Backend ({homepage}, {repository}, Version {version})")
+});
 
 const _: () = {
     assert!(!env!("CARGO_PKG_HOMEPAGE").is_empty());
     assert!(!env!("CARGO_PKG_REPOSITORY").is_empty());
-    assert!(!env!("CARGO_PKG_VERSION").is_empty());
 };
 
 #[derive(Debug, Clone)]
@@ -31,7 +30,7 @@ impl Default for HttpClient {
     fn default() -> Self {
         Self(
             reqwest::Client::builder()
-                .user_agent(USER_AGENT)
+                .user_agent(&*USER_AGENT)
                 .build()
                 .unwrap(),
         )

academy_extern/impl/src/http.rs

@@ -122,7 +122,7 @@ async fn http_client(
 ) -> Result<oauth2::HttpResponse, oauth2::reqwest::AsyncHttpClientError> {
     request.headers.insert(
         oauth2::http::header::USER_AGENT,
-        oauth2::http::HeaderValue::from_static(USER_AGENT),
+        oauth2::http::HeaderValue::from_static(&USER_AGENT),
     );
     oauth2::reqwest::async_http_client(request).await
 }

academy_extern/impl/src/oauth2.rs

@@ -8,7 +8,6 @@ use url::Url;
 const _: () = {
     assert!(!env!("CARGO_PKG_HOMEPAGE").is_empty());
     assert!(!env!("CARGO_PKG_REPOSITORY").is_empty());
-    assert!(!env!("CARGO_PKG_VERSION").is_empty());
 };
 
 #[tokio::main]

academy_testing/src/main.rs

@@ -2,8 +2,20 @@ mod macros;
 pub mod patch;
 pub mod serde;
 
+use std::sync::LazyLock;
+
 pub use academy_utils_derive::trace_instrument;
 
+static ACADEMY_VERSION: LazyLock<&str> = LazyLock::new(|| {
+    std::env::var("ACADEMY_VERSION")
+        .map(|x| &*x.leak())
+        .unwrap_or("0.0.0-dev")
+});
+
+pub fn academy_version() -> &'static str {
+    &ACADEMY_VERSION
+}
+
 pub trait Apply: Sized {
     /// Apply the function `f` with a mutable reference to `self`.
     ///

academy_utils/src/lib.rs

@@ -4,12 +4,16 @@ self: {
   pkgs,
   ...
 }: let
-  package = self.packages.${pkgs.system}.default;
   settingsFormat = pkgs.formats.toml {};
 in {
   options.services.academy.backend = {
     enable = lib.mkEnableOption "Bootstrap Academy Backend";
 
+    package = lib.mkOption {
+      type = lib.types.package;
+      default = self.packages.${pkgs.system}.default;
+    };
+
     localDatabase = lib.mkOption {
       type = lib.types.bool;
       default = true;
@@ -50,8 +54,8 @@ in {
     ACADEMY_CONFIG = builtins.concatStringsSep ":" (cfg.extraConfigFiles ++ [settings]);
 
     wrapper = pkgs.stdenvNoCC.mkDerivation {
-      inherit (package) pname version;
-      src = package;
+      inherit (cfg.package) pname version;
+      src = cfg.package;
       nativeBuildInputs = [pkgs.makeWrapper];
       installPhase = ''
         cp -r . $out
@@ -83,7 +87,7 @@ in {
             // {
               wantedBy = ["multi-user.target"];
               script = ''
-                ${package}/bin/academy serve
+                ${cfg.package}/bin/academy serve
               '';
             };
         }
@@ -95,7 +99,7 @@ in {
               // {
                 startAt = schedule;
                 script = ''
-                  ${package}/bin/academy task ${task}
+                  ${cfg.package}/bin/academy task ${task}
                 '';
               };
           })

nix/module.nix

@@ -7,6 +7,8 @@
   pkgs,
   system,
   self,
+  stdenv,
+  makeWrapper,
 }: let
   toolchain = fenix.packages.${system}.stable;
 
@@ -17,6 +19,22 @@
     rev = self.sourceInfo.shortRev or self.sourceInfo.dirtyShortRev;
   in "${year}.${month}.${day}+${rev}";
 
+  setVersion = drv:
+    stdenv.mkDerivation {
+      inherit (drv) pname;
+      inherit version;
+      dontUnpack = true;
+      nativeBuildInputs = [makeWrapper];
+      installPhase = ''
+        cp -a ${drv} $out
+        chmod -R +w $out
+        for bin in $out/bin/*; do
+          wrapProgram $bin --set ACADEMY_VERSION ${lib.escapeShellArg version}
+        done
+      '';
+      passthru.unwrapped = drv;
+    };
+
   crateDirs = lib.pipe ../. [
     builtins.readDir
     builtins.attrNames
@@ -45,7 +63,6 @@
   mergeOverrideSets = a: b: a // b // (builtins.mapAttrs (k: _: mergeOverrides a.${k} b.${k}) (lib.intersectAttrs a b));
 
   defaultOverrides = lib.genAttrs workspaceMembers (crate: attrs: {
-    inherit version;
     preBuild = ''
       ${attrs.preBuild or ""}
       export CARGO_PKG_HOMEPAGE=${lib.escapeShellArg cargoToml.workspace.package.homepage}
@@ -92,7 +109,8 @@
     });
     defaultCrateOverrides = mergeOverrideSets pkgs.defaultCrateOverrides crateOverrides;
   };
-in {
-  default = cargoNix.workspaceMembers.academy.build;
-  testing = cargoNix.workspaceMembers.academy_testing.build;
-}
+in
+  builtins.mapAttrs (_: setVersion) {
+    default = cargoNix.workspaceMembers.academy.build;
+    testing = cargoNix.workspaceMembers.academy_testing.build;
+  }