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.

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

add releaseAll api to Semaphore #2067

Merged
merged 2 commits into from
Feb 7, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
8 changes: 8 additions & 0 deletions .changeset/chilly-birds-eat.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
"effect": patch
---

add releaseAll api to Semaphore

You can use `semphore.releaseAll` to atomically release all the permits of a
Semaphore.
1 change: 1 addition & 0 deletions packages/effect/src/Effect.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4689,6 +4689,7 @@ export interface Semaphore {
withPermits(permits: number): <R, E, A>(self: Effect<R, E, A>) => Effect<R, E, A>
take(permits: number): Effect<never, never, number>
release(permits: number): Effect<never, never, void>
releaseAll: Effect<never, never, void>
}

/**
Expand Down
32 changes: 21 additions & 11 deletions packages/effect/src/internal/effect/circular.ts
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ import * as supervisor from "../supervisor.js"

/** @internal */
class Semaphore {
public waiters = new Array<() => void>()
public waiters = new Array<() => boolean>()
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Benchmarks show using a Set scales much better than an Array for this.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Insertion order is preserved too, so it is safe to use.

public taken = 0

constructor(readonly permits: number) {}
Expand All @@ -48,14 +48,16 @@ class Semaphore {
core.asyncEither<never, never, number>((resume) => {
if (this.free < n) {
const observer = () => {
if (this.free >= n) {
const observerIndex = this.waiters.findIndex((cb) => cb === observer)
if (observerIndex !== -1) {
this.waiters.splice(observerIndex, 1)
}
this.taken += n
resume(core.succeed(n))
if (this.free < n) {
return false
}
const observerIndex = this.waiters.findIndex((cb) => cb === observer)
if (observerIndex !== -1) {
this.waiters.splice(observerIndex, 1)
}
this.taken += n
resume(core.succeed(n))
return true
}
this.waiters.push(observer)
return Either.left(core.sync(() => {
Expand All @@ -69,15 +71,23 @@ class Semaphore {
return Either.right(core.succeed(n))
})

readonly release = (n: number): Effect.Effect<never, never, void> =>
readonly updateTaken = (f: (n: number) => number): Effect.Effect<never, never, void> =>
core.withFiberRuntime<never, never, void>((fiber) => {
this.taken -= n
this.taken = f(this.taken)
fiber.getFiberRef(currentScheduler).scheduleTask(() => {
this.waiters.forEach((wake) => wake())
while (this.waiters.length > 0) {
if (this.waiters[0]() === false) {
break
}
}
}, fiber.getFiberRef(core.currentSchedulingPriority))
return core.unit
})

readonly release = (n: number): Effect.Effect<never, never, void> => this.updateTaken((taken) => taken - n)

readonly releaseAll: Effect.Effect<never, never, void> = this.updateTaken((_) => 0)

readonly withPermits = (n: number) => <R, E, A>(self: Effect.Effect<R, E, A>) =>
core.uninterruptibleMask((restore) =>
core.flatMap(
Expand Down
8 changes: 8 additions & 0 deletions packages/effect/test/Effect/semaphore.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -34,4 +34,12 @@ describe("Effect", () => {
yield* $(TestClock.adjust(D.seconds(3)))
assert.equal(messages.length, 8)
}))

it.effect("releaseAll", () =>
Effect.gen(function*(_) {
const sem = yield* _(Effect.makeSemaphore(4))
yield* _(sem.take(4))
yield* _(sem.releaseAll)
yield* _(sem.take(1))
}))
})
Loading