Skip to content

[java][retrofit2] Fix: Always set jakarta_annotation_version#12834

Merged
wing328 merged 1 commit intoOpenAPITools:masterfrom
edwardmp:patch-1
Jul 13, 2022
Merged

[java][retrofit2] Fix: Always set jakarta_annotation_version#12834
wing328 merged 1 commit intoOpenAPITools:masterfrom
edwardmp:patch-1

Conversation

@edwardmp
Copy link
Copy Markdown
Contributor

@edwardmp edwardmp commented Jul 11, 2022

Commit 1735ab9 added changes to set the jakarta_annotation_version.

I've recently noticed that when using retrofit2 library, the project builds fine with Maven but fails with Gradle.

The build fails due to Could not get unknown property 'jakarta_annotation_version' for object of type org.gradle.api.internal.artifacts.dsl.dependencies.DefaultDependencyHandler.

Digging into this, in the generated build.gradle the jakarta_annotation_version is never set.
Upon closer inspection, aforementioned commit seems to indeed set it differently for the Maven build configuration than the Gradle build configuration (same for SBT configuration) for that matter.

The issue is that due to human error the jakarta_annotation_version line is added within the {{#usePlayWS}} block, meaning it won't be generated when usePlayWS is false, even though it should.

This commit changes this to always generate it.

E.g. before applying this commit build.gradle looks like:

ext {
    oltu_version = "1.0.1"
    retrofit_version = "2.3.0"
    swagger_annotations_version = "1.5.22"
    junit_version = "4.13.2"
    json_fire_version = "1.8.0"
}

After applying the change:

ext {
    oltu_version = "1.0.1"
    retrofit_version = "2.3.0"
    jakarta_annotation_version = "1.3.5"
    swagger_annotations_version = "1.5.22"
    junit_version = "4.13.2"
    json_fire_version = "1.8.0"
}   

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/utils/export_docs_generators.sh
    
    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*.
    For Windows users, please run the script in Git BASH.
  • File the PR against the correct branch: master (6.1.0) (minor release - breaking changes with fallbacks), 7.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.

@wing328
Copy link
Copy Markdown
Member

wing328 commented Jul 12, 2022

@edwardmp thanks for the PR. Can you please follow step 3 in the PR checklist to update the samples?

Commit 1735ab9 added changes to set the `jakarta_annotation_version`.

I've recently noticed that when using retrofit2 library, the project builds fine with Maven but fails with Gradle.

The build fails due to `Could not get unknown property 'jakarta_annotation_version' for object of type org.gradle.api.internal.artifacts.dsl.dependencies.DefaultDependencyHandler`.

Digging into this, in the generated `build.gradle` the `jakarta_annotation_version` is never set.
Upon closer inspection, aforementioned commit seems to indeed set it differently for the Maven build configuration than the Gradle build configuration (same for SBT configuration) for that matter.

The issue is that due to human error the `jakarta_annotation_version` line is added within the `{{#usePlayWS}}` block, meaning it won't be generated when `usePlayWS` is false, even though it should.

This commit changes this to always generate it.
@edwardmp
Copy link
Copy Markdown
Contributor Author

@wing328 whoops my bad. Done, commit updated!

@wing328
Copy link
Copy Markdown
Member

wing328 commented Jul 13, 2022

Tested locally and the result is good

Starting a Gradle Daemon (subsequent builds will be faster)

> Task :compileJava
Note: Some input files use unchecked or unsafe operations.
Note: Recompile with -Xlint:unchecked for details.

Deprecated Gradle features were used in this build, making it incompatible with Gradle 8.0.

You can use '--warning-mode all' to show the individual deprecation warnings and determine if they come from your own scripts or plugins.

See https://docs.gradle.org/7.2/userguide/command_line_interface.html#sec:command_line_warnings

BUILD SUCCESSFUL in 29s

Will try to setup CI to catch the issue moving forward.

@wing328 wing328 merged commit 8025aa3 into OpenAPITools:master Jul 13, 2022
@wing328 wing328 changed the title Fix: Always set jakarta_annotation_version [java][retrofit2] Fix: Always set jakarta_annotation_version Jul 13, 2022
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.

2 participants