Remove transients from NpmFormatterStepStateBase by embedding NpmPathResolver and making it serializable.

Author: nedtwigg

lib/src/main/java/com/diffplug/spotless/npm/EslintFormatterStep.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2016-2023 DiffPlug
+ * Copyright 2016-2024 DiffPlug
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -102,8 +102,7 @@ private static class State extends NpmFormatterStepStateBase implements Serializ
 							projectDir,
 							buildDir,
 							cacheDir,
-							npmPathResolver::resolveNpmExecutable,
-							npmPathResolver::resolveNodeExecutable));
+							npmPathResolver));
 			this.origEslintConfig = requireNonNull(eslintConfig.verify());
 			this.eslintConfigInUse = eslintConfig;
 		}

lib/src/main/java/com/diffplug/spotless/npm/NpmFormatterStepLocations.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 DiffPlug
+ * Copyright 2023-2024 DiffPlug
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -19,36 +19,23 @@
 
 import java.io.File;
 import java.io.Serializable;
-import java.util.function.Supplier;
 
 import javax.annotation.Nonnull;
 
-import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
-
 class NpmFormatterStepLocations implements Serializable {
 
 	private static final long serialVersionUID = -1055408537924029969L;
-	@SuppressFBWarnings("SE_TRANSIENT_FIELD_NOT_RESTORED")
-	private final transient File projectDir;
-
-	@SuppressFBWarnings("SE_TRANSIENT_FIELD_NOT_RESTORED")
-	private final transient File buildDir;
-
-	@SuppressFBWarnings("SE_TRANSIENT_FIELD_NOT_RESTORED")
-	private final transient File cacheDir;
-
-	@SuppressFBWarnings("SE_TRANSIENT_FIELD_NOT_RESTORED")
-	private final transient Supplier<File> npmExecutable;
 
-	@SuppressFBWarnings("SE_TRANSIENT_FIELD_NOT_RESTORED")
-	private final transient Supplier<File> nodeExecutable;
+	private final File projectDir;
+	private final File buildDir;
+	private final File cacheDir;
+	private final NpmPathResolver resolver;
 
-	public NpmFormatterStepLocations(@Nonnull File projectDir, @Nonnull File buildDir, File cacheDir, @Nonnull Supplier<File> npmExecutable, @Nonnull Supplier<File> nodeExecutable) {
+	public NpmFormatterStepLocations(@Nonnull File projectDir, @Nonnull File buildDir, File cacheDir, @Nonnull NpmPathResolver resolver) {
 		this.projectDir = requireNonNull(projectDir);
 		this.buildDir = requireNonNull(buildDir);
 		this.cacheDir = cacheDir;
-		this.npmExecutable = requireNonNull(npmExecutable);
-		this.nodeExecutable = requireNonNull(nodeExecutable);
+		this.resolver = requireNonNull(resolver);
 	}
 
 	public File projectDir() {
@@ -64,10 +51,10 @@ public File cacheDir() {
 	}
 
 	public File npmExecutable() {
-		return npmExecutable.get();
+		return resolver.resolveNpmExecutable();
 	}
 
 	public File nodeExecutable() {
-		return nodeExecutable.get();
+		return resolver.resolveNodeExecutable();
 	}
 }

lib/src/main/java/com/diffplug/spotless/npm/NpmFormatterStepStateBase.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2016-2023 DiffPlug
+ * Copyright 2016-2024 DiffPlug
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -35,8 +35,6 @@
 import com.diffplug.spotless.ProcessRunner.LongRunningProcess;
 import com.diffplug.spotless.ThrowingEx;
 
-import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
-
 abstract class NpmFormatterStepStateBase implements Serializable {
 
 	private static final Logger logger = LoggerFactory.getLogger(NpmFormatterStepStateBase.class);
@@ -45,15 +43,11 @@ abstract class NpmFormatterStepStateBase implements Serializable {
 
 	private static final long serialVersionUID = 1460749955865959948L;
 
-	@SuppressFBWarnings("SE_TRANSIENT_FIELD_NOT_RESTORED")
-	protected final transient NodeServerLayout nodeServerLayout;
-
-	public final NpmFormatterStepLocations locations;
-
-	private final NpmConfig npmConfig;
-
 	private final String stepName;
+	private final NpmConfig npmConfig;
 
+	public final NpmFormatterStepLocations locations;
+	protected final transient NodeServerLayout nodeServerLayout;
 	private final transient NodeServeApp nodeServeApp;
 
 	protected NpmFormatterStepStateBase(String stepName, NpmConfig npmConfig, NpmFormatterStepLocations locations) throws IOException {

lib/src/main/java/com/diffplug/spotless/npm/NpmPathResolver.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2020-2023 DiffPlug
+ * Copyright 2020-2024 DiffPlug
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -16,10 +16,11 @@
 package com.diffplug.spotless.npm;
 
 import java.io.File;
+import java.io.Serializable;
 import java.util.List;
 import java.util.Optional;
 
-public class NpmPathResolver {
+public class NpmPathResolver implements Serializable {
 
 	private final File explicitNpmExecutable;
 

lib/src/main/java/com/diffplug/spotless/npm/PrettierFormatterStep.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2016-2023 DiffPlug
+ * Copyright 2016-2024 DiffPlug
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -79,8 +79,7 @@ private static class State extends NpmFormatterStepStateBase implements Serializ
 							projectDir,
 							buildDir,
 							cacheDir,
-							npmPathResolver::resolveNpmExecutable,
-							npmPathResolver::resolveNodeExecutable));
+							npmPathResolver));
 			this.prettierConfig = requireNonNull(prettierConfig);
 		}
 

lib/src/main/java/com/diffplug/spotless/npm/TsFmtFormatterStep.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2016-2023 DiffPlug
+ * Copyright 2016-2024 DiffPlug
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -83,8 +83,7 @@ public State(String stepName, Map<String, String> versions, File projectDir, Fil
 							projectDir,
 							buildDir,
 							cacheDir,
-							npmPathResolver::resolveNpmExecutable,
-							npmPathResolver::resolveNodeExecutable));
+							npmPathResolver));
 			this.buildDir = requireNonNull(buildDir);
 			this.configFile = configFile;
 			this.inlineTsFmtSettings = inlineTsFmtSettings == null ? new TreeMap<>() : new TreeMap<>(inlineTsFmtSettings);