openapi-generator icon indicating copy to clipboard operation
openapi-generator copied to clipboard

[crystal-lang] Resolve type check compile error in ApiError

Open usiegj00 opened this issue 1 year ago • 0 comments

Displaying a rescue'd ApiError causes a compile-time error using crystal-lang v1.12.1. The @message instance variable is defined as String | Nil; however, even with a .nil? check, the variable causes a compile-time error when a further .empty? call is made.

The offending line uses the|| (logical OR) operator to ensure @message is not Nil. Although this should logically ensure that further operations on @message were only applied to @message when it is of type String, this is not what is seen during a compilation. It is unintuitive that this is necessary as crystal-lang's logical OR operator uses left-hand associativity.

This PR uses .try to make the .empty? call. Since Nil defines .try and ignores it, this achieves the same functional goal.

In lib/openapi_client/src/openapi_client/api_error.cr:32:31

 32 | if @message.nil? || @message.empty?
                                   ^-----
Error: undefined method 'empty?' for Nil (compile-time type is (String | Nil))

PR checklist

  • [X] Read the contribution guidelines.
  • [X] Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • [X] Run the following to build the project and update samples:
    ./mvnw clean package 
    ./bin/generate-samples.sh ./bin/configs/*.yaml
    ./bin/utils/export_docs_generators.sh
    
    (For Windows users, please run the script in Git BASH) Commit all changed files. This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master. These must match the expectations made by your contribution. You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*. IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
  • [X] File the PR against the correct branch: master (upcoming 7.6.0 minor release - breaking changes with fallbacks), 8.0.x (breaking changes without fallbacks)
  • [X] If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

usiegj00 avatar May 25 '24 00:05 usiegj00