Skip to content

No Issue - Add a warn in the logs when elements have duplicated vars #823

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 3 commits into from
Oct 17, 2024
Merged

No Issue - Add a warn in the logs when elements have duplicated vars #823

merged 3 commits into from
Oct 17, 2024

Conversation

@ricardozanini
Copy link
Member

@ricardozanini ricardozanini commented Oct 16, 2024

Many thanks for submitting your Pull Request ❤️!

Please make sure that your PR meets the following requirements:

  • You have read the contributors guide
  • Your code is properly formatted according to our code style
  • Pull Request title contains the target branch if not targeting main: [0.9.x] Subject
  • Pull Request contains link to the issue
  • Pull Request contains link to any dependent or related Pull Request
  • Pull Request contains description of the issue
  • Pull Request does not include fixes for issues other than the main ticket

In this PR, we add a WARN to the logs when the OpenAPI file has duplicated element variables. For example:

    CheckpointInfo:
      type: object
      properties:
        checkpointId:
          type: integer
          format: int64
        failureCause:
          $ref: '#/components/schemas/SerializedThrowable'
    SavepointInfo:
      type: object
      properties:
        failure-cause:
          $ref: '#/components/schemas/SerializedThrowable'
        location:
          type: string

Will fail because failure-cause and failureCause are the same variables from the Java syntax perspective as soon as we convert both to CamelCase.

Why not remove the duplicates?

Because users will only realize this bug in runtime when it's too late, and Json marshaling won't work:

        /**
        * Get failureCause
        * @return failureCause
        **/
        @com.fasterxml.jackson.annotation.JsonProperty("failure-cause")
        public SerializedThrowable getFailureCause() {
            return failureCause;
        }

        /**
        * Get failureCause
        * @return failureCause
        **/
        @com.fasterxml.jackson.annotation.JsonProperty("failureCause")
        public SerializedThrowable getFailureCause() {
            return failureCause;
        }

Users should fix the OpenAPI spec on their side to have a healthy codegen.

How to backport a pull request to a different branch?

In order to automatically create a backporting pull request please add one or more labels having the following format backport-<branch-name>, where <branch-name> is the name of the branch where the pull request must be backported to (e.g., backport-quarkus2 to backport the original PR to the quarkus2 branch).

NOTE: backporting is an action aiming to move a change (usually a commit) from a branch (usually the main one) to another one, which is generally referring to a still maintained release branch. Keeping it simple: it is about to move a specific change or a set of them from one branch to another.

Once the original pull request is successfully merged, the automated action will create one backporting pull request per each label (with the previous format) that has been added.

If something goes wrong, the author will be notified and at this point a manual backporting is needed.

NOTE: this automated backporting is triggered whenever a pull request on main branch is labeled or closed, but both conditions must be satisfied to get the new PR created.

@ricardozanini ricardozanini requested a review from a team as a code owner October 16, 2024 20:36
@ricardozanini
Fix imports
d327f5a 
Signed-off-by: Ricardo Zanini <[email protected]>
@ricardozanini
Add the Override annotation
0e25fdb 
Signed-off-by: Ricardo Zanini <[email protected]>
@ricardozanini ricardozanini merged commit adf964d into quarkiverse:main Oct 17, 2024
11 checks passed
@ricardozanini ricardozanini deleted the issue-flink branch October 17, 2024 16:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@hbelmiro hbelmiro hbelmiro approved these changes

@fjtirado fjtirado fjtirado approved these changes

@mcruzdev mcruzdev Awaiting requested review from mcruzdev

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@ricardozanini @hbelmiro @fjtirado