-
Notifications
You must be signed in to change notification settings - Fork 129
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
RUM-3060 feat: Deprecate Alamofire extension pod #1966
RUM-3060 feat: Deprecate Alamofire extension pod #1966
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice!
@@ -14,6 +19,8 @@ Pod::Spec.new do |s| | |||
"Maciej Burda" => "[email protected]" | |||
} | |||
|
|||
s.deprecated = true |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
do we need to publish a version in order deprecate?
Can we simply delete this? So when customer tries to update (it is customer trigger action) they see an error and fix the issue instead keep using the deprecated version.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We aim at deprecation not removal. The DatadogAlamofireExtension
will continue to work for all customers in next releases until we finally delete it (in 3.0.0
).
The deprecated = true
will produce a warning during pod update
indicating that this pod is being sunsetted. Customers are expected to follow the notice from pod description and land on https://docs.datadoghq.com/real_user_monitoring/mobile_and_tv_monitoring/integrated_libraries/ios (available once DataDog/documentation#24253 is merged) to instrument Alamofire using our URLSessionInstrumentation
directly.
What and why?
📦 Starting from 2.5.0, RUM can automatically track Alamofire requests, making the DatadogAlamofireExtension pod obsolete. Maintaining this pod is cumbersome as it adds an extra code path to the network instrumentation logic, which became problematic in issue #1638.
The new network instrumentation API introduced in 2.5.0 can handle Alamofire requests without requiring a separate pod. This solution also works for SPM, Carthage, and XCFramework integration. This PR deprecates DatadogAlamofireExtension in favor of the new instructions explained in the following documentation PR:
How?
DatadogAlamofireExtension.podspec
is marked deprecated;Review checklist