Skip to content

Expands InternalExportDataProvider per dataverse-spi 2.1.0 and refactors the DDI exporter to utilize the new functionality#11799

Open
landreev wants to merge 29 commits into
developfrom
11405-refactor-exports
Open

Expands InternalExportDataProvider per dataverse-spi 2.1.0 and refactors the DDI exporter to utilize the new functionality#11799
landreev wants to merge 29 commits into
developfrom
11405-refactor-exports

Conversation

@landreev

@landreev landreev commented Sep 8, 2025

Copy link
Copy Markdown
Contributor

Un-drafting the PR now!

What this PR does / why we need it:

See issue #11405. Short version: the current export data framework is prohibitively expensive for datasets with very large amounts of tabular data (i.e., "ingested" DataFiles that have associated DataTable entities , with large numbers of chilld DataVariable objects). This PR improves it, via adding code that retrieves the data in manageable chunks. This in trurn relies on the new version of the ExportDataProvider interface from https://github.com/gdcc/dataverse-spi.

Which issue(s) this PR closes:

Special notes for your reviewer:

Note that the PR builds with a snapshot release of dataverse-spi:

            <groupId>io.gdcc</groupId>
            <artifactId>dataverse-spi</artifactId>
            <version>2.1.0-SNAPSHOT</version>

I.e., the version 2.1.0 still needs to be properly released under gdcc. But I don't think that should be stopping putting the PR into review and merging it rather sooner than later.

Note specifically the test for the functionality, TabularDataExportIT added in this PR. I have added it to the list of integration tests that are performed automatically by the workflow action (in tests/integration-tests.txt) even though, strictly speaking, it is not a real integration test. I.e., it does not rely on calling a fully-functional Dataverse instance started remotely. It relies instead on the new test framework added in @poikilotherm's #12365 where a local Docker instance of the database is spun up in which some dummy objects - Datasets, Versions, Datatables and Variables etc are created instantly, allowing testing of complex functionality that requires real database access. Without this new framework, the only way to test an export of a dataset with N large tabular files would be to actually ingest these N files via the API in the remote Dataverse instance used by the RestAssured tests. Which would add to the ongoing bloating of the test suite, and still would not allow to test the underlying functionality as thoroughly (for example, there is no easy way to count the actual database queries under such scenario).

You can run the test in question in your own dev. environment via
mvn test -Dtest=TabularDataExportIT#exportTabularMetadata
If you do not have Docker running, the test will be politely skipped. Otherwise it will create a throwaway postgres instance and proceed to test tabular data exports and associated data retrieval, comparing the results produced using the legacy methods vs. the new and optimized versions added in this PR and more.

Suggestions on how to test this:

Please see the info under the "notes for the reviewer" and feel free to play and experiment with the new test described there. Please keep in mind that the test is still somewhat of a reference demonstrator of the new JpaEntityManagerService-based framework from #12365. It can be expanded and improved going forward.

The ultimate test would be to test before vs. after on some real-life monster datasets.
I would suggest these bad boys on qa:
https://qa.dataverse.org/dataset.xhtml?persistentId=doi:10.7910/DVN/KZW8R2 (207 ingested tab. files; 186906 variables total)
https://qa.dataverse.org/dataset.xhtml?persistentId=doi:10.7910/DVN/S5BRBO (134 tab. files; 536006 variables).

"ddi" (aka the "full" ddi) is the export format that needs to be tested.
Note that some extra steps will be required in order to test this on qa:

  • You will want to change the storage driver to local filesystem ("file") for the datasets in question - so that Dataverse can write the export files;
  • And make sure you are testing the export code vs. looking at a potentially existing cached export; i.e., the file export_ddi.cached will need to be erased between testing runs.
    Happy to assist with the above if needed.

Does this PR introduce a user interface change? If mockups are available, please link/include them here:

Is there a release notes update needed for this change?:

Additional documentation:

@landreev landreev self-assigned this Sep 8, 2025
@github-actions github-actions Bot added FY25 Sprint 24 FY25 Sprint 24 (2025-05-21 - 2025-06-04) FY25 Sprint 25 FY25 Sprint 25 (2025-06-04 - 2025-06-18) FY25 Sprint 26 FY25 Sprint 26 (2025-06-18 - 2025-07-02) FY26 Sprint 1 FY26 Sprint 1 (2025-07-02 - 2025-07-16) FY26 Sprint 2 FY26 Sprint 2 (2025-07-16 - 2025-07-30) FY26 Sprint 3 (2025-07-30 - 2025-08-13) FY26 Sprint 4 FY26 Sprint 4 (2025-08-13 - 2025-08-27) FY26 Sprint 5 FY26 Sprint 5 (2025-08-27 - 2025-09-10) Size: 80 A percentage of a sprint. 56 hours. labels Sep 8, 2025
@github-actions

This comment has been minimized.

@landreev

Copy link
Copy Markdown
Contributor Author

Note that the PR now builds under Jenkins (with a snapshot release of dataverse-spi that is now published).

@github-actions

This comment has been minimized.

@cmbz cmbz added the FY26 Sprint 17 FY26 Sprint 17 (2026-02-11 - 2026-02-25) label Feb 11, 2026
@landreev landreev moved this from In Progress 💻 to On Hold ⌛ in IQSS Dataverse Project Feb 23, 2026
@landreev landreev moved this from On Hold ⌛ to In Progress 💻 in IQSS Dataverse Project May 4, 2026
@cmbz cmbz added the FY26 Sprint 22 FY26 Sprint 22 (2026-04-22 - 2026-05-06) label May 6, 2026
@cmbz cmbz added the FY26 Sprint 23 FY26 Sprint 23 (2026-05-06 - 2026-05-20) label May 6, 2026
…built with the new iteration of dataverse-spi 2.1.0 #11405
@coveralls

coveralls commented May 8, 2026

Copy link
Copy Markdown

Coverage Status

Coverage is 24.88%11405-refactor-exports into develop. No base build found for develop.

@cmbz cmbz added the FY26 Sprint 24 FY26 Sprint 24 (2026-05-20 - 2026-06-03) label May 21, 2026
@cmbz cmbz added the FY26 Sprint 25 FY26 Sprint 25 (2026-06-03 - 2026-06-17) label Jun 3, 2026
landreev added 2 commits June 18, 2026 13:57
Resolved the following merge conflicts:
	modules/dataverse-parent/pom.xml
	src/main/java/edu/harvard/iq/dataverse/harvest/server/OAIRecordServiceBean.java
	src/main/java/edu/harvard/iq/dataverse/util/json/JsonPrinter.java
@cmbz cmbz added the FY26 Sprint 26 FY26 Sprint 26 (2026-06-17 - 2026-07-01) label Jun 18, 2026
@cmbz cmbz added the FY27 Sprint 1 FY27 Sprint 1 (2026-07-01 - 2026-07-15) label Jul 1, 2026
@cmbz cmbz added the FY27 Sprint 2 FY27 Sprint 2 (2026-07-15 - 2026-07-29) label Jul 15, 2026
landreev added 5 commits July 19, 2026 22:39
... into IQSS/11405-refactor-exports (the working branch behind an already existing PR). 
merging without further ado.
…ing as is when committed, since there was only one dataset and one datasetversion in the throwaway database. #11405
…ularly-scheduled workflow action integration tests. #11405
Resolved conflicts:
	src/main/java/edu/harvard/iq/dataverse/api/Metadata.java
(seemingly trivial conflict, on account of a new API parameter added in this PR vs. extra annotations having been added in the develop branch). #11405
assertTrue(false, "Unexpected XMLStreamException when attempting to parse the dataDscr section: " + xse.getMessage());
} finally {
if (xmlr != null) {
try {xmlr.close();} catch (XMLStreamException e) {}

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🚫 [reviewdog] <com.puppycrawl.tools.checkstyle.checks.blocks.LeftCurlyCheck> reported by reviewdog 🐶
'{' at column 21 should have line break after.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Don't tell me what to do, reviewdog. That was formatted like that on purpose, to emphasize the fact that we don't care about that particular exception at that stage of the test.

@github-actions

Copy link
Copy Markdown

📦 Pushed preview images as

ghcr.io/gdcc/dataverse:11405-refactor-exports
ghcr.io/gdcc/configbaker:11405-refactor-exports

🚢 See on GHCR. Use by referencing with full name as printed above, mind the registry name.

@github-actions

Copy link
Copy Markdown

Test Results

404 tests  +1   389 ✅ +1   24m 2s ⏱️ - 1m 16s
 56 suites +1    15 💤 ±0 
 56 files   +1     0 ❌ ±0 

Results for commit 1eb8420. ± Comparison against base commit df71344.

@landreev
landreev marked this pull request as ready for review July 20, 2026 16:34
@landreev landreev moved this from In Progress 💻 to Ready for Review ⏩ in IQSS Dataverse Project Jul 20, 2026
@landreev landreev removed their assignment Jul 20, 2026
@landreev

landreev commented Jul 20, 2026

Copy link
Copy Markdown
Contributor Author

@poikilotherm Hi, I'm looking at the test results above, and seeing this failure to "Release Snapshot" for Dataverse SPI:

Screenshot 2026-07-20 at 1 55 13 PM

Am I correct assuming this is an old action that simply needs to be removed, now that dataverse-spi lives in https://github.com/gdcc/dataverse-spi?
Similarly, should I go ahead and purge modules/dataverse-spi from the main source tree?
Please stop me if there is any reasons why I should not delete these.
Thank you!

@poikilotherm

Copy link
Copy Markdown
Contributor

@landreev Yes, the in-tree SPI stuff can be completely eradicated. ☢️ 😄

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

FY25 Sprint 24 FY25 Sprint 24 (2025-05-21 - 2025-06-04) FY25 Sprint 25 FY25 Sprint 25 (2025-06-04 - 2025-06-18) FY25 Sprint 26 FY25 Sprint 26 (2025-06-18 - 2025-07-02) FY26 Sprint 1 FY26 Sprint 1 (2025-07-02 - 2025-07-16) FY26 Sprint 2 FY26 Sprint 2 (2025-07-16 - 2025-07-30) FY26 Sprint 3 (2025-07-30 - 2025-08-13) FY26 Sprint 4 FY26 Sprint 4 (2025-08-13 - 2025-08-27) FY26 Sprint 5 FY26 Sprint 5 (2025-08-27 - 2025-09-10) FY26 Sprint 9 FY26 Sprint 9 (2025-10-22 - 2025-11-05) FY26 Sprint 10 FY26 Sprint 10 (2025-11-05 - 2025-11-19) FY26 Sprint 11 FY26 Sprint 11 (2025-11-20 - 2025-12-03) FY26 Sprint 12 FY26 Sprint 12 (2025-12-03 - 2025-12-17) FY26 Sprint 13 FY26 Sprint 13 (2025-12-17 - 2025-12-31) FY26 Sprint 14 FY26 Sprint 14 (2025-12-31 - 2026-01-14) FY26 Sprint 15 FY26 Sprint 15 (2026-01-14 - 2026-01-28) FY26 Sprint 16 FY26 Sprint 16 (2026-01-28 - 2026-02-11) FY26 Sprint 17 FY26 Sprint 17 (2026-02-11 - 2026-02-25) FY26 Sprint 22 FY26 Sprint 22 (2026-04-22 - 2026-05-06) FY26 Sprint 23 FY26 Sprint 23 (2026-05-06 - 2026-05-20) FY26 Sprint 24 FY26 Sprint 24 (2026-05-20 - 2026-06-03) FY26 Sprint 25 FY26 Sprint 25 (2026-06-03 - 2026-06-17) FY26 Sprint 26 FY26 Sprint 26 (2026-06-17 - 2026-07-01) FY27 Sprint 1 FY27 Sprint 1 (2026-07-01 - 2026-07-15) FY27 Sprint 2 FY27 Sprint 2 (2026-07-15 - 2026-07-29) Size: 80 A percentage of a sprint. 56 hours.

Projects

Status: Ready for Review ⏩

Development

Successfully merging this pull request may close these issues.

Refactor and optimize the Export metadata framework, especially for the data/variable-level metadata

4 participants