Skip to content

1480 speedup npm install step for npm based formatters #1590

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 20 commits into from
Feb 27, 2023
Merged

1480 speedup npm install step for npm based formatters #1590

Changes from 1 commit
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
2e58bd8
1480: introduce timing logger
simschla Feb 10, 2023
4b663d4
1480: add trace logger
simschla Feb 13, 2023
050bb45
1480: extract npm process as interface
simschla Feb 13, 2023
e724d88
1480: extract NpmApp and npm exec calls
simschla Feb 14, 2023
c2bba79
1480: introduce facility to keep copies of node modules
simschla Feb 21, 2023
6efa928
1480: add caching around npm install
simschla Feb 21, 2023
bdceb88
1480: improve logging
simschla Feb 22, 2023
e97764f
1480: allow dynamic npmInstall process
simschla Feb 24, 2023
6f0dd0b
1480: add npmInstallCache to api
simschla Feb 24, 2023
c2c46bb
1582: cleanup logging
simschla Feb 24, 2023
3a20930
1480: add integration test for gradle side
simschla Feb 24, 2023
3c4b5bc
1480: add integration test for tsfmt (and fix api issue)
simschla Feb 24, 2023
64b201b
1480: adding tests without cache and for eslint
simschla Feb 24, 2023
de33c70
1480: clarifications/renamings
simschla Feb 24, 2023
cd84167
1480: integration tests for maven + cleanup
simschla Feb 26, 2023
ed95a7c
1480: add configuration to readme
simschla Feb 26, 2023
00990dc
1480: update changes.md
simschla Feb 26, 2023
37694c1
1480: adapt test to actual output
simschla Feb 26, 2023
78ccbc9
1480: make TimedLogger package-private (PR feedback)
simschla Feb 27, 2023
8ebb896
Merge remote-tracking branch 'upstream/main' into 1480-speedup-npm-in…
simschla Feb 27, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
1480: add trace logger
  • Loading branch information
@simschla
simschla committed Feb 26, 2023
commit 4b663d48639633cc64bef0e9cb6292dab6d30e94
35 changes: 18 additions & 17 deletions lib/src/main/java/com/diffplug/spotless/npm/NpmFormatterStepStateBase.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,13 +34,16 @@
import com.diffplug.spotless.FormatterFunc;
import com.diffplug.spotless.ProcessRunner.LongRunningProcess;
import com.diffplug.spotless.ThrowingEx;
import com.diffplug.spotless.TimedLogger;

import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;

abstract class NpmFormatterStepStateBase implements Serializable {

private static final Logger logger = LoggerFactory.getLogger(NpmFormatterStepStateBase.class);

private static final TimedLogger timedLogger = TimedLogger.forLogger(logger);

private static final long serialVersionUID = 1460749955865959948L;

@SuppressFBWarnings("SE_TRANSIENT_FIELD_NOT_RESTORED")
Expand All @@ -61,26 +64,24 @@ protected NpmFormatterStepStateBase(String stepName, NpmConfig npmConfig, NpmFor

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());
NpmResourceHelper
.writeUtf8StringToFile(nodeServerLayout.serveJsFile(), this.npmConfig.getServeScriptContent());
if (this.npmConfig.getNpmrcContent() != null) {
NpmResourceHelper.writeUtf8StringToFile(nodeServerLayout.npmrcFile(), this.npmConfig.getNpmrcContent());
} else {
NpmResourceHelper.deleteFileIfExists(nodeServerLayout.npmrcFile());
}
logger.info("Prepared {} for npm step {} in {} ms.", this.nodeServerLayout, getClass().getName(), System.currentTimeMillis() - started);

timedLogger.withInfo("Preparing {} for npm step {}.", this.nodeServerLayout, getClass().getName()).run(() -> {
NpmResourceHelper.assertDirectoryExists(nodeServerLayout.nodeModulesDir());
NpmResourceHelper.writeUtf8StringToFile(nodeServerLayout.packageJsonFile(),
this.npmConfig.getPackageJsonContent());
NpmResourceHelper
.writeUtf8StringToFile(nodeServerLayout.serveJsFile(), this.npmConfig.getServeScriptContent());
if (this.npmConfig.getNpmrcContent() != null) {
NpmResourceHelper.writeUtf8StringToFile(nodeServerLayout.npmrcFile(), this.npmConfig.getNpmrcContent());
} else {
NpmResourceHelper.deleteFileIfExists(nodeServerLayout.npmrcFile());
}
});
}

protected void prepareNodeServer() throws IOException {
final long started = System.currentTimeMillis();
logger.info("running npm install in {} for npm step {}", this.nodeServerLayout.nodeModulesDir(), getClass().getName());
runNpmInstall(nodeServerLayout.nodeModulesDir());
logger.info("npm install finished in {} ms in {} for npm step {}", System.currentTimeMillis() - started, this.nodeServerLayout.nodeModulesDir(), getClass().getName());
timedLogger.withInfo("Running npm install in {} for npm step {}.", this.nodeServerLayout.nodeModulesDir(), getClass().getName())
.run(() -> runNpmInstall(nodeServerLayout.nodeModulesDir()));
}

private void runNpmInstall(File npmProjectDir) throws IOException {
Expand Down