Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
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
5 changes: 5 additions & 0 deletions .changeset/olive-doodles-fix.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@eventkit/base": minor
---

Introduces **10** new operators into eventkit: `find`, `findIndex`, `first`, `isEmpty`, `last`, `max`, `min`, `pairwise`, `skip`, and `every`. See the [docs](https://hntrl.github.io/eventkit/guide/concepts/transforming-data#available-operators) for a complete reference.
5 changes: 5 additions & 0 deletions .changeset/sad-radios-rhyme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@eventkit/base": patch
---

Fixed some invariant behavior with the `reduce` operator where the chain of accumulator calls depending on the seed value wasn't consistent with the native array method
52 changes: 51 additions & 1 deletion docs/guide/concepts/transforming-data.md
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,57 @@ Singleton observables are meant to provide a shorthand for dealing with observab

## Available Operators

Eventkit provides a variety of built-in operators to handle common transformations. A complete reference of all operators can be found [here](/reference/operators).
Eventkit provides a variety of built-in operators to handle common transformations. Below is a complete list of all the operators that ship as standard with eventkit.

### Join Operators

- [concat](/reference/_eventkit/base/concat)
- [concatAll](/reference/_eventkit/base/concatAll)
- [concatMap](/reference/_eventkit/base/concatMap)
- [merge](/reference/_eventkit/base/merge)
- [mergeAll](/reference/_eventkit/base/mergeAll)
- [mergeMap](/reference/_eventkit/base/mergeMap)

### Transformation Operators

- [buffer](/reference/_eventkit/base/buffer)
- [bufferCount](/reference/_eventkit/base/bufferCount)
- [map](/reference/_eventkit/base/map)
- [pairwise](/reference/_eventkit/base/pairwise)
- [partition](/reference/_eventkit/base/partition)
- [takeUntil](/reference/_eventkit/base/takeUntil)

### Filtering Operators

- [elementAt](/reference/_eventkit/base/elementAt)
- [filter](/reference/_eventkit/base/filter)
- [find](/reference/_eventkit/base/find)
- [findIndex](/reference/_eventkit/base/findIndex)
- [first](/reference/_eventkit/base/first)
- [last](/reference/_eventkit/base/last)
- [skip](/reference/_eventkit/base/skip)

### Error Handling Operators

- [dlq](/reference/_eventkit/base/dlq)
- [retry](/reference/_eventkit/base/retry)

### Scheduling Operators

- [withOwnScheduler](/reference/_eventkit/base/withOwnScheduler)
- [withScheduler](/reference/_eventkit/base/withScheduler)

### Boolean Operators

- [every](/reference/_eventkit/base/every)
- [isEmpty](/reference/_eventkit/base/isEmpty)

### Aggregation Operators

- [max](/reference/_eventkit/base/max)
- [min](/reference/_eventkit/base/min)
- [count](/reference/_eventkit/base/count)
- [reduce](/reference/_eventkit/base/reduce)

## Creating Custom Operators

Expand Down
236 changes: 236 additions & 0 deletions packages/eventkit/__tests__/operators/every.spec.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,236 @@
import { AsyncObservable } from "@eventkit/async-observable";
import { every } from "../../lib/operators/every";
import { vi, describe, it, expect } from "vitest";
import { SingletonAsyncObservable } from "../../lib/singleton";

describe("every", () => {
it("should return a SingletonAsyncObservable", async () => {
const obs = AsyncObservable.from([1, 2, 3]);
const result = obs.pipe(every((x: number) => x > 0));
expect(result).toBeInstanceOf(SingletonAsyncObservable);
});

describe("when all values satisfy the predicate", () => {
it("should emit true when all values pass", async () => {
const source = AsyncObservable.from([1, 2, 3]);
const result = await source.pipe(every((x) => x > 0));
expect(result).toBe(true);
});

it("should complete after emitting true", async () => {
const source = AsyncObservable.from([1, 2, 3]);
const completionSpy = vi.fn();

const sub = source.pipe(every((x) => x > 0)).subscribe(() => {});
sub.finally(completionSpy);

await sub;
expect(completionSpy).toHaveBeenCalledTimes(1);
});

it("should work with await syntax", async () => {
const source = AsyncObservable.from([2, 4, 6, 8]);
const result = await source.pipe(every((x) => x % 2 === 0));
expect(result).toBe(true);
});

it("should handle empty observables (emit true)", async () => {
const source = AsyncObservable.from([]);
const result = await source.pipe(every((x) => !!x));
expect(result).toBe(true);
});
});

describe("when any value fails the predicate", () => {
it("should emit false immediately when a value fails", async () => {
const source = AsyncObservable.from([1, 2, 3, 4, 5]);
const result = await source.pipe(every((x) => x <= 3));
expect(result).toBe(false);
});

it("should cancel the source observable after emitting false", async () => {
const cancelSpy = vi.fn();
const nextSpy = vi.fn();

const source = new AsyncObservable<number>(async function* () {
try {
yield 1;
yield 2;
yield 4; // This fails the predicate
yield 3;
nextSpy();
yield 5;
} finally {
cancelSpy();
}
});

await source.pipe(every((x) => x <= 3));
expect(cancelSpy).toHaveBeenCalledTimes(1);
expect(nextSpy).not.toHaveBeenCalled();
});

it("should work with await syntax", async () => {
const source = AsyncObservable.from([2, 4, 5, 8]);
const result = await source.pipe(every((x) => x % 2 === 0));
expect(result).toBe(false);
});

it("should handle the first value failing", async () => {
const source = AsyncObservable.from([0, 2, 4, 6]);
const result = await source.pipe(every((x) => x > 0));
expect(result).toBe(false);
});

it("should handle a middle value failing", async () => {
const source = AsyncObservable.from([2, 4, 5, 6, 8]);
const result = await source.pipe(every((x) => x % 2 === 0));
expect(result).toBe(false);
});

it("should handle the last value failing", async () => {
const source = AsyncObservable.from([2, 4, 6, 7]);
const result = await source.pipe(every((x) => x % 2 === 0));
expect(result).toBe(false);
});
});

describe("when predicate throws an error", () => {
it("should propagate the error to the subscriber", async () => {
const error = new Error("predicate error");
const source = AsyncObservable.from([1, 2, 3]);

let caughtError: Error | null = null;
try {
await source.pipe(
every(() => {
throw error;
})
);
} catch (e) {
caughtError = e as Error;
}

expect(caughtError).toBe(error);
});

it("should cancel the source observable", async () => {
const error = new Error("predicate error");
const cancelSpy = vi.fn();

const source = new AsyncObservable<number>(async function* () {
try {
yield 1;
yield 2;
yield 3;
} finally {
cancelSpy();
}
});

try {
await source.pipe(
every(() => {
throw error;
})
);
} catch (e) {
// Expected error
}

expect(cancelSpy).toHaveBeenCalledTimes(1);
});

it("should not emit any value", async () => {
const error = new Error("predicate error");
const source = AsyncObservable.from([1, 2, 3]);

const nextSpy = vi.fn();
try {
await source
.pipe(
every(() => {
throw error;
})
)
.subscribe(nextSpy);
} catch (e) {
// Expected error
}

expect(nextSpy).not.toHaveBeenCalled();
});
});

describe("when source observable errors", () => {
it("should propagate the error to the subscriber", async () => {
const error = new Error("source error");
const source = new AsyncObservable<number>(async function* () {
yield 1;
throw error;
});

let caughtError: Error | null = null;
try {
await source.pipe(every((x) => x > 0));
} catch (e) {
caughtError = e as Error;
}

expect(caughtError).toBe(error);
});

it("should not emit any value", async () => {
const error = new Error("source error");
const source = new AsyncObservable<number>(async function* () {
yield 1;
throw error;
});

const nextSpy = vi.fn();
try {
await source.pipe(every((x) => x > 0)).subscribe(nextSpy);
} catch (e) {
// Expected error
}

expect(nextSpy).not.toHaveBeenCalled();
});
});

describe("when predicate uses the index parameter", () => {
it("should pass the correct index to the predicate", async () => {
const source = AsyncObservable.from(["a", "b", "c"]);
const indexSpy = vi.fn().mockReturnValue(true);

await source.pipe(every(indexSpy));

expect(indexSpy).toHaveBeenNthCalledWith(1, "a", 0);
expect(indexSpy).toHaveBeenNthCalledWith(2, "b", 1);
expect(indexSpy).toHaveBeenNthCalledWith(3, "c", 2);
});

it("should increment index for each value", async () => {
const source = AsyncObservable.from([10, 20, 30]);
const indices: number[] = [];

await source.pipe(
every((_, index) => {
indices.push(index);
return true;
})
);

expect(indices).toEqual([0, 1, 2]);
});

it("should start index at 0", async () => {
const source = AsyncObservable.from([5, 10, 15]);
const indexSpy = vi.fn().mockReturnValue(true);

await source.pipe(every(indexSpy));

expect(indexSpy).toHaveBeenCalledWith(5, 0);
});
});
});
Loading