[Internal]Cosmos Tests - Add client and Netty ByteBuf leak detection by FabianMeiswinkel · Pull Request #47200 · Azure/azure-sdk-for-java

FabianMeiswinkel · 2025-11-07T20:51:50Z

Description

Implements comprehensive resource leak detection infrastructure for the Azure Cosmos Java SDK, disabled by default and enabled via COSMOS.CLIENT_LEAK_DETECTION_ENABLED system property.

This PR is intentionally just adding the test infrastructure - not yet failing/blokcing tests when Netty buffer leaks or RxDocumentClientImpl leaks are detected in test code (or production code). Making any of those necessary changes in separate PRs intentionally to simplify reviews.

Changes

StackTraceUtil: New utility for capturing and formatting call stacks, used to track client creation locations
Client leak detection: Added tracking in RxDocumentClientImpl via addToActiveClients()/removeFromActiveClients() lifecycle hooks and getActiveClientsSnapshot() for diagnostics
Netty leak detection: Custom ResourceLeakDetectorFactory implementations in test modules that intercept all three leak report types (traced, untraced, instances) with consistent isLeakDetectionDisabled flag checking
Disable scope: createDisableLeakDetectionScope() provides AutoCloseable scope to temporarily suppress leak reporting in specific test scenarios
Test integration: Leak detection checks integrated into test base classes at test class granularity

Usage

// Enable via system property
System.setProperty("COSMOS.CLIENT_LEAK_DETECTION_ENABLED", "true");

// Check for active clients (indicates leaks)
Map<Integer, String> activeClients = RxDocumentClientImpl.getActiveClientsSnapshot();

// Temporarily disable leak detection
try (AutoCloseable scope = CosmosNettyLeakDetectorFactory.createDisableLeakDetectionScope()) {
    // Operations that intentionally leak or produce false positives
}

All SDK Contribution checklist:

The pull request does not introduce [breaking changes]
CHANGELOG is updated for new features, bug fixes or other significant changes.
I have read the contribution guidelines.

General Guidelines and Best Practices

Title of the pull request is clear and informative.
There are a small number of commits, each of which have an informative message. This means that previously merged commits do not appear in the history of the PR. For more information on cleaning up the commits in your PR, see this page.

Testing Guidelines

Pull request includes test coverage for the included changes.

FabianMeiswinkel · 2025-11-07T20:54:21Z

/azp run java - cosmos - tests

azure-pipelines · 2025-11-07T20:54:42Z

Azure Pipelines successfully started running 1 pipeline(s).

FabianMeiswinkel · 2025-11-07T20:55:13Z

/azp run java - cosmos - tests

FabianMeiswinkel · 2025-11-07T20:55:24Z

/azp run java - cosmos - spark

FabianMeiswinkel · 2025-11-07T20:55:30Z

/azp run java - cosmos - kafka

azure-pipelines · 2025-11-07T20:55:34Z

Azure Pipelines successfully started running 1 pipeline(s).

azure-pipelines · 2025-11-07T20:55:37Z

Azure Pipelines successfully started running 1 pipeline(s).

azure-pipelines · 2025-11-07T20:55:41Z

Azure Pipelines successfully started running 1 pipeline(s).

Copilot

Pull Request Overview

This pull request introduces client and Netty ByteBuf leak detection infrastructure for the Azure Cosmos Java SDK to help identify resource leaks during testing. The feature is disabled by default and can be enabled via the COSMOS.CLIENT_LEAK_DETECTION_ENABLED system property.

Key changes:

Added a new StackTraceUtil utility class for capturing call stacks
Implemented client leak detection tracking in RxDocumentClientImpl with methods to register/unregister active clients
Added comprehensive Netty leak detection using a custom ResourceLeakDetectorFactory implementation
Integrated leak detection checks into test base classes to detect leaks at the test class level

Reviewed Changes

Copilot reviewed 32 out of 32 changed files in this pull request and generated 15 comments.

Show a summary per file

File	Description
sdk/cosmos/azure-cosmos/src/main/java/com/azure/cosmos/implementation/StackTraceUtil.java	New utility class for capturing and formatting stack traces
sdk/cosmos/azure-cosmos/src/main/java/com/azure/cosmos/implementation/RxDocumentClientImpl.java	Added client leak detection infrastructure with static map to track active clients and their creation call stacks
sdk/cosmos/azure-cosmos/src/main/java/com/azure/cosmos/implementation/Configs.java	Added configuration to enable/disable client leak detection via system property
sdk/cosmos/azure-cosmos/src/main/java/com/azure/cosmos/implementation/AsyncDocumentClient.java	Added try-catch in client initialization to ensure proper cleanup on init failures
sdk/cosmos/azure-cosmos-tests/src/test/resources/*.xml	Added CosmosNettyLeakDetectorFactory listener to all TestNG suite configuration files
sdk/cosmos/azure-cosmos-tests/src/test/java/com/azure/cosmos/rx/TestSuiteBase.java	Added before/after class methods to snapshot client state and report leaks
sdk/cosmos/azure-cosmos-tests/src/test/java/com/azure/cosmos/implementation/TestSuiteBase.java	Added before/after class methods to snapshot client state and report leaks
sdk/cosmos/azure-cosmos-tests/src/test/java/com/azure/cosmos/CosmosNettyLeakDetectorFactory.java	New custom Netty leak detector factory to intercept and log Netty ByteBuf leaks
sdk/cosmos/azure-cosmos-tests/src/test/java/com/azure/cosmos/CosmosAsyncClientTest.java	Added BeforeClass import to support leak detection setup
sdk/cosmos/azure-cosmos-encryption/src/test/java/com/azure/cosmos/encryption/TestSuiteBase.java	Added before/after class methods to snapshot client state and report leaks for encryption tests
sdk/cosmos/azure-cosmos-encryption/src/test/java/com/azure/cosmos/encryption/CosmosNettyLeakDetectorFactory.java	Duplicate of the main CosmosNettyLeakDetectorFactory for the encryption module

…mos/encryption/CosmosNettyLeakDetectorFactory.java Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

FabianMeiswinkel · 2025-11-07T21:46:04Z

@copilot please review the latest iteration again

Copilot · 2025-11-07T21:46:19Z

@FabianMeiswinkel I've opened a new pull request, #47202, to work on those changes. Once the pull request is ready, I'll request review from you.

FabianMeiswinkel · 2025-11-10T09:00:06Z

/azp run java - cosmos - tests

FabianMeiswinkel · 2025-11-10T09:00:16Z

/azp run java - cosmos - spark

FabianMeiswinkel · 2025-11-10T09:00:23Z

/azp run java - cosmos - kafka

azure-pipelines · 2025-11-10T09:00:38Z

Azure Pipelines successfully started running 1 pipeline(s).

azure-pipelines · 2025-11-10T09:00:43Z

Azure Pipelines successfully started running 1 pipeline(s).

azure-pipelines · 2025-11-10T09:00:56Z

Azure Pipelines successfully started running 1 pipeline(s).

FabianMeiswinkel · 2025-11-10T12:18:56Z

/azp run java - cosmos - tests

FabianMeiswinkel · 2025-11-10T12:19:07Z

/azp run java - cosmos - kafka

FabianMeiswinkel · 2025-11-10T12:19:15Z

/azp run java - cosmos - spark

azure-pipelines · 2025-11-10T12:19:19Z

Azure Pipelines successfully started running 1 pipeline(s).

azure-pipelines · 2025-11-10T12:19:22Z

Azure Pipelines successfully started running 1 pipeline(s).

azure-pipelines · 2025-11-10T12:19:25Z

Azure Pipelines successfully started running 1 pipeline(s).

tvaron3

LGTM

FabianMeiswinkel · 2025-11-10T13:53:37Z

/azp run java - cosmos - tests

azure-pipelines · 2025-11-10T13:54:02Z

Azure Pipelines successfully started running 1 pipeline(s).

FabianMeiswinkel · 2025-11-10T13:54:49Z

/azp run java - cosmos - kafka

FabianMeiswinkel · 2025-11-10T13:54:55Z

/azp run java - cosmos - spark

azure-pipelines · 2025-11-10T13:55:01Z

Azure Pipelines successfully started running 1 pipeline(s).

azure-pipelines · 2025-11-10T13:55:05Z

Azure Pipelines successfully started running 1 pipeline(s).

Test changes to add leak detection

446ca0b

Copilot AI review requested due to automatic review settings November 7, 2025 20:51

FabianMeiswinkel requested review from a team and kirankumarkolli as code owners November 7, 2025 20:51

github-actions Bot added the Cosmos label Nov 7, 2025

Update Configs.java

0e2032b

Merge branch 'main' into users/fabianm/TestImprovements

1a7985b

Copilot AI reviewed Nov 7, 2025

View reviewed changes

FabianMeiswinkel and others added 2 commits November 7, 2025 21:25

Update CosmosNettyLeakDetectorFactory.java

455b8bc

Update sdk/cosmos/azure-cosmos-encryption/src/test/java/com/azure/cos…

8360f49

…mos/encryption/CosmosNettyLeakDetectorFactory.java Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Copilot AI mentioned this pull request Nov 7, 2025

[WIP] Apply changes based on feedback for leak detection tests #47201

Closed

FabianMeiswinkel added 2 commits November 7, 2025 21:31

Update CosmosNettyLeakDetectorFactory.java

f9f263c

Fixes

8e3a2d3

Azure deleted a comment from Copilot AI Nov 7, 2025

FabianMeiswinkel added 2 commits November 7, 2025 21:44

Fixes

13370c8

Update CosmosNettyLeakDetectorFactory.java

b59e147

Copilot AI mentioned this pull request Nov 7, 2025

Address review feedback: Add JavaDoc, fix typo, wire up leak detection #47202

Closed

6 tasks

FabianMeiswinkel added 2 commits November 7, 2025 21:53

Update RxDocumentClientImpl.java

d3aa922

Fixes

6c66864

Iterating on test tools

bca461f

tvaron3 approved these changes Nov 10, 2025

View reviewed changes

Update test-resources.json

e2dd22d

FabianMeiswinkel requested review from Netyyyy, moarychan, rujche and saragluna as code owners November 10, 2025 13:35

NITs

92b0a95

tvaron3 approved these changes Nov 10, 2025

View reviewed changes

alzimmermsft approved these changes Nov 10, 2025

View reviewed changes

FabianMeiswinkel merged commit 89dd0df into main Nov 10, 2025
123 checks passed

FabianMeiswinkel deleted the users/fabianm/TestImprovements branch November 10, 2025 21:21

Uh oh!

Conversation

FabianMeiswinkel commented Nov 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Changes

Usage

All SDK Contribution checklist:

General Guidelines and Best Practices

Testing Guidelines

Uh oh!

FabianMeiswinkel commented Nov 7, 2025

Uh oh!

azure-pipelines Bot commented Nov 7, 2025

Uh oh!

FabianMeiswinkel commented Nov 7, 2025

Uh oh!

FabianMeiswinkel commented Nov 7, 2025

Uh oh!

FabianMeiswinkel commented Nov 7, 2025

Uh oh!

azure-pipelines Bot commented Nov 7, 2025

Uh oh!

azure-pipelines Bot commented Nov 7, 2025

Uh oh!

azure-pipelines Bot commented Nov 7, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

FabianMeiswinkel commented Nov 7, 2025

Uh oh!

Copilot AI commented Nov 7, 2025

Uh oh!

FabianMeiswinkel commented Nov 10, 2025

Uh oh!

FabianMeiswinkel commented Nov 10, 2025

Uh oh!

FabianMeiswinkel commented Nov 10, 2025

Uh oh!

azure-pipelines Bot commented Nov 10, 2025

Uh oh!

azure-pipelines Bot commented Nov 10, 2025

Uh oh!

azure-pipelines Bot commented Nov 10, 2025

Uh oh!

FabianMeiswinkel commented Nov 10, 2025

Uh oh!

FabianMeiswinkel commented Nov 10, 2025

Uh oh!

FabianMeiswinkel commented Nov 10, 2025

Uh oh!

azure-pipelines Bot commented Nov 10, 2025

Uh oh!

azure-pipelines Bot commented Nov 10, 2025

Uh oh!

azure-pipelines Bot commented Nov 10, 2025

Uh oh!

tvaron3 left a comment

Choose a reason for hiding this comment

Uh oh!

FabianMeiswinkel commented Nov 10, 2025

Uh oh!

azure-pipelines Bot commented Nov 10, 2025

Uh oh!

FabianMeiswinkel commented Nov 10, 2025

Uh oh!

FabianMeiswinkel commented Nov 10, 2025

FabianMeiswinkel commented Nov 7, 2025 •

edited

Loading