Skip to content

Add once support to IStream #74

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

Open
ChrisWozniak wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add once support to IStream #74

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1 change: 1 addition & 0 deletions typescript/src/types/client.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ export interface StreamOptions {

export interface IStream {
on(event: "report", listener: (report: Report) => void): this;
once(event: "report", listener: (report: Report) => void): this;
on(event: "error", listener: (error: Error) => void): this;
on(event: "disconnected", listener: () => void): this;
on(
Expand Down
21 changes: 20 additions & 1 deletion typescript/tests/unit/stream/stream/events.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { describe, it, expect, beforeEach, jest } from "@jest/globals";
import { Stream } from "../../../../src/stream";
import { Config } from "../../../../src/types/client";
import { Config, IStream } from "../../../../src/types/client";
import { LogLevel } from "../../../../src/types/logger";
import * as originDiscovery from "../../../../src/utils/origin-discovery";

Expand Down Expand Up @@ -93,6 +93,25 @@ describe("Stream - Event Re-emission", () => {
expect(reconnectingSpy).toHaveBeenCalledWith(reconnectingInfo);
});

it("supports one-time report listeners through IStream", () => {
const typedStream: IStream = stream;
const reportListener = jest.fn();
const report = {
feedID: "0x0003" + "1".repeat(60),
fullReport: "0x1234",
validFromTimestamp: 1,
observationsTimestamp: 2,
};

expect(typedStream.once("report", reportListener)).toBe(typedStream);

stream.emit("report", report);
stream.emit("report", report);

expect(reportListener).toHaveBeenCalledTimes(1);
expect(reportListener).toHaveBeenCalledWith(report);
});

it("re-emits 'connection-lost' event exactly once per transition", async () => {
const connectionLostSpy = jest.fn();
stream.on("connection-lost", connectionLostSpy);
Expand Down