Skip to content
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

Regenerate rum model #1344

Merged
merged 4 commits into from
Jun 29, 2023
Merged

Regenerate rum model #1344

merged 4 commits into from
Jun 29, 2023

Conversation

maciejburda
Copy link
Member

@maciejburda maciejburda commented Jun 28, 2023

What and why?

This PR updates RUM model.

How?

It required a fix for enum without explicit type in generator, after adding fix I generated the code and added blank mocks. They'll be filled in the follow up PR that adds these metrics to the event.

Review checklist

  • Feature or bugfix MUST have appropriate tests (unit, integration)
  • Make sure each commit and the PR mention the Issue number or JIRA reference
  • Add CHANGELOG entry for user facing changes

Custom CI job configuration (optional)

  • Run unit tests
  • Run integration tests
  • Run smoke tests

@maciejburda maciejburda marked this pull request as ready for review June 29, 2023 12:09
@maciejburda maciejburda requested a review from a team as a code owner June 29, 2023 12:09
@maciejburda maciejburda requested a review from ncreated June 29, 2023 12:09
@datadog-datadog-prod-us1
Copy link

datadog-datadog-prod-us1 bot commented Jun 29, 2023

Datadog Report

Branch report: maciey/rum-models-update
Commit report: 6fb6e80

dd-sdk-ios: 0 Failed, 0 New Flaky, 116 Passed, 0 Skipped, 4m 28.67s Wall Time

Copy link
Member

@ncreated ncreated left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One small remark on the public API name, other than this looks great 👌 🎯

@@ -300,6 +300,30 @@ public struct RUMActionEvent: RUMDataModel {
}
}

/// Display properties
public struct RUMDisplay: Codable {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

public API convention/ (“avoid platform self referencing”) Because now we nest this model, there is no more need to prefix it with RUM*. We add this prefix as part of RUM code decoration:

if fixedName == "Display" {
   fixedName = "RUMDisplay"
}

Otherwise we're self-referencing the product in public API:

- RUMViewEvent.RUMDisplay
- RUMActionEvent.RUMDisplay
...
+ RUMViewEvent.Display
+ RUMActionEvent.Display

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💪

@maciejburda maciejburda merged commit 1b8cd0b into develop Jun 29, 2023
@maciejburda maciejburda deleted the maciey/rum-models-update branch June 29, 2023 15:53
This was referenced Jul 12, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants