Update misskey-js/streaming.ts
This commit is contained in:
3
index.ts
3
index.ts
@@ -218,6 +218,9 @@ function initializeStream() {
|
||||
{
|
||||
token: Bun.env["MISSKEY_CREDENTIAL"] ?? "",
|
||||
},
|
||||
{
|
||||
binaryType: "arraybuffer"
|
||||
}
|
||||
) as unknown as MisskeyStream;
|
||||
channel = stream.useChannel("main");
|
||||
|
||||
|
||||
@@ -1,25 +1,18 @@
|
||||
import { EventEmitter } from "eventemitter3";
|
||||
import ReconnectingWebsocket, {
|
||||
type Options as WebsocketOptions,
|
||||
} from "reconnecting-websocket";
|
||||
import type { BroadcastEvents, Channels } from "./streaming.types.js";
|
||||
import { EventEmitter } from 'eventemitter3';
|
||||
import ReconnectingWebsocket, { type Options } from 'reconnecting-websocket';
|
||||
import type { BroadcastEvents, Channels } from './streaming.types.js';
|
||||
|
||||
export function urlQuery(
|
||||
obj: Record<string, string | number | boolean | undefined>,
|
||||
): string {
|
||||
export function urlQuery(obj: Record<string, string | number | boolean | undefined>): string {
|
||||
const params = Object.entries(obj)
|
||||
.filter(([, v]) => (Array.isArray(v) ? v.length : v !== undefined))
|
||||
.reduce(
|
||||
// biome-ignore lint/style/noNonNullAssertion: <explanation>
|
||||
// biome-ignore lint/suspicious/noAssignInExpressions: <explanation>
|
||||
// biome-ignore lint/style/noCommaOperator: <explanation>
|
||||
(a, [k, v]) => ((a[k] = v!), a),
|
||||
{} as Record<string, string | number | boolean>,
|
||||
);
|
||||
.filter(([, v]) => Array.isArray(v) ? v.length : v !== undefined)
|
||||
// biome-ignore lint/suspicious/noAssignInExpressions: <explanation>
|
||||
// biome-ignore lint/style/noCommaOperator: <explanation>
|
||||
// biome-ignore lint/style/noNonNullAssertion: <explanation>
|
||||
.reduce((a, [k, v]) => (a[k] = v!, a), {} as Record<string, string | number | boolean>);
|
||||
|
||||
return Object.entries(params)
|
||||
.map((e) => `${e[0]}=${encodeURIComponent(e[1])}`)
|
||||
.join("&");
|
||||
.join('&');
|
||||
}
|
||||
|
||||
type AnyOf<T extends Record<PropertyKey, unknown>> = T[keyof T];
|
||||
@@ -30,23 +23,16 @@ export type StreamEvents = {
|
||||
} & BroadcastEvents;
|
||||
|
||||
export interface IStream extends EventEmitter<StreamEvents> {
|
||||
state: "initializing" | "reconnecting" | "connected";
|
||||
state: 'initializing' | 'reconnecting' | 'connected';
|
||||
|
||||
useChannel<C extends keyof Channels>(
|
||||
channel: C,
|
||||
params?: Channels[C]["params"],
|
||||
name?: string,
|
||||
): IChannelConnection<Channels[C]>;
|
||||
useChannel<C extends keyof Channels>(channel: C, params?: Channels[C]['params'], name?: string): IChannelConnection<Channels[C]>;
|
||||
removeSharedConnection(connection: SharedConnection): void;
|
||||
removeSharedConnectionPool(pool: Pool): void;
|
||||
disconnectToChannel(connection: NonSharedConnection): void;
|
||||
send(typeOrPayload: string): void;
|
||||
send(typeOrPayload: string, payload: unknown): void;
|
||||
send(typeOrPayload: Record<string, unknown> | unknown[]): void;
|
||||
send(
|
||||
typeOrPayload: string | Record<string, unknown> | unknown[],
|
||||
payload?: unknown,
|
||||
): void;
|
||||
send(typeOrPayload: string | Record<string, unknown> | unknown[], payload?: unknown): void;
|
||||
ping(): void;
|
||||
heartbeat(): void;
|
||||
close(): void;
|
||||
@@ -56,29 +42,25 @@ export interface IStream extends EventEmitter<StreamEvents> {
|
||||
* Misskey stream connection
|
||||
*/
|
||||
// eslint-disable-next-line import/no-default-export
|
||||
export default class Stream
|
||||
extends EventEmitter<StreamEvents>
|
||||
implements IStream {
|
||||
export default class Stream extends EventEmitter<StreamEvents> implements IStream {
|
||||
private stream: ReconnectingWebsocket;
|
||||
public state: "initializing" | "reconnecting" | "connected" = "initializing";
|
||||
public state: 'initializing' | 'reconnecting' | 'connected' = 'initializing';
|
||||
private sharedConnectionPools: Pool[] = [];
|
||||
private sharedConnections: SharedConnection[] = [];
|
||||
private nonSharedConnections: NonSharedConnection[] = [];
|
||||
private idCounter = 0;
|
||||
|
||||
constructor(
|
||||
origin: string,
|
||||
user: { token: string } | null,
|
||||
options?: WebsocketOptions,
|
||||
) {
|
||||
constructor(origin: string, user: { token: string; } | null, options: {
|
||||
WebSocket?: Options['WebSocket'];
|
||||
binaryType?: ReconnectingWebsocket['binaryType'];
|
||||
} = {}) {
|
||||
super();
|
||||
|
||||
this.genId = this.genId.bind(this);
|
||||
this.useChannel = this.useChannel.bind(this);
|
||||
this.useSharedConnection = this.useSharedConnection.bind(this);
|
||||
this.removeSharedConnection = this.removeSharedConnection.bind(this);
|
||||
this.removeSharedConnectionPool =
|
||||
this.removeSharedConnectionPool.bind(this);
|
||||
this.removeSharedConnectionPool = this.removeSharedConnectionPool.bind(this);
|
||||
this.connectToChannel = this.connectToChannel.bind(this);
|
||||
this.disconnectToChannel = this.disconnectToChannel.bind(this);
|
||||
this.onOpen = this.onOpen.bind(this);
|
||||
@@ -94,102 +76,70 @@ export default class Stream
|
||||
_t: Date.now(),
|
||||
});
|
||||
|
||||
const wsOrigin = origin
|
||||
.replace("http://", "ws://")
|
||||
.replace("https://", "wss://");
|
||||
const wsOrigin = origin.replace('http://', 'ws://').replace('https://', 'wss://');
|
||||
|
||||
this.stream = new ReconnectingWebsocket(
|
||||
`${wsOrigin}/streaming?${query}`,
|
||||
"",
|
||||
{
|
||||
minReconnectionDelay: 1, // https://github.com/pladaria/reconnecting-websocket/issues/91
|
||||
...(options ?? {}),
|
||||
},
|
||||
);
|
||||
this.stream.binaryType = "arraybuffer";
|
||||
this.stream.addEventListener("open", this.onOpen);
|
||||
this.stream.addEventListener("close", this.onClose);
|
||||
this.stream.addEventListener("message", this.onMessage);
|
||||
this.stream = new ReconnectingWebsocket(`${wsOrigin}/streaming?${query}`, '', {
|
||||
minReconnectionDelay: 1, // https://github.com/pladaria/reconnecting-websocket/issues/91
|
||||
WebSocket: options.WebSocket,
|
||||
});
|
||||
if (options.binaryType) {
|
||||
this.stream.binaryType = options.binaryType;
|
||||
}
|
||||
this.stream.addEventListener('open', this.onOpen);
|
||||
this.stream.addEventListener('close', this.onClose);
|
||||
this.stream.addEventListener('message', this.onMessage);
|
||||
}
|
||||
|
||||
private genId(): string {
|
||||
return (++this.idCounter).toString();
|
||||
}
|
||||
|
||||
public useChannel<C extends keyof Channels>(
|
||||
channel: C,
|
||||
params?: Channels[C]["params"],
|
||||
name?: string,
|
||||
): Connection<Channels[C]> {
|
||||
public useChannel<C extends keyof Channels>(channel: C, params?: Channels[C]['params'], name?: string): Connection<Channels[C]> {
|
||||
if (params) {
|
||||
return this.connectToChannel(channel, params);
|
||||
}
|
||||
return this.useSharedConnection(channel, name);
|
||||
}
|
||||
|
||||
private useSharedConnection<C extends keyof Channels>(
|
||||
channel: C,
|
||||
name?: string,
|
||||
): SharedConnection<Channels[C]> {
|
||||
let pool = this.sharedConnectionPools.find((p) => p.channel === channel);
|
||||
private useSharedConnection<C extends keyof Channels>(channel: C, name?: string): SharedConnection<Channels[C]> {
|
||||
let pool = this.sharedConnectionPools.find(p => p.channel === channel);
|
||||
|
||||
if (pool == null) {
|
||||
pool = new Pool(this, channel, this.genId());
|
||||
this.sharedConnectionPools.push(pool);
|
||||
}
|
||||
|
||||
const connection = new SharedConnection<Channels[C]>(
|
||||
this,
|
||||
channel,
|
||||
pool,
|
||||
name,
|
||||
);
|
||||
const connection = new SharedConnection<Channels[C]>(this, channel, pool, name);
|
||||
this.sharedConnections.push(connection as unknown as SharedConnection);
|
||||
return connection;
|
||||
}
|
||||
|
||||
public removeSharedConnection(connection: SharedConnection): void {
|
||||
this.sharedConnections = this.sharedConnections.filter(
|
||||
(c) => c !== connection,
|
||||
);
|
||||
this.sharedConnections = this.sharedConnections.filter(c => c !== connection);
|
||||
}
|
||||
|
||||
public removeSharedConnectionPool(pool: Pool): void {
|
||||
this.sharedConnectionPools = this.sharedConnectionPools.filter(
|
||||
(p) => p !== pool,
|
||||
);
|
||||
this.sharedConnectionPools = this.sharedConnectionPools.filter(p => p !== pool);
|
||||
}
|
||||
|
||||
private connectToChannel<C extends keyof Channels>(
|
||||
channel: C,
|
||||
params: Channels[C]["params"],
|
||||
): NonSharedConnection<Channels[C]> {
|
||||
const connection = new NonSharedConnection(
|
||||
this,
|
||||
channel,
|
||||
this.genId(),
|
||||
params,
|
||||
);
|
||||
this.nonSharedConnections.push(
|
||||
connection as unknown as NonSharedConnection,
|
||||
);
|
||||
private connectToChannel<C extends keyof Channels>(channel: C, params: Channels[C]['params']): NonSharedConnection<Channels[C]> {
|
||||
const connection = new NonSharedConnection(this, channel, this.genId(), params);
|
||||
this.nonSharedConnections.push(connection as unknown as NonSharedConnection);
|
||||
return connection;
|
||||
}
|
||||
|
||||
public disconnectToChannel(connection: NonSharedConnection): void {
|
||||
this.nonSharedConnections = this.nonSharedConnections.filter(
|
||||
(c) => c !== connection,
|
||||
);
|
||||
this.nonSharedConnections = this.nonSharedConnections.filter(c => c !== connection);
|
||||
}
|
||||
|
||||
/**
|
||||
* Callback of when open connection
|
||||
*/
|
||||
private onOpen(): void {
|
||||
const isReconnect = this.state === "reconnecting";
|
||||
const isReconnect = this.state === 'reconnecting';
|
||||
|
||||
this.state = "connected";
|
||||
this.emit("_connected_");
|
||||
this.state = 'connected';
|
||||
this.emit('_connected_');
|
||||
|
||||
// チャンネル再接続
|
||||
if (isReconnect) {
|
||||
@@ -202,27 +152,27 @@ export default class Stream
|
||||
* Callback of when close connection
|
||||
*/
|
||||
private onClose(): void {
|
||||
if (this.state === "connected") {
|
||||
this.state = "reconnecting";
|
||||
this.emit("_disconnected_");
|
||||
if (this.state === 'connected') {
|
||||
this.state = 'reconnecting';
|
||||
this.emit('_disconnected_');
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Callback of when received a message from connection
|
||||
*/
|
||||
private onMessage(message: { data: string }): void {
|
||||
private onMessage(message: { data: string; }): void {
|
||||
const { type, body } = JSON.parse(message.data);
|
||||
|
||||
if (type === "channel") {
|
||||
if (type === 'channel') {
|
||||
const id = body.id;
|
||||
|
||||
let connections: Connection[];
|
||||
|
||||
connections = this.sharedConnections.filter((c) => c.id === id);
|
||||
connections = this.sharedConnections.filter(c => c.id === id);
|
||||
|
||||
if (connections.length === 0) {
|
||||
const found = this.nonSharedConnections.find((c) => c.id === id);
|
||||
const found = this.nonSharedConnections.find(c => c.id === id);
|
||||
if (found) {
|
||||
connections = [found];
|
||||
}
|
||||
@@ -241,20 +191,15 @@ export default class Stream
|
||||
* Send a message to connection
|
||||
* ! ストリーム上のやり取りはすべてJSONで行われます !
|
||||
*/
|
||||
public send(typeOrPayload: string): void;
|
||||
public send(typeOrPayload: string, payload: unknown): void;
|
||||
public send(typeOrPayload: Record<string, unknown> | unknown[]): void;
|
||||
public send(
|
||||
typeOrPayload: string | Record<string, unknown> | unknown[],
|
||||
payload?: unknown,
|
||||
): void {
|
||||
if (typeof typeOrPayload === "string") {
|
||||
this.stream.send(
|
||||
JSON.stringify({
|
||||
type: typeOrPayload,
|
||||
...(payload === undefined ? {} : { body: payload }),
|
||||
}),
|
||||
);
|
||||
public send(typeOrPayload: string): void
|
||||
public send(typeOrPayload: string, payload: unknown): void
|
||||
public send(typeOrPayload: Record<string, unknown> | unknown[]): void
|
||||
public send(typeOrPayload: string | Record<string, unknown> | unknown[], payload?: unknown): void {
|
||||
if (typeof typeOrPayload === 'string') {
|
||||
this.stream.send(JSON.stringify({
|
||||
type: typeOrPayload,
|
||||
...(payload === undefined ? {} : { body: payload }),
|
||||
}));
|
||||
return;
|
||||
}
|
||||
|
||||
@@ -262,11 +207,11 @@ export default class Stream
|
||||
}
|
||||
|
||||
public ping(): void {
|
||||
this.stream.send("ping");
|
||||
this.stream.send('ping');
|
||||
}
|
||||
|
||||
public heartbeat(): void {
|
||||
this.stream.send("h");
|
||||
this.stream.send('h');
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -298,7 +243,7 @@ class Pool {
|
||||
this.stream = stream;
|
||||
this.id = id;
|
||||
|
||||
this.stream.on("_disconnected_", this.onStreamDisconnected);
|
||||
this.stream.on('_disconnected_', this.onStreamDisconnected);
|
||||
}
|
||||
|
||||
private onStreamDisconnected(): void {
|
||||
@@ -335,41 +280,31 @@ class Pool {
|
||||
public connect(): void {
|
||||
if (this.isConnected) return;
|
||||
this.isConnected = true;
|
||||
this.stream.send("connect", {
|
||||
this.stream.send('connect', {
|
||||
channel: this.channel,
|
||||
id: this.id,
|
||||
});
|
||||
}
|
||||
|
||||
private disconnect(): void {
|
||||
this.stream.off("_disconnected_", this.onStreamDisconnected);
|
||||
this.stream.send("disconnect", { id: this.id });
|
||||
this.stream.off('_disconnected_', this.onStreamDisconnected);
|
||||
this.stream.send('disconnect', { id: this.id });
|
||||
this.stream.removeSharedConnectionPool(this);
|
||||
}
|
||||
}
|
||||
|
||||
export interface IChannelConnection<
|
||||
Channel extends AnyOf<Channels> = AnyOf<Channels>,
|
||||
> extends EventEmitter<Channel["events"]> {
|
||||
export interface IChannelConnection<Channel extends AnyOf<Channels> = AnyOf<Channels>> extends EventEmitter<Channel['events']> {
|
||||
id: string;
|
||||
name?: string;
|
||||
inCount: number;
|
||||
outCount: number;
|
||||
channel: string;
|
||||
|
||||
send<T extends keyof Channel["receives"]>(
|
||||
type: T,
|
||||
body: Channel["receives"][T],
|
||||
): void;
|
||||
send<T extends keyof Channel['receives']>(type: T, body: Channel['receives'][T]): void;
|
||||
dispose(): void;
|
||||
}
|
||||
|
||||
export abstract class Connection<
|
||||
Channel extends AnyOf<Channels> = AnyOf<Channels>,
|
||||
>
|
||||
extends EventEmitter<Channel["events"]>
|
||||
implements IChannelConnection<Channel>
|
||||
{
|
||||
export abstract class Connection<Channel extends AnyOf<Channels> = AnyOf<Channels>> extends EventEmitter<Channel['events']> implements IChannelConnection<Channel> {
|
||||
public channel: string;
|
||||
protected stream: Stream;
|
||||
public abstract id: string;
|
||||
@@ -390,11 +325,8 @@ export abstract class Connection<
|
||||
}
|
||||
}
|
||||
|
||||
public send<T extends keyof Channel["receives"]>(
|
||||
type: T,
|
||||
body: Channel["receives"][T],
|
||||
): void {
|
||||
this.stream.send("ch", {
|
||||
public send<T extends keyof Channel['receives']>(type: T, body: Channel['receives'][T]): void {
|
||||
this.stream.send('ch', {
|
||||
id: this.id,
|
||||
type: type,
|
||||
body: body,
|
||||
@@ -406,9 +338,7 @@ export abstract class Connection<
|
||||
public abstract dispose(): void;
|
||||
}
|
||||
|
||||
class SharedConnection<
|
||||
Channel extends AnyOf<Channels> = AnyOf<Channels>,
|
||||
> extends Connection<Channel> {
|
||||
class SharedConnection<Channel extends AnyOf<Channels> = AnyOf<Channels>> extends Connection<Channel> {
|
||||
private pool: Pool;
|
||||
|
||||
public get id(): string {
|
||||
@@ -431,18 +361,11 @@ class SharedConnection<
|
||||
}
|
||||
}
|
||||
|
||||
class NonSharedConnection<
|
||||
Channel extends AnyOf<Channels> = AnyOf<Channels>,
|
||||
> extends Connection<Channel> {
|
||||
class NonSharedConnection<Channel extends AnyOf<Channels> = AnyOf<Channels>> extends Connection<Channel> {
|
||||
public id: string;
|
||||
protected params: Channel["params"];
|
||||
protected params: Channel['params'];
|
||||
|
||||
constructor(
|
||||
stream: Stream,
|
||||
channel: string,
|
||||
id: string,
|
||||
params: Channel["params"],
|
||||
) {
|
||||
constructor(stream: Stream, channel: string, id: string, params: Channel['params']) {
|
||||
super(stream, channel);
|
||||
|
||||
this.connect = this.connect.bind(this);
|
||||
@@ -455,7 +378,7 @@ class NonSharedConnection<
|
||||
}
|
||||
|
||||
public connect(): void {
|
||||
this.stream.send("connect", {
|
||||
this.stream.send('connect', {
|
||||
channel: this.channel,
|
||||
id: this.id,
|
||||
params: this.params,
|
||||
@@ -464,7 +387,7 @@ class NonSharedConnection<
|
||||
|
||||
public dispose(): void {
|
||||
this.removeAllListeners();
|
||||
this.stream.send("disconnect", { id: this.id });
|
||||
this.stream.send('disconnect', { id: this.id });
|
||||
this.stream.disconnectToChannel(this as unknown as NonSharedConnection);
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user