Skip to content

[cpp-restsdk] Fix invalid code if type is referenced in schema #19456

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

mvistein-dlr
Copy link

@mvistein-dlr mvistein-dlr commented Aug 26, 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.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.
    @ravinikam (2017/07) @stkrwork (2017/07) @etherealjoy (2018/02) @MartinDelille (2018/03) @muttleyxd (2019/08)

Problem

If a (primitive?) type is included in a schema per reference, invalid code is generated by cpp-restsdk. If the type is used directly, it is working as expected.

Example (working)

                    "apiKeyIds": {
                        "type": "array",
                        "readOnly": true,
                        "items": {
                            "type": "string",
                            "format": "uuid",
                            "readOnly": true
                        }
                    }

For this spec, the method getTypeDeclaration(...) in CppRestSdkClientCodegen.java will correctly return the type std::vector<utility::string_t>

Example (not working)

                    "apiKeyIds": {
                        "type": "array",
                        "items": {
                            "$ref": "#/components/schemas/UUID"
                        },
                        "readOnly": true
                    }

and UUID being defined as

           "UUID": {
                "format": "uuid",
                "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}",
                "type": "string"
            },

This spec does no longer work with the cpp-restsdk because the type std::vector<std::shared_ptr<utility::string_t>> is generated. In a generated client there is an attempt to call from_json(...) on utility::string_t which obviously does not exist due to the additional shared pointer.

Fix

The suggested fix checks whether the referenced type is a known, built-in type and uses this type instead of wrapping it in a shared pointer.

I'm not 100% sure this is the right place to fix this.

This should also fix #8456

@mvistein-dlr mvistein-dlr marked this pull request as ready for review August 27, 2024 12:36
@mvistein-dlr
Copy link
Author

@ravinikam (2017/07) @stkrwork (2017/07) @etherealjoy (2018/02) @MartinDelille (2018/03) @muttleyxd (2019/08)
Is there anything missing for this PR? Is there anything further I can provide?

@wing328
Copy link
Member

wing328 commented Mar 10, 2025

@mvistein-dlr thanks again for the PR.

i'll take another look later this week

sorry for the delay in reviewing the fix

@wing328 wing328 modified the milestones: 7.13.0, 7.14.0 Apr 27, 2025
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.

cpp-restsdk code generation issue for type: string when used as $ref:
3 participants