[flatbuffers] Improve Node imports (#1193)

- Add `node:` prefix to all built-in Node imports (replaces PR #1142). - Replace `uuid` package with built-in `crypto.randomUUID()`(replaces PR #1140). - Cosmetic changes in TS files: - Avoid unnecessary `const { createWorker } = mediasoup` in almost all tests. - Move all FBS related imports to the bottom. - Some formating fixes that bypassed our ESLint rules.
versatica · Oct 25, 2023 · 53dbfce · 53dbfce
1 parent b4c80d8
commit 53dbfce
Show file tree

Hide file tree

Showing 31 changed files with 118 additions and 166 deletions.
diff --git a/node/src/Channel.ts b/node/src/Channel.ts
@@ -1,5 +1,5 @@
-import * as os from 'os';
-import { Duplex } from 'stream';
+import * as os from 'node:os';
+import { Duplex } from 'node:stream';
 import * as flatbuffers from 'flatbuffers';
 import { Logger } from './Logger';
 import { EnhancedEventEmitter } from './EnhancedEventEmitter';
@@ -10,7 +10,8 @@ import { Message, Type as MessageType, Body as MessageBody } from './fbs/message
 import { Notification, Body as NotificationBody, Event } from './fbs/notification';
 import { Log } from './fbs/log';
 
-const littleEndian = os.endianness() == 'LE';
+const IS_LITTLE_ENDIAN = os.endianness() === 'LE';
+
 const logger = new Logger('Channel');
 
 type Sent =
@@ -110,7 +111,7 @@ export class Channel extends EnhancedEventEmitter
 				const dataView = new DataView(
 					this.#recvBuffer.buffer,
 					this.#recvBuffer.byteOffset + msgStart);
-				const msgLen = dataView.getUint32(0, littleEndian);
+				const msgLen = dataView.getUint32(0, IS_LITTLE_ENDIAN);
 
 				if (readLen < 4 + msgLen)
 				{

diff --git a/node/src/DataConsumer.ts b/node/src/DataConsumer.ts
@@ -4,12 +4,12 @@ import { Channel } from './Channel';
 import { TransportInternal } from './Transport';
 import { parseSctpStreamParameters, SctpStreamParameters } from './SctpParameters';
 import { AppData } from './types';
+import * as utils from './utils';
 import { Event, Notification } from './fbs/notification';
 import * as FbsTransport from './fbs/transport';
 import * as FbsRequest from './fbs/request';
 import * as FbsDataConsumer from './fbs/data-consumer';
 import * as FbsDataProducer from './fbs/data-producer';
-import * as utils from './utils';
 
 export type DataConsumerOptions<DataConsumerAppData extends AppData = AppData> =
 {

diff --git a/node/src/EnhancedEventEmitter.ts b/node/src/EnhancedEventEmitter.ts
@@ -1,4 +1,4 @@
-import { EventEmitter } from 'events';
+import { EventEmitter } from 'node:events';
 import { Logger } from './Logger';
 
 const logger = new Logger('EnhancedEventEmitter');

diff --git a/node/src/PipeTransport.ts b/node/src/PipeTransport.ts
@@ -1,4 +1,3 @@
-import { v4 as uuidv4 } from 'uuid';
 import * as flatbuffers from 'flatbuffers';
 import { Logger } from './Logger';
 import * as ortc from './ortc';
@@ -29,6 +28,7 @@ import {
 	SrtpParameters
 } from './SrtpParameters';
 import { AppData, Either } from './types';
+import { generateUUIDv4 } from './utils';
 import { MediaKind as FbsMediaKind } from './fbs/rtp-parameters/media-kind';
 import * as FbsRtpParameters from './fbs/rtp-parameters';
 import { Event, Notification } from './fbs/notification';
@@ -368,7 +368,7 @@ export class PipeTransport<PipeTransportAppData extends AppData = AppData>
 			}
 		);
 
-		const consumerId = uuidv4();
+		const consumerId = generateUUIDv4();
 
 		const consumeRequestOffset = createConsumeRequest({
 			builder : this.channel.bufferBuilder,

diff --git a/node/src/Router.ts b/node/src/Router.ts
@@ -1,4 +1,3 @@
-import { v4 as uuidv4 } from 'uuid';
 import { Logger } from './Logger';
 import { EnhancedEventEmitter } from './EnhancedEventEmitter';
 import * as ortc from './ortc';
@@ -22,9 +21,10 @@ import { RtpObserver } from './RtpObserver';
 import { ActiveSpeakerObserver, ActiveSpeakerObserverOptions } from './ActiveSpeakerObserver';
 import { AudioLevelObserver, AudioLevelObserverOptions } from './AudioLevelObserver';
 import { RtpCapabilities, RtpCodecCapability } from './RtpParameters';
+import { cryptoSuiteToFbs } from './SrtpParameters';
 import { NumSctpStreams } from './SctpParameters';
 import { AppData, Either } from './types';
-import { cryptoSuiteToFbs } from './SrtpParameters';
+import { generateUUIDv4 } from './utils';
 import * as FbsActiveSpeakerObserver from './fbs/active-speaker-observer';
 import * as FbsAudioLevelObserver from './fbs/audio-level-observer';
 import * as FbsRequest from './fbs/request';
@@ -507,7 +507,7 @@ export class Router<RouterAppData extends AppData = AppData>
 			}
 		}
 
-		const transportId = uuidv4();
+		const transportId = generateUUIDv4();
 
 		/* Build Request. */
 		let webRtcTransportListenServer:
@@ -689,7 +689,7 @@ export class Router<RouterAppData extends AppData = AppData>
 			};
 		}
 
-		const transportId = uuidv4();
+		const transportId = generateUUIDv4();
 
 		/* Build Request. */
 		const baseTransportOptions = new FbsTransport.OptionsT(
@@ -837,7 +837,7 @@ export class Router<RouterAppData extends AppData = AppData>
 			};
 		}
 
-		const transportId = uuidv4();
+		const transportId = generateUUIDv4();
 
 		/* Build Request. */
 		const baseTransportOptions = new FbsTransport.OptionsT(
@@ -946,7 +946,7 @@ export class Router<RouterAppData extends AppData = AppData>
 			throw new TypeError('if given, appData must be an object');
 		}
 
-		const transportId = uuidv4();
+		const transportId = generateUUIDv4();
 
 		/* Build Request. */
 		const baseTransportOptions = new FbsTransport.OptionsT(
@@ -1404,7 +1404,7 @@ export class Router<RouterAppData extends AppData = AppData>
 			throw new TypeError('if given, appData must be an object');
 		}
 
-		const rtpObserverId = uuidv4();
+		const rtpObserverId = generateUUIDv4();
 
 		/* Build Request. */
 		const activeRtpObserverOptions =
@@ -1482,7 +1482,7 @@ export class Router<RouterAppData extends AppData = AppData>
 			throw new TypeError('if given, appData must be an object');
 		}
 
-		const rtpObserverId = uuidv4();
+		const rtpObserverId = generateUUIDv4();
 
 		/* Build Request. */
 		const audioLevelObserverOptions =

diff --git a/node/src/RtpStream.ts b/node/src/RtpStream.ts
@@ -1,7 +1,8 @@
 import * as FbsRtpStream from './fbs/rtp-stream';
 import * as FbsRtpParameters from './fbs/rtp-parameters';
 
-export type RtpStreamRecvStats = BaseRtpStreamStats & {
+export type RtpStreamRecvStats = BaseRtpStreamStats &
+{
 	type: string;
 	jitter: number;
 	packetCount: number;
@@ -10,14 +11,16 @@ export type RtpStreamRecvStats = BaseRtpStreamStats & {
 	bitrateByLayer?: any;
 };
 
-export type RtpStreamSendStats = BaseRtpStreamStats & {
+export type RtpStreamSendStats = BaseRtpStreamStats &
+{
 	type: string;
 	packetCount: number;
 	byteCount: number;
 	bitrate: number;
 };
 
-type BaseRtpStreamStats = {
+type BaseRtpStreamStats =
+{
 	timestamp: number;
 	ssrc: number;
 	rtxSsrc?: number;
@@ -128,7 +131,7 @@ function parseBitrateByLayer(binary: FbsRtpStream.RecvStats): any
 
 	const bitRateByLayer: {[key: string]: number} = {};
 
-	for (let i=0; i < binary.bitrateByLayerLength(); ++i)
+	for (let i = 0; i < binary.bitrateByLayerLength(); ++i)
 	{
 		const layer: string = binary.bitrateByLayer(i)!.layer()!;
 		const bitrate = binary.bitrateByLayer(i)!.bitrate();

diff --git a/node/src/Transport.ts b/node/src/Transport.ts
@@ -1,8 +1,6 @@
-import { v4 as uuidv4 } from 'uuid';
 import * as flatbuffers from 'flatbuffers';
 import { Logger } from './Logger';
 import { EnhancedEventEmitter } from './EnhancedEventEmitter';
-import * as utils from './utils';
 import * as ortc from './ortc';
 import { Channel } from './Channel';
 import { RouterInternal } from './Router';
@@ -40,6 +38,7 @@ import {
 	SctpStreamParameters
 } from './SctpParameters';
 import { AppData } from './types';
+import * as utils from './utils';
 import { TraceDirection as FbsTraceDirection } from './fbs/common';
 import * as FbsRequest from './fbs/request';
 import { MediaKind as FbsMediaKind } from './fbs/rtp-parameters/media-kind';
@@ -251,7 +250,8 @@ type SctpListenerDump =
 	streamIdTable : {key: number; value: string}[];
 };
 
-type RecvRtpHeaderExtensions = {
+type RecvRtpHeaderExtensions =
+{
   mid?: number;
   rid?: number;
   rrid?: number;
@@ -736,11 +736,11 @@ export class Transport
 			{
 				this.#cnameForProducers = rtpParameters.rtcp.cname;
 			}
-			// Otherwise if we don't have yet a CNAME for Producers and the RTP parameters
-			// do not include CNAME, create a random one.
+			// Otherwise if we don't have yet a CNAME for Producers and the RTP
+			// parameters do not include CNAME, create a random one.
 			else if (!this.#cnameForProducers)
 			{
-				this.#cnameForProducers = uuidv4().substr(0, 8);
+				this.#cnameForProducers = utils.generateUUIDv4().substr(0, 8);
 			}
 
 			// Override Producer's CNAME.
@@ -758,7 +758,7 @@ export class Transport
 		const consumableRtpParameters = ortc.getConsumableRtpParameters(
 			kind, rtpParameters, routerRtpCapabilities, rtpMapping);
 
-		const producerId = id || uuidv4();
+		const producerId = id || utils.generateUUIDv4();
 		const requestOffset = createProduceRequest({
 			builder : this.channel.bufferBuilder,
 			producerId,
@@ -901,7 +901,7 @@ export class Transport
 			}
 		}
 
-		const consumerId = uuidv4();
+		const consumerId = utils.generateUUIDv4();
 		const requestOffset = createConsumeRequest({
 			builder : this.channel.bufferBuilder,
 			producer,
@@ -1015,7 +1015,7 @@ export class Transport
 			}
 		}
 
-		const dataProducerId = id || uuidv4();
+		const dataProducerId = id || utils.generateUUIDv4();
 		const requestOffset = createProduceDataRequest({
 			builder : this.channel.bufferBuilder,
 			dataProducerId,
@@ -1158,7 +1158,7 @@ export class Transport
 		}
 
 		const { label, protocol } = dataProducer;
-		const dataConsumerId = uuidv4();
+		const dataConsumerId = utils.generateUUIDv4();
 
 		const requestOffset = createConsumeDataRequest({
 			builder : this.channel.bufferBuilder,

diff --git a/node/src/Worker.ts b/node/src/Worker.ts
@@ -1,14 +1,14 @@
-import * as process from 'process';
-import * as path from 'path';
-import { spawn, ChildProcess } from 'child_process';
-import { v4 as uuidv4 } from 'uuid';
+import * as process from 'node:process';
+import * as path from 'node:path';
+import { spawn, ChildProcess } from 'node:child_process';
 import { Logger } from './Logger';
 import { EnhancedEventEmitter } from './EnhancedEventEmitter';
 import * as ortc from './ortc';
 import { Channel } from './Channel';
 import { Router, RouterOptions } from './Router';
 import { WebRtcServer, WebRtcServerOptions } from './WebRtcServer';
 import { AppData } from './types';
+import { generateUUIDv4 } from './utils';
 import { Event } from './fbs/notification';
 import * as FbsRequest from './fbs/request';
 import * as FbsWorker from './fbs/worker';
@@ -695,7 +695,7 @@ export class Worker<WorkerAppData extends AppData = AppData>
 			);
 		}
 
-		const webRtcServerId = uuidv4();
+		const webRtcServerId = generateUUIDv4();
 
 		const createWebRtcServerRequestOffset = new FbsWorker.CreateWebRtcServerRequestT(
 			webRtcServerId, fbsListenInfos
@@ -742,7 +742,7 @@ export class Worker<WorkerAppData extends AppData = AppData>
 		// This may throw.
 		const rtpCapabilities = ortc.generateRouterRtpCapabilities(mediaCodecs);
 
-		const routerId = uuidv4();
+		const routerId = generateUUIDv4();
 
 		// Get flatbuffer builder.
 		const createRouterRequestOffset =

diff --git a/node/src/index.ts b/node/src/index.ts
@@ -5,7 +5,6 @@ import * as utils from './utils';
 import { supportedRtpCapabilities } from './supportedRtpCapabilities';
 import { RtpCapabilities } from './RtpParameters';
 import * as types from './types';
-import { AppData } from './types';
 
 /**
  * Expose all types.
@@ -44,7 +43,7 @@ export { workerBin };
 /**
  * Create a Worker.
  */
-export async function createWorker<WorkerAppData extends AppData = AppData>(
+export async function createWorker<WorkerAppData extends types.AppData = types.AppData>(
 	{
 		logLevel = 'error',
 		logTags,

diff --git a/node/src/ortc.ts b/node/src/ortc.ts
@@ -1,7 +1,5 @@
 import * as h264 from 'h264-profile-level-id';
 import * as flatbuffers from 'flatbuffers';
-import * as utils from './utils';
-import { UnsupportedError } from './errors';
 import { supportedRtpCapabilities } from './supportedRtpCapabilities';
 import { parse as parseScalabilityMode } from './scalabilityModes';
 import {
@@ -22,6 +20,8 @@ import {
 	SctpParameters,
 	SctpStreamParameters
 } from './SctpParameters';
+import * as utils from './utils';
+import { UnsupportedError } from './errors';
 import * as FbsRtpParameters from './fbs/rtp-parameters';
 
 export type RtpMapping =

diff --git a/node/src/tests/test-ActiveSpeakerObserver.ts b/node/src/tests/test-ActiveSpeakerObserver.ts
@@ -1,7 +1,5 @@
 import * as mediasoup from '../';
 
-const { createWorker } = mediasoup;
-
 let worker: mediasoup.types.Worker;
 let router: mediasoup.types.Router;
 let activeSpeakerObserver: mediasoup.types.ActiveSpeakerObserver;
@@ -23,7 +21,7 @@ const mediaCodecs: mediasoup.types.RtpCodecCapability[] =
 
 beforeAll(async () =>
 {
-	worker = await createWorker();
+	worker = await mediasoup.createWorker();
 	router = await worker.createRouter({ mediaCodecs });
 });
 

diff --git a/node/src/tests/test-AudioLevelObserver.ts b/node/src/tests/test-AudioLevelObserver.ts
@@ -1,7 +1,5 @@
 import * as mediasoup from '../';
 
-const { createWorker } = mediasoup;
-
 let worker: mediasoup.types.Worker;
 let router: mediasoup.types.Router;
 let audioLevelObserver: mediasoup.types.AudioLevelObserver;
@@ -23,7 +21,7 @@ const mediaCodecs: mediasoup.types.RtpCodecCapability[] =
 
 beforeAll(async () =>
 {
-	worker = await createWorker();
+	worker = await mediasoup.createWorker();
 	router = await worker.createRouter({ mediaCodecs });
 });
 

diff --git a/node/src/tests/test-Consumer.ts b/node/src/tests/test-Consumer.ts
@@ -4,8 +4,6 @@ import { UnsupportedError } from '../errors';
 import { Notification, Body as NotificationBody, Event } from '../fbs/notification';
 import * as FbsConsumer from '../fbs/consumer';
 
-const { createWorker } = mediasoup;
-
 let worker: mediasoup.types.Worker;
 let router: mediasoup.types.Router;
 let transport1: mediasoup.types.WebRtcTransport;
@@ -247,7 +245,7 @@ const consumerDeviceCapabilities: mediasoup.types.RtpCapabilities =
 
 beforeAll(async () =>
 {
-	worker = await createWorker();
+	worker = await mediasoup.createWorker();
 	router = await worker.createRouter({ mediaCodecs });
 	transport1 = await router.createWebRtcTransport(
 		{

diff --git a/node/src/tests/test-DataConsumer.ts b/node/src/tests/test-DataConsumer.ts
@@ -1,7 +1,5 @@
 import * as mediasoup from '../';
 
-const { createWorker } = mediasoup;
-
 let worker: mediasoup.types.Worker;
 let router: mediasoup.types.Router;
 let transport1: mediasoup.types.WebRtcTransport;
@@ -25,7 +23,7 @@ const dataProducerParameters: mediasoup.types.DataProducerOptions =
 
 beforeAll(async () =>
 {
-	worker = await createWorker();
+	worker = await mediasoup.createWorker();
 	router = await worker.createRouter();
 	transport1 = await router.createWebRtcTransport(
 		{