Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged

Conversation

usiegj00
Copy link
Contributor

@usiegj00 usiegj00 commented May 25, 2024

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))

@wing328 @cyangle

PR checklist

  • Read the contribution guidelines.
  • 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.
  • 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.
  • 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)
  • 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 usiegj00 changed the title Crystal update api error type check [crystal-lang] resolve type check compile error in ApiError May 25, 2024
@usiegj00 usiegj00 changed the title [crystal-lang] resolve type check compile error in ApiError [crystal-lang] Resolve type check compile error in ApiError May 25, 2024
…n nillable type. This appears a poor implementation issue by crystal-lang, but this explicit try avoids the issue for now.
@usiegj00 usiegj00 force-pushed the crystal-update-api-error-type-check branch from 5a32437 to 9b4b189 Compare May 26, 2024 03:25
@usiegj00 usiegj00 marked this pull request as ready for review May 26, 2024 03:27
@wing328
Copy link
Member

wing328 commented May 26, 2024

tested locally and the tests passed

thanks for the PR

@wing328 wing328 merged commit 77365c3 into OpenAPITools:master May 26, 2024
15 checks passed
@wing328 wing328 added this to the 7.7.0 milestone May 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants