Add retry for ProfilerIntegration_FullRoundtrip_Works test (#4651)

Author: jamescrosswell

test/Sentry.Profiling.Tests/SamplingTransactionProfilerTests.cs

@@ -235,106 +235,112 @@ public void ProfilerIntegration_FullRoundtrip_Works(bool offlineCaching)
     {
         Skip.If(TestEnvironment.IsGitHubActions, "Flaky in CI");
 
-        var tcs = new TaskCompletionSource<string>();
-        async Task VerifyAsync(HttpRequestMessage message)
+        TestHelpers.RetryTest(maxAttempts: 2, ExecuteTest);
+        return;
+
+        void ExecuteTest()
         {
-            var payload = await message.Content!.ReadAsStringAsync();
-            // We're actually looking for type:profile but it must be sent in the same envelope as the transaction.
-            if (payload.Contains("\"type\":\"transaction\""))
+            var tcs = new TaskCompletionSource<string>();
+            async Task VerifyAsync(HttpRequestMessage message)
             {
-                tcs.TrySetResult(payload);
+                var payload = await message.Content!.ReadAsStringAsync();
+                // We're actually looking for type:profile but it must be sent in the same envelope as the transaction.
+                if (payload.Contains("\"type\":\"transaction\""))
+                {
+                    tcs.TrySetResult(payload);
+                }
             }
-        }
-
-        var cts = new CancellationTokenSource();
-        cts.Token.Register(() => tcs.TrySetCanceled());
 
-        // envelope cache dir
-        using var cacheDirectory = offlineCaching ? new TempDirectory() : null;
+            var cts = new CancellationTokenSource();
+            cts.Token.Register(() => tcs.TrySetCanceled());
 
-        // profiler temp dir (doesn't support `FileSystem`)
-        var tempDir = new TempDirectory();
-
-        var options = new SentryOptions
-        {
-            Dsn = ValidDsn,
-            // To go through a round trip serialization of cached envelope
-            CacheDirectoryPath = cacheDirectory?.Path,
-            // So we don't need to deal with gzip'ed payload
-            RequestBodyCompressionLevel = CompressionLevel.NoCompression,
-            CreateHttpMessageHandler = () => new CallbackHttpClientHandler(VerifyAsync),
-            // Not to send some session envelope
-            AutoSessionTracking = false,
-            Debug = true,
-            DiagnosticLogger = _testOutputLogger,
-            TracesSampleRate = 1.0,
-            ProfilesSampleRate = 1.0,
-            // This keeps all writing-to-file operations in memory instead of actually writing to disk
-            FileSystem = new FakeFileSystem()
-        };
+            // envelope cache dir
+            using var cacheDirectory = offlineCaching ? new TempDirectory() : null;
 
-        // Disable process exit flush to resolve "There is no currently active test." errors.
-        options.DisableAppDomainProcessExitFlush();
+            // profiler temp dir (doesn't support `FileSystem`)
+            var tempDir = new TempDirectory();
 
-        options.AddProfilingIntegration(TimeSpan.FromSeconds(10));
+            var options = new SentryOptions
+            {
+                Dsn = ValidDsn,
+                // To go through a round trip serialization of cached envelope
+                CacheDirectoryPath = cacheDirectory?.Path,
+                // So we don't need to deal with gzip'ed payload
+                RequestBodyCompressionLevel = CompressionLevel.NoCompression,
+                CreateHttpMessageHandler = () => new CallbackHttpClientHandler(VerifyAsync),
+                // Not to send some session envelope
+                AutoSessionTracking = false,
+                Debug = true,
+                DiagnosticLogger = _testOutputLogger,
+                TracesSampleRate = 1.0,
+                ProfilesSampleRate = 1.0,
+                // This keeps all writing-to-file operations in memory instead of actually writing to disk
+                FileSystem = new FakeFileSystem()
+            };
+
+            // Disable process exit flush to resolve "There is no currently active test." errors.
+            options.DisableAppDomainProcessExitFlush();
+
+            options.AddProfilingIntegration(TimeSpan.FromSeconds(10));
 
-        try
-        {
-            using var hub = new Hub(options);
+            try
+            {
+                using var hub = new Hub(options);
 
-            var factory = (options.TransactionProfilerFactory as SamplingTransactionProfilerFactory)!;
-            Skip.If(TestEnvironment.IsGitHubActions && factory.StartupTimedOut, "Session sometimes takes too long to start in CI.");
-            Assert.False(factory.StartupTimedOut);
+                var factory = (options.TransactionProfilerFactory as SamplingTransactionProfilerFactory)!;
+                Skip.If(TestEnvironment.IsGitHubActions && factory.StartupTimedOut, "Session sometimes takes too long to start in CI.");
+                Assert.False(factory.StartupTimedOut);
 
-            var clock = SentryStopwatch.StartNew();
-            var tx = hub.StartTransaction("name", "op");
-            RunForMs(RuntimeMs);
-            tx.Finish();
-            var elapsedNanoseconds = (ulong)((clock.CurrentDateTimeOffset - clock.StartDateTimeOffset).TotalMilliseconds * 1_000_000);
+                var clock = SentryStopwatch.StartNew();
+                var tx = hub.StartTransaction("name", "op");
+                RunForMs(RuntimeMs);
+                tx.Finish();
+                var elapsedNanoseconds = (ulong)((clock.CurrentDateTimeOffset - clock.StartDateTimeOffset).TotalMilliseconds * 1_000_000);
 
-            hub.FlushAsync().Wait();
+                hub.FlushAsync().Wait();
 
-            // Synchronizing in the tests to go through the caching and http transports
-            cts.CancelAfter(options.FlushTimeout + TimeSpan.FromSeconds(1));
-            var ex = Record.Exception(tcs.Task.Wait);
-            Assert.Null(ex);
-            Assert.True(tcs.Task.IsCompleted);
+                // Synchronizing in the tests to go through the caching and http transports
+                cts.CancelAfter(options.FlushTimeout + TimeSpan.FromSeconds(1));
+                var ex = Record.Exception(tcs.Task.Wait);
+                Assert.Null(ex);
+                Assert.True(tcs.Task.IsCompleted);
 
-            var envelopeLines = tcs.Task.Result.Split('\n');
-            SkipIfFailsInCI(() =>
+                var envelopeLines = tcs.Task.Result.Split('\n');
+                SkipIfFailsInCI(() =>
+                {
+                    if (envelopeLines.Length != 6)
+                    {
+                        throw new ArgumentOutOfRangeException("envelopeLines", "Invalid number of envelope lines.");
+                    }
+                });
+
+                // header rows before payloads
+                envelopeLines[1].Should().StartWith("{\"type\":\"transaction\"");
+                envelopeLines[3].Should().StartWith("{\"type\":\"profile\"");
+
+                var transaction = Json.Parse(envelopeLines[2], SentryTransaction.FromJson);
+
+                // TODO do we want to bother with JSON parsing just to do this? Doing at least simple checks for now...
+                // var profileInfo = Json.Parse(envelopeLines[4], ProfileInfo.FromJson);
+                // ValidateProfile(profileInfo.Profile, elapsedNanoseconds);
+                envelopeLines[4].Should().Contain("\"profile\":{");
+                envelopeLines[4].Should().Contain($"\"id\":\"{transaction.EventId}\"");
+                envelopeLines[4].Length.Should().BeGreaterThan(10000);
+
+                Directory.GetFiles(tempDir.Path).Should().BeEmpty("When profiling is done, the temp dir should be empty.");
+            }
+            finally
             {
-                if (envelopeLines.Length != 6)
+                // ensure the task is complete before leaving the test
+                tcs.TrySetResult("");
+                tcs.Task.Wait();
+
+                if (options.Transport is CachingTransport cachingTransport)
                 {
-                    throw new ArgumentOutOfRangeException("envelopeLines", "Invalid number of envelope lines.");
+                    // Disposing the caching transport will ensure its worker
+                    // is shut down before we try to dispose and delete the temp folder
+                    cachingTransport.Dispose();
                 }
-            });
-
-            // header rows before payloads
-            envelopeLines[1].Should().StartWith("{\"type\":\"transaction\"");
-            envelopeLines[3].Should().StartWith("{\"type\":\"profile\"");
-
-            var transaction = Json.Parse(envelopeLines[2], SentryTransaction.FromJson);
-
-            // TODO do we want to bother with JSON parsing just to do this? Doing at least simple checks for now...
-            // var profileInfo = Json.Parse(envelopeLines[4], ProfileInfo.FromJson);
-            // ValidateProfile(profileInfo.Profile, elapsedNanoseconds);
-            envelopeLines[4].Should().Contain("\"profile\":{");
-            envelopeLines[4].Should().Contain($"\"id\":\"{transaction.EventId}\"");
-            envelopeLines[4].Length.Should().BeGreaterThan(10000);
-
-            Directory.GetFiles(tempDir.Path).Should().BeEmpty("When profiling is done, the temp dir should be empty.");
-        }
-        finally
-        {
-            // ensure the task is complete before leaving the test
-            tcs.TrySetResult("");
-            tcs.Task.Wait();
-
-            if (options.Transport is CachingTransport cachingTransport)
-            {
-                // Disposing the caching transport will ensure its worker
-                // is shut down before we try to dispose and delete the temp folder
-                cachingTransport.Dispose();
             }
         }
     }