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

Jump to bottom

Fix registry package swizzling when package name casing differs #8194

Merged
merged 3 commits into from
Jan 21, 2025
Merged

Fix registry package swizzling when package name casing differs #8194

merged 3 commits into from
Jan 21, 2025
+68 −4

Conversation

fortmarek
Copy link
Contributor

Fix registry package swizzling when package name casing differs

Motivation:

When swizzling dependencies when running swift package --replace-scm-with-registry resolve, package references that have different casing don't get swizzled.

You can find an example of this scenario in the Firebase SDK that boils down to:

import PackageDescription


let package = Package(
  name: "Firebase",
  dependencies: [
    .package(
      url: "https://github.com/google/promises.git", // lowercase
      "2.4.0" ..< "3.0.0"
    ),
  ],
  targets: [
    .target(
      name: "FirebaseCrashlytics",
      dependencies: [
        .product(name: "FBLPromises", package: "Promises"), // uppercase
      ]
    )
  ]
)

The .product(name: "FBLPromises", package: "Promises")should be swizzled to use the google.promises identifier, but because of the different casing, it's not.

Modifications:

When creating the map for packages to be swizzled, make the key lowercase. When we access the map, we again use a lowercase variant of the package name, so we don't unexpectedly miss an entry because of a different casing.

Result:

Packages with different casing are swizzled when using the swift package --replace-scm-with-registry resolve command.

@MaxDesiatov
Copy link
Contributor

@swift-ci test

plemarquand
plemarquand requested changes Jan 3, 2025
View reviewed changes
Copy link
Contributor

@plemarquand plemarquand left a comment

Choose a reason for hiding this comment

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

Thanks for the patch, appreciate the contribution! I just have one small comment.

Sources/Workspace/Workspace+Registry.swift Show resolved Hide resolved
@plemarquand
Copy link
Contributor

@swift-ci please test

@plemarquand
Copy link
Contributor

@swift-ci test

@fortmarek fortmarek requested a review from plemarquand January 7, 2025 17:24
@fortmarek
Copy link
Contributor Author

Hey @plemarquand 👋

Is there anything blocking the merge of this PR?

@plemarquand
Copy link
Contributor

@fortmarek so sorry, this fell off my queue! I've kicked off the windows tests and enabled auto merge.

@plemarquand
Copy link
Contributor

@swift-ci test windows

@plemarquand plemarquand enabled auto-merge (squash) January 20, 2025 11:52
@fortmarek
Copy link
Contributor Author

so sorry, this fell off my queue! I've kicked off the windows tests and enabled auto merge.

No worries, thanks for taking a look! 🙇‍♂️

@plemarquand
Copy link
Contributor

@swift-ci test windows

@plemarquand
Copy link
Contributor

@fortmarek CI was down this morning, the windows tests should be running now.

@plemarquand plemarquand merged commit 6106361 into swiftlang:main Jan 21, 2025
5 checks passed
plemarquand pushed a commit to plemarquand/swift-package-manager that referenced this pull request Jan 21, 2025
@fortmarek @plemarquand
Fix registry package swizzling when package name casing differs (swif…
918ffa7 
…tlang#8194)
@plemarquand plemarquand mentioned this pull request Jan 21, 2025
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@plemarquand plemarquand plemarquand approved these changes

@pepicrft pepicrft pepicrft approved these changes

@bnbarham bnbarham Awaiting requested review from bnbarham bnbarham is a code owner

@MaxDesiatov MaxDesiatov Awaiting requested review from MaxDesiatov MaxDesiatov is a code owner

@jakepetroules jakepetroules Awaiting requested review from jakepetroules jakepetroules is a code owner

@francescomikulis francescomikulis Awaiting requested review from francescomikulis francescomikulis is a code owner

@xedin xedin Awaiting requested review from xedin xedin is a code owner

@dschaefer2 dschaefer2 Awaiting requested review from dschaefer2 dschaefer2 is a code owner

@shawnhyam shawnhyam Awaiting requested review from shawnhyam shawnhyam is a code owner

@bripeticca bripeticca Awaiting requested review from bripeticca bripeticca is a code owner

@owenv owenv Awaiting requested review from owenv owenv is a code owner

@bkhouri bkhouri Awaiting requested review from bkhouri bkhouri is a code owner

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@fortmarek @MaxDesiatov @plemarquand @pepicrft