Remove libherokubuildpack::log from all but functions

schneems · schneems · commit 85ea0c201b18 · 2025-01-22T12:40:23.000-06:00
All buildpacks now use the new buildpack logging output instead of libherokubuildpack's old log functions
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/buildpacks/gradle/Cargo.toml b/buildpacks/gradle/Cargo.toml
@@ -10,7 +10,7 @@ workspace = true
 buildpacks-jvm-shared.workspace = true
 indoc = "2"
 libcnb = "=0.26.0"
-libherokubuildpack = { version = "=0.26.0", default-features = false, features = ["command", "error", "log"] }
+libherokubuildpack = { version = "=0.26.0", default-features = false, features = ["command", "error"] }
 nom = "7"
 serde = { version = "1", features = ["derive"] }
 tempfile = "3.15.0"
diff --git a/buildpacks/gradle/src/errors.rs b/buildpacks/gradle/src/errors.rs
@@ -6,16 +6,15 @@ use buildpacks_jvm_shared::{
         log_build_tool_io_error, log_build_tool_unexpected_exit_code_error,
         log_please_try_again_error,
     },
-    output::CmdError,
+    output::{print_error, CmdError},
 };
 use indoc::indoc;
-use libherokubuildpack::log::log_error;
 
 #[allow(clippy::too_many_lines, clippy::needless_pass_by_value)]
 pub(crate) fn on_error_gradle_buildpack(error: GradleBuildpackError) {
     match error {
         GradleBuildpackError::GradleWrapperNotFound => {
-            log_error(
+            print_error(
                 "Missing Gradle Wrapper",
                 indoc! {"
                     This buildpack leverages Gradle Wrapper to install the correct Gradle version to build your application.
@@ -71,7 +70,7 @@ pub(crate) fn on_error_gradle_buildpack(error: GradleBuildpackError) {
             "The Gradle daemon for this build could not be started.",
             error,
         ),
-        GradleBuildpackError::BuildTaskUnknown => log_error(
+        GradleBuildpackError::BuildTaskUnknown => print_error(
             "Failed to determine build task",
             indoc! {"
                 It looks like your project does not contain a 'stage' task, which Heroku needs in order
diff --git a/buildpacks/jvm/Cargo.toml b/buildpacks/jvm/Cargo.toml
@@ -11,7 +11,7 @@ buildpacks-jvm-shared.workspace = true
 fs_extra = "1"
 indoc = "2"
 libcnb = "=0.26.0"
-libherokubuildpack = { version = "=0.26.0", default-features = false, features = ["digest", "download", "error", "inventory", "inventory-sha2", "log", "tar"] }
+libherokubuildpack = { version = "=0.26.0", default-features = false, features = ["digest", "download", "error", "inventory", "inventory-sha2", "tar"] }
 serde = { version = "1", features = ["derive"] }
 tempfile = "3"
 url = "2"
diff --git a/buildpacks/jvm/src/errors.rs b/buildpacks/jvm/src/errors.rs
@@ -4,9 +4,9 @@ use crate::openjdk_artifact::{
 use crate::version_resolver::VersionResolveError;
 use crate::OpenJdkBuildpackError;
 use buildpacks_jvm_shared::log::{log_please_try_again, log_please_try_again_error};
+use buildpacks_jvm_shared::output::print_error;
 use buildpacks_jvm_shared::system_properties::ReadSystemPropertiesError;
 use indoc::formatdoc;
-use libherokubuildpack::log::log_error;
 
 #[allow(clippy::too_many_lines)]
 pub(crate) fn on_error_jvm_buildpack(error: OpenJdkBuildpackError) {
@@ -18,7 +18,7 @@ pub(crate) fn on_error_jvm_buildpack(error: OpenJdkBuildpackError) {
         ),
         OpenJdkBuildpackError::ReadSystemPropertiesError(
             ReadSystemPropertiesError::ParseError(error),
-        ) => log_error(
+        ) => print_error(
             "Invalid system.properties file",
             formatdoc! {"
                 Could not parse your application's system.properties file. Please ensure that your
@@ -71,14 +71,14 @@ pub(crate) fn on_error_jvm_buildpack(error: OpenJdkBuildpackError) {
         ),
         OpenJdkBuildpackError::UnsupportedOpenJdkVersion(artifact_requirement) => {
             match artifact_requirement.version {
-                HerokuOpenJdkVersionRequirement::Major(major_version) => log_error(
+                HerokuOpenJdkVersionRequirement::Major(major_version) => print_error(
                     "Unsupported OpenJDK version",
                     formatdoc! {"
                         The OpenJDK major version {major_version} you specified in your system.properties file is not supported.
                         Please specify a supported major version in your system.properties file.
                     ", major_version = major_version },
                 ),
-                HerokuOpenJdkVersionRequirement::Specific(version) => log_error(
+                HerokuOpenJdkVersionRequirement::Specific(version) => print_error(
                     "Unsupported OpenJDK version",
                     formatdoc! {"
                         The OpenJDK version {version} you specified in your system.properties file is not supported.
@@ -90,7 +90,7 @@ pub(crate) fn on_error_jvm_buildpack(error: OpenJdkBuildpackError) {
                 )
             }
         },
-        OpenJdkBuildpackError::ParseInventoryError(error) => log_error(
+        OpenJdkBuildpackError::ParseInventoryError(error) => print_error(
             "Invalid Inventory File",
             formatdoc! {"
                 The inventory of OpenJDK distributions could not be parsed. This error should
@@ -111,7 +111,7 @@ pub(crate) fn on_error_jvm_buildpack(error: OpenJdkBuildpackError) {
                 Actual: {actual}
             ", expected = hex::encode(expected), actual = hex::encode(actual) }
         ),
-        OpenJdkBuildpackError::ResolveVersionError(VersionResolveError::OpenJdkArtifactRequirementParseError(OpenJdkArtifactRequirementParseError::UnknownDistribution(distribution))) => log_error(
+        OpenJdkBuildpackError::ResolveVersionError(VersionResolveError::OpenJdkArtifactRequirementParseError(OpenJdkArtifactRequirementParseError::UnknownDistribution(distribution))) => print_error(
             format!("Unsupported distribution: {distribution}"),
             formatdoc! {"
                     Please check your system.properties file to ensure the java.runtime.version
@@ -124,7 +124,7 @@ pub(crate) fn on_error_jvm_buildpack(error: OpenJdkBuildpackError) {
                     Heroku
             "}),
         OpenJdkBuildpackError::ResolveVersionError(VersionResolveError::OpenJdkArtifactRequirementParseError(OpenJdkArtifactRequirementParseError::OpenJdkVersionParseError(_))) => {
-            log_error(
+            print_error(
                 "Invalid OpenJDK version selector",
                 formatdoc! {"
             The OpenJDK version selector you specified in your system.properties file is invalid.
@@ -135,7 +135,7 @@ pub(crate) fn on_error_jvm_buildpack(error: OpenJdkBuildpackError) {
             );
         }
         OpenJdkBuildpackError::ResolveVersionError(VersionResolveError::ReadSystemPropertiesError(error)) => {
-            log_error(
+            print_error(
                 "Invalid system.properties file",
                 formatdoc! {"
             The contents of your system.properties file cannot be parsed. Please use a valid
diff --git a/buildpacks/maven/src/errors.rs b/buildpacks/maven/src/errors.rs
@@ -3,10 +3,9 @@ use buildpacks_jvm_shared::log::{
     log_build_tool_io_error, log_build_tool_unexpected_exit_code_error, log_please_try_again,
     log_please_try_again_error,
 };
-use buildpacks_jvm_shared::output::CmdError;
+use buildpacks_jvm_shared::output::{print_error, CmdError};
 use buildpacks_jvm_shared::system_properties::ReadSystemPropertiesError;
 use indoc::formatdoc;
-use libherokubuildpack::log::log_error;
 
 #[allow(clippy::too_many_lines)]
 pub(crate) fn on_error_maven_buildpack(error: MavenBuildpackError) {
@@ -41,22 +40,22 @@ pub(crate) fn on_error_maven_buildpack(error: MavenBuildpackError) {
             "While trying to determine a default process based on the used application framework, an unexpected error occurred.",
             error,
         ),
-        MavenBuildpackError::UnsupportedMavenVersion(version) => log_error(
+        MavenBuildpackError::UnsupportedMavenVersion(version) => print_error(
             "Unsupported Maven version",
             formatdoc! {"
                 You have defined an unsupported Maven version ({version}) in the system.properties file.
             ", version = version },
         ),
         MavenBuildpackError::SettingsError(SettingsError::InvalidMavenSettingsPath(path)) => {
-            log_error(
+            print_error(
                 "Cannot find custom settings.xml file",
                 formatdoc! {"
                     You have set MAVEN_SETTINGS_PATH to \"{path}\". We could not find that file in your app.
                     Please verify the path is correct, ensure you committed this file to your app and then try again.
                 ", path = path.to_string_lossy() },
             );
         },
-        MavenBuildpackError::SettingsError(SettingsError::DownloadError(url, error)) => log_error(
+        MavenBuildpackError::SettingsError(SettingsError::DownloadError(url, error)) => print_error(
             "Download of settings.xml failed",
             formatdoc! {"
                 You have set MAVEN_SETTINGS_URL to \"{url}\". We tried to download the file at this
@@ -90,7 +89,7 @@ pub(crate) fn on_error_maven_buildpack(error: MavenBuildpackError) {
                 CmdError::NonZeroExitAlreadyStreamed(named_output) => log_build_tool_unexpected_exit_code_error("Maven",*named_output.status()),
             }
         }
-        MavenBuildpackError::CannotSplitMavenCustomOpts(error) => log_error(
+        MavenBuildpackError::CannotSplitMavenCustomOpts(error) => print_error(
             "Invalid MAVEN_CUSTOM_OPTS",
             formatdoc! {"
                 Could not split the value of the MAVEN_CUSTOM_OPTS environment variable into separate
@@ -99,7 +98,7 @@ pub(crate) fn on_error_maven_buildpack(error: MavenBuildpackError) {
                 Details: {error}
             ", error = error },
         ),
-        MavenBuildpackError::CannotSplitMavenCustomGoals(error) => log_error(
+        MavenBuildpackError::CannotSplitMavenCustomGoals(error) => print_error(
             "Invalid MAVEN_CUSTOM_GOALS",
             formatdoc! {"
                 Could not split the value of the MAVEN_CUSTOM_GOALS environment variable into separate
@@ -110,7 +109,7 @@ pub(crate) fn on_error_maven_buildpack(error: MavenBuildpackError) {
         ),
         MavenBuildpackError::DetermineModeError(
             ReadSystemPropertiesError::ParseError(error),
-        ) => log_error(
+        ) => print_error(
             "Invalid system.properties file",
             formatdoc! {"
                 Could not parse your application's system.properties file. Please ensure that your
diff --git a/buildpacks/maven/src/warnings.rs b/buildpacks/maven/src/warnings.rs
@@ -1,8 +1,8 @@
+use buildpacks_jvm_shared::output::print_warning;
 use indoc::formatdoc;
-use libherokubuildpack::log::log_warning;
 
 pub(crate) fn log_unused_maven_wrapper_warning(version: &str) {
-    log_warning(
+    print_warning(
         "Unused Maven wrapper",
         formatdoc! {"
             Your application contains Maven wrapper, but a Maven version was also specified in system.properties.
@@ -13,7 +13,7 @@ pub(crate) fn log_unused_maven_wrapper_warning(version: &str) {
 }
 
 pub(crate) fn log_default_maven_version_warning(version: &str) {
-    log_warning(
+    print_warning(
         "Using default version",
         formatdoc! {"
             Your application does not explicitly specify which Maven version should be used to build your application.
diff --git a/buildpacks/sbt/src/errors.rs b/buildpacks/sbt/src/errors.rs
@@ -4,7 +4,7 @@ use crate::layers::sbt_global::SbtGlobalLayerError;
 use crate::sbt::output::SbtError;
 use crate::sbt::version::ReadSbtVersionError;
 use buildpacks_jvm_shared::log::log_please_try_again_error;
-use buildpacks_jvm_shared::output::CmdError;
+use buildpacks_jvm_shared::output::{print_error, CmdError};
 use buildpacks_jvm_shared::system_properties::ReadSystemPropertiesError;
 use indoc::formatdoc;
 use libherokubuildpack::log::log_error;
@@ -58,7 +58,7 @@ pub(crate) fn log_user_errors(error: SbtBuildpackError) {
                 error
             ),
 
-            ReadSbtVersionError::MissingVersionProperty => log_error(
+            ReadSbtVersionError::MissingVersionProperty => print_error(
                 "No sbt version defined",
                 formatdoc! { "
                 Your scala project must include project/build.properties and define a value for
diff --git a/shared/Cargo.toml b/shared/Cargo.toml
@@ -9,6 +9,5 @@ workspace = true
 [dependencies]
 indoc = "2"
 java-properties = "2"
-libherokubuildpack = { version = "=0.26.0", default-features = false, features = ["log", "command", "write"] }
 bullet_stream = "0.4.0"
 fun_run = { version = "0.2.0" }
diff --git a/shared/src/log.rs b/shared/src/log.rs
@@ -1,10 +1,10 @@
+use crate::output::print_error;
 use indoc::formatdoc;
-use libherokubuildpack::log::log_error;
 use std::fmt::Debug;
 use std::process::ExitStatus;
 
 pub fn log_please_try_again<H: AsRef<str>, M: AsRef<str>>(header: H, message: M) {
-    log_error(
+    print_error(
         header,
         formatdoc! {"
             {message}
@@ -20,7 +20,7 @@ pub fn log_please_try_again_error<H: AsRef<str>, M: AsRef<str>, E: Debug>(
     message: M,
     error: E,
 ) {
-    log_error(
+    print_error(
         header,
         formatdoc! {"
             {message}
@@ -38,7 +38,7 @@ pub fn log_build_tool_unexpected_exit_code_error(build_tool_name: &str, exit_sta
         .code()
         .map_or(String::from("<unknown>"), |code| code.to_string());
 
-    log_error(
+    print_error(
         format!("Unexpected {build_tool_name} exit code"),
         formatdoc! { "
             {build_tool_name} unexpectedly exited with code '{exit_code_string}'. The most common reason for this are
