Implement a Java-backed DB_File provider
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 20/100
Research direction
Start with src/main/perl/lib/XSLoader.pm, src/main/java/org/perlonjava/runtime/perlmodule/DBM.java, and the upstream DB_File.pm API to understand module registration and the existing storage boundary. Then add the unchanged upstream DB_File tests and fixtures and validate them first with system Perl, followed by both PerlOnJava backends. Done means the documented API and file format pass the supported upstream tests and the stated dependency chain no longer fails solely on XS loading.
Written by the indexing model from the issue text.
Description
Summary
Implement a Java-backed DB_File provider so PerlOnJava applications can use the CPAN module's Perl-facing database API without loading its XS extension.
This is separate from #1494 and #1495: those implement Perl's dbmopen/dbmclose over a PerlOnJava SQLite format. They do not implement DB_File, its tie classes, or Berkeley DB's API.
Evidence and impact
- In CPAN random run
20261109-091152-39587,Kwiki::GoogleLink0.01 pulled in Kwiki 0.39, then Spoon 0.24; Spoon requiresDB_File. The PerlOnJava run timed out during this dependency chain before the target distribution's tests started. - The archived system-Perl oracle passed the target tests:
Kwiki::GoogleLinkpassed 1 test and Kwiki passed 59 tests (with optional cycle tests skipped). - A bounded isolated run of
DB_File1.861 with PerlOnJava's launcher built its Perl files, then failed its tests becauseXSLoaderreportsXS module not supported on PerlOnJava. The failing upstream test files includedt/000prereq.t,t/db-btree.t,t/db-hash.t,t/db-recno.t, andt/db-threads.t. - The targeted CPAN reverse-dependency lookup found 63 unique released distributions with a runtime dependency on
DB_File, including 7 recent dependants. Examples include BioPerl, LaTeXML, Geo-Coder-Free, XML-TMX, and IP-Country-DB_File.
Current implementation boundary
src/main/perl/lib/XSLoader.pm explicitly lists DB_File as unsupported. The existing PerlOnJava::DBM implementation in src/main/java/org/perlonjava/runtime/perlmodule/DBM.java stores data in SQLite and explicitly does not read or write native Berkeley DB files.
The first provider may use SQLite or another Java implementation, but it must document its file format and must not claim interoperability with Berkeley DB files unless that is actually implemented. Existing DB_File users should receive a clear error for unsupported features rather than silently getting different semantics.
Proposed scope
- Preserve and expose the upstream
DB_File.pmPerl API while registering Java-backed operations through PerlOnJava's module/XSLoader mechanism. - Support the common tied-hash use cases for
DB_HASHandDB_BTREE, including open/create flags, byte-string keys and values,FETCH,STORE,DELETE,EXISTS,CLEAR, and stable key iteration. - Support the tied-array
DB_RECNOinterface, including array indexing and mutation behavior. - Implement and document the useful direct object methods (
get,put,del,seq,sync, and duplicate-record methods where supported), exported constants, and DB configuration objects. - Define behavior for unsupported native-only operations such as returning a real file descriptor; do not report success with a fabricated value.
- Keep the provider usable on both JVM and interpreter backends and independent of Berkeley DB libraries installed on the host for the initial Java-backed format.
A follow-up can add native Berkeley DB file interoperability if there is a supported, distributable cross-platform implementation. That requirement would add native-library packaging and platform work beyond this initial scope.
Acceptance criteria
use DB_Filesucceeds through the Java provider, without loading the XS extension.- Add the unchanged upstream
DB_Filetest suite and fixtures to the repository and use it to track supported behavior; do not modify upstream tests to hide gaps. - Validate Perl-level tests with system Perl first, then run the supported tests on both PerlOnJava backends.
- Cover persistence/reopen, binary keys and values, HASH/BTREE iteration, RECNO array semantics, read-only/error paths, duplicate behavior where implemented, close/untie, and documented unsupported operations.
- Re-run the CPAN dependency chain that exposed this gap and verify
DB_Filetests no longer fail solely because XS loading is unsupported. - Update bundled-module and feature documentation with the API and file-format boundaries.
- 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