Improvement on check for missing commas when importing or opening a .bib file

[LIM0000]

Previous discussion about check for missing commas when importing or opening a .bib file #8011

• When importing the bib file, the following exception stack trace pops up:
  org.jabref.logic.importer.ImportException: Could not find a suitable import format.
  at [email protected]/org.jabref.logic.importer.ImportFormatReader.importUnknownFormat(Unknown Source)
  at [email protected]/org.jabref.gui.importer.ImportAction.doImport(Unknown Source)
  at [email protected]/org.jabref.gui.importer.ImportAction.lambda$automatedImport$1(Unknown Source)
  at [email protected]/org.jabref.gui.util.BackgroundTask$1.call(Unknown Source)
  at [email protected]/org.jabref.gui.util.DefaultTaskExecutor$1.call(Unknown Source)
  at [email protected]/javafx.concurrent.Task$TaskCallable.call(Unknown Source)
  at java.base/java.util.concurrent.FutureTask.run(Unknown Source)
  at java.base/java.util.concurrent.Executors$RunnableAdapter.call(Unknown Source)
  at java.base/java.util.concurrent.FutureTask.run(Unknown Source)
  at java.base/java.util.concurrent.ThreadPoolExecutor.runWorker(Unknown Source)
  at java.base/java.util.concurrent.ThreadPoolExecutor$Worker.run(Unknown Source)
  at java.base/java.lang.Thread.run(Unknown Source)
• When opening the library normally, there is no error message. It is just shown to be empty. No message, no error, nothing.

Proposal solution: Display warning dialog with meaningful message instead of error dialog to user

Fixes: #8011

1. Display meaningful dialog by getting error message from parserResult.

throw new ImportException(parserResult.getErrorMessage());

2. Check if is instanceof ImportExpection, display warning dialog instead of error dialog

} else if (importError instanceof ImportException) {
                    DefaultTaskExecutor.runAndWaitInJavaFXThread(() -> dialogService.showWarningDialogAndWait(Localization.lang("Import error"), importError.getLocalizedMessage()));

Further discussion:

Add this implementation to opening of file.

PR checklist:

• 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.

[koppor]

I like this change

[koppor]

This is "only" to show a warning instead of an error?

What happens if you remove that code? Is JabRef showing an error? Then I would vote to remove this check

[Siedlerchr]

@LIM0000 What's the status here?

[LIM0000]

Hi @Siedlerchr , this PR is still pending for #8011 (comment) and #8011 (comment).

[Siedlerchr]

Please also change the dialog when leaving the source tab

[ThiloteE]

Additionally, as I was arguing in #8011 (comment), having different error messages depending on what the user was doing would be nice.

Those are the error messages I came up with

• When user input via entry editor in {}bibtex source tab:

  User input via entry-editor in `{}bibtex source` tab led to failure.
  Please check your library file for wrong syntax.
  
  Error occurred when parsing entry:
  Error in line 11 or above: Empty text token.
  Typical cause: Missing comma between two fields.
  
  JabRef skipped the entry.
  

• When importing library file:

  Please check your library file for wrong syntax.
  
  Error occurred when parsing entry:
  Error in line 11 or above: Empty text token.
  Typical cause: Missing comma between two fields.
  
  JabRef skipped the entry.
  

• When opening library file:

  Please check your library file for wrong syntax.
  
  Error occurred when parsing entry:
  Error in line 11 or above: Empty text token.
  Typical cause: Missing comma between two fields.
  
  JabRef skipped the entry.
  

The blank lines in between sentences is intentional to prevent "wall of text".