RUMM-1097 Fix DefaultUIKitRUMViewsPredicate for Objc view controllers
#419
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -5,3 +5,4 @@ | |
| */ | ||
|
|
||
| #import "NSURLSessionBridge.h" | ||
| #import "CustomObjcViewController.h" | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -8,16 +8,31 @@ import XCTest | |
| import Datadog | ||
|
|
||
| class UIKitRUMViewsPredicateTests: XCTestCase { | ||
|
There was a problem hiding this comment. We could also add test cases to check that some known UIKit classes are filtered out, to catch any regressions of the internal There was a problem hiding this comment. +1 to @acgh , we rely on private information ( There was a problem hiding this comment. It's already there - just not visible in this diff. We had this test before: func testGivenDefaultPredicate_whenAskingUIKitViewController_itReturnsNoView() {
// Given
let predicate = DefaultUIKitRUMViewsPredicate()
// When
let uiKitViewController = UIViewController()
let rumView = predicate.rumView(for: uiKitViewController)
// Then
XCTAssertNil(rumView)
} |
||
| func testGivenDefaultPredicate_whenAskingForCustomSwiftViewController_itNamesTheViewByItsClassName() { | ||
| // Given | ||
| let predicate = DefaultUIKitRUMViewsPredicate() | ||
|
|
||
| // When | ||
| let customViewController = createMockView(viewControllerClassName: "CustomSwiftViewController") | ||
| let rumView = predicate.rumView(for: customViewController) | ||
|
|
||
| // Then | ||
| XCTAssertEqual(rumView?.name, "CustomSwiftViewController") | ||
| XCTAssertEqual(rumView?.path, "CustomSwiftViewController") | ||
| XCTAssertTrue(rumView!.attributes.isEmpty) | ||
| } | ||
|
|
||
| func testGivenDefaultPredicate_whenAskingForCustomObjcViewController_itNamesTheViewByItsClassName() { | ||
| // Given | ||
| let predicate = DefaultUIKitRUMViewsPredicate() | ||
|
|
||
| // When | ||
| let customViewController = CustomObjcViewController() | ||
| let rumView = predicate.rumView(for: customViewController) | ||
|
|
||
| // Then | ||
| XCTAssertEqual(rumView?.name, "CustomObjcViewController") | ||
| XCTAssertEqual(rumView?.path, "CustomObjcViewController") | ||
| XCTAssertTrue(rumView!.attributes.isEmpty) | ||
| } | ||
|
|
||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| /* | ||
| * Unless explicitly stated otherwise all files in this repository are licensed under the Apache License Version 2.0. | ||
| * This product includes software developed at Datadog (https://www.datadoghq.com/). | ||
| * Copyright 2019-2020 Datadog, Inc. | ||
| */ | ||
|
|
||
| #import <UIKit/UIKit.h> | ||
|
|
||
| NS_ASSUME_NONNULL_BEGIN | ||
|
|
||
| @interface CustomObjcViewController : UIViewController | ||
|
|
||
| @end | ||
|
|
||
| NS_ASSUME_NONNULL_END |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| /* | ||
| * Unless explicitly stated otherwise all files in this repository are licensed under the Apache License Version 2.0. | ||
| * This product includes software developed at Datadog (https://www.datadoghq.com/). | ||
| * Copyright 2019-2020 Datadog, Inc. | ||
| */ | ||
|
|
||
| #import "CustomObjcViewController.h" | ||
|
|
||
| @interface CustomObjcViewController () | ||
|
|
||
| @end | ||
|
|
||
| @implementation CustomObjcViewController | ||
|
|
||
| - (void)viewDidLoad { | ||
| [super viewDidLoad]; | ||
| } | ||
|
|
||
| @end |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
the real goal is excluding container view controllers, exclusion of
UIKittypes is just the workaround that we could come up with.this comment here may be misleading if we come back to this issue later on, can we correct it?
here is the same issue in PR's description as well:
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.
It's about plain (not subclassed / customized) VCs from
UIKit.Before this PR, this implementation was considering
MyCustomNavigationViewControlleras the RUM View. I think we shouldn't change that default if no one has reported it being wrong. We're doing a bug fix here, I wouldn't change the previous behaviour.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.
no i'm not talking about the behavior, my concern is that the comments don't tell the whole story.
we first wanted to exclude containers and then noticed invisible view controllers in the hiearchy. if one asks "why do we exclude UIKit types?", the answer is not obvious without this story.
IMO this comment
do not track UIKit controllersbrings questions (why?) rather than answeringThere 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.
I see 👍. Improved it with discussing the reasoning and optimisation.