Split `interruptible` #2343

alexandrustana · 2021-09-10T21:03:55Z

This PR tries to fix #2268.
Running mimaReportBinaryIssues doesn't seem to report anything, so I hope the changes are binary compatible 😄

TODO:

add scalafix migration

djspiewak

This looks really good apart from my one note! And I would generally trust mima: the approached you used is indeed binary compatible.

core/shared/src/main/scala/cats/effect/IO.scala

kernel/shared/src/main/scala/cats/effect/kernel/Sync.scala

vasilmkd · 2021-09-10T21:53:50Z

Thanks for taking this on.

core/js/src/main/scala/cats/effect/IOCompanionPlatform.scala

core/jvm/src/main/scala/cats/effect/IOCompanionPlatform.scala

djspiewak · 2021-09-13T15:22:39Z

for the output test folder a new version which is not yet released and will contain these changes)

Can we solve this by publishing a snapshot?

djspiewak · 2021-09-13T16:59:32Z

core/shared/src/main/scala/cats/effect/IO.scala

@@ -1466,9 +1466,13 @@ object IO extends IOCompanionPlatform with IOLowPriorityImplicits {

    override def blocking[A](thunk: => A): IO[A] = IO.blocking(thunk)

-    override def interruptible[A](many: Boolean)(thunk: => A): IO[A] =
+    private[effect] override def interruptible[A](many: Boolean)(thunk: => A): IO[A] =


Wait you can do that?

It technically doesn't change the visibility in the bytecode, so yes.

Are we sure it does what we want downstream?

Yeah, let's not take that risk.

scala> import cats.effect.IO import cats.effect.IO scala> IO.interruptible(false) { println("hi") } val res0: cats.effect.IO[Unit] = IO(...)

Looks like it doesn't mask it.

Ok, thanks for confirming. Good to know.

djspiewak · 2021-09-13T18:31:23Z

For posterity, the problem here is the following:

[error] cats-effect: Failed binary compatibility check against org.typelevel:cats-effect_2.13:3.1.0! Found 1 potential problems (filtered 7)
[error]  * static method interruptible(Boolean,scala.Function0)cats.effect.IO in class cats.effect.IO does not have a correspondent in current version
[error]    filter with: ProblemFilters.exclude[DirectMissingMethodProblem]("cats.effect.IO.interruptible")

Looks like the private[effect] overload isn't getting peered into a static forwarder. I'm not totally certain how to trick the compiler into doing that…

djspiewak · 2021-09-19T20:48:49Z

IMO, it's worth breaking binary compatibility with Java interop on this one function in order to get the better API for everyone. Anyone have any objections? Paging @rossabaker and @johnynek for opposing opinions.

stale

johnynek · 2021-09-21T00:22:26Z

just to chime in:

My feeling is that runtime errors really suck, and if you want to be a super core library, you will be implicated in many diamonds, so try to never break binary compatibility.

But this is your project, of course, so make your own calls.

djspiewak · 2021-09-21T13:24:23Z

I do very much agree with this. The only reason I'm even pondering the breakage is the fact that it's confined to the Java interop exclusively. Scala code paths never hit this forwarder and remain binary compatible.

armanbilge · 2021-09-21T14:41:19Z

FWIW http4s recently made a similar decision to eschew Java forwarders in http4s/http4s#5071 (comment).

alexandrustana · 2021-09-21T16:08:10Z

@djspiewak @vasilmkd, can someone publish a snapshot, please, so I can try and write the scalafix migration? (if it is still needed I mean 😄 )

vasilmkd · 2021-09-21T16:14:07Z

I will right now.

vasilmkd · 2021-09-21T16:28:27Z

"io.vasilev" %%% "cats-effect" % "3.3-208-b352672"

@alexandrustana

…into 2268

vasilmkd

How did the build.sbt changes get pulled in? That PR is not merged yet.

rossabaker · 2021-09-25T18:45:17Z

This one is tough: a marginally better API for what is probably 100% of users, or a landmine for an unanticipated use case. We chose the Scala users in http4s, but it makes me queasy, and the risk is higher on this project.

A third option is bytecode postprocessing. I haven't done it in the Scala Era, but I'm pretty sure it would be possible.

vasilmkd · 2021-09-26T17:27:55Z

With a repeated word of caution and previous experience, maybe it is worth reconsidering the extent of this change.

alexandrustana · 2021-10-05T10:07:04Z

Having these in mind, should I close this PR?

vasilmkd · 2021-10-05T10:31:44Z

No, not yet, let's have a discussion with Daniel, whenever he's back.

We'll definitely add interruptibleOnce and interruptibleMany if this doesn't go through, and the scalafix rules will still be good (with minor changes).

djspiewak · 2021-10-10T19:26:25Z

I'm back ish. :-) To @rossabaker's point… There's another option here, which is that we can keep the current interruptible overload public and mark it as @deprecated. That's what's visible currently in the PR, and thus there is no binary breakage at all. It's kind of ugly, but it's not really the end of the world, and it's probably less fraught than bytecode shenanigans in the build.

Either way, I think that we can shift the discussion a bit. We agree the changes here are good (I think), and they're binary-compatible as currently written. I'm in favor of merging this PR and having a follow-up if we want to get fancy with hiding the old interruptible overload.

djspiewak

Awesome work, @alexandrustana! Thanks for shepherding this through the process, and sorry for handing you such a thorny change.

djspiewak · 2021-10-10T19:27:27Z

scalafix/build.sbt

+  .in(file("v3_3_0/output"))
+  .settings(
+    libraryDependencies ++= Seq(
+      "io.vasilev" %% "cats-effect" % "3.3-208-b352672"


Let's remember to update this to the mainline 3.3.0 once released

fthomas · 2021-10-11T06:05:28Z

FYI: scala-steward-org/scala-steward#2270 adds the v3_3_0 Scalafix to Scala Steward.

alexandrustana · 2021-10-11T06:28:27Z

@djspiewak, @vasilmkd thank you for all the help and support 🙂

vasilmkd · 2021-10-11T06:48:35Z

Thank you @fthomas!

@alexandrustana Thank you for the outstanding work and your patience.

alexandrustana added 2 commits September 10, 2021 23:42

Deprecate and add expose new interruptible

b41687f

Use new implementation in specs

6a5fe66

djspiewak requested changes Sep 10, 2021

View reviewed changes

core/shared/src/main/scala/cats/effect/IO.scala Outdated Show resolved Hide resolved

djspiewak reviewed Sep 10, 2021

View reviewed changes

kernel/shared/src/main/scala/cats/effect/kernel/Sync.scala Outdated Show resolved Hide resolved

djspiewak added the ❗ source breaking ❗ label Sep 10, 2021

Move implementation to public API

2fc71d0

djspiewak added this to the v3.3.0 milestone Sep 13, 2021

alexandrustana added 3 commits September 13, 2021 10:35

Split interruptible in IO companion

6faea9d

Convert thunk to Function0

f209b9c

Fix documentation

51d7096

alexandrustana marked this pull request as ready for review September 13, 2021 11:00

Update comments

02105ea

alexandrustana requested review from djspiewak and armanbilge September 13, 2021 11:08

djspiewak previously requested changes Sep 13, 2021

View reviewed changes

core/js/src/main/scala/cats/effect/IOCompanionPlatform.scala Outdated Show resolved Hide resolved

core/jvm/src/main/scala/cats/effect/IOCompanionPlatform.scala Show resolved Hide resolved

Add access modifier

1e3a2a6

djspiewak reviewed Sep 13, 2021

View reviewed changes

djspiewak added 2 commits September 20, 2021 16:14

Adjusted visibility of forwarders

3e02162

Merge branch 'series/3.x' into 2268

337601a

djspiewak added 2 commits September 21, 2021 08:37

Deprecate rather than hide the old IO.interruptible on JVM

d98832d

Scalafmt

0638178

Derp...

fdbf5da

fthomas mentioned this pull request Sep 21, 2021

[meta] Prospective Scalafix migrations scala-steward-org/scala-steward#655

Closed

12 tasks

alexandrustana added 2 commits September 22, 2021 18:10

Setup migration

6ebd12c

Merge branch '2268' of https://github.com/alexandrustana/cats-effect …

0fb1ebf

…into 2268

vasilmkd reviewed Sep 24, 2021

View reviewed changes

alexandrustana added 5 commits September 24, 2021 21:08

Add rewrites for IO.interruptible

36103bc

Add rewrite rule for Sync[IO]

cda5a48

Rewrite IO rule

9d2b685

Add comments

f742302

Handle implicit case

c8a66d7

alexandrustana requested review from djspiewak and vasilmkd September 25, 2021 17:37

djspiewak approved these changes Oct 10, 2021

View reviewed changes

djspiewak merged commit b117e63 into typelevel:series/3.x Oct 10, 2021

armanbilge mentioned this pull request Dec 1, 2021

Enable MiMa for Scala 3 typelevel/cats#4063

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Split `interruptible` #2343

Split `interruptible` #2343

alexandrustana commented Sep 10, 2021 •

edited

Loading

djspiewak left a comment

vasilmkd commented Sep 10, 2021

djspiewak commented Sep 13, 2021

djspiewak Sep 13, 2021

vasilmkd Sep 13, 2021

djspiewak Sep 13, 2021

vasilmkd Sep 13, 2021

djspiewak Sep 13, 2021

vasilmkd Sep 13, 2021

djspiewak commented Sep 13, 2021

djspiewak commented Sep 19, 2021

johnynek commented Sep 21, 2021

djspiewak commented Sep 21, 2021

armanbilge commented Sep 21, 2021

alexandrustana commented Sep 21, 2021

vasilmkd commented Sep 21, 2021

vasilmkd commented Sep 21, 2021

vasilmkd left a comment

rossabaker commented Sep 25, 2021

vasilmkd commented Sep 26, 2021

alexandrustana commented Oct 5, 2021

vasilmkd commented Oct 5, 2021 •

edited

Loading

djspiewak commented Oct 10, 2021

djspiewak left a comment

djspiewak Oct 10, 2021

fthomas commented Oct 11, 2021

alexandrustana commented Oct 11, 2021

vasilmkd commented Oct 11, 2021

Split interruptible #2343

Split interruptible #2343

Conversation

alexandrustana commented Sep 10, 2021 • edited Loading

djspiewak left a comment

Choose a reason for hiding this comment

vasilmkd commented Sep 10, 2021

djspiewak commented Sep 13, 2021

djspiewak Sep 13, 2021

Choose a reason for hiding this comment

vasilmkd Sep 13, 2021

Choose a reason for hiding this comment

djspiewak Sep 13, 2021

Choose a reason for hiding this comment

vasilmkd Sep 13, 2021

Choose a reason for hiding this comment

djspiewak Sep 13, 2021

Choose a reason for hiding this comment

vasilmkd Sep 13, 2021

Choose a reason for hiding this comment

djspiewak commented Sep 13, 2021

djspiewak commented Sep 19, 2021

johnynek commented Sep 21, 2021

djspiewak commented Sep 21, 2021

armanbilge commented Sep 21, 2021

alexandrustana commented Sep 21, 2021

vasilmkd commented Sep 21, 2021

vasilmkd commented Sep 21, 2021

vasilmkd left a comment

Choose a reason for hiding this comment

rossabaker commented Sep 25, 2021

vasilmkd commented Sep 26, 2021

alexandrustana commented Oct 5, 2021

vasilmkd commented Oct 5, 2021 • edited Loading

djspiewak commented Oct 10, 2021

djspiewak left a comment

Choose a reason for hiding this comment

djspiewak Oct 10, 2021

Choose a reason for hiding this comment

fthomas commented Oct 11, 2021

alexandrustana commented Oct 11, 2021

vasilmkd commented Oct 11, 2021

Split `interruptible` #2343

Split `interruptible` #2343

alexandrustana commented Sep 10, 2021 •

edited

Loading

vasilmkd commented Oct 5, 2021 •

edited

Loading