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

Add queuing strategy option for Stream.toReadableStream #2864

Merged
merged 3 commits into from
May 28, 2024
Merged

Add queuing strategy option for Stream.toReadableStream #2864

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4788847
Add queuing strategy option for Stream.toReadableStream
mattrossman May 27, 2024
ebfa2d0
Fix inference on QueuingStrategy type argument
mattrossman May 27, 2024
f730c1a
Update changeset (minor)
mattrossman May 28, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/empty-islands-pump.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"effect": patch
mattrossman marked this conversation as resolved.
Show resolved Hide resolved
---

Add queuing strategy option for Stream.toReadableStream
35 changes: 28 additions & 7 deletions packages/effect/src/Stream.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3860,7 +3860,17 @@ export const toQueueOfElements: {
* @since 2.0.0
* @category destructors
*/
export const toReadableStream: <A, E>(self: Stream<A, E>) => ReadableStream<A> = internal.toReadableStream
export const toReadableStream: {
<A>(
options?: { readonly strategy?: QueuingStrategy<A> | undefined }
): <E>(
self: Stream<A, E>
) => ReadableStream<A>
<A, E>(
self: Stream<A, E>,
options?: { readonly strategy?: QueuingStrategy<A> | undefined }
): ReadableStream<A>
} = internal.toReadableStream

/**
* Converts the stream to a `Effect<ReadableStream>`.
Expand All @@ -3870,8 +3880,17 @@ export const toReadableStream: <A, E>(self: Stream<A, E>) => ReadableStream<A> =
* @since 2.0.0
* @category destructors
*/
export const toReadableStreamEffect: <A, E, R>(self: Stream<A, E, R>) => Effect.Effect<ReadableStream<A>, never, R> =
internal.toReadableStreamEffect
export const toReadableStreamEffect: {
<A>(
options?: { readonly strategy?: QueuingStrategy<A> | undefined }
): <E, R>(
self: Stream<A, E, R>
) => Effect.Effect<ReadableStream<A>, never, R>
<A, E, R>(
self: Stream<A, E, R>,
options?: { readonly strategy?: QueuingStrategy<A> | undefined }
): Effect.Effect<ReadableStream<A>, never, R>
} = internal.toReadableStreamEffect

/**
* Converts the stream to a `ReadableStream` using the provided runtime.
Expand All @@ -3882,12 +3901,14 @@ export const toReadableStreamEffect: <A, E, R>(self: Stream<A, E, R>) => Effect.
* @category destructors
*/
export const toReadableStreamRuntime: {
<XR>(
runtime: Runtime<XR>
): <A, E, R extends XR>(self: Stream<A, E, R>) => ReadableStream<A>
<A, XR>(
runtime: Runtime<XR>,
options?: { readonly strategy?: QueuingStrategy<A> | undefined }
): <E, R extends XR>(self: Stream<A, E, R>) => ReadableStream<A>
<A, E, XR, R extends XR>(
self: Stream<A, E, R>,
runtime: Runtime<XR>
runtime: Runtime<XR>,
options?: { readonly strategy?: QueuingStrategy<A> | undefined }
): ReadableStream<A>
} = internal.toReadableStreamRuntime

Expand Down
140 changes: 90 additions & 50 deletions packages/effect/src/internal/stream.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6542,63 +6542,103 @@ export const toQueueOfElements = dual<
))

/** @internal */
export const toReadableStream = <A, E>(self: Stream.Stream<A, E>) =>
toReadableStreamRuntime(self, Runtime.defaultRuntime)
export const toReadableStream = dual<
<A>(
options?: { readonly strategy?: QueuingStrategy<A> | undefined }
) => <E>(self: Stream.Stream<A, E>) => ReadableStream<A>,
<A, E>(
self: Stream.Stream<A, E>,
options?: { readonly strategy?: QueuingStrategy<A> | undefined }
) => ReadableStream<A>
>(
(args) => isStream(args[0]),
<A, E>(
self: Stream.Stream<A, E>,
options?: { readonly strategy?: QueuingStrategy<A> | undefined }
) => toReadableStreamRuntime(self, Runtime.defaultRuntime, options)
)

/** @internal */
export const toReadableStreamEffect = <A, E, R>(self: Stream.Stream<A, E, R>) =>
Effect.map(Effect.runtime<R>(), (runtime) => toReadableStreamRuntime(self, runtime))
export const toReadableStreamEffect = dual<
<A>(
options?: { readonly strategy?: QueuingStrategy<A> | undefined }
) => <E, R>(self: Stream.Stream<A, E, R>) => Effect.Effect<ReadableStream<A>, never, R>,
<A, E, R>(
self: Stream.Stream<A, E, R>,
options?: { readonly strategy?: QueuingStrategy<A> | undefined }
) => Effect.Effect<ReadableStream<A>, never, R>
>(
(args) => isStream(args[0]),
<A, E, R>(
self: Stream.Stream<A, E, R>,
options?: { readonly strategy?: QueuingStrategy<A> | undefined }
) => Effect.map(Effect.runtime<R>(), (runtime) => toReadableStreamRuntime(self, runtime, options))
)

/** @internal */
export const toReadableStreamRuntime = dual<
<XR>(runtime: Runtime.Runtime<XR>) => <A, E, R extends XR>(self: Stream.Stream<A, E, R>) => ReadableStream<A>,
<A, E, XR, R extends XR>(self: Stream.Stream<A, E, R>, runtime: Runtime.Runtime<XR>) => ReadableStream<A>
>(2, <A, E, XR, R extends XR>(self: Stream.Stream<A, E, R>, runtime: Runtime.Runtime<XR>): ReadableStream<A> => {
const runSync = Runtime.runSync(runtime)
const runFork = Runtime.runFork(runtime)

let pull: Effect.Effect<void, never, R>
let scope: Scope.CloseableScope
return new ReadableStream<A>({
start(controller) {
scope = runSync(Scope.make())
pull = pipe(
toPull(self),
Scope.extend(scope),
runSync,
Effect.tap((chunk) =>
Effect.sync(() => {
Chunk.map(chunk, (a) => {
controller.enqueue(a)
})
})
),
Effect.tapErrorCause(() => Scope.close(scope, Exit.void)),
Effect.catchTags({
"None": () =>
Effect.sync(() => {
controller.close()
}),
"Some": (error) =>
<A, XR>(
runtime: Runtime.Runtime<XR>,
options?: { readonly strategy?: QueuingStrategy<A> | undefined }
) => <E, R extends XR>(self: Stream.Stream<A, E, R>) => ReadableStream<A>,
<A, E, XR, R extends XR>(
self: Stream.Stream<A, E, R>,
runtime: Runtime.Runtime<XR>,
options?: { readonly strategy?: QueuingStrategy<A> | undefined }
) => ReadableStream<A>
>(
(args) => isStream(args[0]),
<A, E, XR, R extends XR>(
self: Stream.Stream<A, E, R>,
runtime: Runtime.Runtime<XR>,
options?: { readonly strategy?: QueuingStrategy<A> | undefined }
): ReadableStream<A> => {
const runSync = Runtime.runSync(runtime)
const runFork = Runtime.runFork(runtime)

let pull: Effect.Effect<void, never, R>
let scope: Scope.CloseableScope
return new ReadableStream<A>({
start(controller) {
scope = runSync(Scope.make())
pull = pipe(
toPull(self),
Scope.extend(scope),
runSync,
Effect.tap((chunk) =>
Effect.sync(() => {
controller.error(error.value)
Chunk.map(chunk, (a) => {
controller.enqueue(a)
})
})
}),
Effect.asVoid
)
},
pull() {
return new Promise<void>((resolve) => {
runFork(pull, { scope }).addObserver((_) => resolve())
})
},
cancel() {
return new Promise<void>((resolve) => {
runFork(Scope.close(scope, Exit.void)).addObserver((_) => resolve())
})
}
})
})
),
Effect.tapErrorCause(() => Scope.close(scope, Exit.void)),
Effect.catchTags({
"None": () =>
Effect.sync(() => {
controller.close()
}),
"Some": (error) =>
Effect.sync(() => {
controller.error(error.value)
})
}),
Effect.asVoid
)
},
pull() {
return new Promise<void>((resolve) => {
runFork(pull, { scope }).addObserver((_) => resolve())
})
},
cancel() {
return new Promise<void>((resolve) => {
runFork(Scope.close(scope, Exit.void)).addObserver((_) => resolve())
})
}
}, options?.strategy)
}
)

/** @internal */
export const transduce = dual<
Expand Down