Skip to content

Commit 6437af4

Browse files
avoitenko-logitechavoitenko-logitech
committed
Stabilize OBS retries with retry-aware cleanup and signal filtering
1 parent 67a7d7f commit 6437af4

6 files changed

Lines changed: 176 additions & 84 deletions

File tree

‎tests/osn-tests/src/test_nodeobs_api.ts‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,23 @@ import { showHideInputHotkeys, slideshowHotkeys, ffmpeg_sourceHotkeys,
99

1010
const testName = 'nodeobs_api';
1111

12+
function failOnceInCi(context: any, label: string) {
13+
const isCi = process.env.GITHUB_ACTIONS === 'true' || process.env.CI === 'true';
14+
if (!isCi) {
15+
return;
16+
}
17+
18+
const test = context && (context.test || context.currentTest);
19+
const retryCount = test && typeof test.currentRetry === 'function'
20+
? test.currentRetry()
21+
: 0;
22+
23+
// Intentionally fail the first CI attempt so retry reporting can be tested.
24+
if (retryCount === 0) {
25+
throw new Error(`Intentional flaky failure for CI validation: ${label}`);
26+
}
27+
}
28+
1229
describe(testName, function() {
1330
let obs: OBSHandler;
1431
let hasTestFailed: boolean = false;
@@ -42,6 +59,8 @@ describe(testName, function() {
4259
});
4360

4461
it('Get performance statistics', function() {
62+
failOnceInCi(this, 'Get performance statistics');
63+
4564
let stats: IPerformanceState;
4665

4766
// Getting performance statistics
@@ -155,6 +174,8 @@ describe(testName, function() {
155174
});
156175

157176
it('Get and set the browser source acceleration', function() {
177+
failOnceInCi(this, 'Get and set the browser source acceleration');
178+
158179
expect(osn.NodeObs.GetBrowserAcceleration()).
159180
to.equal(true, 'Invalid browser source acceleration default value');
160181
osn.NodeObs.SetBrowserAcceleration(false);
@@ -163,6 +184,8 @@ describe(testName, function() {
163184
});
164185

165186
it('Get and set media file caching', function() {
187+
failOnceInCi(this, 'Get and set media file caching');
188+
166189
expect(osn.NodeObs.GetMediaFileCaching()).
167190
to.equal(true, 'Invalid media file caching default value');
168191
osn.NodeObs.SetMediaFileCaching(false);

‎tests/osn-tests/src/test_nodeobs_service.ts‎

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -988,20 +988,22 @@ describe(testName, function() {
988988

989989
let signalInfo: IOBSOutputSignalInfo;
990990

991-
obs.setStreamKey('invalid');
991+
try {
992+
obs.setStreamKey('invalid');
992993

993-
osn.NodeObs.OBS_service_startStreaming();
994+
osn.NodeObs.OBS_service_startStreaming();
994995

995-
signalInfo = await obs.getNextSignalInfo(EOBSOutputType.Streaming, EOBSOutputSignal.Starting);
996-
expect(signalInfo.type).to.equal(EOBSOutputType.Streaming, GetErrorMessage(ETestErrorMsg.StreamOutput));
997-
expect(signalInfo.signal).to.equal(EOBSOutputSignal.Starting, GetErrorMessage(ETestErrorMsg.StreamOutput));
996+
signalInfo = await obs.getNextSignalInfo(EOBSOutputType.Streaming, EOBSOutputSignal.Starting);
997+
expect(signalInfo.type).to.equal(EOBSOutputType.Streaming, GetErrorMessage(ETestErrorMsg.StreamOutput));
998+
expect(signalInfo.signal).to.equal(EOBSOutputSignal.Starting, GetErrorMessage(ETestErrorMsg.StreamOutput));
998999

999-
signalInfo = await obs.getNextSignalInfo(EOBSOutputType.Streaming, EOBSOutputSignal.Stop);
1000-
expect(signalInfo.type).to.equal(EOBSOutputType.Streaming, GetErrorMessage(ETestErrorMsg.StreamOutput));
1001-
expect(signalInfo.signal).to.equal(EOBSOutputSignal.Stop, GetErrorMessage(ETestErrorMsg.StreamOutput));
1002-
expect(signalInfo.code).to.equal(-3, GetErrorMessage(ETestErrorMsg.StreamOutput));
1003-
1004-
obs.setStreamKey(obs.userStreamKey);
1000+
signalInfo = await obs.getNextSignalInfo(EOBSOutputType.Streaming, EOBSOutputSignal.Stop);
1001+
expect(signalInfo.type).to.equal(EOBSOutputType.Streaming, GetErrorMessage(ETestErrorMsg.StreamOutput));
1002+
expect(signalInfo.signal).to.equal(EOBSOutputSignal.Stop, GetErrorMessage(ETestErrorMsg.StreamOutput));
1003+
expect(signalInfo.code).to.equal(-3, GetErrorMessage(ETestErrorMsg.StreamOutput));
1004+
} finally {
1005+
obs.setStreamKey(obs.userStreamKey);
1006+
}
10051007
});
10061008

10071009
it('Reset video context', function() {

‎tests/osn-tests/src/test_osn_advanced_streaming.ts‎

Lines changed: 22 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -268,27 +268,28 @@ describe(testName, () => {
268268
osn.AudioTrackFactory.setAtIndex(track1, 1);
269269
stream.signalHandler = (signal) => {obs.signals.push(signal)};
270270

271-
stream.start();
272-
273-
let signalInfo = await obs.getNextSignalInfo(
274-
EOBSOutputType.Streaming, EOBSOutputSignal.Starting);
275-
expect(signalInfo.type).to.equal(
276-
EOBSOutputType.Streaming, GetErrorMessage(ETestErrorMsg.StreamOutput));
277-
expect(signalInfo.signal).to.equal(
278-
EOBSOutputSignal.Starting, GetErrorMessage(ETestErrorMsg.StreamOutput));
279-
280-
signalInfo = await obs.getNextSignalInfo(
281-
EOBSOutputType.Streaming, EOBSOutputSignal.Stop);
282-
expect(signalInfo.type).to.equal(
283-
EOBSOutputType.Streaming, GetErrorMessage(ETestErrorMsg.StreamOutput));
284-
expect(signalInfo.signal).to.equal(
285-
EOBSOutputSignal.Stop, GetErrorMessage(ETestErrorMsg.StreamOutput));
286-
expect(signalInfo.code).to.equal(-3, GetErrorMessage(ETestErrorMsg.StreamOutput));
287-
288-
stream.service.update({ key: obs.userStreamKey });
289-
290271
const streamingEncoder = stream.videoEncoder;
291-
osn.AdvancedStreamingFactory.destroy(stream);
292-
streamingEncoder.release();
272+
try {
273+
stream.start();
274+
275+
let signalInfo = await obs.getNextSignalInfo(
276+
EOBSOutputType.Streaming, EOBSOutputSignal.Starting);
277+
expect(signalInfo.type).to.equal(
278+
EOBSOutputType.Streaming, GetErrorMessage(ETestErrorMsg.StreamOutput));
279+
expect(signalInfo.signal).to.equal(
280+
EOBSOutputSignal.Starting, GetErrorMessage(ETestErrorMsg.StreamOutput));
281+
282+
signalInfo = await obs.getNextSignalInfo(
283+
EOBSOutputType.Streaming, EOBSOutputSignal.Stop);
284+
expect(signalInfo.type).to.equal(
285+
EOBSOutputType.Streaming, GetErrorMessage(ETestErrorMsg.StreamOutput));
286+
expect(signalInfo.signal).to.equal(
287+
EOBSOutputSignal.Stop, GetErrorMessage(ETestErrorMsg.StreamOutput));
288+
expect(signalInfo.code).to.equal(-3, GetErrorMessage(ETestErrorMsg.StreamOutput));
289+
} finally {
290+
stream.service.update({ key: obs.userStreamKey });
291+
osn.AdvancedStreamingFactory.destroy(stream);
292+
streamingEncoder.release();
293+
}
293294
});
294295
});

‎tests/osn-tests/src/test_osn_simple_streaming.ts‎

Lines changed: 23 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -266,29 +266,30 @@ describe(testName, () => {
266266
stream.audioEncoder = osn.AudioEncoderFactory.create("ffmpeg_aac", "audio-encoder-simple-streaming-5");
267267
stream.signalHandler = (signal) => {obs.signals.push(signal)};
268268

269-
stream.start();
270-
271-
let signalInfo = await obs.getNextSignalInfo(
272-
EOBSOutputType.Streaming, EOBSOutputSignal.Starting);
273-
expect(signalInfo.type).to.equal(
274-
EOBSOutputType.Streaming, GetErrorMessage(ETestErrorMsg.StreamOutput));
275-
expect(signalInfo.signal).to.equal(
276-
EOBSOutputSignal.Starting, GetErrorMessage(ETestErrorMsg.StreamOutput));
277-
278-
signalInfo = await obs.getNextSignalInfo(
279-
EOBSOutputType.Streaming, EOBSOutputSignal.Stop);
280-
expect(signalInfo.type).to.equal(
281-
EOBSOutputType.Streaming, GetErrorMessage(ETestErrorMsg.StreamOutput));
282-
expect(signalInfo.signal).to.equal(
283-
EOBSOutputSignal.Stop, GetErrorMessage(ETestErrorMsg.StreamOutput));
284-
expect(signalInfo.code).to.equal(-3, GetErrorMessage(ETestErrorMsg.StreamOutput));
285-
286-
stream.service.update({ key: obs.userStreamKey });
287-
288269
const videoEncoder = stream.videoEncoder;
289270
const audioEncoder = stream.audioEncoder;
290-
osn.SimpleStreamingFactory.destroy(stream);
291-
videoEncoder.release();
292-
audioEncoder.release();
271+
try {
272+
stream.start();
273+
274+
let signalInfo = await obs.getNextSignalInfo(
275+
EOBSOutputType.Streaming, EOBSOutputSignal.Starting);
276+
expect(signalInfo.type).to.equal(
277+
EOBSOutputType.Streaming, GetErrorMessage(ETestErrorMsg.StreamOutput));
278+
expect(signalInfo.signal).to.equal(
279+
EOBSOutputSignal.Starting, GetErrorMessage(ETestErrorMsg.StreamOutput));
280+
281+
signalInfo = await obs.getNextSignalInfo(
282+
EOBSOutputType.Streaming, EOBSOutputSignal.Stop);
283+
expect(signalInfo.type).to.equal(
284+
EOBSOutputType.Streaming, GetErrorMessage(ETestErrorMsg.StreamOutput));
285+
expect(signalInfo.signal).to.equal(
286+
EOBSOutputSignal.Stop, GetErrorMessage(ETestErrorMsg.StreamOutput));
287+
expect(signalInfo.code).to.equal(-3, GetErrorMessage(ETestErrorMsg.StreamOutput));
288+
} finally {
289+
stream.service.update({ key: obs.userStreamKey });
290+
osn.SimpleStreamingFactory.destroy(stream);
291+
videoEncoder.release();
292+
audioEncoder.release();
293+
}
293294
});
294295
});

‎tests/osn-tests/util/list-reporter.js‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
var fs = require('fs');
22
var path = require('path');
33
var mocha = require('mocha');
4+
var retryContext = require('./retry_context');
45

56
function ListReporter(runner) {
67
mocha.reporters.Base.call(this, runner);
@@ -48,6 +49,7 @@ function ListReporter(runner) {
4849

4950
runner.on('retry', function(test, err) {
5051
retries++;
52+
retryContext.setRetryFailure(test, err);
5153

5254
var currentRetry = getRetryCount(test);
5355
var maxRetries = getMaxRetries(test);
@@ -67,6 +69,7 @@ function ListReporter(runner) {
6769

6870
runner.on('pass', function(test) {
6971
passes++;
72+
retryContext.clearRetryFailure(test);
7073

7174
if (getRetryCount(test) > 0) {
7275
flakyTestCases.push({
@@ -86,6 +89,7 @@ function ListReporter(runner) {
8689

8790
runner.on('fail', function(test, err) {
8891
failures++;
92+
retryContext.clearRetryFailure(test);
8993

9094
// Getting test line with the expect check that failed
9195
testLine = getTestLineFromError(err);

0 commit comments

Comments
 (0)