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

[dotnet] parametric app improvements #3723

Merged
merged 38 commits into from
Jan 17, 2025
Merged

Conversation

lucaspimentel
Copy link
Member

@lucaspimentel lucaspimentel commented Dec 19, 2024

Motivation

Improve the developer experience of modifying, running, and troubleshooting the parametric app for .NET.

Changes

  • reduce code repetition
    • refactor reflection code
    • refactor json serialization and deserialization, including validation and logging
  • troubleshooting
    • enable more built-in ASP.NET Core logging
    • add more custom logging, in particular the request/response payloads
  • reduce external dependencies
    • replace use of Newtonsoft.Json with the built-in System.Text.Json
  • fix compiler warnings
    • add missing nullability annotations and null checks
    • make members private where possible

I will do the same with the OpenTelemetry test endpoints (ApmTestApiOtel.cs) in a separate PR and then remove the Newtonsoft.Json reference.

Note

While making these changes I found several unrelated bugs when using the .NET tracing library's manual API:

Workflow

  1. ⚠️ Create your PR as draft ⚠️
  2. Work on you PR until the CI passes (if something not related to your task is failing, you can ignore it)
  3. Mark it as ready for review
    • Test logic is modified? -> Get a review from RFC owner. We're working on refining the codeowners file quickly.
    • Framework is modified, or non obvious usage of it -> get a review from R&P team

🚀 Once your PR is reviewed, you can merge it!

🛟 #apm-shared-testing 🛟

Reviewer checklist

  • If PR title starts with [<language>], double-check that only <language> is impacted by the change
  • No system-tests internal is modified. Otherwise, I have the approval from R&P team
  • CI is green, or failing jobs are not related to this change (and you are 100% sure about this statement)
  • A docker base image is modified?
    • the relevant build-XXX-image label is present
  • A scenario is added (or removed)?

@lucaspimentel lucaspimentel force-pushed the lpimentel/dotnet-json-helper branch 3 times, most recently from 223303e to f296fa8 Compare December 19, 2024 03:57
@lucaspimentel lucaspimentel added dev-x Improve developer experience dotnet Pull requests that update .NET code run-parametric-scenario labels Dec 19, 2024
@lucaspimentel lucaspimentel force-pushed the lpimentel/dotnet-json-helper branch 4 times, most recently from 6173f48 to 0d884a9 Compare December 19, 2024 16:23
@lucaspimentel lucaspimentel force-pushed the lpimentel/dotnet-json-helper branch 4 times, most recently from 755e081 to dc1c562 Compare January 14, 2025 22:53
@lucaspimentel lucaspimentel force-pushed the lpimentel/dotnet-json-helper branch from dc1c562 to e01c48d Compare January 15, 2025 22:55
@lucaspimentel lucaspimentel marked this pull request as ready for review January 15, 2025 23:09
@lucaspimentel lucaspimentel requested review from a team as code owners January 15, 2025 23:09
Copy link
Collaborator

@cbeauchesne cbeauchesne left a comment

Choose a reason for hiding this comment

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

Thank you so much for improving this !!

Copy link
Contributor

@bouwkast bouwkast left a comment

Choose a reason for hiding this comment

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

Thank you!

@lucaspimentel lucaspimentel merged commit 63d1b6d into main Jan 17, 2025
26 checks passed
@lucaspimentel lucaspimentel deleted the lpimentel/dotnet-json-helper branch January 17, 2025 18:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dev-x Improve developer experience dotnet Pull requests that update .NET code run-parametric-scenario
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants