Extract BibEntry endpoints into BibEntryResource and add tests #13731

muigor · 2025-08-21T22:23:12Z

Steps to test

Mandatory checks

I own the copyright of the code submitted and I license it under the MIT license
[/] Change in CHANGELOG.md described in a way that is understandable for the average user (if change is visible to the user)
Tests created for changes (if applicable)
Manually tested changed features in running JabRef (always required)
[/] Screenshots added in PR description (if change is visible to the user)
[/] 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 · 2025-08-22T08:15:44Z

jabsrv/src/test/java/org/jabref/http/server/BibEntryResourceTest.java

+
+        JsonNode root = mapper.readTree(response);
+
+        assertTrue(root.isArray(), "CSL JSON must be a JSON array");


We normally check the complete content at once. Then, its easier to know whats going wrong, because IntellIj displays the diff

Thanks for the feedback , i work on it , it is ready

Hello @koppor, @calixtus , the change has been implemented and everything should be fine. I would appreciate it if you could review it when you have time

…13588)

trag-bot · 2025-08-22T23:01:52Z

@trag-bot didn't find any issues in the code! ✅✨

Siedlerchr

codewise looks good to me, but I have no clue if this is correct otherwise

muigor · 2025-08-25T21:28:27Z

codewise looks good to me, but I have no clue if this is correct otherwise

Hello @Siedlerchr Thanks for the Feedback, I made changes regarding the tasks on this issue #13588

palukku · 2025-08-26T15:47:11Z

Did you manually tested the changes you made?
For me the api requests in rest-api.http don't work anymore:
This is what I expected:

But I received:

palukku · 2025-08-26T16:00:47Z

Also looks like you added the json ones (which for itself looks on first sight good and can be kept) but you removed the html and plain string representation for the responses. If I understand the task correct they are the ones that should be moved to the new resource.

palukku · 2025-08-26T16:02:02Z

jabsrv/src/main/java/org/jabref/http/server/LibraryResource.java

-    /**
-     * At http://localhost:23119/libraries/{id}/entries/{entryId} <br><br>
-     *
-     * Combines attributes of a given BibEntry into a basic entry preview for as plain text.
-     *
-     * @param id The name of the library
-     * @param entryId The CitationKey of the BibEntry
-     * @return a basic entry preview as plain text
-     * @throws IOException
-     * @throws NotFoundException
-     */
-    @GET
-    @Path("entries/{entryId}")
-    @Produces(MediaType.TEXT_PLAIN + ";charset=UTF-8")
-    public String getPlainRepresentation(@PathParam("id") String id, @PathParam("entryId") String entryId) throws IOException {
-        BibDatabaseContext databaseContext = getDatabaseContext(id);
-        List<BibEntry> entriesByCitationKey = databaseContext.getDatabase().getEntriesByCitationKey(entryId);
-        if (entriesByCitationKey.isEmpty()) {
-            throw new NotFoundException("Entry with citation key '" + entryId + "' not found in library " + id);
-        }
-        if (entriesByCitationKey.size() > 1) {
-            LOGGER.warn("Multiple entries found with citation key '{}'. Using the first one.", entryId);
-        }
-
-        // TODO: Currently, the preview preferences are in GUI package, which is not accessible here.
-        // build the preview
-        BibEntry entry = entriesByCitationKey.getFirst();
-
-        String author = entry.getField(StandardField.AUTHOR).orElse("(N/A)");
-        String title = entry.getField(StandardField.TITLE).orElse("(N/A)");
-        String journal = entry.getField(StandardField.JOURNAL).orElse("(N/A)");
-        String volume = entry.getField(StandardField.VOLUME).orElse("(N/A)");
-        String number = entry.getField(StandardField.NUMBER).orElse("(N/A)");
-        String pages = entry.getField(StandardField.PAGES).orElse("(N/A)");
-        String releaseDate = entry.getField(StandardField.DATE).orElse("(N/A)");
-
-        // the only difference to the HTML version of this method is the format of the output:
-        String preview =
-                "Author: " + author
-                        + "\nTitle: " + title
-                        + "\nJournal: " + journal
-                        + "\nVolume: " + volume
-                        + "\nNumber: " + number
-                        + "\nPages: " + pages
-                        + "\nReleased on: " + releaseDate;
-
-        return preview;
-    }


Those are the ones that should be moved to the new resource.

palukku · 2025-08-26T16:02:22Z

jabsrv/src/main/java/org/jabref/http/server/LibraryResource.java

-    /**
-     * At http://localhost:23119/libraries/{id}/entries/{entryId} <br><br>
-     *
-     * Combines attributes of a given BibEntry into a basic entry preview for as HTML text.
-     *
-     * @param id The name of the library
-     * @param entryId The CitationKey of the BibEntry
-     * @return a basic entry preview as HTML text
-     * @throws IOException
-     */
-    @GET
-    @Path("entries/{entryId}")
-    @Produces(MediaType.TEXT_HTML + ";charset=UTF-8")
-    public String getHTMLRepresentation(@PathParam("id") String id, @PathParam("entryId") String entryId) throws IOException {
-        List<BibEntry> entriesByCitationKey = getDatabaseContext(id).getDatabase().getEntriesByCitationKey(entryId);
-        if (entriesByCitationKey.isEmpty()) {
-            throw new NotFoundException("Entry with citation key '" + entryId + "' not found in library " + id);
-        }
-        if (entriesByCitationKey.size() > 1) {
-            LOGGER.warn("Multiple entries found with citation key '{}'. Using the first one.", entryId);
-        }
-
-        // TODO: Currently, the preview preferences are in GUI package, which is not accessible here.
-        // build the preview
-        BibEntry entry = entriesByCitationKey.getFirst();
-
-        String author = entry.getField(StandardField.AUTHOR).orElse("(N/A)");
-        String title = entry.getField(StandardField.TITLE).orElse("(N/A)");
-        String journal = entry.getField(StandardField.JOURNAL).orElse("(N/A)");
-        String volume = entry.getField(StandardField.VOLUME).orElse("(N/A)");
-        String number = entry.getField(StandardField.NUMBER).orElse("(N/A)");
-        String pages = entry.getField(StandardField.PAGES).orElse("(N/A)");
-        String releaseDate = entry.getField(StandardField.DATE).orElse("(N/A)");
-
-        // the only difference to the plain text version of this method is the format of the output:
-        String preview =
-                "<strong>Author:</strong> " + author + "<br>" +
-                        "<strong>Title:</strong> " + title + "<br>" +
-                        "<strong>Journal:</strong> " + journal + "<br>" +
-                        "<strong>Volume:</strong> " + volume + "<br>" +
-                        "<strong>Number:</strong> " + number + "<br>" +
-                        "<strong>Pages:</strong> " + pages + "<br>" +
-                        "<strong>Released on:</strong> " + releaseDate;
-
-        return preview;
-    }


palukku · 2025-08-26T16:03:58Z

jabsrv/src/test/rest-api.http

+
+###
+GET http://localhost:23119/libraries/demo/entries/Corti_2009


Please add a heading like on the others and move it up to the other cases which handle the entries itself, the end is for error cases. Also add that it only accepts the according mediatype

muigor changed the title ~~Add biby entry ressource endpoint test~~ Extract BibEntry endpoints into BibEntryResource and add tests Aug 21, 2025

koppor reviewed Aug 22, 2025

View reviewed changes

muigor force-pushed the add-bibyEntryRessource-endpoint-test(#13588) branch from 79168dd to 0b17f24 Compare August 22, 2025 11:44

igor and others added 4 commits August 22, 2025 13:46

Extract BibEntry endpoints into BibEntryResource and add tests

0b17f24

Merge branch 'main' into add-bibyEntryRessource-endpoint-test(JabRef#…

009b223

…13588)

Merge branch 'main' into add-bibyEntryRessource-endpoint-test(JabRef#…

9788ad3

…13588)

Merge branch 'main' into add-bibyEntryRessource-endpoint-test(JabRef#…

d0e2f38

…13588)

Siedlerchr requested a review from palukku August 25, 2025 17:49

Siedlerchr reviewed Aug 25, 2025

View reviewed changes

Siedlerchr added the status: ready-for-review Pull Requests that are ready to be reviewed by the maintainers label Aug 25, 2025

palukku reviewed Aug 26, 2025

View reviewed changes

koppor removed the status: ready-for-review Pull Requests that are ready to be reviewed by the maintainers label Sep 8, 2025

koppor marked this pull request as draft September 8, 2025 20:18

koppor added the status: changes-required Pull requests that are not yet complete label Sep 8, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Extract BibEntry endpoints into BibEntryResource and add tests #13731

Extract BibEntry endpoints into BibEntryResource and add tests #13731

muigor commented Aug 21, 2025

Uh oh!

koppor Aug 22, 2025

Uh oh!

muigor Aug 22, 2025

Uh oh!

muigor Aug 25, 2025 •

edited

Loading

Uh oh!

trag-bot bot commented Aug 22, 2025

Uh oh!

Siedlerchr left a comment

Uh oh!

muigor commented Aug 25, 2025 •

edited

Loading

Uh oh!

palukku commented Aug 26, 2025

Uh oh!

palukku commented Aug 26, 2025

Uh oh!

palukku Aug 26, 2025

Uh oh!

palukku Aug 26, 2025

Uh oh!

palukku Aug 26, 2025

Uh oh!

Uh oh!


		JsonNode root = mapper.readTree(response);

		assertTrue(root.isArray(), "CSL JSON must be a JSON array");


		###
		GET http://localhost:23119/libraries/demo/entries/Corti_2009

Uh oh!

Extract BibEntry endpoints into BibEntryResource and add tests #13731

Are you sure you want to change the base?

Extract BibEntry endpoints into BibEntryResource and add tests #13731

Conversation

muigor commented Aug 21, 2025

Steps to test

Mandatory checks

Uh oh!

koppor Aug 22, 2025

Choose a reason for hiding this comment

Uh oh!

muigor Aug 22, 2025

Choose a reason for hiding this comment

Uh oh!

muigor Aug 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

trag-bot bot commented Aug 22, 2025

Uh oh!

Siedlerchr left a comment

Choose a reason for hiding this comment

Uh oh!

muigor commented Aug 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

palukku commented Aug 26, 2025

Uh oh!

palukku commented Aug 26, 2025

Uh oh!

palukku Aug 26, 2025

Choose a reason for hiding this comment

Uh oh!

palukku Aug 26, 2025

Choose a reason for hiding this comment

Uh oh!

palukku Aug 26, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

muigor Aug 25, 2025 •

edited

Loading

muigor commented Aug 25, 2025 •

edited

Loading