@bymax-one/nest-realtime 1.2.1 → 1.2.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +133 -1
- package/README.md +82 -10
- package/dist/internal/index.cjs +71 -7
- package/dist/internal/index.d.cts +21 -2
- package/dist/internal/index.d.ts +21 -2
- package/dist/internal/index.mjs +72 -8
- package/dist/shared/index.cjs +1 -0
- package/dist/shared/index.d.cts +1 -0
- package/dist/shared/index.d.ts +1 -0
- package/dist/shared/index.mjs +1 -0
- package/dist/websocket/index.cjs +127 -78
- package/dist/websocket/index.d.cts +10 -7
- package/dist/websocket/index.d.ts +10 -7
- package/dist/websocket/index.mjs +133 -82
- package/package.json +1 -1
package/dist/websocket/index.mjs
CHANGED
|
@@ -1,15 +1,17 @@
|
|
|
1
|
+
import { createRequire } from 'node:module';
|
|
1
2
|
import { Injectable, Inject, Logger, Global, Module } from '@nestjs/common';
|
|
2
|
-
import { ConnectionRegistry, RoomRegistry, REALTIME_AUTHENTICATOR_TOKEN, REALTIME_HOOKS_TOKEN, REALTIME_OPTIONS_TOKEN, SseTransport, ROOM_PREFIXES, REALTIME_ERROR_CODES, composeForRoot, composeForRootAsync, REALTIME_TRANSPORT_TOKEN, SseSubscriptionHandler, RealtimePubSubSubscriber, createSseController,
|
|
3
|
+
import { ConnectionRegistry, RoomRegistry, REALTIME_AUTHENTICATOR_TOKEN, REALTIME_HOOKS_TOKEN, REALTIME_OPTIONS_TOKEN, SseTransport, ROOM_PREFIXES, REALTIME_ERROR_CODES, composeForRoot, composeForRootAsync, REALTIME_TRANSPORT_TOKEN, SseSubscriptionHandler, RealtimePubSubSubscriber, createSseController, resolveAuthTenant, assertIdentityIsNotBlank, parseCookieHeader, RESERVED_EVENT_NAMES } from '@bymax-one/nest-realtime/internal';
|
|
3
4
|
import { WebSocketServer, WebSocketGateway } from '@nestjs/websockets';
|
|
4
5
|
import { IoAdapter } from '@nestjs/platform-socket.io';
|
|
5
6
|
|
|
7
|
+
const require$1 = createRequire(import.meta.url || __filename);
|
|
6
8
|
var __defProp = Object.defineProperty;
|
|
7
9
|
var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
|
|
8
10
|
var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
|
|
9
|
-
var __require = /* @__PURE__ */ ((x) => typeof require !== "undefined" ? require : typeof Proxy !== "undefined" ? new Proxy(x, {
|
|
10
|
-
get: (a, b) => (typeof require !== "undefined" ? require : a)[b]
|
|
11
|
+
var __require = /* @__PURE__ */ ((x) => typeof require$1 !== "undefined" ? require$1 : typeof Proxy !== "undefined" ? new Proxy(x, {
|
|
12
|
+
get: (a, b) => (typeof require$1 !== "undefined" ? require$1 : a)[b]
|
|
11
13
|
}) : x)(function(x) {
|
|
12
|
-
if (typeof require !== "undefined") return require.apply(this, arguments);
|
|
14
|
+
if (typeof require$1 !== "undefined") return require$1.apply(this, arguments);
|
|
13
15
|
throw Error('Dynamic require of "' + x + '" is not supported');
|
|
14
16
|
});
|
|
15
17
|
var __decorateClass = (decorators, target, key, kind) => {
|
|
@@ -391,6 +393,90 @@ CompositeTransport = __decorateClass([
|
|
|
391
393
|
__decorateParam(0, Inject(SseTransport)),
|
|
392
394
|
__decorateParam(1, Inject(WebSocketTransport))
|
|
393
395
|
], CompositeTransport);
|
|
396
|
+
var realtimeServers = /* @__PURE__ */ new WeakSet();
|
|
397
|
+
function isRealtimeIoServer(server) {
|
|
398
|
+
return typeof server === "object" && server !== null && realtimeServers.has(server);
|
|
399
|
+
}
|
|
400
|
+
var RealtimeIoAdapter = class _RealtimeIoAdapter extends IoAdapter {
|
|
401
|
+
adapterLogger = new Logger(_RealtimeIoAdapter.name);
|
|
402
|
+
options;
|
|
403
|
+
constructor(app) {
|
|
404
|
+
super(app);
|
|
405
|
+
this.options = app.get(REALTIME_OPTIONS_TOKEN);
|
|
406
|
+
}
|
|
407
|
+
/**
|
|
408
|
+
* Bind the gateway to `websocket.namespace` when configured.
|
|
409
|
+
*
|
|
410
|
+
* `@WebSocketGateway()` args are evaluated at class-decoration time — before
|
|
411
|
+
* the module options resolve — so the namespace cannot be declared there.
|
|
412
|
+
* Instead we build the root server via `super.create` (which routes through the
|
|
413
|
+
* overridden {@link createIOServer}, applying CORS/ping/Redis) and then return
|
|
414
|
+
* the requested namespace via `server.of(ns)`. The gateway's `@WebSocketServer()`
|
|
415
|
+
* and `WebSocketTransport` then operate on that `Namespace`. A `'/'` or unset
|
|
416
|
+
* namespace leaves the root server untouched.
|
|
417
|
+
*/
|
|
418
|
+
create(port, options) {
|
|
419
|
+
const server = super.create(port, options);
|
|
420
|
+
const ns = this.options.websocket?.namespace;
|
|
421
|
+
if (ns && ns !== "/" && typeof server.of === "function") {
|
|
422
|
+
const namespace = server.of(ns);
|
|
423
|
+
realtimeServers.add(namespace);
|
|
424
|
+
return namespace;
|
|
425
|
+
}
|
|
426
|
+
return server;
|
|
427
|
+
}
|
|
428
|
+
/**
|
|
429
|
+
* Create the Socket.IO server with merged WebSocket options.
|
|
430
|
+
*
|
|
431
|
+
* When `websocket.redisAdapter.pubClient` is set, installs the
|
|
432
|
+
* `@socket.io/redis-adapter` lazily: the optional peer is needed only then.
|
|
433
|
+
*/
|
|
434
|
+
createIOServer(port, opts) {
|
|
435
|
+
const wsOpts = this.options.websocket ?? {};
|
|
436
|
+
const mergedOpts = {
|
|
437
|
+
...opts,
|
|
438
|
+
cors: wsOpts.cors ?? opts?.cors,
|
|
439
|
+
pingInterval: wsOpts.pingIntervalMs ?? 25e3,
|
|
440
|
+
pingTimeout: wsOpts.pingTimeoutMs ?? 2e4,
|
|
441
|
+
maxHttpBufferSize: wsOpts.maxHttpBufferSize ?? 1e6
|
|
442
|
+
};
|
|
443
|
+
const server = super.createIOServer(port, mergedOpts);
|
|
444
|
+
if (wsOpts.redisAdapter?.pubClient) {
|
|
445
|
+
try {
|
|
446
|
+
this.installRedisAdapter(server, wsOpts.redisAdapter.pubClient);
|
|
447
|
+
} catch (err) {
|
|
448
|
+
server.close().catch(() => void 0);
|
|
449
|
+
throw err;
|
|
450
|
+
}
|
|
451
|
+
}
|
|
452
|
+
realtimeServers.add(server);
|
|
453
|
+
return server;
|
|
454
|
+
}
|
|
455
|
+
/**
|
|
456
|
+
* Install `@socket.io/redis-adapter`. A deterministic failure fails the boot: a
|
|
457
|
+
* silent single-instance server drops cross-node messages. An unreachable Redis
|
|
458
|
+
* is not one; reconnecting stays with the client.
|
|
459
|
+
*/
|
|
460
|
+
installRedisAdapter(server, pubClient) {
|
|
461
|
+
try {
|
|
462
|
+
const { createAdapter } = __require("@socket.io/redis-adapter");
|
|
463
|
+
const pub = pubClient;
|
|
464
|
+
const sub = pub.duplicate();
|
|
465
|
+
server.adapter(createAdapter(pub, sub));
|
|
466
|
+
} catch (err) {
|
|
467
|
+
const reason = err instanceof Error ? err.message : String(err);
|
|
468
|
+
throw new Error(
|
|
469
|
+
`[${_RealtimeIoAdapter.name}] ${REALTIME_ERROR_CODES.REDIS_ADAPTER_FAILED}: websocket.redisAdapter is set but the Socket.IO Redis adapter could not be installed (${reason}). Install @socket.io/redis-adapter and pass an ioredis client as pubClient.`,
|
|
470
|
+
{ cause: err }
|
|
471
|
+
);
|
|
472
|
+
}
|
|
473
|
+
this.adapterLogger.log(
|
|
474
|
+
"Socket.IO Redis adapter registered \u2014 cross-instance WebSocket fan-out enabled"
|
|
475
|
+
);
|
|
476
|
+
}
|
|
477
|
+
};
|
|
478
|
+
|
|
479
|
+
// src/websocket/transports/websocket/realtime.gateway.ts
|
|
394
480
|
function firstQueryValue(value) {
|
|
395
481
|
return Array.isArray(value) ? value[0] : value;
|
|
396
482
|
}
|
|
@@ -403,11 +489,43 @@ var RealtimeGateway = class {
|
|
|
403
489
|
options;
|
|
404
490
|
logger = new Logger(RealtimeGateway.name);
|
|
405
491
|
server;
|
|
492
|
+
/** Identities the handshake middleware resolved, until `handleConnection` takes them. */
|
|
493
|
+
authenticated = /* @__PURE__ */ new WeakMap();
|
|
494
|
+
/** Authenticate before accept: a refusal is a `connect_error` with `data.code`; a failure is generic. */
|
|
495
|
+
authenticateHandshake = async (socket, next) => {
|
|
496
|
+
try {
|
|
497
|
+
const auth = await this.transport.authenticator().authenticate(this.buildAuthContext(socket));
|
|
498
|
+
if (!auth) {
|
|
499
|
+
const refusal = new Error(REALTIME_ERROR_CODES.AUTH_FAILED);
|
|
500
|
+
refusal.data = { code: REALTIME_ERROR_CODES.AUTH_FAILED };
|
|
501
|
+
next(refusal);
|
|
502
|
+
return;
|
|
503
|
+
}
|
|
504
|
+
const resolvedAuth = resolveAuthTenant(this.options, auth);
|
|
505
|
+
assertIdentityIsNotBlank(resolvedAuth);
|
|
506
|
+
this.authenticated.set(socket, resolvedAuth);
|
|
507
|
+
next();
|
|
508
|
+
} catch (err) {
|
|
509
|
+
this.logger.error(
|
|
510
|
+
`handshake refused for socket ${socket.id}: ${err instanceof Error ? err.message : String(err)}`
|
|
511
|
+
);
|
|
512
|
+
next(new Error("Internal Server Error"));
|
|
513
|
+
}
|
|
514
|
+
};
|
|
406
515
|
/** Wire the resolved Socket.IO server to the transport after gateway init. */
|
|
407
516
|
afterInit(server) {
|
|
517
|
+
server.use(this.authenticateHandshake);
|
|
408
518
|
this.transport.setServer(server);
|
|
519
|
+
if (!isRealtimeIoServer(server)) this.reportMissingAdapter();
|
|
409
520
|
this.logger.log("RealtimeGateway initialized");
|
|
410
521
|
}
|
|
522
|
+
/** Report a server that `RealtimeIoAdapter` did not create: its options are dropped. */
|
|
523
|
+
reportMissingAdapter() {
|
|
524
|
+
const configured = Object.keys(this.options.websocket ?? {});
|
|
525
|
+
this.logger.error(
|
|
526
|
+
"RealtimeIoAdapter is not the active WebSocket adapter, so the websocket options" + (configured.length > 0 ? ` (${configured.join(", ")})` : "") + " are ignored and the gateway CORS stays closed (origin: false): browsers on another origin cannot connect. Add app.useWebSocketAdapter(new RealtimeIoAdapter(app)) in main.ts, importing it from '@bymax-one/nest-realtime/websocket'."
|
|
527
|
+
);
|
|
528
|
+
}
|
|
411
529
|
/**
|
|
412
530
|
* Handle a new WebSocket connection.
|
|
413
531
|
*
|
|
@@ -460,13 +578,17 @@ var RealtimeGateway = class {
|
|
|
460
578
|
}
|
|
461
579
|
async handleConnection(socket) {
|
|
462
580
|
try {
|
|
463
|
-
|
|
464
|
-
|
|
465
|
-
|
|
466
|
-
|
|
581
|
+
let resolvedAuth = this.authenticated.get(socket);
|
|
582
|
+
this.authenticated.delete(socket);
|
|
583
|
+
if (!resolvedAuth) {
|
|
584
|
+
const auth = await this.transport.authenticator().authenticate(this.buildAuthContext(socket));
|
|
585
|
+
if (!auth) {
|
|
586
|
+
socket.disconnect(true);
|
|
587
|
+
return;
|
|
588
|
+
}
|
|
589
|
+
resolvedAuth = resolveAuthTenant(this.options, auth);
|
|
590
|
+
assertIdentityIsNotBlank(resolvedAuth);
|
|
467
591
|
}
|
|
468
|
-
const resolvedAuth = resolveAuthTenant(this.options, auth);
|
|
469
|
-
assertIdentityIsNotBlank(resolvedAuth);
|
|
470
592
|
await this.transport.registerSocket(socket, resolvedAuth);
|
|
471
593
|
if (this.options.websocket?.emitConnectionEvent !== false) {
|
|
472
594
|
socket.emit(RESERVED_EVENT_NAMES.CONNECTION_ESTABLISHED, {
|
|
@@ -480,7 +602,7 @@ var RealtimeGateway = class {
|
|
|
480
602
|
}
|
|
481
603
|
} catch (err) {
|
|
482
604
|
this.logger.error(
|
|
483
|
-
`handleConnection threw for socket ${socket.id} \u2014 disconnecting: ${err.message}`
|
|
605
|
+
`handleConnection threw for socket ${socket.id} \u2014 disconnecting: ${err instanceof Error ? err.message : String(err)}`
|
|
484
606
|
);
|
|
485
607
|
socket.disconnect(true);
|
|
486
608
|
}
|
|
@@ -630,76 +752,5 @@ BymaxRealtimeWebSocketModule = __decorateClass([
|
|
|
630
752
|
Global(),
|
|
631
753
|
Module({})
|
|
632
754
|
], BymaxRealtimeWebSocketModule);
|
|
633
|
-
var RealtimeIoAdapter = class _RealtimeIoAdapter extends IoAdapter {
|
|
634
|
-
adapterLogger = new Logger(_RealtimeIoAdapter.name);
|
|
635
|
-
options;
|
|
636
|
-
constructor(app) {
|
|
637
|
-
super(app);
|
|
638
|
-
this.options = app.get(REALTIME_OPTIONS_TOKEN);
|
|
639
|
-
}
|
|
640
|
-
/**
|
|
641
|
-
* Bind the gateway to `websocket.namespace` when configured.
|
|
642
|
-
*
|
|
643
|
-
* `@WebSocketGateway()` args are evaluated at class-decoration time — before
|
|
644
|
-
* the module options resolve — so the namespace cannot be declared there.
|
|
645
|
-
* Instead we build the root server via `super.create` (which routes through the
|
|
646
|
-
* overridden {@link createIOServer}, applying CORS/ping/Redis) and then return
|
|
647
|
-
* the requested namespace via `server.of(ns)`. The gateway's `@WebSocketServer()`
|
|
648
|
-
* and `WebSocketTransport` then operate on that `Namespace`. A `'/'` or unset
|
|
649
|
-
* namespace leaves the root server untouched.
|
|
650
|
-
*/
|
|
651
|
-
create(port, options) {
|
|
652
|
-
const server = super.create(port, options);
|
|
653
|
-
const ns = this.options.websocket?.namespace;
|
|
654
|
-
if (ns && ns !== "/" && typeof server.of === "function") {
|
|
655
|
-
return server.of(ns);
|
|
656
|
-
}
|
|
657
|
-
return server;
|
|
658
|
-
}
|
|
659
|
-
/**
|
|
660
|
-
* Create the Socket.IO server with merged WebSocket options.
|
|
661
|
-
*
|
|
662
|
-
* When `websocket.redisAdapter.pubClient` is set, installs the
|
|
663
|
-
* `@socket.io/redis-adapter` lazily (so the package stays an optional peer
|
|
664
|
-
* dep — its absence does not crash the lib).
|
|
665
|
-
*/
|
|
666
|
-
createIOServer(port, opts) {
|
|
667
|
-
const wsOpts = this.options.websocket ?? {};
|
|
668
|
-
const mergedOpts = {
|
|
669
|
-
...opts,
|
|
670
|
-
cors: wsOpts.cors ?? opts?.cors,
|
|
671
|
-
pingInterval: wsOpts.pingIntervalMs ?? 25e3,
|
|
672
|
-
pingTimeout: wsOpts.pingTimeoutMs ?? 2e4,
|
|
673
|
-
maxHttpBufferSize: wsOpts.maxHttpBufferSize ?? 1e6
|
|
674
|
-
};
|
|
675
|
-
const server = super.createIOServer(port, mergedOpts);
|
|
676
|
-
if (wsOpts.redisAdapter?.pubClient) {
|
|
677
|
-
this.installRedisAdapter(server, wsOpts.redisAdapter.pubClient);
|
|
678
|
-
}
|
|
679
|
-
return server;
|
|
680
|
-
}
|
|
681
|
-
/**
|
|
682
|
-
* Lazily load and install `@socket.io/redis-adapter`.
|
|
683
|
-
*
|
|
684
|
-
* Uses a dynamic `require` so the package stays optional — absent peers do
|
|
685
|
-
* not crash the lib. A load or install failure is logged and tolerated;
|
|
686
|
-
* the lib degrades gracefully to single-instance mode.
|
|
687
|
-
*/
|
|
688
|
-
installRedisAdapter(server, pubClient) {
|
|
689
|
-
try {
|
|
690
|
-
const { createAdapter } = __require("@socket.io/redis-adapter");
|
|
691
|
-
const pub = pubClient;
|
|
692
|
-
const sub = pub.duplicate();
|
|
693
|
-
server.adapter(createAdapter(pub, sub));
|
|
694
|
-
this.adapterLogger.log(
|
|
695
|
-
"Socket.IO Redis adapter registered \u2014 cross-instance WebSocket fan-out enabled"
|
|
696
|
-
);
|
|
697
|
-
} catch (err) {
|
|
698
|
-
this.adapterLogger.error(
|
|
699
|
-
`Failed to register @socket.io/redis-adapter: ${err.message}. Falling back to single-instance mode.`
|
|
700
|
-
);
|
|
701
|
-
}
|
|
702
|
-
}
|
|
703
|
-
};
|
|
704
755
|
|
|
705
756
|
export { BymaxRealtimeWebSocketModule, CompositeTransport, RealtimeGateway, RealtimeIoAdapter, WebSocketTransport };
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@bymax-one/nest-realtime",
|
|
3
|
-
"version": "1.2.
|
|
3
|
+
"version": "1.2.3",
|
|
4
4
|
"description": "Realtime backend → frontend communication for NestJS — dual-transport SSE (default) and WebSocket (opt-in) with a unified server-side API.",
|
|
5
5
|
"author": "Bymax One <support@bymax.one>",
|
|
6
6
|
"license": "MIT",
|