-
Notifications
You must be signed in to change notification settings - Fork 0
feat(automatic-instrumentation): log on appear/disappear for swiftui #18
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
Open
mario-launchdarkly
wants to merge
5
commits into
main
Choose a base branch
from
feature/screen
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
1f9f8f9
feat: add posibility to name screens and add attributes
mario-launchdarkly 9e93a87
feat: log on appear/disappear
mario-launchdarkly 1b74f76
refactor: rename view modifier name
mario-launchdarkly e2035e6
Merge branch 'main' into feature/screen
mario-launchdarkly ee889f5
refactor: remove unnecessary nil coalescing with non-optional string
mario-launchdarkly File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
14 changes: 14 additions & 0 deletions
14
ExampleApp/ExampleApp/Instrumentation/Automatic/AutomaticInstrumentationView.swift
This file contains hidden or 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,14 @@ | ||
import SwiftUI | ||
|
||
struct AutomaticInstrumentationView: View { | ||
var body: some View { | ||
VStack { | ||
NetworkRequestView() | ||
HelloWorldView() | ||
} | ||
} | ||
} | ||
|
||
#Preview { | ||
AutomaticInstrumentationView() | ||
} |
55 changes: 55 additions & 0 deletions
55
ExampleApp/ExampleApp/Instrumentation/Automatic/HelloWorldView.swift
This file contains hidden or 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,55 @@ | ||
import SwiftUI | ||
import ObservabilitySwiftUIExtensions | ||
|
||
struct AChildView: View { | ||
@State private var count = 0 | ||
var body: some View { | ||
VStack { | ||
Text("Child A View") | ||
.padding() | ||
Text(count.description) | ||
.bold() | ||
Button { | ||
count = count + 1 | ||
} label: { | ||
Text("Increment") | ||
.bold() | ||
} | ||
.tint(.yellow) | ||
.buttonStyle(.borderedProminent) | ||
} | ||
.padding() | ||
.background { | ||
Color.red | ||
} | ||
} | ||
} | ||
|
||
struct HelloWorldView: View { | ||
@State private var count = 0 | ||
var body: some View { | ||
VStack { | ||
Text(count.description) | ||
.bold() | ||
Button { | ||
count = count + 1 | ||
} label: { | ||
Text("Increment") | ||
} | ||
AChildView() | ||
} | ||
.logViewName( | ||
"HelloWorldView", | ||
attributes: [ | ||
"view": .string("vstack") | ||
] | ||
) | ||
.onAppear { | ||
print("PRINT FROM ONAPPEAR") | ||
} | ||
} | ||
} | ||
|
||
#Preview { | ||
HelloWorldView() | ||
} |
This file contains hidden or 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
50 changes: 50 additions & 0 deletions
50
Sources/ObservabilitySwiftUIExtensions/ViewNameViewModifier.swift
This file contains hidden or 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,50 @@ | ||
import Foundation | ||
import os | ||
import SwiftUI | ||
|
||
import OpenTelemetryApi | ||
|
||
import LaunchDarklyObservability | ||
|
||
public struct ViewNameViewModifier: ViewModifier { | ||
public let viewName: String | ||
public let attributes: [String: AttributeValue]? | ||
|
||
public init(viewName: String, attributes: [String: AttributeValue]? = nil) { | ||
self.viewName = viewName | ||
self.attributes = attributes | ||
} | ||
|
||
public func body(content: Content) -> some View { | ||
content | ||
.onDisappear { | ||
let logAttributes = self.attributes ?? [String: AttributeValue]() | ||
LDObserve.shared.recordLog( | ||
message: "on Disappear \(self.viewName)", | ||
severity: .info, | ||
attributes: [ | ||
"screen.name": .string(self.viewName), | ||
].merging(logAttributes) { _, inbound in inbound } | ||
) | ||
} | ||
.onAppear { | ||
let logAttributes = self.attributes ?? [String: AttributeValue]() | ||
LDObserve.shared.recordLog( | ||
message: "on Appear \(self.viewName)", | ||
severity: .info, | ||
attributes: [ | ||
"screen.name": .string(self.viewName), | ||
].merging(logAttributes) { _, inbound in inbound } | ||
) | ||
} | ||
} | ||
} | ||
|
||
|
||
extension View { | ||
public func logViewName(_ viewName: String, attributes: [String: AttributeValue]? = nil) -> some View { | ||
modifier(ViewNameViewModifier(viewName: viewName, attributes: attributes)) | ||
} | ||
} | ||
|
||
|
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.
Bug: Screen Name Mismatch in View Modifier
The
onAppear
andonDisappear
blocks inViewNameViewModifier
use a merging strategy that allows user-provided attributes to override thescreen.name
attribute. This can lead to the logged screen name not matching theviewName
parameter, potentially causing confusion.