npmInstall up-to-date check broken with fastNpmInstall

Open Beginner friendly
#310 6 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
65/100
Issue type
Bug
Clarity
Clearly specified
Activity status
Stale
Tech stack
kotlin, nodejs
Domain
build-system, tooling

Research direction

Start in src/main/kotlin/com/github/gradle/node/npm/task/NpmInstallTask.kt around line 115 and inspect how fastNpmInstall determines its outputs. Reproduce the npmInstall, clean, and npmInstall sequence, then verify that removing node_modules makes the task out of date and restores the directory on execution.

Written by the indexing model from the issue text.

Description

I stumbled on a weird issue with the following steps:

  1. Fresh git checkout, i.e. no node_modules directory present
  2. Run task npmInstall with the fastNpmInstall option enabled
  3. Run the clean task, i.e. remove the whole node_modules directory
  4. Run npmInstall again, it reports as up-to-date
  5. Other tasks fail because node_modules is missing

The problem is that in step 2 the file node_modules/.package-lock.json was not recorded as output because it did not yet exist at configuration time, only after task execution. So the task has no configured outputs and won't become out of date by removing the node_modules directory.

Proposed fix: When using fastNpmInstall, do not check for existance of the file at configuration time here, instead always return the file.

Dominant language
Groovy
Stars
677
Forks
120
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from node-gradle/gradle-node-plugin

All issues in node-gradle/gradle-node-plugin

Similar issues

More Build System issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.