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.

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

test(client): fix Signals test #22559

Merged
merged 1 commit into from
Sep 18, 2024
Merged

test(client): fix Signals test #22559

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
88 changes: 46 additions & 42 deletions packages/test/test-end-to-end-tests/src/test/localTestSignals.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ interface SignalClient {
containerRuntime: IContainerRuntimeBaseWithClientId;
signalReceivedCount: number;
clientId: string | undefined;
index: number;
}

const testContainerConfig: ITestContainerConfig = {
Expand Down Expand Up @@ -68,8 +69,8 @@ async function waitForSignal(...signallers: { once(e: "signal", l: () => void):

async function waitForTargetedSignal(
targetedSignaller: { once(e: "signal", l: () => void): void },
otherSignallers: { once(e: "signal", l: () => void): void }[],
): Promise<[void, ...string[]]> {
otherSignallers: { runtime: { once(e: "signal", l: () => void): void }; index: number }[],
): Promise<[void, ..."No Signal Received"[]]> {
return Promise.all([
timeoutPromise(({ resolve }) => targetedSignaller.once("signal", () => resolve()), {
durationMs: 2000,
Expand All @@ -78,12 +79,14 @@ async function waitForTargetedSignal(
...otherSignallers.map(async (signaller, index) =>
timeoutPromise(
({ reject }) =>
signaller.once("signal", () =>
reject(`Signaller[${index}] should not have received a signal`),
signaller.runtime.once("signal", () =>
reject(
new Error(`Signaller[${signaller.index}] should not have received a signal`),
),
),
{
durationMs: 100,
value: "No Signal Received",
value: "No Signal Received" as const,
reject: false,
},
),
Expand Down Expand Up @@ -276,28 +279,53 @@ describeCompat("Targeted Signals", "NoCompat", (getTestObjectProvider) => {
containerRuntime: dataObject.context.containerRuntime,
signalReceivedCount: 0,
clientId: container.clientId,
index: i,
});
}
});
async function sendAndVerifySignalToRemoteClient(runtime: RuntimeLayer) {

async function sendAndVerifySignalToTargetClient(
runtime: RuntimeLayer,
targetOffset: 0 | 1,
) {
const accumulatedFailures: unknown[] = [];
clients.forEach((client) => {
client[runtime].on("signal", (message: IInboundSignalMessage, local: boolean) => {
assert.equal(local, false, "Signal should be remote");
assertSignalProperties(message, client.clientId);
client.signalReceivedCount += 1;
// If there are any errors during signal processing, they will be raised later.
// Errors thrown during signal processing will cause a connection to close.
// More importantly an error will be reported via telemetry and that would
// just be noise compared to the test results.
try {
if (targetOffset === 0) {
assert.equal(local, true, "Signal should be local");
} else {
assert.equal(local, false, "Signal should be remote");
}
assertSignalProperties(message, client.clientId);
} catch (error) {
accumulatedFailures.push(error);
}
});
});

for (let i = 0; i < clients.length; i++) {
const targetClient = clients[(i + 1) % clients.length];
// Reset accumulated failures for each client iteration
accumulatedFailures.length = 0;
const targetClient = clients[(i + targetOffset) % clients.length];
clients[i][runtime].submitSignal(
"Test Signal Type",
"Test Signal Content",
targetClient.clientId,
);
const targetedSignalPromise = await waitForTargetedSignal(
targetClient[runtime],
clients.filter((c) => c !== targetClient).map((c) => c[runtime]),
clients
.filter((c) => c !== targetClient)
.map((c) => ({
runtime: c[runtime],
index: c.index,
})),
);

const [targetedSignalResult, ...otherResults] = targetedSignalPromise;
Expand All @@ -308,6 +336,10 @@ describeCompat("Targeted Signals", "NoCompat", (getTestObjectProvider) => {
"Non-targeted client should not receive signal",
);
});
// Raise any during signal processing errors now
for (const error of accumulatedFailures) {
throw error;
}
}

clients.forEach((client, index) => {
Expand All @@ -319,39 +351,11 @@ describeCompat("Targeted Signals", "NoCompat", (getTestObjectProvider) => {
});
}

async function sendAndVerifySignalToRemoteClient(runtime: RuntimeLayer) {
return sendAndVerifySignalToTargetClient(runtime, 1);
}
async function sendAndVerifySignalToSelf(runtime: RuntimeLayer) {
clients.forEach((client) => {
client[runtime].on("signal", (message: IInboundSignalMessage, local: boolean) => {
assert.equal(local, true, "Signal should be local");
assertSignalProperties(message, client.clientId);
client.signalReceivedCount += 1;
});
});

for (const client of clients) {
client[runtime].submitSignal("Test Signal Type", "Test Signal Content", client.clientId);
const targetedSignalPromise = await waitForTargetedSignal(
client[runtime],
clients.filter((c) => c !== client).map((c) => c[runtime]),
);

const [targetedSignalResult, ...otherResults] = targetedSignalPromise;
otherResults.forEach((result) => {
assert.equal(
result,
"No Signal Received",
"Non-targeted client should not receive signal",
);
});
}

clients.forEach((client, index) => {
assert.equal(
client.signalReceivedCount,
1,
`client ${index + 1} did not receive signal`,
);
});
return sendAndVerifySignalToTargetClient(runtime, 0);
}

function assertSignalProperties(
Expand Down
Loading