palantir / conjure-java

Conjure generator for Java clients and servers
Apache License 2.0
27 stars 43 forks source link

Avoid generating union builders for large unions #2275

Closed carterkozak closed 7 months ago

carterkozak commented 7 months ago

Before this PR

all unions are generated with a visitor builder.

After this PR

This is equivalent to #2143, but for unions rather than exclusively enums. ==COMMIT_MSG== Avoid generating union builders for large unions. Particularly large enums result in too much bytecode, and in some cases cause us to run against Java limits ==COMMIT_MSG==

Possible downsides?

Possible that folks are using builders for existing large unions, however this isn't terribly likely, and most failures should be caught at compile time in the unexpected case this is hit.

changelog-app[bot] commented 7 months ago

Generate changelog in changelog-dir>`changelog/@unreleased`</changelog-dir

What do the change types mean? - `feature`: A new feature of the service. - `improvement`: An incremental improvement in the functionality or operation of the service. - `fix`: Remedies the incorrect behaviour of a component of the service in a backwards-compatible way. - `break`: Has the potential to break consumers of this service's API, inclusive of both Palantir services and external consumers of the service's API (e.g. customer-written software or integrations). - `deprecation`: Advertises the intention to remove service functionality without any change to the operation of the service itself. - `manualTask`: Requires the possibility of manual intervention (running a script, eyeballing configuration, performing database surgery, ...) at the time of upgrade for it to succeed. - `migration`: A fully automatic upgrade migration task with no engineer input required. _Note: only one type should be chosen._
How are new versions calculated? - ❗The `break` and `manual task` changelog types will result in a major release! - πŸ› The `fix` changelog type will result in a minor release in most cases, and a patch release version for patch branches. This behaviour is configurable in autorelease. - ✨ All others will result in a minor version release.

Type

- [ ] Feature - [x] Improvement - [ ] Fix - [ ] Break - [ ] Deprecation - [ ] Manual task - [ ] Migration

Description

Avoid generating union builders for large unions. Particularly large enums result in too much bytecode, and in some cases cause us to run against Java limits **Check the box to generate changelog(s)** - [x] Generate changelog entry
svc-autorelease commented 7 months ago

Released 8.17.0

ash211 commented 7 months ago

Possible that folks are using builders for existing large unions, however this isn't terribly likely, and most failures should be caught at compile time in the unexpected case this is hit.

πŸ™‹ that's me!

Internal search for r:/eddie f:ValidationErrorHelper.java shows the location, and failing PR is foundry/eddie/pull/17087. It's a conjure union of ~175 values.

What's the recommended fix? Should we switch from the visitor builder to the far more verbose visitor subclass?