feat!: adds interface for oneOf objects for Java #1271

kennethaasan · 2023-05-04T12:25:06Z

This PR solves oneOf for objects for Java, and only that by adding an interface and attaches Jackson annotations.

Description

Generates a Java interface for unions with objects
All classes that are part of unions implement the union interface
Add union support to the Jackson annotation preset
- Support using a discriminator property or deducing union members via property names

Potensial TODOs after this MR

Add common property accessors are defined as part of the interface
Work out what do to when unions include primitive/built-in types (int, bool, float, String, etc...)
Support OpenAPI style discriminator property syntax

Related issue(s)

Figure out how to render union types for Java class #391
Inspired by feat!: java interfaced union generation for oneOf #1264. Thanks to @dlkj for the contribution!

netlify · 2023-05-04T12:25:13Z

❌ Deploy Preview for modelina failed.

Name	Link
🔨 Latest commit	`caa2558`
🔍 Latest deploy log	https://app.netlify.com/sites/modelina/deploys/645a3f2953f9b0000843e535

This reverts commit e7bd8fb.

docs/migrations/version-1-to-2.md

dlkj · 2023-05-09T10:29:24Z

#1264 had some examples, can we bring some of those across as well? Happy to split into a separate PR.

Co-authored-by: Daniel KJ <github@dlkj.co.uk>

test/generators/java/__snapshots__/JavaGenerator.spec.ts.snap

jonaslagoni

I cant find any tests where you expect union without Jackson preset, is that looking like expected?

sonarqubecloud · 2023-05-09T12:41:43Z

Kudos, SonarCloud Quality Gate passed!

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
0.0% Duplication

kennethaasan · 2023-05-09T12:42:33Z

I cant find any tests where you expect union without Jackson preset, is that looking like expected?

@jonaslagoni, I added a test for that in test/generators/java/JavaGenerator.spec.ts

jonaslagoni

LGTM 👍

@dlkj wanna give a final review?

dlkj · 2023-05-09T14:10:52Z

LGMT. Great work!

kennethaasan · 2023-05-09T14:17:43Z

Appreciate the quick review! @dlkj deserves most of the credit for making #1264. Feel free to close that one. If you want the common properties available in the interface, please submit a new PR.

asyncapi-bot · 2023-05-09T14:30:14Z

🎉 This PR is included in version 2.0.0-next.10 🎉

The release is available on:

Your semantic-release bot 📦🚀

jonaslagoni · 2023-05-09T14:33:42Z

@all-contributors please add @dlkj for code, test, example, review

allcontributors · 2023-05-09T14:33:52Z

@jonaslagoni

I've put up a pull request to add @dlkj! 🎉

* fix!: use preferred ids over anonymous ids (#1099) * chore(release): v2.0.0-next.1 (#1113) * fix!: adds union type when operation.message.oneOf is set (#1136) * chore(release): v2.0.0-next.2 (#1144) * chore(release): v2.0.0-next.3 (#1146) * fix!: additionalItems being applied for regular arrays (#1140) * chore(release): v2.0.0-next.4 (#1151) * test: upgrades eslint and adds eslint-plugin-jest (#1166) * fix!: fixes required properties when if/then/else is used (#1149) * chore(release): v2.0.0-next.5 (#1184) * chore: update snapshot and packagelock * chore: update snapshot of example * feat: force release (#1221) * chore(release): v2.0.0-next.6 (#1222) * feat!: handle const and discriminator (#1169) * feat: handle const * feat: handle const * feat: handle const * feat: handle const * feat: handle const * feat: handle const * feat: handle const * fixes bug when using oneOf in channel by not adding models to input model if they have already been scanned * feat: handle const * feat: handle const * feat: handle const * feat: handle const * feat: handle const * feat: handle const * feat: handle const * feat: set correct java quotes * remove discriminator from CommonModel because we don't need it * remove discriminator from CommonModel because we don't need it * fixes review comments * adds constant constrainers * adds constant constrainers * adds constant constrainers * adds constant constrainers * remove unused var * chore(release): v2.0.0-next.7 (#1242) * fix!: should not carry over options from metaModel to constrainedModel (#1243) * chore(release): v2.0.0-next.8 (#1247) * docs: fixes constant constraints documentation (#1241) * refactor: adds discriminator in CommonModel and interpreters (#1269) * refactor: adds discriminator in CommonModel and interpreters * refactor: adds discriminator in CommonModel and interpreters * refactor: adds discriminator in MetaModel and ConstrainedMetaModel (#1270) * refactor: adds discriminator in CommonModel and interpreters * refactor: adds discriminator in MetaModel and ConstrainedMetaModel * refactor: adds discriminator in MetaModel and ConstrainedMetaModel * refactor: adds discriminator in MetaModel and ConstrainedMetaModel * fix test * review fix * fix!: update default Kotlin renderer to make non-required properties nullable (#1277) * chore(release): v2.0.0-next.9 (#1278) * feat!: adds interface for oneOf objects for Java (#1271) * refactor: adds discriminator in CommonModel and interpreters * refactor: adds discriminator in MetaModel and ConstrainedMetaModel * feat: adds interface for oneOf objects for Java * refactor: adds discriminator in MetaModel and ConstrainedMetaModel * update snapshot * refactor: adds discriminator in MetaModel and ConstrainedMetaModel * fix test * feat: adds interface for oneOf objects for Java * Revert "feat: adds interface for oneOf objects for Java" This reverts commit e7bd8fb. * review fix * merge fix * adds tests * adds documentation * fixes docs * Update docs/migrations/version-1-to-2.md Co-authored-by: Daniel KJ <github@dlkj.co.uk> * adds test for union without jackson preset * fixes docs * fixes docs * fixes docs --------- Co-authored-by: Daniel KJ <github@dlkj.co.uk> * chore(release): v2.0.0-next.10 (#1279) * chore: update Rust union render to use ConstrainedMetaModelOptionsDiscriminator (#1282) Update Rust union render to use `ConstrainedMetaModelOptionsDiscriminator` Co-authored-by: Daniel Kenyon-Jones <daniel.kenyon-jones@featurespace.co.uk> * fix wrong import * Revert "fix wrong import" This reverts commit b6c5be6. * fix: wrong import for Java preset (#1283) fix: wrong import * chore(release): v2.0.0-next.11 (#1286) * feat!: add discriminator support for OpenAPI v3 and Swagger v2 (#1281) Co-authored-by: Daniel Kenyon-Jones <daniel.kenyon-jones@featurespace.co.uk> * chore(release): v2.0.0-next.12 (#1287) * feat!: use EXISTING_PROPERTY as JsonTypeInfo.As annotation to avoid duplicates when serializing (#1290) * chore(release): v2.0.0-next.13 (#1291) * chore: blackbox tests (#1303) Co-authored-by: Daniel Kenyon-Jones <daniel.kenyon-jones@featurespace.co.uk> * feat!: enable nullable models (#1141) * chore(release): v2.0.0-next.14 (#1313) * chore: update new generators with next syntax * chore: fix linting problem * feat!: add java oneOf union support for properties of models (#1296) Co-authored-by: Daniel Kenyon-Jones <daniel.kenyon-jones@featurespace.co.uk> * chore: update dependency * feat: update dependencies * feat: update dependencies * feat: update dependencies * feat: trigger release and update dependencies (#1428) * ci: temporarily enable release for next (#1430) * fix: ts/js unmarshalling function bug (#1429) * fix!: support java nullable double type (#1439) Co-authored-by: Daniel Kenyon-Jones <daniel.kenyon-jones@featurespace.co.uk> * feat: update release configuration and trigger release (#1467) * chore(release): v2.0.0-next.15 (#1468) * feat: make discriminator property visible to deserializer from Java Jackson preset (#1469) Co-authored-by: Daniel Kenyon-Jones <daniel.kenyon-jones@featurespace.co.uk> * chore(release): v2.0.0-next.16 (#1470) * fix: typescript interface variable assignment (#1472) Co-authored-by: Kristupas Narkeliunas <kristupas.narkeliun@ihsmarkit.com> * chore(release): v2.0.0-next.17 (#1473) * feat!: upgrade to node 18 (#1422) * upgrade to v18 * adapt rest of workflows * update readme * recommit packagelock * feat!: supports optional properties in java (#1485) * chore(release): v2.0.0-next.18 (#1487) * chore: add next integration example (#1488) * fix: adds format in options instead of using original input (#1486) * chore(release): v2.0.0-next.19 (#1492) * feat!: generate models for OpenAPI parameters (#1498) Co-authored-by: Daniel Kenyon-Jones <daniel.kenyon-jones@featurespace.co.uk> * chore(release): v2.0.0-next.20 (#1500) * fix: fixes java jackson discriminator when property is not camel case (#1502) * chore(release): v2.0.0-next.21 (#1504) * fix: fixes performance issues in java when calling parent unions (#1501) * chore(release): v2.0.0-next.22 (#1506) * feat!: refactors generators to use the same arg types (#1505) * chore(release): v2.0.0-next.23 (#1507) * fix: escape java string literals used for regex patterns and string constants (#1509) Co-authored-by: Daniel Kenyon-Jones <kenyonjd@featurespace.co.uk> * chore(release): v2.0.0-next.24 (#1558) * chore: update linting and dev dependency versions * chore: update migration guide (#1560) * chore(release): v2.0.0-next.25 (#1571) --------- Co-authored-by: Kenneth Aasan <k.aasan@sportradar.com> Co-authored-by: asyncapi-bot <bot+chan@asyncapi.io> Co-authored-by: Cyprian Gracz <cyprian.gracz@micro-jumbo.eu> Co-authored-by: Daniel KJ <github@dlkj.co.uk> Co-authored-by: Daniel Kenyon-Jones <daniel.kenyon-jones@featurespace.co.uk> Co-authored-by: Kristupas <53404771+Ksisa@users.noreply.github.com> Co-authored-by: Kristupas Narkeliunas <kristupas.narkeliun@ihsmarkit.com> Co-authored-by: Daniel Kenyon-Jones <kenyonjd@featurespace.co.uk>

kennethaasan added 3 commits May 4, 2023 14:13

refactor: adds discriminator in CommonModel and interpreters

8159fde

refactor: adds discriminator in MetaModel and ConstrainedMetaModel

ff350df

feat: adds interface for oneOf objects for Java

d5e2de3

kennethaasan added 15 commits May 5, 2023 10:31

Merge remote-tracking branch 'origin/next' into metamodel-discriminator

bdad87d

refactor: adds discriminator in MetaModel and ConstrainedMetaModel

6906ac9

Merge branch 'metamodel-discriminator' into java-object-union

19851bf

update snapshot

794a47c

refactor: adds discriminator in MetaModel and ConstrainedMetaModel

6f39458

fix test

9f6ecf7

Merge branch 'metamodel-discriminator' into java-object-union

6a2d69c

feat: adds interface for oneOf objects for Java

e7bd8fb

Revert "feat: adds interface for oneOf objects for Java"

1ce44b9

This reverts commit e7bd8fb.

review fix

1e865e4

Merge branch 'metamodel-discriminator' into java-object-union

d0564f2

merge fix

96965f7

Merge remote-tracking branch 'origin/next' into java-object-union

9dcf057

adds tests

550c4a1

adds documentation

170ef30

kennethaasan marked this pull request as ready for review May 9, 2023 09:40

kennethaasan requested a review from jonaslagoni May 9, 2023 09:42

fixes docs

eb82cb4

dlkj reviewed May 9, 2023

View reviewed changes

docs/migrations/version-1-to-2.md Outdated Show resolved Hide resolved

Update docs/migrations/version-1-to-2.md

36cfd6c

Co-authored-by: Daniel KJ <github@dlkj.co.uk>

dlkj reviewed May 9, 2023

View reviewed changes

test/generators/java/__snapshots__/JavaGenerator.spec.ts.snap Show resolved Hide resolved

jonaslagoni reviewed May 9, 2023

View reviewed changes

kennethaasan added 3 commits May 9, 2023 13:44

adds test for union without jackson preset

42c2c42

fixes docs

7b6f0af

fixes docs

fa8594e

fixes docs

caa2558

jonaslagoni reviewed May 9, 2023

View reviewed changes

kennethaasan merged commit a961fe3 into asyncapi:next May 9, 2023

kennethaasan deleted the java-object-union branch May 9, 2023 14:18

asyncapi-bot added the released on @next label May 9, 2023

allcontributors bot mentioned this pull request May 9, 2023

chore: add dlkj as a contributor for code, test, and 2 more #1280

Merged

This was referenced May 9, 2023

feat!: java interfaced union generation for oneOf #1264

Closed

feat!: add discriminator support for OpenAPI v3 and Swagger v2 #1281

Merged

This was referenced May 18, 2023

Figure out how to render union types for Java class #391

Closed

feat!: add java oneOf union support for properties of models #1296

Merged

jonaslagoni mentioned this pull request Oct 16, 2023

feat!: release version 2 #1112

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat!: adds interface for oneOf objects for Java #1271

feat!: adds interface for oneOf objects for Java #1271

kennethaasan commented May 4, 2023 •

edited

Loading

netlify bot commented May 4, 2023 •

edited

Loading

dlkj commented May 9, 2023

jonaslagoni left a comment

sonarqubecloud bot commented May 9, 2023

kennethaasan commented May 9, 2023

jonaslagoni left a comment

dlkj commented May 9, 2023

kennethaasan commented May 9, 2023

asyncapi-bot commented May 9, 2023

jonaslagoni commented May 9, 2023

allcontributors bot commented May 9, 2023

feat!: adds interface for oneOf objects for Java #1271

feat!: adds interface for oneOf objects for Java #1271

Conversation

kennethaasan commented May 4, 2023 • edited Loading

netlify bot commented May 4, 2023 • edited Loading

❌ Deploy Preview for modelina failed.

dlkj commented May 9, 2023

jonaslagoni left a comment

Choose a reason for hiding this comment

sonarqubecloud bot commented May 9, 2023

kennethaasan commented May 9, 2023

jonaslagoni left a comment

Choose a reason for hiding this comment

dlkj commented May 9, 2023

kennethaasan commented May 9, 2023

asyncapi-bot commented May 9, 2023

jonaslagoni commented May 9, 2023

allcontributors bot commented May 9, 2023

kennethaasan commented May 4, 2023 •

edited

Loading

netlify bot commented May 4, 2023 •

edited

Loading