fix: Finish transaction for external view controllers #3440

brustolin · 2023-11-22T09:44:39Z

📜 Description

View controllers from frameworks in inAppIncludes option are not being swizzled, and so, their transactions are not being closed, but we do start the transaction, because start happens with swizzling of UIViewController.

💡 Motivation and Context

close #3434

💚 How did you test it?

Sample, Unit Test

📝 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

…try-cocoa into fiz/external-lib-swizzling

github-actions · 2023-11-22T10:31:02Z

Performance metrics 🚀

	Plain	With Sentry	Diff
Startup time	1260.08 ms	1280.14 ms	20.06 ms
Size	22.85 KiB	413.98 KiB	391.13 KiB

Baseline results on branch: main

Startup times

Revision	Plain	With Sentry	Diff
`d8eb419`	1221.91 ms	1253.62 ms	31.71 ms
`e324230`	1254.92 ms	1262.92 ms	8.00 ms
`6e342ac`	1202.98 ms	1228.74 ms	25.76 ms
`596ccc1`	1230.85 ms	1244.24 ms	13.39 ms
`4fc7fdf`	1236.69 ms	1242.80 ms	6.11 ms
`591a01b`	1242.69 ms	1259.98 ms	17.29 ms
`6943de0`	1215.83 ms	1253.22 ms	37.39 ms
`fdfe96b`	1227.90 ms	1242.56 ms	14.66 ms
`dbc67d2`	1239.49 ms	1248.88 ms	9.39 ms
`e79ead7`	1233.39 ms	1255.52 ms	22.13 ms

App size

Revision	Plain	With Sentry	Diff
`d8eb419`	22.85 KiB	408.87 KiB	386.02 KiB
`e324230`	22.85 KiB	408.88 KiB	386.03 KiB
`6e342ac`	20.76 KiB	436.66 KiB	415.90 KiB
`596ccc1`	22.84 KiB	401.44 KiB	378.60 KiB
`4fc7fdf`	20.76 KiB	436.25 KiB	415.49 KiB
`591a01b`	22.84 KiB	401.67 KiB	378.83 KiB
`6943de0`	20.76 KiB	393.33 KiB	372.57 KiB
`fdfe96b`	20.76 KiB	419.70 KiB	398.95 KiB
`dbc67d2`	20.76 KiB	427.74 KiB	406.98 KiB
`e79ead7`	20.76 KiB	426.11 KiB	405.35 KiB

Previous results on branch: fiz/external-lib-swizzling

Startup times

Revision	Plain	With Sentry	Diff
`6e6e3e2`	1241.96 ms	1247.32 ms	5.36 ms
`be7f054`	1370.04 ms	1371.65 ms	1.61 ms
`feef17b`	1228.65 ms	1253.61 ms	24.97 ms
`91f07c2`	1253.82 ms	1261.12 ms	7.30 ms
`cb30d90`	1230.52 ms	1247.55 ms	17.03 ms
`af83051`	1226.14 ms	1245.22 ms	19.08 ms
`83e2ce0`	1221.55 ms	1238.16 ms	16.61 ms
`3ba22d7`	1223.59 ms	1241.36 ms	17.77 ms
`b61f614`	1248.20 ms	1262.60 ms	14.40 ms

App size

Revision	Plain	With Sentry	Diff
`6e6e3e2`	22.85 KiB	413.75 KiB	390.91 KiB
`be7f054`	22.85 KiB	413.88 KiB	391.03 KiB
`feef17b`	22.85 KiB	414.00 KiB	391.15 KiB
`91f07c2`	22.85 KiB	413.87 KiB	391.02 KiB
`cb30d90`	22.85 KiB	413.81 KiB	390.96 KiB
`af83051`	22.85 KiB	414.00 KiB	391.15 KiB
`83e2ce0`	22.85 KiB	413.77 KiB	390.92 KiB
`3ba22d7`	22.85 KiB	413.98 KiB	391.13 KiB
`b61f614`	22.85 KiB	413.81 KiB	390.96 KiB

kahest

I'll leave the detailled reviews to @armcknight and @philipphofmann, but we shouldn't rush this

Sources/Sentry/SentryBinaryImageCache.m

Sources/Sentry/SentrySDK.m

codecov · 2023-11-22T10:57:05Z

Codecov Report

Merging #3440 (ecb0372) into main (b064665) will decrease coverage by 0.001%.
Report is 10 commits behind head on main.
The diff coverage is 98.837%.

Additional details and impacted files

@@              Coverage Diff              @@
##              main     #3440       +/-   ##
=============================================
- Coverage   89.019%   89.018%   -0.001%     
=============================================
  Files          525       525               
  Lines        56590     56634       +44     
  Branches     20365     20383       +18     
=============================================
+ Hits         50376     50415       +39     
- Misses        5298      5302        +4     
- Partials       916       917        +1

Files	Coverage Δ
Sources/Sentry/SentryBinaryImageCache.m	`100.000% <100.000%> (ø)`
Sources/Sentry/SentryInAppLogic.m	`100.000% <100.000%> (ø)`
...rces/Sentry/SentryPerformanceTrackingIntegration.m	`100.000% <100.000%> (ø)`
Sources/Sentry/SentrySDK.m	`90.000% <100.000%> (ø)`
Sources/Sentry/SentryUIViewControllerSwizzling.m	`87.732% <100.000%> (+0.775%)`	⬆️
...ests/SentryTests/SentryBinaryImageCacheTests.swift	`100.000% <100.000%> (ø)`
...troller/SentryUIViewControllerSwizzlingTests.swift	`98.431% <97.500%> (-0.393%)`	⬇️

... and 14 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 b064665...ecb0372. Read the comment docs.

philipphofmann

The PR looks great. Thanks for fixing this. There are some issues to address before we can merge this @brustolin.

Samples/iOS-Swift/iOS-Swift/AppDelegate.swift

SentryTestUtils/ExternalUIViewController.swift

Sources/Sentry/SentrySDK.m

Sources/Sentry/SentryUIViewControllerSwizzling.m

Sources/Sentry/SentryBinaryImageCache.m

Sources/Sentry/SentryUIViewControllerSwizzling.m

...ryTests/Integrations/Performance/UIViewController/SentryUIViewControllerSwizzlingTests.swift

…try-cocoa into fiz/external-lib-swizzling

Sources/Sentry/SentryUIViewControllerSwizzling.m

Sources/Sentry/SentryBinaryImageCache.m

Sources/Sentry/SentryUIViewControllerSwizzling.m

armcknight

Some quick questions/suggestions!

armcknight · 2023-11-28T01:01:03Z

...ryTests/Integrations/Performance/UIViewController/SentryUIViewControllerSwizzlingTests.swift


        init() {
            subClassFinder = TestSubClassFinder(dispatchQueue: dispatchQueue, objcRuntimeWrapper: objcRuntimeWrapper)
+            binaryImageCache = SentryDependencyContainer.sharedInstance().binaryImageCache


What's the point of doing this? Why add another parameter to SentryUIViewControllerSwizzling where it was already using the singleton from SentryDependencyContainer, just to assign it to the same value again in these tests? It's not even accessed anywhere in the tests.

Following @philipphofmann suggestion to use injection in the constructor instead of making direct use of SentryDependencyContainer

Yep, that's following our decision on how to handle dependency injection. I'm a fan of specifying all dependencies via their constructor to improve testability. If you disagree, I'm happy to discuss this again, but not here in this PR 😃

i mean, we're not injecting anything, we just added it and aren't using it. yagni, do this if/when we actually need to inject a mock

Sentry.xcodeproj/project.pbxproj

armcknight · 2023-11-28T01:13:04Z

...ryTests/Integrations/Performance/UIViewController/SentryUIViewControllerSwizzlingTests.swift

+        //To finish the transaction we need to finish `initialDisplay` span
+        //by calling `viewWillAppear` and reporting a new frame
+        controller.viewWillAppear(false)
+        Dynamic(SentryDependencyContainer.sharedInstance().framesTracker).reportNewFrame()


Is this to cause SentryTimeToDisplayTracker.framesTrackerHasNewFrame to be called, ending the span it's managing? If so, please mention it here, or whatever other side effect is desired.

It does not call SentryTimeToDisplayTracker.framesTrackerHasNewFrame it calls SentryTimeToDisplayTracker.reportNewFrame which cause SentryTimeToDisplayTracker to report a new frame to all its delegate. This desired side effect is described in the comment above.

So the reason I asked about SentryTimeToDisplayTracker.framesTrackerHasNewFrame is because when I looked at SentryTimeToDisplayTracker.reportNewFrame and clicked through to the delegate call, the only option that comes up is SentryTimeToDisplayTracker.framesTrackerHasNewFrame:

So either we're both right or there's something else going on? Please let us know the mechanism.

Yes, you're right, I misread the class name you wrote. reportNewFrame is a function of SentryFramesTracker that will call framesTrackerHasNewFrame from its delegates.

philipphofmann

LGTM, after you either include or ditch my suggestion to extract the logic of calling hasPrefix to a function in #3452.

armcknight

Please do not merge the change declaring SentryTestUtils as a dynamic lib, as it breaks our ability to run some unit tests locally. Or let me know if that's not the case for anyone else, and I can look into why it's happening on my machine.

Add method isImageNameInApp to SentryInAppLogic, so both SentryInAppLogic and SentryBinaryImageCache use the same code. Co-authored-by: Andrew McKnight <[email protected]>

Solved already. Thanks for pointing this out.

...ryTests/Integrations/Performance/UIViewController/SentryUIViewControllerSwizzlingTests.swift

…ntryUIViewControllerSwizzlingTests.swift

github-actions · 2023-11-29T13:01:14Z

	Fails
🚫	Please consider adding a changelog entry for the next release.

Instructions and example for changelog

Please add an entry to CHANGELOG.md to the "Unreleased" section. Make sure the entry includes this PR's number.

Example:

## Unreleased

- Finish transaction for external view controllers ([#3440](https://github.com/getsentry/sentry-cocoa/pull/3440))

If none of the above apply, you can opt out of this check by adding #skip-changelog to the PR description.

Generated by 🚫 dangerJS against 527e6fc

Move Finish transaction for external view controllers (#3440) up to unreleased

brustolin added 2 commits November 22, 2023 10:38

fix: External view controller transactions not finished

cf9f8da

Update ExternalUIViewController.swift

24839d4

brustolin requested review from philipphofmann and armcknight as code owners November 22, 2023 09:44

brustolin and others added 5 commits November 22, 2023 10:46

Merge branch 'main' into fiz/external-lib-swizzling

a9cc9a8

Update CHANGELOG.md

c441887

Merge branch 'fiz/external-lib-swizzling' of github.com:getsentry/sen…

2c5f1f5

…try-cocoa into fiz/external-lib-swizzling

Update CHANGELOG.md

a236c95

Update SentryUIViewControllerSwizzlingTests.swift

a60eff5

kahest reviewed Nov 22, 2023

View reviewed changes

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

Sources/Sentry/SentrySDK.m Show resolved Hide resolved

brustolin and others added 4 commits November 22, 2023 12:21

Update project.pbxproj

58708cf

Update project.pbxproj

ce79a00

Update no-changes-in-high-risk-files.sh

cd449ad

Merge branch 'main' into fiz/external-lib-swizzling

bd6b7ce

philipphofmann reviewed Nov 22, 2023

View reviewed changes

brustolin and others added 4 commits November 23, 2023 12:20

refs

bfbf299

Format code

9ef9f2d

lint

c0c330e

Merge branch 'fiz/external-lib-swizzling' of github.com:getsentry/sen…

cff8050

…try-cocoa into fiz/external-lib-swizzling

philipphofmann reviewed Nov 24, 2023

View reviewed changes

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

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

brustolin commented Nov 24, 2023

View reviewed changes

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

brustolin and others added 2 commits November 24, 2023 11:07

Apply suggestions from code review

ed603af

Format code

00668a1

brustolin commented Nov 24, 2023

View reviewed changes

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

brustolin and others added 3 commits November 24, 2023 11:52

Update Sources/Sentry/SentryUIViewControllerSwizzling.m

49bfca6

Update no-changes-in-high-risk-files.sh

129c342

search lib

0141922

armcknight reviewed Nov 28, 2023

View reviewed changes

brustolin requested a review from philipphofmann November 28, 2023 10:54

philipphofmann mentioned this pull request Nov 28, 2023

ref: Extract checking image name inApp #3452

Merged

philipphofmann approved these changes Nov 28, 2023

View reviewed changes

armcknight previously requested changes Nov 28, 2023

View reviewed changes

philipphofmann and others added 2 commits November 29, 2023 10:08

ref: Extract checking image name inApp (#3452)

10fc126

Add method isImageNameInApp to SentryInAppLogic, so both SentryInAppLogic and SentryBinaryImageCache use the same code. Co-authored-by: Andrew McKnight <[email protected]>

Extra test framework

8e7f7a0

getsentry-bot and others added 3 commits November 29, 2023 10:33

Format code

ea2c5ea

Update project.pbxproj

b17cbd7

Update project.pbxproj

ecb0372

brustolin commented Nov 29, 2023

View reviewed changes

...ryTests/Integrations/Performance/UIViewController/SentryUIViewControllerSwizzlingTests.swift Show resolved Hide resolved

Update Tests/SentryTests/Integrations/Performance/UIViewController/Se…

527e6fc

…ntryUIViewControllerSwizzlingTests.swift

brustolin merged commit 8b39743 into main Nov 29, 2023
44 of 45 checks passed

brustolin deleted the fiz/external-lib-swizzling branch November 29, 2023 13:00

philipphofmann added a commit that referenced this pull request Nov 30, 2023

Fix CHANGELOG.md

469456f

Move Finish transaction for external view controllers (#3440) up to unreleased

philipphofmann mentioned this pull request Nov 30, 2023

Fix CHANGELOG.md #3467

Merged

philipphofmann added a commit that referenced this pull request Nov 30, 2023

Fix CHANGELOG.md (#3467)

24c239b

Move Finish transaction for external view controllers (#3440) up to unreleased

philipphofmann mentioned this pull request Jun 17, 2024

Validate inAppIncludes/inAppExcludes behavior in a sample app #3871

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: Finish transaction for external view controllers #3440

fix: Finish transaction for external view controllers #3440

brustolin commented Nov 22, 2023

github-actions bot commented Nov 22, 2023 •

edited

Loading

Baseline results on branch: main

Startup times

App size

Previous results on branch: fiz/external-lib-swizzling

Startup times

App size

kahest left a comment

codecov bot commented Nov 22, 2023 •

edited

Loading

philipphofmann left a comment •

edited

Loading

armcknight left a comment

armcknight Nov 28, 2023

brustolin Nov 28, 2023

philipphofmann Nov 28, 2023

armcknight Nov 28, 2023

armcknight Nov 28, 2023

brustolin Nov 28, 2023

armcknight Nov 28, 2023 •

edited

Loading

brustolin Nov 29, 2023 •

edited

Loading

philipphofmann left a comment

armcknight left a comment

github-actions bot commented Nov 29, 2023

fix: Finish transaction for external view controllers #3440

fix: Finish transaction for external view controllers #3440

Conversation

brustolin commented Nov 22, 2023

📜 Description

💡 Motivation and Context

💚 How did you test it?

📝 Checklist

🔮 Next steps

github-actions bot commented Nov 22, 2023 • edited Loading

Performance metrics 🚀

Baseline results on branch: main

Startup times

App size

Previous results on branch: fiz/external-lib-swizzling

Startup times

App size

kahest left a comment

Choose a reason for hiding this comment

codecov bot commented Nov 22, 2023 • edited Loading

Codecov Report

philipphofmann left a comment • edited Loading

Choose a reason for hiding this comment

armcknight left a comment

Choose a reason for hiding this comment

armcknight Nov 28, 2023

Choose a reason for hiding this comment

brustolin Nov 28, 2023

Choose a reason for hiding this comment

philipphofmann Nov 28, 2023

Choose a reason for hiding this comment

armcknight Nov 28, 2023

Choose a reason for hiding this comment

armcknight Nov 28, 2023

Choose a reason for hiding this comment

brustolin Nov 28, 2023

Choose a reason for hiding this comment

armcknight Nov 28, 2023 • edited Loading

Choose a reason for hiding this comment

brustolin Nov 29, 2023 • edited Loading

Choose a reason for hiding this comment

philipphofmann left a comment

Choose a reason for hiding this comment

armcknight left a comment

Choose a reason for hiding this comment

github-actions bot commented Nov 29, 2023

Instructions and example for changelog

github-actions bot commented Nov 22, 2023 •

edited

Loading

codecov bot commented Nov 22, 2023 •

edited

Loading

philipphofmann left a comment •

edited

Loading

armcknight Nov 28, 2023 •

edited

Loading

brustolin Nov 29, 2023 •

edited

Loading