HBASE-29857 better handling NPE in BucketCache #7685

teamconfx · 2026-01-28T17:54:55Z

This PR is for JIRA issue: https://issues.apache.org/jira/browse/HBASE-29857

The original JIRA issue is found in HBase v2.6.3, and fixed by HBASE-28839.
I tested with the same workload that I see the bug from v2.6.3 and verify the fix works in both master and branch-2.6.

However the current code still not handle NPE when persistence file is empty or corrupted explicitly.
This PR proposes a new checker to better catch the null from BucketCacheProtos.BucketCacheEntry.parseDelimitedFrom(in);.

Apache-HBase · 2026-01-28T18:50:43Z

🎊 +1 overall

Vote	Subsystem	Runtime	Logfile	Comment
+0 🆗	reexec	0m 29s		Docker mode activated.
			_ Prechecks _
+1 💚	dupname	0m 0s		No case conflicting files found.
+0 🆗	codespell	0m 0s		codespell was not available.
+0 🆗	detsecrets	0m 0s		detect-secrets was not available.
+1 💚	@author	0m 0s		The patch does not contain any @author tags.
+1 💚	hbaseanti	0m 0s		Patch does not have any anti-patterns.
			_ master Compile Tests _
+1 💚	mvninstall	3m 21s		master passed
+1 💚	compile	3m 28s		master passed
+1 💚	checkstyle	1m 0s		master passed
+1 💚	spotbugs	1m 38s		master passed
+1 💚	spotless	0m 49s		branch has no errors when running spotless:check.
			_ Patch Compile Tests _
+1 💚	mvninstall	3m 1s		the patch passed
+1 💚	compile	3m 21s		the patch passed
+1 💚	javac	3m 21s		the patch passed
+1 💚	blanks	0m 0s		The patch has no blanks issues.
+1 💚	checkstyle	1m 3s		the patch passed
+1 💚	spotbugs	1m 42s		the patch passed
+1 💚	hadoopcheck	11m 22s		Patch does not cause any errors with Hadoop 3.3.6 3.4.1.
+1 💚	spotless	0m 44s		patch has no errors when running spotless:check.
			_ Other Tests _
+1 💚	asflicense	0m 11s		The patch does not generate ASF License warnings.
		39m 34s

Subsystem	Report/Notes
Docker	ClientAPI=1.43 ServerAPI=1.43 base: https://ci-hbase.apache.org/job/HBase-PreCommit-GitHub-PR/job/PR-7685/1/artifact/yetus-general-check/output/Dockerfile
GITHUB PR	#7685
Optional Tests	dupname asflicense javac spotbugs checkstyle codespell detsecrets compile hadoopcheck hbaseanti spotless
uname	Linux f7f206766f5f 5.4.0-1103-aws #111~18.04.1-Ubuntu SMP Tue May 23 20:04:10 UTC 2023 x86_64 x86_64 x86_64 GNU/Linux
Build tool	maven
Personality	dev-support/hbase-personality.sh
git revision	master / `71d16e2`
Default Java	Eclipse Adoptium-17.0.11+9
Max. process+thread count	84 (vs. ulimit of 30000)
modules	C: hbase-server U: hbase-server
Console output	https://ci-hbase.apache.org/job/HBase-PreCommit-GitHub-PR/job/PR-7685/1/console
versions	git=2.34.1 maven=3.9.8 spotbugs=4.7.3
Powered by	Apache Yetus 0.15.0 https://yetus.apache.org

This message was automatically generated.

Apache-HBase · 2026-01-28T22:04:39Z

💔 -1 overall

Vote	Subsystem	Runtime	Logfile	Comment
+0 🆗	reexec	0m 12s		Docker mode activated.
-0 ⚠️	yetus	0m 2s		Unprocessed flag(s): --brief-report-file --spotbugs-strict-precheck --author-ignore-list --blanks-eol-ignore-file --blanks-tabs-ignore-file --quick-hadoopcheck
			_ Prechecks _
			_ master Compile Tests _
+1 💚	mvninstall	2m 41s		master passed
+1 💚	compile	0m 47s		master passed
+1 💚	javadoc	0m 23s		master passed
+1 💚	shadedjars	4m 25s		branch has no errors when building our shaded downstream artifacts.
			_ Patch Compile Tests _
+1 💚	mvninstall	2m 18s		the patch passed
+1 💚	compile	0m 47s		the patch passed
+1 💚	javac	0m 47s		the patch passed
+1 💚	javadoc	0m 21s		the patch passed
+1 💚	shadedjars	4m 24s		patch has no errors when building our shaded downstream artifacts.
			_ Other Tests _
-1 ❌	unit	213m 13s	/patch-unit-hbase-server.txt	hbase-server in the patch failed.
		233m 36s

Subsystem	Report/Notes
Docker	ClientAPI=1.53 ServerAPI=1.53 base: https://ci-hbase.apache.org/job/HBase-PreCommit-GitHub-PR/job/PR-7685/1/artifact/yetus-jdk17-hadoop3-check/output/Dockerfile
GITHUB PR	#7685
Optional Tests	javac javadoc unit compile shadedjars
uname	Linux 7bdb232afab0 6.14.0-1018-aws #18~24.04.1-Ubuntu SMP Mon Nov 24 19:46:27 UTC 2025 x86_64 x86_64 x86_64 GNU/Linux
Build tool	maven
Personality	dev-support/hbase-personality.sh
git revision	master / `71d16e2`
Default Java	Eclipse Adoptium-17.0.11+9
Test Results	https://ci-hbase.apache.org/job/HBase-PreCommit-GitHub-PR/job/PR-7685/1/testReport/
Max. process+thread count	5325 (vs. ulimit of 30000)
modules	C: hbase-server U: hbase-server
Console output	https://ci-hbase.apache.org/job/HBase-PreCommit-GitHub-PR/job/PR-7685/1/console
versions	git=2.34.1 maven=3.9.8
Powered by	Apache Yetus 0.15.0 https://yetus.apache.org

This message was automatically generated.

vaijosh · 2026-01-29T05:24:01Z

hbase-server/src/main/java/org/apache/hadoop/hbase/io/hfile/bucket/BucketCache.java


+    // HBASE-29857: Handle case where persistence file is empty or corrupted.
+    // parseDelimitedFrom() returns null when there's no data to read.
+    if (cacheEntry == null) {


@teamconfx
I noticed one more potential NPE in BucketCache.retrieveFromFile e.g. when ProtobufMagic.isPBMagicPrefix(pbuf)=true.

So can we validation check in the caller, BucketCache.retrieveFromFile to check if the persistence file is empty or corrupted?

Thanks for pointing this out! Will do it.

@vaijosh I added a similar validation check for BucketCache.retrieveFromFile, can you please take another look? Thanks!

Apache-HBase · 2026-01-29T07:52:35Z

💔 -1 overall

Vote	Subsystem	Runtime	Logfile	Comment
+0 🆗	reexec	1m 28s		Docker mode activated.
			_ Prechecks _
+1 💚	dupname	0m 0s		No case conflicting files found.
+0 🆗	codespell	0m 0s		codespell was not available.
+0 🆗	detsecrets	0m 0s		detect-secrets was not available.
+1 💚	@author	0m 0s		The patch does not contain any @author tags.
+1 💚	hbaseanti	0m 0s		Patch does not have any anti-patterns.
			_ master Compile Tests _
+1 💚	mvninstall	2m 41s		master passed
+1 💚	compile	2m 40s		master passed
+1 💚	checkstyle	0m 47s		master passed
+1 💚	spotbugs	1m 15s		master passed
+1 💚	spotless	0m 40s		branch has no errors when running spotless:check.
			_ Patch Compile Tests _
+1 💚	mvninstall	2m 14s		the patch passed
+1 💚	compile	2m 37s		the patch passed
+1 💚	javac	2m 36s		the patch passed
+1 💚	blanks	0m 0s		The patch has no blanks issues.
+1 💚	checkstyle	0m 45s		the patch passed
+1 💚	spotbugs	1m 20s		the patch passed
+1 💚	hadoopcheck	8m 32s		Patch does not cause any errors with Hadoop 3.3.6 3.4.1.
-1 ❌	spotless	0m 29s	/patch-spotless.txt	patch has 24 errors when running spotless:check, run spotless:apply to fix.
			_ Other Tests _
+1 💚	asflicense	0m 8s		The patch does not generate ASF License warnings.
		30m 57s

Subsystem	Report/Notes
Docker	ClientAPI=1.48 ServerAPI=1.48 base: https://ci-hbase.apache.org/job/HBase-PreCommit-GitHub-PR/job/PR-7685/2/artifact/yetus-general-check/output/Dockerfile
GITHUB PR	#7685
Optional Tests	dupname asflicense javac spotbugs checkstyle codespell detsecrets compile hadoopcheck hbaseanti spotless
uname	Linux 0684bcf0a180 6.8.0-1024-aws #26~22.04.1-Ubuntu SMP Wed Feb 19 06:54:57 UTC 2025 x86_64 x86_64 x86_64 GNU/Linux
Build tool	maven
Personality	dev-support/hbase-personality.sh
git revision	master / `7b367dd`
Default Java	Eclipse Adoptium-17.0.11+9
Max. process+thread count	86 (vs. ulimit of 30000)
modules	C: hbase-server U: hbase-server
Console output	https://ci-hbase.apache.org/job/HBase-PreCommit-GitHub-PR/job/PR-7685/2/console
versions	git=2.34.1 maven=3.9.8 spotbugs=4.7.3
Powered by	Apache Yetus 0.15.0 https://yetus.apache.org

This message was automatically generated.

vaijosh · 2026-01-29T09:19:11Z

Thanks @teamconfx
Changes LGTM.

fix hbase-29857: better handling NPE

71d16e2

vaijosh suggested changes Jan 29, 2026

View reviewed changes

one more potential NPE in retrieveFromFile

7b367dd

apply spotless

8423bce

vaijosh approved these changes Jan 29, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

HBASE-29857 better handling NPE in BucketCache #7685

HBASE-29857 better handling NPE in BucketCache #7685

teamconfx commented Jan 28, 2026

Uh oh!

Apache-HBase commented Jan 28, 2026

Uh oh!

Apache-HBase commented Jan 28, 2026

Uh oh!

vaijosh Jan 29, 2026

Uh oh!

teamconfx Jan 29, 2026

Uh oh!

teamconfx Jan 29, 2026

Uh oh!

Apache-HBase commented Jan 29, 2026

Uh oh!

vaijosh commented Jan 29, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

HBASE-29857 better handling NPE in BucketCache #7685

Are you sure you want to change the base?

HBASE-29857 better handling NPE in BucketCache #7685

Conversation

teamconfx commented Jan 28, 2026

Uh oh!

Apache-HBase commented Jan 28, 2026

Uh oh!

Apache-HBase commented Jan 28, 2026

Uh oh!

vaijosh Jan 29, 2026

Choose a reason for hiding this comment

Uh oh!

teamconfx Jan 29, 2026

Choose a reason for hiding this comment

Uh oh!

teamconfx Jan 29, 2026

Choose a reason for hiding this comment

Uh oh!

Apache-HBase commented Jan 29, 2026

Uh oh!

vaijosh commented Jan 29, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants