In Progress : SLR : Improved study.yml format and terminology alignment so far#15215
In Progress : SLR : Improved study.yml format and terminology alignment so far#15215faneeshh wants to merge 6 commits intoJabRef:mainfrom
Conversation
|
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. |
This comment has been minimized.
This comment has been minimized.
6068de3 to
33ce1aa
Compare
This comment has been minimized.
This comment has been minimized.
33ce1aa to
41d3223
Compare
This comment has been minimized.
This comment has been minimized.
|
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. |
|
For submodule conflicts see https://devdocs.jabref.org/code-howtos/faq.html#submodules |
|
Refs #14170 |
|
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. |
|
Superficially, this PR should also include the other fixes outlined at #13844 (comment) |
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
✅ All tests passed ✅🏷️ Commit: 2573254 Learn more about TestLens at testlens.app. |
|
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. |
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
Checklist
CHANGELOG.mdin a way that can be understood by the average user (if change is visible to the user)