WIP: Improve all public APIs by dropping (using Context) #538
Conversation
… due to Output.apply consuming Result now
lbialy
changed the title
|
|
||
| def ofData[A](data: OutputData[A]): Output[A] = new Output(ctx => Result.pure(data)) | ||
|
|
||
| def secret[A](value: A): Output[A] = new Output(ctx => Result.pure(OutputData(value, Set.empty, isSecret = true))) |
There was a problem hiding this comment.
For completeness, should we have something like def deferSecret?
There was a problem hiding this comment.
Nope, internal API, if we don't use something (we won't use this method), it should not exist.
| def trace(message: LoggableMessage, res: Option[Resource] = None, streamId: Int = 0, ephemeral: Boolean = false)(using | ||
| pkg: sourcecode.Pkg, | ||
| fileName: sourcecode.FileName, | ||
| name: sourcecode.Name, | ||
| line: sourcecode.Line, | ||
| mdc: BesomMDC[_] = BesomMDC.empty | ||
| mdc: BesomMDC[_] = BesomMDC.empty, |
There was a problem hiding this comment.
Now it won't be possible to call this method without mdc, unless one passes ctx as a named argument. This is a source incompatible change. Was this supposed to work like that now? ctx isn't used actually at the moment
There was a problem hiding this comment.
This is not a public API. This logger is purely internal, it's not even used by published packages.
| @@ -10,7 +10,7 @@ object interpolator: | |||
|
|
|||
| implicit final class PulumiInterpolationOps(sc: StringContext): | |||
| def pulumi(args: Any*)(using Context): Output[String] = | |||
There was a problem hiding this comment.
Shouldn't (using Context) be unnecessary now (here and for p)?
There was a problem hiding this comment.
It's WIP, I haven't completed the search for all (using Context) clauses in public APIs yet.
The
(using Context)clause and related context function executed inPulumi.runare both a blessing as they make the task of propagation of the main data structure quite easy and a curse as they pollute public API with a detail that can't be used in any way by the user. @jchapuis suggested to move the main monad (from user's perspective) - theOutput- towards a Kleisli-like structure and I was wary of that as it looked like it would break one of the core invariants of all async tasks being tracked by theContextto prevent early exits. There wasn't also much motivation to do such change beyond the simplification of the API but then we've got some reports about how Intellij IDEA's Scala Plugin fails to handle most of our APIs.This PR changes
Outputfrom a wrapper overResult[OutputData[A]]to a wrapper overContext => Result[OutputData[A]]. This in turn allows us to drop(using Context)onOutputconstructors and demand an instance ofContextonly when interpretingOutputto get the underlyingOutputData[A]or justOption[A]. This interpretation happens in the guts of besom-core library and therefore this change should be invisible for the user (beyond the disappearance of(using Context)clause).06.09.2024 / 70d2538 Current state is that
Outputwas modified and all the changes to make the tests green have been applied. Task tracking is applied by registering the top-level tasks that are getting interpreted inside of theget*family of functions. The logic behind this is that since the final task waits for all tasks it composes it should be fine to do only this but this probably won't work for fire-and-forget cases where subtasks are launched in composed effects as it's possible we won't track their final Outputs at all. This is not a problem, we can modify the implementation so that all tasks are tracked the same way it was done before by just transforming the received function to track the resultingResult[OutputData[A]]. This comes at an increased memory cost but that's probably not a big deal given the amount of real parallelism that happens in Besom programs.