feat: Add option to use own NSURLSession for transport #3811

dKasabwala · 2024-04-01T20:51:50Z

…on configuration.
#skip-changelog

📜 Description

We are a current customer of sentry, and we use custom socks proxy on our end, we have no way to set up socks proxy for sentry services. we have added change to provide hook with URL Session.

💡 Support Socks proxy and private session configuration with custom SSL Certs.

Solve Custom SSL pinning
Provide support Socks Proxy

💚 How did you test it?

📝 Checklist

You have to check all boxes before merging:

I reviewed the submitted code.
I added tests to verify the changes.
No new PII added or SDK only sends newly added PII if sendDefaultPII is enabled.
I updated the docs if needed.
Review from the native team if needed.
No breaking change or entry added to the changelog.
No breaking change for hybrid SDKs or communicated to hybrid SDKs.

🔮 Next steps

…on configuration.

brustolin

This change is pretty simple and gives the user more power, which in my opinion make sense in here.

SentryOptions has a - (BOOL)validateOptions:(NSDictionary<NSString *, id> *)options didFailWithError:(NSError *_Nullable *_Nullable)error method that need to be updated to accommodate the new property.

We also need some tests to make sure the new property its being used properly.

Sources/Sentry/SentryTransportFactory.m

Sources/Sentry/Public/SentryOptions.h

dKasabwala · 2024-04-02T15:20:03Z

Added unit tests around new options for urlSession
updated - (BOOL)validateOptions:(NSDictionary<NSString *, id> *)options didFailWithError:(NSError *_Nullable *_Nullable)error
new property description been added as well.

philipphofmann

I pushed some updates for code docs for the options to this branch. Please add some tests @dKasabwala, as pointed out, and an entry to the Changelog.

Thanks for doing this 😃.

Sources/Sentry/SentryTransportFactory.m

codecov · 2024-04-03T13:20:44Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.743%. Comparing base (523915a) to head (4a7084e).

Additional details and impacted files

@@              Coverage Diff              @@
##              main     #3811       +/-   ##
=============================================
- Coverage   90.761%   90.743%   -0.019%     
=============================================
  Files          586       586               
  Lines        45754     45783       +29     
  Branches     16335     16333        -2     
=============================================
+ Hits         41527     41545       +18     
- Misses        4047      4168      +121     
+ Partials       180        70      -110

Files	Coverage Δ
Sources/Sentry/SentryOptions.m	`99.195% <100.000%> (+0.004%)`	⬆️
Sources/Sentry/SentryTransportFactory.m	`100.000% <100.000%> (ø)`
...Tests/Networking/SentryTransportFactoryTests.swift	`100.000% <100.000%> (ø)`
Tests/SentryTests/SentryOptionsTest.m	`98.619% <100.000%> (+0.012%)`	⬆️

... and 30 files with indirect coverage changes

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 523915a...4a7084e. Read the comment docs.

dKasabwala · 2024-05-03T20:22:42Z

@philipphofmann Please get this approved, All checks are complete, we do need these changes next release version.

philipphofmann

The unit tests in CI are failing because the unit test don't compile @dKasabwala. You can ignore the other failing CI jobs. They fail due to our CI setup.

…ry#3810) Bumps [codecov/codecov-action](https://github.com/codecov/codecov-action) from 3.1.5 to 4.1.1. - [Release notes](https://github.com/codecov/codecov-action/releases) - [Changelog](https://github.com/codecov/codecov-action/blob/main/CHANGELOG.md) - [Commits](codecov/codecov-action@4fe8c5f...c16abc2) --- updated-dependencies: - dependency-name: codecov/codecov-action dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

Fix NSInvalidArgumentException for NSError sentryErrorWithDomain by removing the category functions because they get stripped for static libraries. This is related to getsentryGH-3764. Fixes getsentryGH-3818

Again remove category functions to avoid NSInvalidArgumentException when including Sentry statically.

Add an option to exclude certain classes from swizzling. Fixes getsentryGH-3798

Fix a crash in SentryTracer hasUnfinishedChildSpansToWaitFor by not setting the shouldIgnoreWaitForChildrenCallback to nil when finishing the tracer. Fixes getsentryGH-3781

tl;dr; Fixed SentrySwiftUI Carthage build import. Since there is no modulemap for the SentrySwiftUI declaring exported submodules: For Carthage build make @_implementationOnly import SentryInternal. Import SentrySwiftUI xcframework Samples/Carthage-Validation/XCFramework project to check imports. Co-authored-by: Dhiogo Brustolin <[email protected]>

Add the timing API to measure the duration of a closure.

)

…try#3831)

Instead of capturing and serializing the transaction on the calling thread, the SDK now does this on a background thread. Fixes getsentryGH-3826

If there is no UIWindow available during SDK initialization, wait for a UISceneDidActivateNotification

This is a follow up on getsentry#3912.

) Bumps [dorny/paths-filter](https://github.com/dorny/paths-filter) from 3.0.0 to 3.0.2. - [Release notes](https://github.com/dorny/paths-filter/releases) - [Changelog](https://github.com/dorny/paths-filter/blob/master/CHANGELOG.md) - [Commits](dorny/paths-filter@0bc4621...de90cc6) --- updated-dependencies: - dependency-name: dorny/paths-filter dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

The release name passed to the app state from the options is nullable. The SentryAppState including the SentryWatchDogTerminationLogic couldn't handle this edge case correctly, which is fixed now.

The ThreadSanitizer reports data races for the SentryFramesTracker, which we can ignore. Fixes getsentryGH-3702

Ignore the thread sanitizer in the code where possible, which has the advantage of knowing a method is ignored when reading the code and not jumping to the ThreadSanitizer.sup file. Furthermore, use the ThreadSanitizer.sup file not only for tests but for the Run Xcode schemes.

Every log message needs to acquire a lock to evaluate whether the logger should log it. getsentry#3303 added this logic to fix a data race the thread sanitizer job found. As the SDK only calls the configure method when starting, we don't need to put a synchronized keyword around the code that evaluates the log level. This PR replaces the synchronized keyword by ignoring the thread sanitizer.

Move XCFrameworks zip files to the repository root folder after building so that you can compile the Carthage sample locally.

Use the text color or the average color of the image as the redaction mask. Co-authored-by: Philipp Hofmann <[email protected]>

…on configuration.

dKasabwala · 2024-05-06T14:31:33Z

Fix up compiler error

…o DK-Sentry-Session

philipphofmann

LGTM

Add an option to use their own NSURLSession for transports so users can configure a proxy and such. Fixes getsentryGH-3052 Co-authored-by: Philipp Hofmann <[email protected]>

[Updated] added Change to support SDK to socks proxy or private sessi…

5bd8c6d

…on configuration.

dKasabwala requested review from philipphofmann, brustolin and armcknight as code owners April 1, 2024 20:51

brustolin reviewed Apr 2, 2024

View reviewed changes

Sources/Sentry/SentryTransportFactory.m Outdated Show resolved Hide resolved

Sources/Sentry/Public/SentryOptions.h Outdated Show resolved Hide resolved

Dipak Kasabwala added 2 commits April 2, 2024 10:53

[Added] changed to resolve comment on pull request.

2ab0bb8

[added] unit test for sentry url session

f91f30b

kahest linked an issue Apr 3, 2024 that may be closed by this pull request

Add custom HTTPHeaders in URLRequest #3052

Closed

minor cleanup

aa37384

philipphofmann reviewed Apr 3, 2024

View reviewed changes

Sources/Sentry/SentryTransportFactory.m Show resolved Hide resolved

[Updated] Added Unit test to cover new property on sentry option.

52c06c5

philipphofmann reviewed May 6, 2024

View reviewed changes

dependabot bot and others added 15 commits May 6, 2024 10:28

fix: InvalidArgException for sentryErrorWithDomain (getsentry#3819)

10a2b61

Fix NSInvalidArgumentException for NSError sentryErrorWithDomain by removing the category functions because they get stripped for static libraries. This is related to getsentryGH-3764. Fixes getsentryGH-3818

Disable flaky testGetCaptureFailedRequestsEnabled (getsentry#3814)

86ac0c2

fix: Runtime error when including Sentry static (getsentry#3820)

f0685bb

Again remove category functions to avoid NSInvalidArgumentException when including Sentry statically.

feat: Add the option swizzleClassNameExcludes (getsentry#3813)

45ed870

Add an option to exclude certain classes from swizzling. Fixes getsentryGH-3798

fix: Crash in hasUnfinishedChildSpansToWaitFor (getsentry#3821)

92bd0a2

Fix a crash in SentryTracer hasUnfinishedChildSpansToWaitFor by not setting the shouldIgnoreWaitForChildrenCallback to nil when finishing the tracer. Fixes getsentryGH-3781

release: 8.23.0

f1db8e2

Update CHANGELOG.md

addb9c4

meta: Fix typos in DECISIONS.md (getsentry#3806)

900ea02

feat(metrics): Add timing API (getsentry#3812)

3b0ed49

Add the timing API to measure the duration of a closure.

ref: Remove duplicate code in NSDataTracker (getsentry#3828)

05aff89

ref: Delete dead code in SentryCrashMach (getsentry#3827)

1b5dd86

meta: add some config files to pbxproj and clean up list (getsentry#3830

fc63b66

)

feat(profiling): add private feature flag for continuous mode (getsen…

f6cfdb4

…try#3831)

philipphofmann and others added 19 commits May 6, 2024 10:28

impr: Capture transactions on a bg thread (getsentry#3892)

0149923

Instead of capturing and serializing the transaction on the calling thread, the SDK now does this on a background thread. Fixes getsentryGH-3826

fix: Start session replay without a UIWindow (getsentry#3911)

f244621

If there is no UIWindow available during SDK initialization, wait for a UISceneDidActivateNotification

fix: Remove boot_time from crash reports (getsentry#3916)

29e1554

This is a follow up on getsentry#3912.

chore: Changelog for 8.25.0 (getsentry#3917)

9525d38

release: 8.25.0

e714576

fix: Handle no releaseName in WatchdogLogic (getsentry#3919)

88d6701

The release name passed to the app state from the options is nullable. The SentryAppState including the SentryWatchDogTerminationLogic couldn't handle this edge case correctly, which is fixed now.

fix: Ignore FramesTracker thread data races (getsentry#3922)

67bf176

The ThreadSanitizer reports data races for the SentryFramesTracker, which we can ignore. Fixes getsentryGH-3702

date range to license - 2015-2024 (getsentry#3921)

14164a0

chore: Format code with clang-format 18.1.5 (getsentry#3935)

320e05b

test: compile sectors for test/testci for debug also (getsentry#3929)

9c7bc04

chore: Move XCFrameworks to root after building (getsentry#3766)

760edfa

Move XCFrameworks zip files to the repository root folder after building so that you can compile the Carthage sample locally.

ref: Use average color for redact masking (getsentry#3877)

d22006a

Use the text color or the average color of the image as the redaction mask. Co-authored-by: Philipp Hofmann <[email protected]>

[Updated] added Change to support SDK to socks proxy or private sessi…

9cb4cfc

…on configuration.

[Added] changed to resolve comment on pull request.

8d32a88

minor cleanup

5a23c8d

[Fixup] unit test

e6328de

Dipak Kasabwala and others added 2 commits May 6, 2024 10:45

Merge branch 'main' of https://github.com/dKasabwala/sentry-cocoa int…

0327dcf

…o DK-Sentry-Session

format code

be8f3c4

philipphofmann self-assigned this May 7, 2024

philipphofmann changed the title ~~[Updated] added Change to support socks proxy or private session configuration.~~ feat: Add option to use own NSURLSession for transport May 7, 2024

philipphofmann added 2 commits May 7, 2024 10:26

Merge branch 'main' into DK-Sentry-Session

1ff7ad7

changelog

4a7084e

philipphofmann approved these changes May 7, 2024

View reviewed changes

philipphofmann merged commit 99ab5d0 into getsentry:main May 7, 2024
63 of 68 checks passed

pquerner mentioned this pull request Jun 10, 2024

Add tunnel option (sets the url used by transport) #3583

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Add option to use own NSURLSession for transport #3811

feat: Add option to use own NSURLSession for transport #3811

dKasabwala commented Apr 1, 2024 •

edited by philipphofmann

Loading

brustolin left a comment

dKasabwala commented Apr 2, 2024

philipphofmann left a comment

codecov bot commented Apr 3, 2024 •

edited

Loading

dKasabwala commented May 3, 2024

philipphofmann left a comment

dKasabwala commented May 6, 2024

philipphofmann left a comment

feat: Add option to use own NSURLSession for transport #3811

feat: Add option to use own NSURLSession for transport #3811

Conversation

dKasabwala commented Apr 1, 2024 • edited by philipphofmann Loading

📜 Description

💡 Support Socks proxy and private session configuration with custom SSL Certs.

💚 How did you test it?

📝 Checklist

🔮 Next steps

brustolin left a comment

Choose a reason for hiding this comment

dKasabwala commented Apr 2, 2024

philipphofmann left a comment

Choose a reason for hiding this comment

codecov bot commented Apr 3, 2024 • edited Loading

Codecov Report

dKasabwala commented May 3, 2024

philipphofmann left a comment

Choose a reason for hiding this comment

dKasabwala commented May 6, 2024

philipphofmann left a comment

Choose a reason for hiding this comment

dKasabwala commented Apr 1, 2024 •

edited by philipphofmann

Loading

codecov bot commented Apr 3, 2024 •

edited

Loading