Skip to content

In Progress : SLR : Improved study.yml format and terminology alignment so far#15215

Draft
faneeshh wants to merge 6 commits intoJabRef:mainfrom
faneeshh:fix/slr-study-v2
Draft

In Progress : SLR : Improved study.yml format and terminology alignment so far#15215
faneeshh wants to merge 6 commits intoJabRef:mainfrom
faneeshh:fix/slr-study-v2

Conversation

@faneeshh
Copy link
Copy Markdown
Contributor

Closes #12642 (hopefully)

This is basically a continuation of the work done in #13844. I'm starting with the foundational schema changed for the improved SLR support and I'm currently just gonna focus on getting the infrastructure right before diving into the actual fetcher logic.

Progress so far in the 1st Commit :

Terminology Alignment : Renamed StudyDatabase to StudyCatalog across the model and logic to match the UI and align with the domain language used in the repository
Schema Versioning : Added the version field to the Study model to support SEMVER (v2.0) which I feel is necessary for the migration

I'm attaching this rough sketch of how the data flow changes between the legacy format and the v2 format. I'm planning on creating a Migrator and string to string integration tests to ensure we don't break existing user studies

image

Checklist

  • I own the copyright of the code submitted and I license it under the MIT license
  • I manually tested my changes in running JabRef (always required)
  • [/] I added JUnit tests for changes (if applicable)
  • [/] I added screenshots in the PR description (if change is visible to the user)
  • [/] I added a screenshot in the PR description showing a library with a single entry with me as author and as title the issue number
  • [/] I described the change in CHANGELOG.md in a way that can be understood by the average user (if change is visible to the user)
  • I checked the user documentation for up to dateness and submitted a pull request to our user documentation repository

@faneeshh
Copy link
Copy Markdown
Contributor Author

I've added the reason field directly into the StudyCatalog model. While it's not fully wired into the fxml yet in this specific commit I felt like having it in the data model would make sure that upcoming StudyYamlMigrator can handle the field mapping consistently from the start.

@testlens-app

This comment has been minimized.

@github-actions github-actions Bot added the status: changes-required Pull requests that are not yet complete label Feb 26, 2026
@testlens-app

This comment has been minimized.

@testlens-app

This comment has been minimized.

@github-actions
Copy link
Copy Markdown
Contributor

Your pull request conflicts with the target branch.

Please merge with your code. For a step-by-step guide to resolve merge conflicts, see https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-using-the-command-line.

@subhramit
Copy link
Copy Markdown
Member

For submodule conflicts see https://devdocs.jabref.org/code-howtos/faq.html#submodules

@subhramit
Copy link
Copy Markdown
Member

Refs #14170

@koppor
Copy link
Copy Markdown
Member

koppor commented Mar 17, 2026

I think, its OK for me to drop support for the old format. If anyone rasies their voice rearging this, we can work on this.

One reason for this: the current code does not keep datastructrures for the v1 format, it just updates to the new one.

@koppor
Copy link
Copy Markdown
Member

koppor commented Mar 17, 2026

Superficially, this PR should also include the other fixes outlined at #13844 (comment)

@testlens-app

This comment has been minimized.

@testlens-app

This comment has been minimized.

@testlens-app

This comment has been minimized.

@testlens-app

This comment has been minimized.

@testlens-app
Copy link
Copy Markdown

testlens-app Bot commented Mar 19, 2026

✅ All tests passed ✅

🏷️ Commit: 2573254
▶️ Tests: 10195 executed
⚪️ Checks: 49/49 completed


Learn more about TestLens at testlens.app.

@github-actions github-actions Bot added status: no-bot-comments and removed status: changes-required Pull requests that are not yet complete labels Mar 19, 2026
@calixtus
Copy link
Copy Markdown
Member

Whts the status here?

@faneeshh
Copy link
Copy Markdown
Contributor Author

Whts the status here?

The Migrator is handling the v1 to v2 conversion automatically on read and the tests are passing as well. I do still have to extend StudyQuery to support catalogSpecific map for per-catalog native query overrides and also add the string to string tests that @koppor pointed out were missing from the original PR.

I had finals going on at college so didn't really get much time to work on it in a while. I can possibly work on it next week.

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

New study.yml format

4 participants