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] catch enum classes in toJSON #18194

Draft
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

joXemMx
Copy link
Contributor

@joXemMx joXemMx commented Mar 21, 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.

Related to #18183

If an enum-class is parameter of another class, it currently gets serialized by toJSON like every other class:

EnumObject[["enum"]] <-
  self$`enum`$toJSON()

This runs into issues as an enum class is essentially just a class holding a singular string value "ENUM". In the JSON that is being put into the http request, "ENUM" is then turned into "\"ENUM\"", which will not be recognized by the API as it is not a valid enum, but rather the same enum with quotations marks around it.

To circumvent this, I implemented a check in toJSON that looks at the class in JSON form and checks if it has no keys and its only value is a string (this should apply only to enum classes in my mind, but please prove me wrong otherwise).

if (length(names(self$`{{name}}`$toJSON())) == 0L && is.character(jsonlite::fromJSON(self$`{{name}}`$toJSON()))) {
  jsonlite::fromJSON(self$`{{name}}`$toJSON())
} else {
  self$`{{name}}`$toJSON()
}

This way, the enum will be assigned as a string instead of an JSON object and serialized correctly. If you see any better fixes for this problem, please feel free to pitch some ideas. This was just the easiest and most obvious fix for me right now.
Technical committee @Ramanth @saigiridhar21

@@ -238,7 +238,11 @@
self$`{{name}}`
{{/isPrimitiveType}}
{{^isPrimitiveType}}
self$`{{name}}`$toJSON()
if (length(names(self$`{{name}}`$toJSON())) == 0L && is.character(jsonlite::fromJSON(self$`{{name}}`$toJSON()))) {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i saw you using is.character check

Does it also cover numeric values such as 13, 5.6 ?

@@ -238,7 +238,11 @@
self$`{{name}}`
{{/isPrimitiveType}}
{{^isPrimitiveType}}
self$`{{name}}`$toJSON()
if (length(names(self$`{{name}}`$toJSON())) == 0L && is.character(jsonlite::fromJSON(self$`{{name}}`$toJSON()))) {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i saw you using is.character check

Does it also cover numeric values such as 13, 5.6 ?

Copy link
Contributor Author

@joXemMx joXemMx Mar 22, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Currently it does not, as I intended. I only want to catch enum classes (as generated by modelEnum.mustache) and did not see how anything other than character would make much sense. If you want to include numeric values, I could check for jsonlite::fromJSON(self$`{{name}}`$toJSON()) %in$ c("character", "numeric", "integer", "logical", "complex") instead of using is.character.

@wing328 wing328 added this to the 7.5.0 milestone Mar 22, 2024
@joXemMx joXemMx marked this pull request as draft March 22, 2024 16:29
@joXemMx
Copy link
Contributor Author

joXemMx commented Mar 22, 2024

This seems to still have some hickups, I converted to draft until I sorted them out

@wing328 wing328 modified the milestones: 7.5.0, 7.6.0 Apr 17, 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