Skip to content
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

Projection binary compatibility issues #2129

Closed
ignasi35 opened this issue Jul 26, 2019 · 3 comments · Fixed by #2205
Closed

Projection binary compatibility issues #2129

ignasi35 opened this issue Jul 26, 2019 · 3 comments · Fixed by #2205
Assignees
@dwijnand
Milestone
Lagom 1.6.0-M6

Comments

@ignasi35
Copy link
Contributor

Projections API is @ApiMayChange but detecting potential binary compatibility issues early will be helpful.

See for example Stopped, Started, State, WorkerCoordinates,... are all case classes.
@ignasi35 ignasi35 mentioned this issue Jul 26, 2019
Closed
24 tasks
@octonato octonato removed the triage label Jul 29, 2019
@octonato
Copy link
Member

I don't get the intention here. At some point, we will have 1.6.0 containing this new API.

It will be marked @ApiMayChange, but that won't exclude it from the binary compatibility checks. See lightbend-labs/mima#160

Since I believe we are going to have it for free because we will have the MiMa checks, I'm closing this one. Please, feel free if you believe I'm missing something here.

@dwijnand
Copy link
Contributor

Case classes are a binary-compatibility hazard. It's best to avoid them for anything outside of stable algebraic datatypes.

Let's keep this one alive and discuss it with Ignasi.

@dwijnand dwijnand reopened this Jul 29, 2019
@dwijnand dwijnand removed the triage label Jul 29, 2019
@dwijnand
Copy link
Contributor

At least make sure everything is @ApiMayChange.

@dwijnand dwijnand added this to the Lagom 1.6.0 milestone Jul 29, 2019
@dwijnand dwijnand self-assigned this Aug 27, 2019
@dwijnand dwijnand mentioned this issue Aug 27, 2019
Merged
@mergify mergify bot closed this as completed in #2205 Aug 28, 2019
@dwijnand dwijnand modified the milestones: Lagom 1.6.0, Lagom 1.6.0-M6 Nov 7, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@dwijnand dwijnand

Labels
None yet
Milestone
Lagom 1.6.0-M6
Development

Successfully merging a pull request may close this issue.

Prevent API/bincompat issues in projections dwijnand/lagom
3 participants
@dwijnand @octonato @ignasi35