(Closeable)ThreadContext putAll removes entire context

[nielsm5]

Description

The ThreadContext no longer works as intended. The new version closes/removes items from the stack when it shouldn't.

CloseableThreadContext calls ThreadContext.putAll.

if (!valuesToReplace.isEmpty()) {
    ThreadContext.putAll(valuesToReplace);
}

Once putAll has been called, the stack is gone, and only the newly inserted values are present.
Since it's used by CloseableThreadContext#close() it's quite destructive...

Configuration

Version: 2.24.0

Operating system: All

JDK: All

Reproduction

	@Test
	public void testAutoCloseableThreadContext() {
		try (final CloseableThreadContext.Instance ctc1 = CloseableThreadContext.put("outer", "one")) {
			try (final CloseableThreadContext.Instance ctc2 = CloseableThreadContext.put("outer", "two")) {
				assertEquals("two", ThreadContext.get("outer"));

				try (final CloseableThreadContext.Instance ctc3 = CloseableThreadContext.put("inner", "one")) {
					assertEquals("one", ThreadContext.get("inner"));

					ThreadContext.put("not-in-closeable", "true");
					assertEquals("two", ThreadContext.get("outer"));
				}

				assertEquals("two", ThreadContext.get("outer"));
				assertNull(ThreadContext.get("inner"));
			}

			assertEquals("one", ThreadContext.get("outer"));
			assertNull(ThreadContext.get("inner"));
		}
		assertEquals("true", ThreadContext.get("not-in-closeable"));

		assertNull(ThreadContext.get("inner"));
		assertNull(ThreadContext.get("outer"));
	}

and

	@Test
	public void testAutoCloseableThreadContextPutAll() {
		try (final CloseableThreadContext.Instance ctc1 = CloseableThreadContext.put("outer", "one")) {
			try (final CloseableThreadContext.Instance ctc2 = CloseableThreadContext.put("outer", "two")) {
				assertEquals("two", ThreadContext.get("outer"));

				try (final CloseableThreadContext.Instance ctc3 = CloseableThreadContext.put("inner", "one")) {
					assertEquals("one", ThreadContext.get("inner"));

					ThreadContext.put("not-in-closeable", "true");
					ThreadContext.putAll(Collections.singletonMap("inner", "two"));
					assertEquals("two", ThreadContext.get("inner"));
					assertEquals("two", ThreadContext.get("outer"));
				}

				assertEquals("two", ThreadContext.get("outer"));
				assertNull(ThreadContext.get("inner"));
			}

			assertEquals("one", ThreadContext.get("outer"));
			assertNull(ThreadContext.get("inner"));
		}
		assertEquals("true", ThreadContext.get("not-in-closeable"));

		assertNull(ThreadContext.get("inner"));
		assertNull(ThreadContext.get("outer"));
	}

[tnleeuw]

Another test that shows the same failure is this test, which does not use ThreadContext.put / ThreadContext.putAll() in the test code but just nesting of CloseableThreadContext.Instance, with nested values that need to be restored on closing an inner context. This test fails because CloseableThreadContext.Instance.closeMap() calls ThreadContext.putAll(valuesToReplace).

	@Test
	public void testCloseableThreadContextWithMultipleNestingLevels() {
		ThreadContext.clearMap();

		try (CloseableThreadContext.Instance k1Outer = CloseableThreadContext.put("k1", "outer")) {
			assertEquals("outer", ThreadContext.get("k1"));
			try (CloseableThreadContext.Instance k1Inner = CloseableThreadContext.put("k1", "inner")) {
				assertEquals("inner", ThreadContext.get("k1"));

				try (CloseableThreadContext.Instance k2Outer = CloseableThreadContext.put("k2", "outer")) {
					assertEquals("inner", ThreadContext.get("k1"));
					assertEquals("outer", ThreadContext.get("k2"));
					try (CloseableThreadContext.Instance k2Inner = CloseableThreadContext.put("k2", "inner")) {
						assertEquals("inner", ThreadContext.get("k1"));
						assertEquals("inner", ThreadContext.get("k2"));

					}
					assertEquals("inner", ThreadContext.get("k1")); // Expect k1 to still exist but it has disappeared here
					assertEquals("outer", ThreadContext.get("k2"));
				}
				assertEquals("inner", ThreadContext.get("k1"));
				assertNull(ThreadContext.get("k2"));

			}
			assertEquals("outer", ThreadContext.get("k1"));
			assertNull(ThreadContext.get("k2"));
		}
		assertNull(ThreadContext.get("k1"));
	}

And another test, simpler, that fails because now CloseableThreadContext.putAll() calls ThreadContext.putAll().

	@Test
	public void testCloseableThreadContext2() {
		ThreadContext.clearMap();

		try (CloseableThreadContext.Instance outer = CloseableThreadContext.put("k1", "outer")) {
			assertEquals("outer", ThreadContext.get("k1"));
			try (CloseableThreadContext.Instance inner = CloseableThreadContext.putAll(Collections.singletonMap("k2", "inner"))) {
				assertEquals("inner", ThreadContext.get("k2"));
				assertEquals("outer", ThreadContext.get("k1")); // Cannot find key "k1" anymore, but it should
			}
			assertNull(ThreadContext.get("k2"));
			assertEquals("outer", ThreadContext.get("k1"));
		}
		assertNull(ThreadContext.get("k1"));
	}

[ppkarwasz]

@nielsm5,

Thank you for the report. I believe this is the same problem that was fixed in #2942.

[tnleeuw]

@nielsm5,

Thank you for the report. I believe this is the same problem that was fixed in #2942.

That would be great; does it fix the tests we added? (Just short on time to verify that myself right now but if you don't have time either then perhaps tomorrow I can find the time to verify this).

[ppkarwasz]

@nielsm5,

Can you check the latest 2.24.1-SNAPSHOT snapshot, if it solves the problem (see Logging Services Download for details about our snapshot repository).

[ppkarwasz]

That would be great; does it fix the tests we added? (Just short on time to verify that myself right now but if you don't have time either then perhaps tomorrow I can find the time to verify this).

I believe so, the problem with putAll was that it overwrote the previous entries instead of appending to them.

[tnleeuw]

That would be great; does it fix the tests we added? (Just short on time to verify that myself right now but if you don't have time either then perhaps tomorrow I can find the time to verify this).

I believe so, the problem with putAll was that it overwrote the previous entries instead of appending to them.

Sounds like it should fix this issue. I will test with a snapshot-build tomorrow.

[tnleeuw]

I can confirm that the latest snapshot build fixes our tests.

[ppkarwasz]

Thanks for the confirmation, I am closing it and adding it to the 2.24.1 milestone due in about 10 days.