Honor PERL_JSON_BACKEND=JSON::XS through the bundled compatibility shim
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 58/100
Research direction
Start with src/main/perl/lib/JSON.pm and the existing adapter in src/main/perl/lib/JSON/XS.pm; compare how the dispatcher handles PERL_JSON_BACKEND with how the adapter reports its backend and native XS status. Add the project owned regression described in the acceptance criteria, first checking its expected behavior with system Perl. Run it on both JVM and interpreter backends, then verify the default and JSON::backportPP selections and the CPAN distribution test.
Written by the indexing model from the issue text.
Description
Summary
The bundled JSON dispatcher ignores PERL_JSON_BACKEND=JSON::XS. It always loads JSON::PP unless the value is exactly JSON::backportPP, and JSON->backend consequently reports JSON::PP. This makes CPAN distributions that explicitly request the XS-compatible backend fail even though PerlOnJava already ships a JSON::XS compatibility module backed by the bundled pure-Perl JSON implementation.
Reproduction
With PERL_JSON_BACKEND=JSON::XS, run:
./jperl -e 'require JSON; print JSON->backend, "\n"'
./jperl --interpreter -e 'require JSON; print JSON->backend, "\n"'
Both currently print JSON::PP. The same selection occurs when the variable is set inside a test's BEGIN block before use JSON.
This was observed in CPAN random run 20261118-104825-43075 for Data-Compare-Plugins-JSON 1.04. t/05-compare-json-uses-xs.t sets PERL_JSON_BACKEND=JSON::XS, loads JSON::XS and JSON, then expects JSON->backend to be an isa JSON::XS. The PerlOnJava run reports JSON::PP and fails that assertion (1 of 75 tests; 1 of 11 test programs). The run used JSON 4.11, JSON::XS 4.04 and JSON::PP 4.18. The complete unmodified distribution suite passed under system Perl (11 files, 75 tests); the focused test also passed with the distribution and dependency library paths active.
Root cause and existing support
src/main/perl/lib/JSON.pm loads JSON::PP for every backend value other than JSON::backportPP, initializes $Backend / $BackendModule to JSON::PP, and leaves $BackendModuleXS undefined. Separately, src/main/perl/lib/JSON/XS.pm already exposes a JSON::XS-compatible API by delegating to Cpanel::JSON::XS, which uses the JSON::PP stack. The compatibility adapter is therefore present, but JSON never selects it when the caller requests JSON::XS.
The fix should connect the dispatcher to this existing adapter (or a small JSON::Backend::XS wrapper over it) when PERL_JSON_BACKEND=JSON::XS. It should preserve the distinction between selecting an XS-compatible API and actually running native XS: do not claim a native XS implementation is loaded. Keep the default PP selection and the JSON::backportPP behavior intact.
Acceptance criteria
- Add a project-owned regression for setting
PERL_JSON_BACKEND=JSON::XSbefore loadingJSON; validate the test's expected behavior with system Perl first. - On both JVM and interpreter backends, the requested
JSON::XSadapter is selected andJSON->backendsatisfiesisa JSON::XS. - The selected adapter continues to encode/decode through the bundled PP implementation and retains the existing
JSON::XSAPI behavior; native XS status is reported accurately. - Default backend selection and
PERL_JSON_BACKEND=JSON::backportPPremain unchanged. Data-Compare-Plugins-JSON1.04's unmodifiedt/05-compare-json-uses-xs.tand full suite pass through the normal PerlOnJava CPAN dependency overlay.
Related work
The existing JSON::XS shim is documented in docs/reference/xs-compatibility.md and implemented in src/main/perl/lib/JSON/XS.pm. Issue #1148 covers JSON::Parse loading without XS and is a separate problem. Issue #2097 concerns adding JSON::SL support; it may share JSON infrastructure, but does not cover backend selection.
- Dominant language
- Perl
- Stars
- 67
- Forks
- 8
- Avg merge
- 5h 12m
- Merged PRs (30d)
- 131
Getting set up
- Ships a Dockerfile or Docker Compose file
- No pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from fglock/PerlOnJava
-
area:cpan-port bug
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
fglock/PerlOnJava#2153 ·
Maintainers usually reply within 1 day
-
area:cpan-port area:parser bug
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
fglock/PerlOnJava#2137 ·
Maintainers usually reply within 1 day
-
area:backend area:cpan-port area:runtime bug
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
fglock/PerlOnJava#2071 ·
Maintainers usually reply within 1 day
-
area:runtime documentation enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
fglock/PerlOnJava#1579 ·
Maintainers usually reply within 1 day
-
area:cpan-port bug
Difficulty 3/5 1-2 days Newbie friendliness 62/100
fglock/PerlOnJava#2157 ·
Maintainers usually reply within 1 day
All issues in fglock/PerlOnJava
Similar issues
-
Dev-output directory preparation accepts file-valued lib/include paths and fails on dangling linksOpenteam-cli
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
Maintainers usually reply within 2 days
-
Difficulty 2/5 1-3 hours Newbie friendliness 66/100
-
Difficulty 1/5 Under an hour Newbie friendliness 93/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 73/100
inverse-inc/packetfence#9728 ·
Maintainers usually reply within 1 day
-
fix(char-create): show the real reason a character is refusedPossibly taken @baphomello claimed this 1 day ago. Open
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
Maintainers usually reply within 1 day