[service] Fix memory leaks and enable goleak check in tests #9241

crobert-1 · 2024-01-08T21:30:00Z

Description:

This change adds goleak to check for memory leaks. Originally there were 3 failing tests in the service package, so I'll describe changes in relation to resolving each test's failing goleak check.

TestServiceTelemetryRestart: Simplest fix, close the response body to make sure goroutines aren't leaked by reopening a server on the same port. This was just a test issue
TestTelemetryInit.UseOTelWithSDKConfiguration: The meter provider was being started in the initialization process (metrics reference), but never shutdown. The type originally being used (meter.MetricProvider) was the base interface which didn't provide a Shutdown method. I changed this to use the sdk interfaces that provide the required Shutdown method. The actual functionality of starting the providers was already using and returning the sdk interface, so the actual underlying type remains the same. Since mp is a private member and sdkmetric and implement the original type, I don't believe changing the type is a breaking change.
TestServiceTelemetryCleanupOnError: This test starts a server using a sub-goroutine, cancels it, starts again in a subroutine, and cancels again in the main goroutine. This test showed the racing behavior of the subroutine running server.ListenAndServe and the main goroutine's functionality of calling close and then starting the server again right away. The solution here is to add a sync.WaitGroup variable that can properly block until all servers are closed before returning from shutdown. This will allow us to ensure it's safe to proceed knowing the ports are free, and server is fully closed.

The first test fix was just a test issue, but 2 and 3 were real bugs. I realize it's a bit hard to read with them all together, but I assumed adding PR dependency notes would be more complicated.

Link to tracking Issue:
#9165

Testing:
All tests are passing as well as goleak check.

codecov · 2024-01-08T21:33:28Z

Codecov Report

Attention: Patch coverage is 81.25000% with 3 lines in your changes are missing coverage. Please review.

Project coverage is 91.89%. Comparing base (d294537) to head (b860fa9).

Files	Patch %	Lines
service/internal/proctelemetry/config.go	75.00%	3 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #9241      +/-   ##
==========================================
- Coverage   91.90%   91.89%   -0.01%     
==========================================
  Files         361      361              
  Lines       16970    16976       +6     
==========================================
+ Hits        15596    15600       +4     
- Misses       1032     1034       +2     
  Partials      342      342

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

service/telemetry.go

github-actions · 2024-02-03T03:15:46Z