-
Notifications
You must be signed in to change notification settings - Fork 1.4k
feat: Add Swift FileParser support for Xcode-managed SwiftPM projects #14360
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.
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
Changes from all commits
Commits
Show all changes
12 commits
Select commit
Hold shift + click to select a range
4bee70b
Add Xcode SPM FileParser support (Part 2)
markhallen 4f37d49
Refactor: address code review feedback for Xcode SPM file parser
markhallen 57e8fdb
Address remaining review feedback for Xcode SPM file parser
markhallen 3e40a20
Revert lockfiles
markhallen 1475db9
Address code review feedback for Xcode SPM file parser\n\n- Remove di…
markhallen 92a6683
Merge branch 'main' into swift-xcode-spm-file-parser
markhallen 909e7b0
Change Sorbet type from strict to strong in pbxproj_parser and url_he…
markhallen b3ac91e
Address review feedback: consistent check_required_files, fix comment…
markhallen 9ee1087
Merge branch 'main' into swift-xcode-spm-file-parser
markhallen 7ba6156
Extract Xcode SPM orchestration into FileParser::XcodeSpmResolver\n\n…
markhallen 1064f75
Merge branch 'main' into swift-xcode-spm-file-parser
markhallen 72a60eb
Merge branch 'main' into swift-xcode-spm-file-parser
markhallen File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
165 changes: 165 additions & 0 deletions
165
swift/lib/dependabot/swift/file_parser/package_resolved_parser.rb
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,165 @@ | ||
| # typed: strict | ||
| # frozen_string_literal: true | ||
|
|
||
| require "json" | ||
| require "sorbet-runtime" | ||
| require "dependabot/dependency" | ||
| require "dependabot/errors" | ||
| require "dependabot/shared_helpers" | ||
| require "dependabot/swift/file_parser" | ||
| require "dependabot/swift/url_helpers" | ||
|
|
||
| module Dependabot | ||
| module Swift | ||
| class FileParser < Dependabot::FileParsers::Base | ||
| class PackageResolvedParser | ||
| extend T::Sig | ||
|
|
||
| SUPPORTED_VERSIONS = T.let([1, 2, 3].freeze, T::Array[Integer]) | ||
|
|
||
| # Maps schema version to the JSON keys used for each pin field | ||
| PIN_KEYS = T.let( | ||
| { | ||
| 1 => { url: "repositoryURL", identity: "package", state: "state" }, | ||
| 2 => { url: "location", identity: "identity", state: "state" }, | ||
| 3 => { url: "location", identity: "identity", state: "state" } | ||
| }.freeze, | ||
| T::Hash[Integer, T::Hash[Symbol, String]] | ||
| ) | ||
|
|
||
| sig { params(resolved_file: Dependabot::DependencyFile).void } | ||
| def initialize(resolved_file) | ||
| @resolved_file = resolved_file | ||
| end | ||
|
|
||
| sig { returns(T::Array[Dependabot::Dependency]) } | ||
| def parse | ||
| parsed = parse_json | ||
| schema_version = detect_schema_version(parsed) | ||
| pins = extract_pins(parsed, schema_version) | ||
|
|
||
| pins.filter_map { |pin| build_dependency(pin, schema_version) } | ||
| end | ||
|
|
||
| private | ||
|
|
||
| sig { returns(Dependabot::DependencyFile) } | ||
| attr_reader :resolved_file | ||
|
|
||
| sig { returns(T::Hash[String, T.untyped]) } | ||
| def parse_json | ||
| content = resolved_file.content | ||
| unless content | ||
| raise Dependabot::DependencyFileNotParseable.new( | ||
| resolved_file.name, | ||
| "#{resolved_file.name} has no content" | ||
| ) | ||
| end | ||
|
|
||
| JSON.parse(content) | ||
| rescue JSON::ParserError => e | ||
| raise Dependabot::DependencyFileNotParseable.new( | ||
| resolved_file.name, | ||
| "#{resolved_file.name} is not valid JSON: #{e.message}" | ||
| ) | ||
| end | ||
|
|
||
| sig { params(parsed: T::Hash[String, T.untyped]).returns(Integer) } | ||
| def detect_schema_version(parsed) | ||
| version = parsed["version"] | ||
|
|
||
| unless version.is_a?(Integer) && SUPPORTED_VERSIONS.include?(version) | ||
| raise Dependabot::DependencyFileNotParseable.new( | ||
| resolved_file.name, | ||
| "#{resolved_file.name} has unsupported schema version: #{version.inspect}. " \ | ||
| "Supported versions: #{SUPPORTED_VERSIONS.join(', ')}" | ||
| ) | ||
| end | ||
|
|
||
| version | ||
| end | ||
|
|
||
| sig do | ||
| params( | ||
| parsed: T::Hash[String, T.untyped], | ||
| schema_version: Integer | ||
| ).returns(T::Array[T::Hash[String, T.untyped]]) | ||
| end | ||
| def extract_pins(parsed, schema_version) | ||
| pins = if schema_version == 1 | ||
| parsed.dig("object", "pins") | ||
| else | ||
| # v2 and v3 use the same top-level "pins" key | ||
| parsed["pins"] | ||
| end | ||
|
|
||
| unless pins.is_a?(Array) | ||
| raise Dependabot::DependencyFileNotParseable.new( | ||
| resolved_file.name, | ||
| "#{resolved_file.name} is missing the expected 'pins' array " \ | ||
| "(schema version #{schema_version})" | ||
| ) | ||
| end | ||
|
|
||
| pins | ||
| end | ||
|
|
||
| sig do | ||
| params( | ||
| pin: T::Hash[String, T.untyped], | ||
| schema_version: Integer | ||
| ).returns(T.nilable(Dependabot::Dependency)) | ||
| end | ||
| def build_dependency(pin, schema_version) | ||
| keys = T.must(PIN_KEYS[schema_version]) | ||
| url = pin[T.must(keys[:url])] | ||
| return nil unless url.is_a?(String) && !url.empty? | ||
|
|
||
| state = pin[T.must(keys[:state])] || {} | ||
| identity = pin[T.must(keys[:identity])] | ||
| # v1 uses a display name for "package"; normalize to lowercase like v2/v3 "identity". | ||
| # v2/v3 identity is always lowercase per spec, so only v1 needs downcasing. | ||
| identity = identity&.downcase if schema_version == 1 | ||
|
|
||
| build_dependency_object( | ||
| identity: identity, | ||
| url: url, | ||
| version: state["version"], | ||
| revision: state["revision"], | ||
| branch: state["branch"] | ||
| ) | ||
| end | ||
|
|
||
| sig do | ||
| params( | ||
| identity: T.nilable(String), | ||
| url: String, | ||
| version: T.nilable(String), | ||
| revision: T.nilable(String), | ||
| branch: T.nilable(String) | ||
| ).returns(T.nilable(Dependabot::Dependency)) | ||
| end | ||
| def build_dependency_object(identity:, url:, version:, revision:, branch:) | ||
| normalized_url = SharedHelpers.scp_to_standard(url) | ||
| name = UrlHelpers.normalize_name(normalized_url) | ||
| ref = version || revision | ||
|
|
||
| source = { type: "git", url: normalized_url, ref: ref, branch: branch } | ||
|
|
||
| Dependency.new( | ||
| name: name, | ||
| version: version, | ||
| package_manager: "swift", | ||
| requirements: [{ | ||
| requirement: version ? "= #{version}" : nil, | ||
| groups: ["dependencies"], | ||
| file: resolved_file.name, | ||
| source: source | ||
| }], | ||
| metadata: { identity: identity } | ||
| ) | ||
| end | ||
| end | ||
| end | ||
| end | ||
| end |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.