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

Remove curl dependency and disable OAuth Bearer SASL mechanism #155

Merged
merged 5 commits into from
Nov 18, 2024
Merged

Remove curl dependency and disable OAuth Bearer SASL mechanism #155

merged 5 commits into from
Nov 18, 2024

Conversation

FranzBusch
Copy link
Contributor

Motivation

The curl dependency is just necessary for the OAuth Bearer SASL mechanism. Let's remove that configuration option for now.

Modification

Removes the curl dependency.

@FranzBusch FranzBusch mentioned this pull request Dec 4, 2023
Open
blindspotbounty
blindspotbounty reviewed Dec 11, 2023
View reviewed changes
Sources/Kafka/Configuration/KafkaConfiguration+Security.swift
@@ -309,7 +309,7 @@ extension KafkaConfiguration {
}
}

public struct OAuthBearerMethod: Sendable, Hashable {
struct OAuthBearerMethod: Sendable, Hashable {
Copy link
Collaborator

Choose a reason for hiding this comment

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

Won't it be (formally) a breaking change if anyone uses that one for auth?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes it would but we haven't released a major yet so removing APIs is still possible. I would love to get the package into a state where we don't require system dependencies at all.

FranzBusch and others added 2 commits November 15, 2024 21:02
@FranzBusch @mimischi
Remove curl dependency and disable OAuth Bearer SASL mechanism
8e7b78e 
The curl dependency is just necessary for the OAuth Bearer SASL mechanism. Let's remove that configuration option for now.

Removes the curl dependency.
@mimischi
Remove duplicates ENABLE_CURL definition
ff579ee 
There's a couple more duplicated definitions.
@mimischi mimischi added the ⚠️ semver/major Breaks existing public API. label Nov 16, 2024
@mimischi
Copy link
Member

I can see that there's lots of duplicated #define statements in config.h. I don't think that's expected, is it?

These

swift-kafka-client/Sources/Crdkafka/custom/config/config.h

Lines 22 to 31 in ff579ee

#define ENABLE_ZLIB 1
#define ENABLE_ZSTD 1
#define ENABLE_SSL 1
#define ENABLE_GSSAPI 1
#define ENABLE_CURL 0
#define ENABLE_DEVEL 0
#define ENABLE_VALGRIND 0
#define ENABLE_REFCNT_DEBUG 0
#define ENABLE_LZ4_EXT 1
#define ENABLE_LZ4_EXT 1

are duplicated just a few lines below

swift-kafka-client/Sources/Crdkafka/custom/config/config.h

Lines 34 to 38 in ff579ee

#define ENABLE_ZLIB 1
#define ENABLE_ZSTD 1
#define ENABLE_SSL 1
#define ENABLE_GSSAPI 1
#define ENABLE_LZ4_EXT 1

ENABLE_LZ4_EXT is even defined three times in the above two segments. There's some more duplication further down in the file.

@mimischi
Set WITH_CURL=0
75f2bc8 
This took me a while. `ENABLE_CURL` and `WITH_CURL` are two different
definitions.
@mimischi
Copy link
Member

mimischi commented Nov 16, 2024 •
edited
Loading

This was confusing as heck, but I've got things to build locally at least. Turns out config.h defines both ENABLE_CURL and WITH_CURL—not something my brain was willing to differentiate right now. The former is only referenced in configure.libcurl, while WITH_CURL is all over the place and appears to control the inclusion of rdkafka_sasl_oauthbearer.c?

@mimischi
Copy link
Member

Oh fun, the build is still broken on Linux

@mimischi
Disable OAuth Bearer definitions
6e9e57b
@mimischi
Explicitly exclude files using cURL
73ea988 
Can't get things to compile without doing this. I'm either missing some
glaringly obvious flag I need to disable, or there's an issue with the
`librdkafka` version we are using when one tries to build without
`curl`.
FranzBusch
FranzBusch commented Nov 18, 2024
View reviewed changes
Package.swift
@@ -72,7 +78,6 @@ let package = Package(
.define("_GNU_SOURCE", to: "1"), // Fix build error for Swift 5.9 onwards
],
linkerSettings: [
.linkedLibrary("curl"),
.linkedLibrary("sasl2"),
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Should we remove this here as well then?

Copy link
Member

Choose a reason for hiding this comment

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

We can't get rid of sasl2, as that would disable the more generic SASL authentication mechanisms, like SASL/PLAIN.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Okay we should look into building libsassl with SwiftPM then to avoid the system dependency.

@FranzBusch FranzBusch merged commit ebfa094 into main Nov 18, 2024
23 checks passed
@FranzBusch FranzBusch deleted the fb-curl-optional branch November 18, 2024 10:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mimischi mimischi mimischi left review comments

@blindspotbounty blindspotbounty blindspotbounty approved these changes

Assignees
No one assigned
Labels
⚠️ semver/major Breaks existing public API.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@FranzBusch @mimischi @blindspotbounty