Skip to content
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.

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

Make Node tests independent (part 2) #1296

Merged
merged 2 commits into from
Jan 4, 2024
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
128 changes: 66 additions & 62 deletions node/src/test/test-Router.ts
Original file line number Diff line number Diff line change
@@ -1,55 +1,69 @@
import * as mediasoup from '../';
import { InvalidStateError } from '../errors';
import * as utils from '../utils';

let worker: mediasoup.types.Worker;
type TestContext =
{
worker?: mediasoup.types.Worker;
mediaCodecs: mediasoup.types.RtpCodecCapability[];
};

beforeEach(() => worker && !worker.closed && worker.close());
afterEach(() => worker && !worker.closed && worker.close());
const ctx: TestContext =
{
mediaCodecs : utils.deepFreeze(
[
{
kind : 'audio',
mimeType : 'audio/opus',
clockRate : 48000,
channels : 2,
parameters :
{
useinbandfec : 1,
foo : 'bar'
}
},
{
kind : 'video',
mimeType : 'video/VP8',
clockRate : 90000
},
{
kind : 'video',
mimeType : 'video/H264',
clockRate : 90000,
parameters :
{
'level-asymmetry-allowed' : 1,
'packetization-mode' : 1,
'profile-level-id' : '4d0032'
},
rtcpFeedback : [] // Will be ignored.
}
]
)
};

beforeEach(async () =>
{
ctx.worker = await mediasoup.createWorker();
});

const mediaCodecs: mediasoup.types.RtpCodecCapability[] =
[
{
kind : 'audio',
mimeType : 'audio/opus',
clockRate : 48000,
channels : 2,
parameters :
{
useinbandfec : 1,
foo : 'bar'
}
},
{
kind : 'video',
mimeType : 'video/VP8',
clockRate : 90000
},
{
kind : 'video',
mimeType : 'video/H264',
clockRate : 90000,
parameters :
{
'level-asymmetry-allowed' : 1,
'packetization-mode' : 1,
'profile-level-id' : '4d0032'
},
rtcpFeedback : [] // Will be ignored.
}
];
afterEach(() =>
{
ctx.worker?.close();
});

test('worker.createRouter() succeeds', async () =>
{
worker = await mediasoup.createWorker();

const onObserverNewRouter = jest.fn();

worker.observer.once('newrouter', onObserverNewRouter);
ctx.worker!.observer.once('newrouter', onObserverNewRouter);

const router = await worker.createRouter<{ foo: number; bar?: string }>(
const router = await ctx.worker!.createRouter<{ foo: number; bar?: string }>(
{
mediaCodecs,
appData : { foo: 123 }
mediaCodecs : ctx.mediaCodecs,
appData : { foo: 123 }
});

expect(onObserverNewRouter).toHaveBeenCalledTimes(1);
Expand All @@ -63,11 +77,11 @@ test('worker.createRouter() succeeds', async () =>

expect(() => (router.appData = { foo: 222, bar: 'BBB' })).not.toThrow();

await expect(worker.dump())
await expect(ctx.worker!.dump())
.resolves
.toMatchObject(
{
pid : worker.pid,
pid : ctx.worker!.pid,
webRtcServerIds : [],
routerIds : [ router.id ],
channelMessageHandlers :
Expand All @@ -92,49 +106,41 @@ test('worker.createRouter() succeeds', async () =>
});

// Private API.
expect(worker.routersForTesting.size).toBe(1);
expect(ctx.worker!.routersForTesting.size).toBe(1);

worker.close();
ctx.worker!.close();

expect(router.closed).toBe(true);

// Private API.
expect(worker.routersForTesting.size).toBe(0);
expect(ctx.worker!.routersForTesting.size).toBe(0);
}, 2000);

test('worker.createRouter() with wrong arguments rejects with TypeError', async () =>
{
worker = await mediasoup.createWorker();

// @ts-ignore
await expect(worker.createRouter({ mediaCodecs: {} }))
await expect(ctx.worker!.createRouter({ mediaCodecs: {} }))
.rejects
.toThrow(TypeError);

// @ts-ignore
await expect(worker.createRouter({ appData: 'NOT-AN-OBJECT' }))
await expect(ctx.worker!.createRouter({ appData: 'NOT-AN-OBJECT' }))
.rejects
.toThrow(TypeError);

worker.close();
}, 2000);

test('worker.createRouter() rejects with InvalidStateError if Worker is closed', async () =>
{
worker = await mediasoup.createWorker();

worker.close();
ctx.worker!.close();

await expect(worker.createRouter({ mediaCodecs }))
await expect(ctx.worker!.createRouter({ mediaCodecs: ctx.mediaCodecs }))
.rejects
.toThrow(InvalidStateError);
}, 2000);

test('router.close() succeeds', async () =>
{
worker = await mediasoup.createWorker();

const router = await worker.createRouter({ mediaCodecs });
const router = await ctx.worker!.createRouter({ mediaCodecs: ctx.mediaCodecs });
const onObserverClose = jest.fn();

router.observer.once('close', onObserverClose);
Expand All @@ -146,17 +152,15 @@ test('router.close() succeeds', async () =>

test('Router emits "workerclose" if Worker is closed', async () =>
{
worker = await mediasoup.createWorker();

const router = await worker.createRouter({ mediaCodecs });
const router = await ctx.worker!.createRouter({ mediaCodecs: ctx.mediaCodecs });
const onObserverClose = jest.fn();

router.observer.once('close', onObserverClose);

await new Promise<void>((resolve) =>
{
router.on('workerclose', resolve);
worker.close();
ctx.worker!.close();
});

expect(onObserverClose).toHaveBeenCalledTimes(1);
Expand Down
23 changes: 23 additions & 0 deletions node/src/utils.ts
Original file line number Diff line number Diff line change
Expand Up @@ -197,3 +197,26 @@ export function parseStringStringArrayVector(

return array;
}

/**
* Make an object or array recursively immutable.
* https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/freeze.
*/
export function deepFreeze<T>(object: T): T
{
// Retrieve the property names defined on object.
const propNames = Reflect.ownKeys(object as any);

// Freeze properties before freezing self.
for (const name of propNames)
{
const value = (object as any)[name];

if ((value && typeof value === 'object') || typeof value === 'function')
{
deepFreeze(value);
}
}

return Object.freeze(object);
}
Loading