Skip to content

#12362 factory method for jso nbuilders#12541

Draft
TillJan wants to merge 6 commits into
IQSS:developfrom
TillJan:#12362-factory-method-for-JSONbuilders
Draft

#12362 factory method for jso nbuilders#12541
TillJan wants to merge 6 commits into
IQSS:developfrom
TillJan:#12362-factory-method-for-JSONbuilders

Conversation

@TillJan

@TillJan TillJan commented Jul 17, 2026

Copy link
Copy Markdown
Contributor

What this PR does / why we need it:
The PR adds methods in the JsonUtil for creating a JsonObjectBuilder and a JsonArrayBuilder. JsonUtil caches a JsonBuilderFactory which is shared by both methods.

All usage of Json.createArrayBuilder() and Json.createObjectBuilder has been replaced by the new methods.

This avoids repeatedly loading a Jakarta JSON-P implementation through the ServiceLoader which caused inefficiency.
Which issue(s) this PR closes:

Special notes for your reviewer:
The JsonBuilderFactory is shared and only created one time, while the methods are returning new Builder everytime.
Suggestions on how to test this:
run existing tests
Does this PR introduce a user interface change? If mockups are available, please link/include them here:
no
Is there a release notes update needed for this change?:
no
Additional documentation:

@poikilotherm poikilotherm left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A good start!

@@ -1,5 +1,6 @@
package edu.harvard.iq.dataverse.api.errorhandlers;

import edu.harvard.iq.dataverse.util.json.JsonUtil;
import jakarta.json.Json;

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we try deleting all the jakarta.json.Json imports in all the affected class files? People really should no longer use it for object or array builders.

I would be curious if there are any other usages. Ideally, we would make the build fail if someone uses these functions, as avoiding them in the future would eliminate the performance problem.

Comment thread src/main/java/edu/harvard/iq/dataverse/util/json/JsonUtil.java Outdated
t.jansen and others added 2 commits July 17, 2026 13:44
use JsonUtil.createObjectBuilder and JsonUtil.createArrayBuilder to reuse JsonUtil.builderFactory and avoid inefficient usage of JSON providers/builders.
@TillJan
TillJan force-pushed the #12362-factory-method-for-JSONbuilders branch from bff606e to 04f565f Compare July 17, 2026 12:13
t.jansen added 2 commits July 17, 2026 14:39
refactored the start import to specific imports
replaced all Json.createObjectBuilder() and Json.createArrayBuilder() calls with the matching JsonUtil methods.
@TillJan
TillJan force-pushed the #12362-factory-method-for-JSONbuilders branch from 04f565f to ac66224 Compare July 17, 2026 12:45
For now, enable less invasive bundled checks.
In addition, adding first rules to disallow usage of JSON-P Json.createX() API.
Disallow more methods for object and array builders using copy-style arguments.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Component: Code Infrastructure formerly "Feature: Code Infrastructure" Feature: Performance & Stability Size: 0.5 A percentage of a sprint. 0.35 hours

Projects

Status: No status

Development

Successfully merging this pull request may close these issues.

Performance: inefficient usage of JSON providers/builders

2 participants