fix(model): Fix NPE when OpenAIClient stream call handle error

[aihai]

AgentScope-Java Version

1.0.10

Description

Fixes: #786

Checklist

Please check the following items before code is ready to be reviewed.

• Code has been formatted with mvn spotless:apply
• All tests are passing (mvn test)
• Javadoc comments are complete and follow project conventions
• Related documentation has been updated (e.g. links, examples, etc.)
• Code is ready for review

[gemini-code-assist]

Summary of Changes

Hello @aihai, 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 resolves a potential NullPointerException that could occur in the OpenAIClient when handling errors during streaming calls, particularly if the HTTP status code was not provided. The change ensures robust error handling by explicitly checking for null status codes and adding a dedicated test to validate this behavior.

Highlights

• NullPointerException Fix: Addressed a potential NullPointerException in the OpenAIException.create method by changing the statusCode parameter from int to Integer and providing a default status code (418) if the provided status code is null.
• Error Handling Test Case: Introduced a new test case in OpenAIClientTest to verify that an OpenAIException is correctly thrown when the OpenAIClient encounters an error during a streaming call, specifically when a non-2xx HTTP status code is returned.

Changelog

• agentscope-core/src/main/java/io/agentscope/core/model/exception/OpenAIException.java
  • Modified the create method signature to accept Integer statusCode instead of int statusCode.
  • Added a null check for statusCode in the create method, defaulting it to 418 if null.
• agentscope-core/src/test/java/io/agentscope/core/model/OpenAIClientTest.java
  • Reordered import statements to group static imports separately.
  • Added a new test method testThrowOpenAIExceptionWhenCustomEndpointPathInStreamCall to assert that OpenAIException is thrown for erroneous stream responses (e.g., 301 status code).

Activity

• The author has completed the checklist, indicating the code has been formatted, tests are passing, Javadoc comments are complete, documentation is updated, and the code is ready for review.

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 by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

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 pull request 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.

Footnotes

1. 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 addresses a potential NullPointerException during stream error handling in the OpenAIClient. The fix involves changing the statusCode parameter in OpenAIException.create to an Integer to allow for null values, and providing a default status code of 418 when it is null. Additionally, a new test case has been added to improve test coverage for error handling in stream calls. The changes are logical and effectively resolve the issue.

[gemini-code-assist]

Using the HTTP status code 418 ("I'm a teapot") as a default is a bit unusual and can be confusing for developers who are not familiar with this context. To improve readability and maintainability, it would be better to define this as a named constant, for example private static final int DEFAULT_STATUS_CODE_WHEN_NULL = 418;, and add a comment explaining its purpose as a placeholder for when no status code is available. Since adding a constant might be outside the scope of this change, at a minimum, a code comment explaining the choice of 418 would be beneficial.

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!