1162: separate node dirs per package.json

Author: simschla

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

@@ -18,25 +18,44 @@
 import java.io.File;
 import java.nio.file.Files;
 import java.nio.file.Path;
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
 import java.util.stream.Stream;
 
 import com.diffplug.spotless.ThrowingEx;
 
 class NodeServerLayout {
 
+	private static final Pattern PACKAGE_JSON_NAME_PATTERN = Pattern.compile("\"name\"\\s*:\\s*\"([^\"]+)\"");
+
 	private final File nodeModulesDir;
 	private final File packageJsonFile;
+
+	private final File packageLockJsonFile;
+
 	private final File serveJsFile;
 	private final File npmrcFile;
 
-	NodeServerLayout(File buildDir, String stepName, String stepSuffix) {
-		this.nodeModulesDir = new File(buildDir, String.format("spotless-node-modules-%s-%s", stepName, stepSuffix));
+	NodeServerLayout(File buildDir, String packageJsonContent) {
+		this.nodeModulesDir = new File(buildDir, nodeModulesDirName(packageJsonContent));
 		this.packageJsonFile = new File(nodeModulesDir, "package.json");
+		this.packageLockJsonFile = new File(nodeModulesDir, "package-lock.json");
 		this.serveJsFile = new File(nodeModulesDir, "serve.js");
 		this.npmrcFile = new File(nodeModulesDir, ".npmrc");
 	}
 
+	private static String nodeModulesDirName(String packageJsonContent) {
+		String md5Hash = NpmResourceHelper.md5(packageJsonContent);
+		Matcher matcher = PACKAGE_JSON_NAME_PATTERN.matcher(packageJsonContent);
+		if (!matcher.find()) {
+			throw new IllegalArgumentException("package.json must contain a name property");
+		}
+		String packageName = matcher.group(1);
+		return String.format("%s-node-modules-%s", packageName, md5Hash);
+	}
+
 	File nodeModulesDir() {
+
 		return nodeModulesDir;
 	}
 
@@ -52,17 +71,16 @@ public File npmrcFile() {
 		return npmrcFile;
 	}
 
-	static File getBuildDirFromNodeModulesDir(File nodeModulesDir) {
-		return nodeModulesDir.getParentFile();
-	}
-
 	public boolean isLayoutPrepared() {
 		if (!nodeModulesDir().isDirectory()) {
 			return false;
 		}
 		if (!packageJsonFile().isFile()) {
 			return false;
 		}
+		if (!packageLockJsonFile.isFile()) {
+			return false;
+		}
 		if (!serveJsFile().isFile()) {
 			return false;
 		}
@@ -82,4 +100,14 @@ public boolean isNodeModulesPrepared() {
 			}
 		});
 	}
+
+	@Override
+	public String toString() {
+		return String.format(
+				"NodeServerLayout[nodeModulesDir=%s, packageJsonFile=%s, serveJsFile=%s, npmrcFile=%s]",
+				this.nodeModulesDir,
+				this.packageJsonFile,
+				this.serveJsFile,
+				this.npmrcFile);
+	}
 }

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

@@ -56,17 +56,13 @@ protected NpmFormatterStepStateBase(String stepName, NpmConfig npmConfig, NpmFor
 		this.stepName = requireNonNull(stepName);
 		this.npmConfig = requireNonNull(npmConfig);
 		this.locations = locations;
-		String stateSuffix = stateSuffix();
-		logger.info("Creating {} with name {} and state suffix {}", this.getClass().getSimpleName(), stepName, stateSuffix);
-		this.nodeServerLayout = new NodeServerLayout(locations.buildDir(), stepName, stateSuffix);
-	}
-
-	protected String stateSuffix() {
-		String packageJsonContent = npmConfig.getPackageJsonContent();
-		return NpmResourceHelper.md5(packageJsonContent);
+		this.nodeServerLayout = new NodeServerLayout(locations.buildDir(), npmConfig.getPackageJsonContent());
 	}
 
 	protected void prepareNodeServerLayout() throws IOException {
+		final long started = System.currentTimeMillis();
+		// maybe introduce trace logger?
+		logger.info("Preparing {} for npm step {}.", this.nodeServerLayout, getClass().getName());
 		NpmResourceHelper.assertDirectoryExists(nodeServerLayout.nodeModulesDir());
 		NpmResourceHelper.writeUtf8StringToFile(nodeServerLayout.packageJsonFile(),
 				this.npmConfig.getPackageJsonContent());
@@ -77,12 +73,14 @@ protected void prepareNodeServerLayout() throws IOException {
 		} else {
 			NpmResourceHelper.deleteFileIfExists(nodeServerLayout.npmrcFile());
 		}
+		logger.info("Prepared {} for npm step {} in {} ms.", this.nodeServerLayout, getClass().getName(), System.currentTimeMillis() - started);
 	}
 
 	protected void prepareNodeServer() throws IOException {
-		FormattedPrinter.SYSOUT.print("running npm install");
+		final long started = System.currentTimeMillis();
+		logger.info("running npm install in {} for npm step {}", this.nodeServerLayout.nodeModulesDir(), getClass().getName());
 		runNpmInstall(nodeServerLayout.nodeModulesDir());
-		FormattedPrinter.SYSOUT.print("npm install finished");
+		logger.info("npm install finished in {} ms in {} for npm step {}", System.currentTimeMillis() - started, this.nodeServerLayout.nodeModulesDir(), getClass().getName());
 	}
 
 	private void runNpmInstall(File npmProjectDir) throws IOException {

lib/src/main/resources/com/diffplug/spotless/npm/eslint-package.json

@@ -1,5 +1,5 @@
 {
-	"name": "spotless-eslint-formatter-step",
+	"name": "spotless-eslint",
 	"version": "2.0.0",
 	"description": "Spotless formatter step for running eslint as a rest service.",
 	"repository": "https://github.com/diffplug/spotless",

lib/src/main/resources/com/diffplug/spotless/npm/prettier-package.json

@@ -1,5 +1,5 @@
 {
-	"name": "spotless-prettier-formatter-step",
+	"name": "spotless-prettier",
 	"version": "2.0.0",
 	"description": "Spotless formatter step for running prettier as a rest service.",
 	"repository": "https://github.com/diffplug/spotless",

lib/src/main/resources/com/diffplug/spotless/npm/tsfmt-package.json

@@ -1,5 +1,5 @@
 {
-	"name": "spotless-tsfmt-formatter-step",
+	"name": "spotless-tsfmt",
 	"version": "2.0.0",
 	"description": "Spotless formatter step for running tsfmt as a rest service.",
 	"repository": "https://github.com/diffplug/spotless",