Skip to content
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

Gracefully handle error when trying to read package.json in detect #733

Merged
merged 2 commits into from
Nov 29, 2023
Merged

Gracefully handle error when trying to read package.json in detect #733

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0466aea
Gracefully handle error when trying to read `package.json` in detect
colincasey Nov 24, 2023
80f2636
Update CHANGELOG.md
colincasey Nov 24, 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
4 changes: 4 additions & 0 deletions buildpacks/nodejs-npm-install/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## [Unreleased]

### Fixed

- Detection will report a failure instead of throwing an error when there is no `package.json` file in the application directory. ([#733](https://github.com/heroku/buildpacks-nodejs/pull/733))

## [2.3.0] - 2023-11-09

- No changes.
Expand Down
29 changes: 15 additions & 14 deletions buildpacks/nodejs-npm-install/src/main.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,20 +46,21 @@ impl Buildpack for NpmInstallBuildpack {
.try_exists()
.map_err(NpmInstallBuildpackError::Detect)?;

let package_json = PackageJson::read(context.app_dir.join("package.json"))
.map_err(NpmInstallBuildpackError::PackageJson)?;

if npm_lockfile_exists || package_json.has_dependencies() {
DetectResultBuilder::pass()
.build_plan(
BuildPlanBuilder::new()
.provides("node_modules")
.requires("npm")
.requires("node_modules")
.requires("node")
.build(),
)
.build()
if let Ok(package_json) = PackageJson::read(context.app_dir.join("package.json")) {
if npm_lockfile_exists || package_json.has_dependencies() {
DetectResultBuilder::pass()
.build_plan(
BuildPlanBuilder::new()
.provides("node_modules")
.requires("npm")
.requires("node_modules")
.requires("node")
.build(),
)
.build()
} else {
DetectResultBuilder::fail().build()
}
} else {
DetectResultBuilder::fail().build()
}
Expand Down
Empty file added buildpacks/nodejs-npm-install/tests/fixtures/empty/.gitkeep
View file
Open in desktop
Empty file.
14 changes: 14 additions & 0 deletions buildpacks/nodejs-npm-install/tests/integration_test.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -172,6 +172,20 @@ fn test_dependencies_and_missing_lockfile_errors() {
);
}

#[test]
#[ignore]
fn detect_rejects_non_npm_project() {
nodejs_integration_test_with_config(
"./fixtures/empty",
|config| {
config.expected_pack_result(PackResult::Failure);
},
|ctx| {
assert_contains!(ctx.pack_stdout, "fail: heroku/nodejs-npm-install");
},
);
}

fn add_lockfile_entry(app_dir: &Path, package_name: &str, lockfile_entry: serde_json::Value) {
update_json_file(&app_dir.join("package-lock.json"), |json| {
let dependencies = json["dependencies"].as_object_mut().unwrap();
Expand Down