Follow-up #12035 and #12068: Show an informative progress indicator when dragging and dropping PDF files to JabRef

[BaronMac08]

Closes #8738
A follow-up to #12035 and #12068
Builds upon: the branch fix-melting-630 merged at #12001

Modifications:

• Dragging and dropping several PDF files into JabRef will be one large import rather than one small import for every file

Additions:

• Added informative messages about the ongoing progress of the big import by building upon the BackgroundTask progress indicator
• Added shortenFileName(fileName, maxLength) in StringUtil to shorten and prominently display the files being imported
• Added one new unit test for validating StringUtil.shortenFileName()

UI Screenshots after modifications and additions:

Mandatory checks

• I own the copyright of the code submitted and I licence it under the MIT license
• Change in CHANGELOG.md described in a way that is understandable for the average user (if applicable)
• Tests created for changes (if applicable)
• Manually tested changed features in running JabRef (always required)
• Screenshots added in PR description (for UI changes)
• Checked developer's documentation: Is the information available and up to date? If not, I outlined it in this pull request.
• Checked documentation: Is the information available and up to date? If not, I created an issue at https://github.com/JabRef/user-documentation/issues or, even better, I submitted a pull request to the documentation repository.

[BaronMac08]

Completed manually adding changes from https://github.com/JabRef/jabref/pull/12035/files. Awaiting peer-review from @mag-sun before marking pull request as ready for review.

[BaronMac08]

Peer review from @mag-sun completed, the PR is now ready for review.

[BaronMac08]

Hi @koppor, I have opened this PR as you requested in #12068. For the two failing unit tests:

1. StringUtil should have less than or equal to 774 lines of code
2. doNotUseLogicInModel was triggered due to the usage of FileUtil within StringUtil

Please let me know if there are any changes you would like me to make, thank you in advance for the feedback.

[koppor]

@BaronMac08 #12068 was closed. Maybe you mean #12072 -- please let pull requests open after changing something. Otherwise, it is really hard to follow.

[koppor]

2. doNotUseLogicInModel was triggered due to the usage of FileUtil within StringUtil

I think, not. import org.jabref.logic.util.io.FileUtil; is in logic, too. -- Please recheck.

[koppor]

1. StringUtil should have less than or equal to 774 lines of code

Move the code to FileUtil. I think, the cohesion is better there.

[BaronMac08]

I have moved the shortenFileName() method to FileUtil, as @koppor suggested. All checks have passed.

[koppor]

Small comments on the functionality of the ellipses. Maybe, you can fix it?

[koppor]

This is not good behavior.

Expected:

Suggested change

	"... , longfilename.extremelylongextension , 5",
	"... , longfilename.extremelylongextension , 10",
	"... , longfilename.extremelylongextension , 20",
	"lo.. , longfilename.extremelylongextension , 5",
	"longfil... , longfilename.extremelylongextension , 10",
	"longfilename.extr.... , longfilename.extremelylongextension , 20",

Reason: There are plenty !! of characters available at 10 and 20. They should be used. Not just 3

[koppor]

Please! Use all 5 characters: th....

[BaronMac08]

Definitely, I will modify the functionality to make use of the available characters.

[koppor]

Additional comment:

The number of files is displayed multiple times:

Please change progress information before the pipe sign to Importing files into 12072.bib |

And if you are on it, can you also change it for the indexing string?

[koppor]

Drop of files does not work. ALL files are attached to ALL entries. Even on pressing Cancel.

Please try out your things. Having 500 PDFs available is not too hard. I used all from my Downloads folder to test. - If not, you can try out the PDFs available at https://github.com/koppor/tugboat-mirror/tree/main/tugboat_issues.

[BaronMac08]

Drop of files does not work. ALL files are attached to ALL entries. Even on pressing Cancel.

Please try out your things. Having 500 PDFs available is not too hard. I used all from my Downloads folder to test. - If not, you can try out the PDFs available at https://github.com/koppor/tugboat-mirror/tree/main/tugboat_issues.

Thank you for pointing out the issue. I believe the issue is caused by the grouping of all files' entries and then sending it to the indexManager as one big EntriesAddedEvent. Therefore, I perform the exact same test of dragging and dropping the PDF files provided at https://github.com/koppor/tugboat-mirror/tree/main/tugboat_issues into JabRef/main and branch fix-8738 with the following results:

1. On JabRef/main:
   
   

2. On fix-8738:
   
   

The difference between main and fix-8738 for the entry "... To Don Knuth..." in the linked files section:

1. On main: tb139complete.pdf and tb138complete.pdf are at the beginning of the list
2. On fix-8738: tb138complete.pdf and tb139completed.pdf are at the end of the list

Additionally, on both main and fix-8738, the file "The Communications of the TEX Users Group.pdf" has the same linked file.

I am wondering what would be the correct behaviour for this dataset of PDF files so that the issue on branch fix-8738 could be identified and resolved. Thank you in advance for the clarification @koppor.

[koppor]

I am wondering what would be the correct behaviour for this dataset of PDF files so that the issue on branch fix-8738 could be identified and resolved.

Thank you for investigating. I needed to raise a new issue at #12098.

[koppor]

Thank you for the quick follow-up in the filename methods. This is good to go now!

[BaronMac08]

Thank you for your guidance and advice!