Use @CompileTimeConstant on SpawnAction.Builder#setProgressMessage.

Add SpawnAction.Builder#setProgressMessageNonLazy for dynamic strings. This should help guide users to the right method.

This also helped find a few methods I'd missed previously that could use a constant-string version.

RELNOTES: None
PiperOrigin-RevId: 164150264

1 files changed, 16 insertions, 1 deletions

diff --git a/src/main/java/com/google/devtools/build/lib/analysis/actions/SpawnAction.java b/src/main/java/com/google/devtools/build/lib/analysis/actions/SpawnAction.java
index e578483eb2..54f1d9e7f0 100644
--- a/src/main/java/com/google/devtools/build/lib/analysis/actions/SpawnAction.java
+++ b/src/main/java/com/google/devtools/build/lib/analysis/actions/SpawnAction.java
@@ -59,6 +59,7 @@ import com.google.devtools.build.lib.util.LazyString;
 import com.google.devtools.build.lib.util.Preconditions;
 import com.google.devtools.build.lib.util.ShellEscaper;
 import com.google.devtools.build.lib.vfs.PathFragment;
+import com.google.errorprone.annotations.CompileTimeConstant;
 import com.google.errorprone.annotations.FormatMethod;
 import com.google.errorprone.annotations.FormatString;
 import com.google.protobuf.GeneratedMessage.GeneratedExtension;
@@ -1124,8 +1125,12 @@ public class SpawnAction extends AbstractAction implements ExecutionInfoSpecifie
      * <p>If you are formatting the string in any way, prefer one of the overloads that do the
      * formatting lazily. This helps save memory by delaying the construction of the progress
      * message string.
+     *
+     * <p>If you cannot use simple formatting, try {@link Builder#setProgressMessage(LazyString)}.
+     *
+     * <p>If you must eagerly compute the string, use {@link Builder#setProgressMessageNonLazy}.
      */
-    public Builder setProgressMessage(String progressMessage) {
+    public Builder setProgressMessage(@CompileTimeConstant String progressMessage) {
       this.progressMessage = progressMessage;
       return this;
     }
@@ -1222,6 +1227,16 @@ public class SpawnAction extends AbstractAction implements ExecutionInfoSpecifie
       return this;
     }
 
+    /**
+     * Sets an eagerly computed progress message.
+     *
+     * <p>Prefer one of the lazy overloads whenever possible, as it will generally save memory.
+     */
+    public Builder setProgressMessageNonLazy(String progressMessage) {
+      this.progressMessage = progressMessage;
+      return this;
+    }
+
     public Builder setMnemonic(String mnemonic) {
       Preconditions.checkArgument(
           !mnemonic.isEmpty() && CharMatcher.javaLetterOrDigit().matchesAllOf(mnemonic),