Transfer Cont from @nomisrev to arrow #2661

i-walker · 2022-02-03T11:38:13Z

Thanks to @nomisRev proposal 🙌🏾
I've slightly changed the names from Cont to Effect and ContEffect to EffectScope, e.g.:

class DomainError(msg: String) 

context(CoroutineScope, EffectScope<DomainError>)
suspend fun program(): Int {
    val fa = async<Int> { shift(DomainError("error")) }
    val fb = async { delay(2000); 1 }
    return fa.await() + fb.await()
}

Feedback is welcome ☺️

nomisRev · 2022-02-08T08:40:35Z

arrow-libs/core/arrow-core/src/commonMain/kotlin/arrow/core/continuations/EagerEffect.kt

+internal class Eager(val token: Token, val shifted: Any?, val recover: (Any?) -> Any?) :
+  ShiftCancellationException() {
+  override fun toString(): String = "ShiftCancellationException($message)"
+}


I think we should use the same trick here as we do for Effect, so users have an escape hatch to differentiate between JobCanncellationException and ShiftCanncelationException when they have to in low-level niche use-cases.

added tests in EagerEffect and Effect for low-level use-cases

nomisRev · 2022-02-08T08:44:36Z

arrow-site/docs/docs/arrow/core/continuations/README.md

@@ -0,0 +1,202 @@
+# Semantics of Structured Concurrency + Effect<R, A>


This is not the documentation we want, this was part of the design process/documentation.
What we want instead is the README.MD

I'm thinking we should make it part of the KDoc on top of Effect, and link the page to Effect as well.

Currently, a lot of users have a hard time understanding the difference between Effect and EagerEffect and when or why they should be using either { } vs either.eager { }. This is currently completely undocumented inside arrow-continuations/arrow.core.computations.

I think we should add proper documentation in this PR before we merge, otherwise, it's going to be dropped to the bottom of the backlog again.

I've ported most of the Docs and still updating others, but the last commit can be reviewed

Updated most places I was aware of, can I get another review

…display at website

…able from other Throwables for 3rd parties

i-walker · 2022-02-16T21:03:58Z

I removed EagerEffect<R, A>.toEffect(): Effect<R, A>, because effect { } and eagerEffect { } can fold or bind() an EagerEffect value and it would introduce multiple paths of how to operate with this value doing something like toEffect().bind(), even though bind() is sufficient.

nomisRev

Great work @i-walker! Thanks for all the great effort moving this into Arrow 🥳 👏 👏 👏

arrow-libs/core/arrow-core/src/commonMain/kotlin/arrow/core/continuations/EagerEffect.kt

arrow-libs/core/arrow-core/src/commonMain/kotlin/arrow/core/continuations/Effect.kt

nomisRev · 2022-02-21T09:39:21Z

arrow-site/docs/_data/sidebar-core.yml

+      - title: arrow.core.continutions.Effect
+        url: /apidocs/arrow-core/arrow.core.continuations/-effect/


Not blocking this PR but I think we should put Effect under extensions and data types because it's something we want to promote.

It's the new implementation of Arrow's most powerful feature "computation blocks", and offers polymorphic properties we didn't have before. If we can somehow reference from the Effect page that'd be awesome.

Not sure if we have to link EffectScope, and EagerEffectScope since those should be linked from the Effect * EagerEffect page.
We can put EagerEffect alongside Effect and get away with only 2 new entries on the page, instead of a new section with 4 sub-sections.

I can take a stab at this in a subsequent PR though. What do you think?

cc\ @arrow-kt/maintainers

Yes sounds great too, it would be great if we could link EffectScope with EagerEffectScope and showing they cover similar signatures.
And rearranging it sounds super.

On that note now that we moved on from Data type + extension (aka implementation of a Type class) we might want to consider just having Data types and computations.

The few typeclasses we have left can also have a dedicated place, if necessary
Just as a note, though.

arrow-site/docs/_data/sidebar-fx.yml

nomisRev · 2022-02-21T09:41:42Z

arrow-site/docs/docs/fx/README.md

@@ -63,6 +63,7 @@ s [Coroutines Guide](https://kotlinlang.org/docs/coroutines-guide.html) on Kotli
  - [Pure & Referentially Transparent Functions]({{ '/fx/purity-and-referentially-transparent-functions/' | relative_url }})
  - [Kotlin's Std Coroutines package]({{ '/fx/coroutines/' | relative_url }})
  - [Why suspend over IO monad]({{ '/effects/io/' | relative_url }})
+  - [Semantics of Structured Concurrency and Effect]({{ '/arrow/core/continuations/' | relative_url }})


Idem. Arrow Core functionality.
We have a document already concerning Arrow Fx Coroutines & Structured Concurrency, no?
If we don't need to create a ticket to write one and add it to this documentation page.

We have this, but it doesn't go as deep as Semantics of Structured Concurrency and Effect maybe we can create a ticket and I'd be happy to contribute it. Or help in whatever way

nomisRev · 2022-02-21T09:42:15Z

arrow-site/docs/docs/core/README.md

@@ -68,6 +68,7 @@ boilerplate and enable direct syntax including [monad comprehensions and computa
  - [Kotlin's Std Lib Guide](https://kotlinlang.org/api/latest/jvm/stdlib/)
  - [Pure & Referentially Transparent Functions]({{ '/fx/purity-and-referentially-transparent-functions/' | relative_url }})
  - [Why suspend over IO monad]({{ '/effects/io/' | relative_url }})
+  - [Semantics of Structured Concurrency and Effect]({{ '/arrow/core/continuations/' | relative_url }})


If we follow the changes suggested above, we should add Effect and EagerEffect to Extensions and data types above.

Can be done in subsequent PR.

yes we can leave it as a task in a ticket regarding how/ or what we should show on the site

Co-authored-by: Simon Vergauwen <nomisRev@users.noreply.github.com>

…ntinuations/EagerEffect.kt Co-authored-by: Simon Vergauwen <nomisRev@users.noreply.github.com>

…ntinuations/Effect.kt Co-authored-by: Simon Vergauwen <nomisRev@users.noreply.github.com>

i-walker · 2022-02-21T20:18:38Z

Thanks for extensive review @nomisRev, learnt a lot 🤗

nomisRev added 30 commits February 2, 2022 21:21

Initial commit

88edce8

Initial impl

825f5e6

Clean up, and add ior block

17bc59f

Reformat

d79382a

Add Cont#toEither, and optimise OptionEffect

5678c42

Add some docs

d1b0985

Concurrency fix Ior

9d6448b

Add monadic syntax

60ce519

Fix bug shift

404b7d5

Add attempt

97cb176

Add restricted cont implementation

4308475

Run workflow on push main

2d3ed21

Fix workflow

89657b8

Fix try/catch over shift

b05bde8

Add docs

e4b6218

Use ControlThrowable, and add more tests Structured Concurrency

d0dbf79

Add documentation

116632e

Optimise how shift/fold run, and allow catching shift

31a878d

Revert catch

27a0a36

Add deeply nested exception tests

572ac3c

Add weird scenarios

fd97ee1

Add some docs structurred concurrency

340a104

Try KotlinX Knit

5773eb2

Add more Knit examples, and setup Dokka

1134615

Setup docs

edadce4

Rename branch

a2e4cfc

Auto update docs

65c325e

Update knit

15c8a53

Auto update docs

9cb1b71

Update build to MPP

b8abf3b

i-walker added 7 commits February 8, 2022 01:12

clean up and add apiDump

197a49a

Merge remote-tracking branch 'origin/is-effect' into is-effect

e954781

add eager option tests

f062352

add similar tests from arrow.comptutations.nullable

76b26f6

clean up dead test code

5f4f135

fix typo

c1c185b

fix nullable tests

a3a9a65

nomisRev reviewed Feb 8, 2022

View reviewed changes

i-walker added 3 commits February 10, 2022 18:07

add docs for all types in arrow.core.continuations based on Cont and …

3e4b2d6

…display at website

add it to core

81b069f

Merge remote-tracking branch 'origin/main' into is-effect

1f54966

i-walker mentioned this pull request Feb 11, 2022

The top level function ensureNotNull should be available not only for NullableEffect, EitherEffect and NullableEffect, but also for the Restrictable*Effect #2656

Closed

i-walker and others added 5 commits February 16, 2022 17:09

adjust for low-level use-cases, making shiftcancellations distinguish…

74257e5

…able from other Throwables for 3rd parties

Merge remote-tracking branch 'origin/is-effect' into is-effect

bb1f465

Update API files

8e60a66

add links and fix docs

9405fb8

remove outdated transactionEither example

9112cdf

i-walker requested a review from nomisRev February 16, 2022 16:51

i-walker added 2 commits February 16, 2022 21:18

effect interoperates with eagerEffect

a1364c3

rm toEffect

d4b8baf

raulraja mentioned this pull request Feb 19, 2022

Validated conditionally #2603

Closed

nomisRev approved these changes Feb 21, 2022

View reviewed changes

nomisRev and others added 4 commits February 21, 2022 20:06

Merge branch 'main' into is-effect

16212c2

Update arrow-site/docs/_data/sidebar-fx.yml

cbb2707

Co-authored-by: Simon Vergauwen <nomisRev@users.noreply.github.com>

Update arrow-libs/core/arrow-core/src/commonMain/kotlin/arrow/core/co…

c90ff7e

…ntinuations/EagerEffect.kt Co-authored-by: Simon Vergauwen <nomisRev@users.noreply.github.com>

Update arrow-libs/core/arrow-core/src/commonMain/kotlin/arrow/core/co…

9479e77

…ntinuations/Effect.kt Co-authored-by: Simon Vergauwen <nomisRev@users.noreply.github.com>

i-walker merged commit 658b642 into main Feb 21, 2022

i-walker deleted the is-effect branch February 21, 2022 20:19

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Transfer Cont from @nomisrev to arrow #2661

Transfer Cont from @nomisrev to arrow #2661

i-walker commented Feb 3, 2022 •

edited

nomisRev Feb 8, 2022

i-walker Feb 16, 2022

nomisRev Feb 8, 2022

i-walker Feb 10, 2022

i-walker Feb 16, 2022

i-walker commented Feb 16, 2022

nomisRev left a comment

nomisRev Feb 21, 2022

i-walker Feb 21, 2022

nomisRev Feb 21, 2022

i-walker Feb 21, 2022

nomisRev Feb 21, 2022

i-walker Feb 21, 2022

i-walker commented Feb 21, 2022 •

edited

		@@ -0,0 +1,202 @@
		# Semantics of Structured Concurrency + Effect<R, A>

		- title: arrow.core.continutions.Effect
		url: /apidocs/arrow-core/arrow.core.continuations/-effect/

Transfer Cont from @nomisrev to arrow #2661

Transfer Cont from @nomisrev to arrow #2661

Conversation

i-walker commented Feb 3, 2022 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

i-walker commented Feb 16, 2022

nomisRev left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

i-walker commented Feb 21, 2022 • edited

i-walker commented Feb 3, 2022 •

edited

i-walker commented Feb 21, 2022 •

edited