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

[R][Client] Allow api responses to be NULL or invalid JSON and fix file_params for file upload #18108

Closed

Conversation

joXemMx
Copy link
Contributor

@joXemMx joXemMx commented Mar 14, 2024

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.1.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.

Introduces changes:
ApiResponse now deserializes NULL values instead of producing errors by turning them into strings "NULL"

if (is.null(self$response)) {
  self$response <- charToRaw(jsonlite::toJSON("NULL"))
}

ApiClient now allows to deserialize responses not conforming to JSON, i.e. a simple string would normally produce an error in jsonlite::fromJSON but will now be passed on unchanged.

if (jsonlite::validate(raw_response)) {
  resp_obj <- jsonlite::fromJSON(raw_response)
} else {
  resp_obj <- raw_response
}

api.mustache file_params["{{baseName}}"] has been changed to file_params[["{{baseName}}"]] in order to function as intended when a file path is given as paramName in file_params[["{{baseName}}"]] <- curl::form_file(`{{paramName}}`)

Technical committee @Ramanth @saigiridhar21

@joXemMx joXemMx marked this pull request as ready for review March 15, 2024 07:59
@wing328
Copy link
Member

wing328 commented Mar 17, 2024

thanks for the PR. Why would we allow invalid JSON in the server response?

I think current behaviour is to throw errors/exceptions when the server response is invalid.

@wing328
Copy link
Member

wing328 commented Mar 17, 2024

I would recommend you to break down this PR into 3 smaller PRs for each fix/enhancement.

@joXemMx
Copy link
Contributor Author

joXemMx commented Mar 18, 2024

thanks for the PR. Why would we allow invalid JSON in the server response?

I think current behaviour is to throw errors/exceptions when the server response is invalid.

This was because my server response was a simple string, not a string in JSON format. But I now believe this is better to be fixed on the API side rather than in the Clients, so I will skip this in the separate merge requests.

@joXemMx
Copy link
Contributor Author

joXemMx commented Mar 18, 2024

Split into #18141 and #18142

@joXemMx joXemMx closed this Mar 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants