|
| 1 | +# typed: strict |
| 2 | +# frozen_string_literal: true |
| 3 | + |
| 4 | +require "json" |
| 5 | +require "sorbet-runtime" |
| 6 | +require "dependabot/dependency" |
| 7 | +require "dependabot/dependency_file" |
| 8 | +require "dependabot/errors" |
| 9 | +require "dependabot/shared_helpers" |
| 10 | +require "dependabot/file_updaters" |
| 11 | +require "dependabot/file_updaters/base" |
| 12 | +require "dependabot/swift/url_helpers" |
| 13 | + |
| 14 | +module Dependabot |
| 15 | + module Swift |
| 16 | + class FileUpdater < Dependabot::FileUpdaters::Base |
| 17 | + class XcodeLockfileUpdater |
| 18 | + extend T::Sig |
| 19 | + |
| 20 | + SUPPORTED_VERSIONS = T.let([1, 2, 3].freeze, T::Array[Integer]) |
| 21 | + |
| 22 | + # Maps schema version to the JSON keys used for each pin field |
| 23 | + PIN_KEYS = T.let( |
| 24 | + { |
| 25 | + 1 => { url: "repositoryURL", identity: "package", pins_path: %w(object pins) }, |
| 26 | + 2 => { url: "location", identity: "identity", pins_path: ["pins"] }, |
| 27 | + 3 => { url: "location", identity: "identity", pins_path: ["pins"] } |
| 28 | + }.freeze, |
| 29 | + T::Hash[Integer, T::Hash[Symbol, T.untyped]] |
| 30 | + ) |
| 31 | + |
| 32 | + sig do |
| 33 | + params( |
| 34 | + resolved_file: Dependabot::DependencyFile, |
| 35 | + dependencies: T::Array[Dependabot::Dependency] |
| 36 | + ).void |
| 37 | + end |
| 38 | + def initialize(resolved_file:, dependencies:) |
| 39 | + @resolved_file = resolved_file |
| 40 | + @dependencies = dependencies |
| 41 | + end |
| 42 | + |
| 43 | + sig { returns(String) } |
| 44 | + def updated_lockfile_content |
| 45 | + content = resolved_file.content |
| 46 | + unless content |
| 47 | + raise Dependabot::DependencyFileNotParseable.new( |
| 48 | + resolved_file.name, |
| 49 | + "#{resolved_file.name} has no content" |
| 50 | + ) |
| 51 | + end |
| 52 | + |
| 53 | + parsed = parse_json(content) |
| 54 | + schema_version = detect_schema_version(parsed) |
| 55 | + keys = T.must(PIN_KEYS[schema_version]) |
| 56 | + |
| 57 | + update_pins(parsed, schema_version, keys) |
| 58 | + |
| 59 | + # Use JSON.pretty_generate to match Xcode's output format: |
| 60 | + # - 2-space indentation |
| 61 | + # - space before colon (e.g., "key" : "value") |
| 62 | + JSON.pretty_generate( |
| 63 | + parsed, |
| 64 | + indent: " ", |
| 65 | + space: " ", |
| 66 | + space_before: " ", |
| 67 | + object_nl: "\n", |
| 68 | + array_nl: "\n" |
| 69 | + ) + "\n" |
| 70 | + end |
| 71 | + |
| 72 | + sig { returns(T::Boolean) } |
| 73 | + def lockfile_changed? |
| 74 | + dependencies_for_file.any? |
| 75 | + end |
| 76 | + |
| 77 | + private |
| 78 | + |
| 79 | + sig { returns(Dependabot::DependencyFile) } |
| 80 | + attr_reader :resolved_file |
| 81 | + |
| 82 | + sig { returns(T::Array[Dependabot::Dependency]) } |
| 83 | + attr_reader :dependencies |
| 84 | + |
| 85 | + sig { params(content: String).returns(T::Hash[String, T.untyped]) } |
| 86 | + def parse_json(content) |
| 87 | + JSON.parse(content) |
| 88 | + rescue JSON::ParserError => e |
| 89 | + raise Dependabot::DependencyFileNotParseable.new( |
| 90 | + resolved_file.name, |
| 91 | + "#{resolved_file.name} is not valid JSON: #{e.message}" |
| 92 | + ) |
| 93 | + end |
| 94 | + |
| 95 | + sig { params(parsed: T::Hash[String, T.untyped]).returns(Integer) } |
| 96 | + def detect_schema_version(parsed) |
| 97 | + version = parsed["version"] |
| 98 | + |
| 99 | + unless version.is_a?(Integer) && SUPPORTED_VERSIONS.include?(version) |
| 100 | + raise Dependabot::DependencyFileNotParseable.new( |
| 101 | + resolved_file.name, |
| 102 | + "#{resolved_file.name} has unsupported schema version: #{version.inspect}. " \ |
| 103 | + "Supported versions: #{SUPPORTED_VERSIONS.join(', ')}" |
| 104 | + ) |
| 105 | + end |
| 106 | + |
| 107 | + version |
| 108 | + end |
| 109 | + |
| 110 | + sig do |
| 111 | + params( |
| 112 | + parsed: T::Hash[String, T.untyped], |
| 113 | + schema_version: Integer, |
| 114 | + keys: T::Hash[Symbol, T.untyped] |
| 115 | + ).void |
| 116 | + end |
| 117 | + def update_pins(parsed, schema_version, keys) |
| 118 | + pins_path = T.cast(keys[:pins_path], T::Array[String]) |
| 119 | + pins = dig_pins(parsed, pins_path) |
| 120 | + |
| 121 | + unless pins.is_a?(Array) |
| 122 | + raise Dependabot::DependencyFileNotParseable.new( |
| 123 | + resolved_file.name, |
| 124 | + "#{resolved_file.name} is missing the expected 'pins' array " \ |
| 125 | + "(schema version #{schema_version})" |
| 126 | + ) |
| 127 | + end |
| 128 | + |
| 129 | + dependencies_for_file.each do |dep| |
| 130 | + update_pin_for_dependency(pins, dep, keys, schema_version) |
| 131 | + end |
| 132 | + end |
| 133 | + |
| 134 | + sig do |
| 135 | + params( |
| 136 | + parsed: T::Hash[String, T.untyped], |
| 137 | + path: T::Array[String] |
| 138 | + ).returns(T.untyped) |
| 139 | + end |
| 140 | + def dig_pins(parsed, path) |
| 141 | + # Navigate nested hash using path keys |
| 142 | + # Path is either ["object", "pins"] for v1 or ["pins"] for v2/v3 |
| 143 | + current = T.let(parsed, T.untyped) |
| 144 | + path.each do |key| |
| 145 | + break unless current.is_a?(Hash) |
| 146 | + |
| 147 | + current = current[key] |
| 148 | + end |
| 149 | + current |
| 150 | + end |
| 151 | + |
| 152 | + sig do |
| 153 | + params( |
| 154 | + pins: T::Array[T::Hash[String, T.untyped]], |
| 155 | + dependency: Dependabot::Dependency, |
| 156 | + keys: T::Hash[Symbol, T.untyped], |
| 157 | + schema_version: Integer |
| 158 | + ).void |
| 159 | + end |
| 160 | + def update_pin_for_dependency(pins, dependency, keys, schema_version) |
| 161 | + pin = find_pin_for_dependency(pins, dependency, keys, schema_version) |
| 162 | + return unless pin |
| 163 | + |
| 164 | + state = pin["state"] |
| 165 | + return unless state.is_a?(Hash) |
| 166 | + |
| 167 | + source = dependency.requirements.first&.dig(:source) |
| 168 | + new_version = dependency.version |
| 169 | + new_ref = source&.dig(:ref) |
| 170 | + |
| 171 | + if new_version |
| 172 | + state["version"] = new_version |
| 173 | + # When updating to a new version, update revision if provided in source |
| 174 | + # The ref from source is typically the git SHA corresponding to the version tag |
| 175 | + state["revision"] = new_ref if new_ref && looks_like_sha?(new_ref) |
| 176 | + elsif new_ref |
| 177 | + # Revision-only update (no version, just SHA) |
| 178 | + state["revision"] = new_ref |
| 179 | + state.delete("version") |
| 180 | + end |
| 181 | + end |
| 182 | + |
| 183 | + sig { params(str: String).returns(T::Boolean) } |
| 184 | + def looks_like_sha?(str) |
| 185 | + str.match?(/\A[0-9a-f]{40}\z/i) |
| 186 | + end |
| 187 | + |
| 188 | + sig do |
| 189 | + params( |
| 190 | + pins: T::Array[T::Hash[String, T.untyped]], |
| 191 | + dependency: Dependabot::Dependency, |
| 192 | + keys: T::Hash[Symbol, T.untyped], |
| 193 | + schema_version: Integer |
| 194 | + ).returns(T.nilable(T::Hash[String, T.untyped])) |
| 195 | + end |
| 196 | + def find_pin_for_dependency(pins, dependency, keys, schema_version) |
| 197 | + identity_key = T.cast(keys[:identity], String) |
| 198 | + url_key = T.cast(keys[:url], String) |
| 199 | + identity = dependency.metadata[:identity] |
| 200 | + |
| 201 | + pins.find do |pin| |
| 202 | + pin_identity = pin[identity_key] |
| 203 | + pin_identity = pin_identity&.downcase if schema_version == 1 |
| 204 | + |
| 205 | + if identity && pin_identity == identity |
| 206 | + true |
| 207 | + else |
| 208 | + # Fall back to URL matching |
| 209 | + pin_url = pin[url_key] |
| 210 | + next false unless pin_url.is_a?(String) |
| 211 | + |
| 212 | + normalized_pin_url = SharedHelpers.scp_to_standard(pin_url) |
| 213 | + pin_name = UrlHelpers.normalize_name(normalized_pin_url) |
| 214 | + |
| 215 | + pin_name == dependency.name |
| 216 | + end |
| 217 | + end |
| 218 | + end |
| 219 | + |
| 220 | + sig { returns(T::Array[Dependabot::Dependency]) } |
| 221 | + def dependencies_for_file |
| 222 | + @dependencies_for_file ||= T.let( |
| 223 | + dependencies.select do |dep| |
| 224 | + dep.requirements.any? do |req| |
| 225 | + req_file = req[:file] |
| 226 | + if req_file == resolved_file.name |
| 227 | + true |
| 228 | + elsif req_file&.include?(".xcodeproj/") |
| 229 | + # Extract the xcodeproj dir from both files and compare |
| 230 | + req_xcodeproj = extract_xcodeproj_dir(req_file) |
| 231 | + resolved_xcodeproj = extract_xcodeproj_dir(resolved_file.name) |
| 232 | + req_xcodeproj && req_xcodeproj == resolved_xcodeproj |
| 233 | + else |
| 234 | + false |
| 235 | + end |
| 236 | + end |
| 237 | + end, |
| 238 | + T.nilable(T::Array[Dependabot::Dependency]) |
| 239 | + ) |
| 240 | + end |
| 241 | + |
| 242 | + # Extracts the .xcodeproj directory from a file path. |
| 243 | + # e.g. "MyApp.xcodeproj/project.xcworkspace/.../Package.resolved" -> "MyApp.xcodeproj" |
| 244 | + sig { params(path: String).returns(T.nilable(String)) } |
| 245 | + def extract_xcodeproj_dir(path) |
| 246 | + match = path.match(%r{^(.*?\.xcodeproj)/}) |
| 247 | + match&.captures&.first |
| 248 | + end |
| 249 | + end |
| 250 | + end |
| 251 | + end |
| 252 | +end |
0 commit comments