Skip to content

Include removed dependency flag when creating a pull request #5671

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
mctofu merged 3 commits into from
Sep 9, 2022
Merged

Include removed dependency flag when creating a pull request #5671

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f95305a
Include removed dependency flag when creating a pull request
mctofu Sep 9, 2022
119fc8b
Keep api payload consistent for non-removed dependencies
mctofu Sep 9, 2022
14dac23
Only compact the optional fields
mctofu Sep 9, 2022
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
5 changes: 3 additions & 2 deletions updater/lib/dependabot/api_client.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -187,8 +187,9 @@ def create_pull_request_data(dependencies, updated_dependency_files, base_commit
version: dep.version,
"previous-version": dep.previous_version,
requirements: dep.requirements,
"previous-requirements": dep.previous_requirements
}
"previous-requirements": dep.previous_requirements,
removed: dep.removed? ? true : nil
}.compact
end,
"updated-dependency-files": updated_dependency_files,
"base-commit-sha": base_commit_sha
Expand Down
28 changes: 28 additions & 0 deletions updater/spec/dependabot/api_client_spec.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,34 @@
end)
end
end

context "with a removed dependency" do

@Nishnha Nishnha Sep 9, 2022 •
edited
Loading

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What happens if somehow we pass in removed: false instead of nil?

@mctofu mctofu Sep 9, 2022 •
edited
Loading

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It defaults to false so should be the same:

dependabot-core/common/lib/dependabot/dependency.rb

Lines 42 to 44 in a716ea6

def initialize(name:, requirements:, package_manager:, version: nil,
previous_version: nil, previous_requirements: nil,
subdependency_metadata: [], removed: false)

let(:removed_dependency) do
Dependabot::Dependency.new(
name: "removed",
package_manager: "bundler",
previous_version: "1.7.0",
requirements: [],
previous_requirements: [],
removed: true
)
end

it "encodes fields" do
client.create_pull_request(1, [removed_dependency, dependency], dependency_files, base_commit, message)
expect(WebMock).
to(have_requested(:post, create_pull_request_url).
with(headers: { "Authorization" => "token" }).
with do |req|
data = JSON.parse(req.body)["data"]
expect(data["dependencies"].first["removed"]).to eq(true)
expect(data["dependencies"].first.key?("version")).to eq(false)
expect(data["dependencies"].last.key?("removed")).to eq(false)
expect(data["dependencies"].last["version"]).to eq("1.8.0")
true
end)
end
end
end

describe "update_pull_request" do
Expand Down