Skip to content

@W-18250548 add deprecation marker for signpost removal in upcoming release of 14.0 #3882

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 2 commits into from
Jun 27, 2025

Conversation

Crebs
Copy link
Contributor

@Crebs Crebs commented Jun 26, 2025

πŸ”§ Deprecate SFSDKInstrumentationHelper Ahead of Removal in v14.0

This PR marks SFSDKInstrumentationHelper as deprecated in preparation for its removal in version 14.0.

πŸ“Œ Context
β€’ The class was originally introduced to support internal signpost-based debugging/logging.
β€’ There is no known customer usage of this functionality.
β€’ We’re moving to remove unnecessary internal tooling from the SDK surface.

🧱 Changes
β€’ Added attribute((deprecated)) to the SFSDKInstrumentationHelper interface.
β€’ Included an Xcode-friendly doc comment (@deprecated) for visibility in IDEs.

βœ… Why This Matters
β€’ Prevents client teams from relying on an internal-only utility.
β€’ Provides a clear warning and migration window before permanent removal.
β€’ Keeps the public API lean and maintainable.

🚫 No Breaking Changes
β€’ This class was not meant for external use.
β€’ Client apps not referencing SFSDKInstrumentationHelper will see no impact.

Copy link

codecov bot commented Jun 26, 2025

Codecov Report

All modified and coverable lines are covered by tests βœ…

Project coverage is 62.50%. Comparing base (ee533a6) to head (9ab80f1).
Report is 3 commits behind head on dev.

Additional details and impacted files
@@            Coverage Diff             @@
##              dev    #3882      +/-   ##
==========================================
+ Coverage   62.48%   62.50%   +0.01%     
==========================================
  Files         247      247              
  Lines       22311    22311              
==========================================
+ Hits        13942    13945       +3     
+ Misses       8369     8366       -3     
Components Coverage Ξ”
Analytics 70.78% <ΓΈ> (ΓΈ)
Common 69.39% <ΓΈ> (ΓΈ)
Core 52.33% <ΓΈ> (+0.02%) ⬆️
SmartStore 73.66% <ΓΈ> (ΓΈ)
MobileSync 87.66% <ΓΈ> (ΓΈ)

see 2 files with indirect coverage changes

πŸš€ New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@@ -30,6 +30,8 @@
NS_ASSUME_NONNULL_BEGIN

NS_SWIFT_NAME(SalesforceInstrumentationHelper)
/// @deprecated Signpost logging is deprecated and this helper will be removed in version 14.0.
__attribute__((deprecated("Signpost logging is deprecated and will be removed in version 14.0")));
Copy link
Member

Choose a reason for hiding this comment

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

Is it possible to use the SFSDK_DEPRECATED macro instead?

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

@Crebs Crebs merged commit ad0ecdb into forcedotcom:dev Jun 27, 2025
19 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants