embrace-io / embrace-apple-sdk

Embrace's Swift SDK built on OpenTelemetry
https://embrace.io/docs/ios/
Apache License 2.0
117 stars 11 forks source link

Updates EmbraceSemantics to move definitions under `SpanEventType` #65

Closed atreat closed 1 month ago

atreat commented 2 months ago

These were incorrectly defined under SpanType. They are created/added to items that we record as SpanEvents.

notion-workspace[bot] commented 2 months ago

Formalize spanEventType

github-actions[bot] commented 2 months ago

Dependency Review

✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.

OpenSSF Scorecard

PackageVersionScoreDetails

Scanned Manifest Files

github-actions[bot] commented 2 months ago
Warnings
:warning: No CHANGELOG entry added.
:warning: No tests added / modified.
:warning: **Sources/EmbraceCore/Capture/UX/Tap/TapCaptureService.swift#L137** - Returning Void in a function declaration is redundant (`redundant_void_return`)

Generated by :no_entry_sign: Danger Swift against 98cc7065badc2623f6d7aced5a5cedb11bc52f4f

codecov[bot] commented 2 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 91.78%. Comparing base (52375c4) to head (ea2543a). Report is 1 commits behind head on main.

Additional details and impacted files [![Impacted file tree graph](https://app.codecov.io/gh/embrace-io/embrace-apple-sdk/pull/65/graphs/tree.svg?width=650&height=150&src=pr&token=R3KMG2Ar52&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=embrace-io)](https://app.codecov.io/gh/embrace-io/embrace-apple-sdk/pull/65?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=embrace-io) ```diff @@ Coverage Diff @@ ## main #65 +/- ## ========================================== - Coverage 91.84% 91.78% -0.06% ========================================== Files 403 403 Lines 25931 25931 ========================================== - Hits 23816 23802 -14 - Misses 2115 2129 +14 ``` | [Files with missing lines](https://app.codecov.io/gh/embrace-io/embrace-apple-sdk/pull/65?dropdown=coverage&src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=embrace-io) | Coverage Δ | | |---|---|---| | [...apture/System/LowMemoryWarningCaptureService.swift](https://app.codecov.io/gh/embrace-io/embrace-apple-sdk/pull/65?src=pr&el=tree&filepath=Sources%2FEmbraceCore%2FCapture%2FSystem%2FLowMemoryWarningCaptureService.swift&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=embrace-io#diff-U291cmNlcy9FbWJyYWNlQ29yZS9DYXB0dXJlL1N5c3RlbS9Mb3dNZW1vcnlXYXJuaW5nQ2FwdHVyZVNlcnZpY2Uuc3dpZnQ=) | `100.00% <100.00%> (ø)` | | | [...EmbraceCore/Capture/UX/Tap/TapCaptureService.swift](https://app.codecov.io/gh/embrace-io/embrace-apple-sdk/pull/65?src=pr&el=tree&filepath=Sources%2FEmbraceCore%2FCapture%2FUX%2FTap%2FTapCaptureService.swift&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=embrace-io#diff-U291cmNlcy9FbWJyYWNlQ29yZS9DYXB0dXJlL1VYL1RhcC9UYXBDYXB0dXJlU2VydmljZS5zd2lmdA==) | `96.19% <100.00%> (ø)` | | | [...ceCore/Capture/WebView/WebViewCaptureService.swift](https://app.codecov.io/gh/embrace-io/embrace-apple-sdk/pull/65?src=pr&el=tree&filepath=Sources%2FEmbraceCore%2FCapture%2FWebView%2FWebViewCaptureService.swift&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=embrace-io#diff-U291cmNlcy9FbWJyYWNlQ29yZS9DYXB0dXJlL1dlYlZpZXcvV2ViVmlld0NhcHR1cmVTZXJ2aWNlLnN3aWZ0) | `80.39% <100.00%> (ø)` | | | [Sources/EmbraceCore/Public/Events/Breadcrumb.swift](https://app.codecov.io/gh/embrace-io/embrace-apple-sdk/pull/65?src=pr&el=tree&filepath=Sources%2FEmbraceCore%2FPublic%2FEvents%2FBreadcrumb.swift&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=embrace-io#diff-U291cmNlcy9FbWJyYWNlQ29yZS9QdWJsaWMvRXZlbnRzL0JyZWFkY3J1bWIuc3dpZnQ=) | `100.00% <100.00%> (ø)` | | | [...blic/PushNotifications/PushNotificationEvent.swift](https://app.codecov.io/gh/embrace-io/embrace-apple-sdk/pull/65?src=pr&el=tree&filepath=Sources%2FEmbraceCore%2FPublic%2FPushNotifications%2FPushNotificationEvent.swift&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=embrace-io#diff-U291cmNlcy9FbWJyYWNlQ29yZS9QdWJsaWMvUHVzaE5vdGlmaWNhdGlvbnMvUHVzaE5vdGlmaWNhdGlvbkV2ZW50LnN3aWZ0) | `79.56% <100.00%> (ø)` | | ... and [6 files with indirect coverage changes](https://app.codecov.io/gh/embrace-io/embrace-apple-sdk/pull/65/indirect-changes?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=embrace-io)
ArielDemarco commented 1 month ago

Would this PR generate any breaking changes on the public API? If that's the case I'd: a. Keep both old and new code (marking old as deprecated) b. Specify this in someway. I understand EmbraceSemantics is meant to be exposed and used publicly.