fix: consistent http repsonses by gramian · Pull Request #2523 · ArcadeData/arcadedb

gramian · 2025-09-15T11:06:46Z

What does this PR do?

This change:

removes the createResult method in the AbstractHttpServerHandler class as it is now unneeded.
adds server name and server version to the responses of the /server GET query (which was before done via createResult
removes meta information from the /server POST commands
removes meta information from the /databases GET query

Motivation

I observed differing contents in HTTP responses in terms of non-result content.

Related issues

#2398

Additional Notes

I will be updating the docs accordingly

Checklist

I have run the build using mvn clean package command
My unit tests cover both failure and success scenarios

gemini-code-assist

Summary of Changes

Hello @gramian, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request addresses an observed inconsistency in HTTP responses by standardizing their content. The primary goal is to ensure that API responses are predictable and contain only the necessary information. This is achieved by removing a redundant utility method, directly embedding server details where appropriate, and stripping unnecessary meta-information from specific API endpoints, thus improving the overall clarity and consistency of the server's HTTP output.

Highlights

Removed Redundant Method: The createResult method in AbstractHttpServerHandler has been removed as it is no longer needed, simplifying the codebase.
Enhanced /server GET Response: The /server GET query now explicitly includes the server name and server version directly in its responses, providing essential server information.
Streamlined /server POST Responses: Meta information has been removed from the responses of /server POST commands, leading to cleaner and more focused output.
Simplified databases GET Query: Meta information has also been removed from the responses of the databases GET query, ensuring consistency with other API endpoints.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.

Feature	Command	Description
Code Review	`/gemini review`	Performs a code review for the current pull request in its current state.
Pull Request Summary	`/gemini summary`	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in issue comments and review comments.
Help	`/gemini help`	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

gemini-code-assist

Code Review

This pull request aims to create more consistent HTTP responses by selectively including or removing metadata. The createResult helper method is removed, and its call sites are updated to either remove the metadata or explicitly add only the necessary fields. The changes correctly implement the described behavior and improve API consistency. My review includes a few suggestions to improve code readability by removing redundant parentheses in JSONObject instantiations.

gemini-code-assist · 2025-09-15T11:08:25Z

server/src/main/java/com/arcadedb/server/http/handler/GetDatabasesHandler.java

      installedDatabases.retainAll(allowedDatabases);

-    final JSONObject result = createResult(user, null).put("result", new JSONArray(installedDatabases));
+    final JSONObject response = (new JSONObject()).put("result", new JSONArray(installedDatabases));


The parentheses around new JSONObject() are redundant and can be removed to improve code clarity. The line can be simplified to new JSONObject().put(...).

Suggested change

final JSONObject response = (new JSONObject()).put("result", new JSONArray(installedDatabases));

final JSONObject response = new JSONObject().put("result", new JSONArray(installedDatabases));

gemini-code-assist · 2025-09-15T11:08:25Z

server/src/main/java/com/arcadedb/server/http/handler/GetServerHandler.java

+    final JSONObject response = (new JSONObject()).put("version", Constants.getVersion())
+                                                  .put("serverName", httpServer.getServer().getServerName());


The parentheses around new JSONObject() are redundant and can be removed to improve code clarity. The instantiation can be simplified to new JSONObject().put(...).

Suggested change

final JSONObject response = (new JSONObject()).put("version", Constants.getVersion())

.put("serverName", httpServer.getServer().getServerName());

final JSONObject response = new JSONObject().put("version", Constants.getVersion())

.put("serverName", httpServer.getServer().getServerName());

gemini-code-assist · 2025-09-15T11:08:26Z

server/src/main/java/com/arcadedb/server/http/handler/PostServerCommandHandler.java

      installedDatabases.retainAll(allowedDatabases);

-    final JSONObject response = createResult(user, null).put("result", new JSONArray(installedDatabases));
+    final JSONObject response = (new JSONObject()).put("result", new JSONArray(installedDatabases));


The parentheses around new JSONObject() are redundant and can be removed to improve code clarity. The line can be simplified to new JSONObject().put(...).

Suggested change

final JSONObject response = (new JSONObject()).put("result", new JSONArray(installedDatabases));

final JSONObject response = new JSONObject().put("result", new JSONArray(installedDatabases));

(cherry picked from commit 1df409f)

fix: consistent http repsonses

effdf6e

gemini-code-assist bot reviewed Sep 15, 2025

View reviewed changes

clean up

39b2184

robfrank approved these changes Sep 16, 2025

View reviewed changes

robfrank added this to the 25.9.1 milestone Sep 16, 2025

robfrank added the enhancement New feature or request label Sep 16, 2025

robfrank merged commit 1df409f into ArcadeData:main Sep 16, 2025
8 of 12 checks passed

robfrank linked an issue Sep 16, 2025 that may be closed by this pull request

[HTTP-API] Inconsistent responses among endpoints #2398

Closed

gramian mentioned this pull request Sep 17, 2025

[HTTP-API] Inconsistent responses among endpoints #2398

Closed

lvca assigned gramian Oct 9, 2025

robfrank pushed a commit that referenced this pull request Nov 10, 2025

#2398 fix: consistent http responses (#2523)

baf0f7e

(cherry picked from commit 1df409f)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

fix: consistent http repsonses#2523

fix: consistent http repsonses#2523
robfrank merged 2 commits intoArcadeData:mainfrom
gramian:main

gramian commented Sep 15, 2025 •

edited

Loading

Uh oh!

gemini-code-assist bot left a comment

Uh oh!

gemini-code-assist bot left a comment

Uh oh!

gemini-code-assist bot Sep 15, 2025

Uh oh!

gemini-code-assist bot Sep 15, 2025

Uh oh!

gemini-code-assist bot Sep 15, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

	final JSONObject response = (new JSONObject()).put("result", new JSONArray(installedDatabases));
	final JSONObject response = new JSONObject().put("result", new JSONArray(installedDatabases));

		final JSONObject response = (new JSONObject()).put("version", Constants.getVersion())
		.put("serverName", httpServer.getServer().getServerName());

Uh oh!

Conversation

gramian commented Sep 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What does this PR do?

Motivation

Related issues

Additional Notes

Checklist

Uh oh!

gemini-code-assist bot left a comment

Choose a reason for hiding this comment

Summary of Changes

Highlights

Footnotes

Uh oh!

gemini-code-assist bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

gemini-code-assist bot Sep 15, 2025

Choose a reason for hiding this comment

Uh oh!

gemini-code-assist bot Sep 15, 2025

Choose a reason for hiding this comment

Uh oh!

gemini-code-assist bot Sep 15, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

gramian commented Sep 15, 2025 •

edited

Loading