Add Paratext metadata to project data files

[Enkidu93]

Fixes #902.

Is there other data we'd like to put in here? Language code? Translation type (e.g. BackTranslation)?

I wasn't sure @ddaspit if you wanted a generic metadata field. I can do that if you prefer.

I had to avoid a naming collision with the type Guid thus the slightly verbose property names.

---

This change is 

[codecov-commenter]

Codecov Report

❌ Patch coverage is 70.00000% with 15 lines in your changes missing coverage. Please review.
✅ Project coverage is 64.64%. Comparing base (a49cb12) to head (a7964c7).

Files with missing lines	Patch %	Lines
...val.DataFiles/Features/DataFiles/UpdateDataFile.cs	10.00%	8 Missing and 1 partial ⚠️
...al.DataFiles/Services/ParatextProjectDataParser.cs	73.91%	6 Missing ⚠️

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #931   +/-   ##
=======================================
  Coverage   64.63%   64.64%           
=======================================
  Files         379      381    +2     
  Lines       21646    21694   +48     
  Branches     2763     2765    +2     
=======================================
+ Hits        13991    14024   +33     
- Misses       6631     6645   +14     
- Partials     1024     1025    +1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[ddaspit]

@ddaspit reviewed 3 files and all commit messages, and made 1 comment.
Reviewable status: complete! all files reviewed, all discussions resolved (waiting on Enkidu93).

[Enkidu93]

@ddaspit reviewed 3 files and all commit messages, and made 1 comment.
Reviewable status: complete! all files reviewed, all discussions resolved (waiting on Enkidu93).

Thanks for the review 😁! Just making sure you saw my question above: While we're at it, is there any other Paratext information that would be helpful to stow here?

[ddaspit]

I missed your questions in the description. I responded to them in the comments.

@ddaspit made 3 comments.
Reviewable status: all files reviewed, 2 unresolved discussions (waiting on Enkidu93).

---

src/Serval/src/Serval.DataFiles/Models/DataFile.cs line 11 at r1 (raw file):

    public string Filename { get; init; } = "";
    public required FileFormat Format { get; init; }
    public ParatextMetadata? ParatextMetadata { get; init; }

I would like this property to be extensible for different formats, but I also like the type-safety of a statically typed class. Since we only support metadata for the Paratext format, we can just use the ParatextMetadata as the type but rename the field to FileMetadata. In the future, if we want to support different metadata for other formats, we can create a custom serializer that deserializes to the correct metadata class based on the value of the Format field.

---

src/Serval/src/Serval.DataFiles/Models/ParatextMetadata.cs line 3 at r1 (raw file):

namespace Serval.DataFiles.Models;

public record ParatextMetadata

I think it would make sense to include the language code, translation type, and versification. I think that would be the most useful metadata. What do you think?

[pmachapman]

@Enkidu93 You may want to consider including the FullName and perhaps the Visibility? Some projects have a Visibility of Confidential, and in it can be helpful to know that we have to deal quite sensitively with that project (on SF we store Visibility in the sf_project Mongo document for that reason).

[Enkidu93]

Thanks, Peter! I went ahead and added those. The visibility will require a new Machine version. See sillsdev/machine#412.

I also added a test.

@Enkidu93 made 3 comments.
Reviewable status: 0 of 8 files reviewed, 2 unresolved discussions (waiting on ddaspit).

---

src/Serval/src/Serval.DataFiles/Models/DataFile.cs line 11 at r1 (raw file):

Previously, ddaspit (Damien Daspit) wrote…

I would like this property to be extensible for different formats, but I also like the type-safety of a statically typed class. Since we only support metadata for the Paratext format, we can just use the ParatextMetadata as the type but rename the field to FileMetadata. In the future, if we want to support different metadata for other formats, we can create a custom serializer that deserializes to the correct metadata class based on the value of the Format field.

Done. Let me know if this is what you wanted.

---

src/Serval/src/Serval.DataFiles/Models/ParatextMetadata.cs line 3 at r1 (raw file):

Previously, ddaspit (Damien Daspit) wrote…

I think it would make sense to include the language code, translation type, and versification. I think that would be the most useful metadata. What do you think?

I went ahead added the fields you suggested as well as those Peter mentioned.

[ddaspit]

@ddaspit reviewed 8 files and all commit messages, made 1 comment, and resolved 2 discussions.
Reviewable status: complete! all files reviewed, all discussions resolved (waiting on Enkidu93).

[Enkidu93]

Waiting for #934 to go through first

[pmachapman]

Waiting for #934 to go through first

@Enkidu93 #934 is blocked awaiting feedback for stakeholders. I don't think it will be ready for this week.

[Enkidu93]

Waiting for #934 to go through first

@Enkidu93 #934 is blocked awaiting feedback for stakeholders. I don't think it will be ready for this week.

OK, I'll just go ahead and make the minimal changes to preserve the behavior with the new API. Thank you, Peter!

[Enkidu93]

@ddaspit If you could take a look to see if I properly merged my changes given your data files vertical slice refactoring, that would be great!

[ddaspit]

@ddaspit reviewed 11 files and all commit messages, and made 1 comment.
Reviewable status: complete! all files reviewed, all discussions resolved (waiting on Enkidu93).