appium-webdriveragent 17.0.7 → 17.0.9

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 CHANGED
@@ -3,6 +3,21 @@
3
3
  All notable changes to this project will be documented in this file.
4
4
  See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
5
5
 
6
+ ## [17.0.9](https://github.com/appium/appium-ios/compare/appium-webdriveragent@17.0.8...appium-webdriveragent@17.0.9) (2026-11-16)
7
+
8
+ **Note:** Version bump only for package appium-webdriveragent
9
+
10
+
11
+
12
+
13
+
14
+ ## [17.0.8](https://github.com/appium/appium-ios/compare/appium-webdriveragent@17.0.7...appium-webdriveragent@17.0.8) (2026-11-16)
15
+
16
+ ### Bug Fixes
17
+
18
+ * **webdriveragent:** clear screen recording state before attachment cleanup ([#115](https://github.com/appium/appium-ios/issues/115)) ([9caef7e](https://github.com/appium/appium-ios/commit/9caef7ee9a77541a785a5248576fd3266afae4a2))
19
+
20
+
6
21
  ## [17.0.7](https://github.com/appium/appium-ios/compare/appium-webdriveragent@17.0.6...appium-webdriveragent@17.0.7) (2026-11-16)
7
22
 
8
23
  ### Bug Fixes
@@ -69,10 +69,10 @@ const NSUInteger DEFAULT_CODEC = 0;
69
69
  NSDictionary *response = [FBScreenRecordingContainer.sharedInstance toDictionary];
70
70
  NSError *error;
71
71
  if (![FBXCTestDaemonsProxy stopScreenRecordingWithUUID:recordingId error:&error]) {
72
- [FBScreenRecordingContainer.sharedInstance reset];
72
+ [FBScreenRecordingContainer.sharedInstance resetIfPromiseIs:activeScreenRecording];
73
73
  return FBResponseWithUnknownError(error);
74
74
  }
75
- [FBScreenRecordingContainer.sharedInstance reset];
75
+ [FBScreenRecordingContainer.sharedInstance resetIfPromiseIs:activeScreenRecording];
76
76
  return FBResponseWithObject(response);
77
77
  }
78
78
 
@@ -15,11 +15,11 @@
15
15
  <key>CFBundlePackageType</key>
16
16
  <string>FMWK</string>
17
17
  <key>CFBundleShortVersionString</key>
18
- <string>17.0.7</string>
18
+ <string>17.0.9</string>
19
19
  <key>CFBundleSignature</key>
20
20
  <string>????</string>
21
21
  <key>CFBundleVersion</key>
22
- <string>17.0.7</string>
22
+ <string>17.0.9</string>
23
23
  <key>NSPrincipalClass</key>
24
24
  <string/>
25
25
  </dict>
@@ -9,19 +9,16 @@
9
9
 
10
10
  #import "FBScreenRecordingContainer.h"
11
11
 
12
+ #import "FBLogger.h"
12
13
  #import "FBScreenRecordingPromise.h"
13
14
 
14
- @interface FBScreenRecordingContainer ()
15
-
16
- @property (readwrite) NSUInteger fps;
17
- @property (readwrite) long long codec;
18
- @property (readwrite) FBScreenRecordingPromise* screenRecordingPromise;
19
- @property (readwrite) NSNumber *startedAt;
20
-
21
- @end
22
-
23
15
  @implementation FBScreenRecordingContainer
24
16
 
17
+ @synthesize fps = _fps;
18
+ @synthesize codec = _codec;
19
+ @synthesize screenRecordingPromise = _screenRecordingPromise;
20
+ @synthesize startedAt = _startedAt;
21
+
25
22
  + (instancetype)sharedInstance
26
23
  {
27
24
  static FBScreenRecordingContainer *instance;
@@ -32,57 +29,105 @@
32
29
  return instance;
33
30
  }
34
31
 
32
+ - (NSUInteger)fps
33
+ {
34
+ @synchronized (self) {
35
+ return _fps;
36
+ }
37
+ }
38
+
39
+ - (long long)codec
40
+ {
41
+ @synchronized (self) {
42
+ return _codec;
43
+ }
44
+ }
45
+
46
+ - (nullable FBScreenRecordingPromise *)screenRecordingPromise
47
+ {
48
+ @synchronized (self) {
49
+ return _screenRecordingPromise;
50
+ }
51
+ }
52
+
53
+ - (nullable NSNumber *)startedAt
54
+ {
55
+ @synchronized (self) {
56
+ return _startedAt;
57
+ }
58
+ }
59
+
35
60
  - (void)storeScreenRecordingPromise:(FBScreenRecordingPromise *)screenRecordingPromise
36
61
  fps:(NSUInteger)fps
37
62
  codec:(long long)codec;
38
63
  {
39
64
  @synchronized (self) {
40
- self.fps = fps;
41
- self.codec = codec;
42
- self.screenRecordingPromise = screenRecordingPromise;
43
- self.startedAt = @([NSDate.date timeIntervalSince1970]);
65
+ _fps = fps;
66
+ _codec = codec;
67
+ _screenRecordingPromise = screenRecordingPromise;
68
+ _startedAt = @([NSDate.date timeIntervalSince1970]);
44
69
  }
45
70
  }
46
71
 
47
- - (void)reset;
72
+ - (nullable FBScreenRecordingPromise *)detachScreenRecordingPromise
48
73
  {
49
74
  @synchronized (self) {
50
- self.fps = 0;
51
- self.codec = 0;
52
- if (nil != self.screenRecordingPromise) {
53
- [XCTContext runActivityNamed:@"Video Cleanup" block:^(id<XCTActivity> activity){
54
- [activity addAttachment:(XCTAttachment *)self.screenRecordingPromise.nativePromise];
55
- }];
56
- self.screenRecordingPromise = nil;
57
- }
58
- self.startedAt = nil;
75
+ FBScreenRecordingPromise *detachedPromise = _screenRecordingPromise;
76
+ _fps = 0;
77
+ _codec = 0;
78
+ _screenRecordingPromise = nil;
79
+ _startedAt = nil;
80
+ return detachedPromise;
81
+ }
82
+ }
83
+
84
+ - (void)cleanupDetachedPromise:(nullable FBScreenRecordingPromise *)promise
85
+ {
86
+ if (nil == promise) {
87
+ return;
88
+ }
89
+ @try {
90
+ [XCTContext runActivityNamed:@"Video Cleanup" block:^(id<XCTActivity> activity){
91
+ [activity addAttachment:(XCTAttachment *)promise.nativePromise];
92
+ }];
93
+ } @catch (NSException *exception) {
94
+ [FBLogger logFmt:@"Failed to clean up screen recording attachment: %@", exception.reason];
59
95
  }
60
96
  }
61
97
 
98
+ - (void)reset;
99
+ {
100
+ FBScreenRecordingPromise *detachedPromise = [self detachScreenRecordingPromise];
101
+ [self cleanupDetachedPromise:detachedPromise];
102
+ }
103
+
62
104
  - (BOOL)resetIfPromiseIs:(FBScreenRecordingPromise *)screenRecordingPromise
63
105
  {
64
- // @synchronized is recursive, so -reset may take the very same lock again below.
106
+ FBScreenRecordingPromise *detachedPromise = nil;
65
107
  @synchronized (self) {
66
- if (self.screenRecordingPromise != screenRecordingPromise) {
108
+ if (_screenRecordingPromise != screenRecordingPromise) {
67
109
  return NO;
68
110
  }
69
- [self reset];
70
- return YES;
111
+ detachedPromise = [self detachScreenRecordingPromise];
71
112
  }
113
+ [self cleanupDetachedPromise:detachedPromise];
114
+ return YES;
72
115
  }
73
116
 
74
117
  - (nullable NSDictionary *)toDictionary
75
118
  {
76
- if (nil == self.screenRecordingPromise) {
77
- return nil;
78
- }
119
+ @synchronized (self) {
120
+ if (nil == _screenRecordingPromise) {
121
+ return nil;
122
+ }
79
123
 
80
- return @{
81
- @"fps": @(self.fps),
82
- @"codec": @(self.codec),
83
- @"uuid": [self.screenRecordingPromise identifier].UUIDString ?: [NSNull null],
84
- @"startedAt": self.startedAt ?: [NSNull null],
85
- };
124
+ return @{
125
+ @"fps": @(_fps),
126
+ @"codec": @(_codec),
127
+ @"uuid": [_screenRecordingPromise identifier].UUIDString ?: [NSNull null],
128
+ @"startedAt": _startedAt ?: [NSNull null],
129
+ };
130
+ }
86
131
  }
87
132
 
88
133
  @end
@@ -12,6 +12,13 @@
12
12
  #import "FBMjpegServer.h"
13
13
  #import "FBTCPSocket.h"
14
14
 
15
+ // Upper bound for conditions that must come true; they return as soon as they do. It stays below the
16
+ // failure backoff, so a missing backoff is still caught.
17
+ static const NSTimeInterval FBMjpegTestWaitTimeout = 8.;
18
+
19
+ // CI is passed to the test runner as TEST_RUNNER_CI. Shared CI runners starve the loop's low-priority queue.
20
+ static NSString *const FBMjpegCIEnvKey = @"CI";
21
+
15
22
  typedef void (^FBFrameCompletion)(NSData * _Nullable, NSError * _Nullable);
16
23
 
17
24
  // Redeclared here, the implementations live in FBMjpegServer.m.
@@ -57,6 +64,7 @@ typedef void (^FBFrameCompletion)(NSData * _Nullable, NSError * _Nullable);
57
64
  @property (nonatomic, strong) NSData *frameData;
58
65
  @property (nonatomic, strong, nullable) NSError *requestError;
59
66
  @property (nonatomic, strong) NSMutableArray<id> *clients;
67
+ @property (nonatomic, assign) NSUInteger originalFramerate;
60
68
  @end
61
69
 
62
70
  @implementation FBMjpegServerTests
@@ -64,6 +72,17 @@ typedef void (^FBFrameCompletion)(NSData * _Nullable, NSError * _Nullable);
64
72
  - (void)setUp
65
73
  {
66
74
  [super setUp];
75
+ // These do not depend on the loop timing.
76
+ NSSet<NSString *> *deterministicTests = [NSSet setWithObjects:@"testDoesNotRequestFramesWithoutClients",
77
+ @"testDoesNotSendFrameThatWentStaleDuringScaling", nil];
78
+ XCTSkipIf(nil != NSProcessInfo.processInfo.environment[FBMjpegCIEnvKey]
79
+ && ![deterministicTests containsObject:NSStringFromSelector(self.invocation.selector)],
80
+ @"The streaming loop is starved on CI runners");
81
+ // A failed wait must not run on into requests that were never made.
82
+ self.continueAfterFailure = NO;
83
+ // A fast idle loop picks up a new client quickly even on a loaded runner.
84
+ self.originalFramerate = FBConfiguration.sharedInstance.mjpegServerFramerate;
85
+ FBConfiguration.sharedInstance.mjpegServerFramerate = 60;
67
86
  self.requests = [NSMutableArray array];
68
87
  self.requestsLock = [[NSLock alloc] init];
69
88
  self.clients = [NSMutableArray array];
@@ -79,8 +98,8 @@ typedef void (^FBFrameCompletion)(NSData * _Nullable, NSError * _Nullable);
79
98
  self.server.socket = self.socket;
80
99
  self.server.frameTimeout = 0.05;
81
100
  self.server.lateFrameLimit = 5;
82
- // The first failure waits 2 s, which is much more than any check below waits for.
83
- self.server.failureBackoffMin = 1.0;
101
+ // The first failure waits 10 s (the cap), which is more than any condition below waits for.
102
+ self.server.failureBackoffMin = 5.0;
84
103
  __weak typeof(self) weakSelf = self;
85
104
  self.server.frameRequest = ^BOOL(FBFrameCompletion completion, NSError **error) {
86
105
  typeof(self) strongSelf = weakSelf;
@@ -100,6 +119,7 @@ typedef void (^FBFrameCompletion)(NSData * _Nullable, NSError * _Nullable);
100
119
  - (void)tearDown
101
120
  {
102
121
  FBConfiguration.sharedInstance.currentDisplayId = nil;
122
+ FBConfiguration.sharedInstance.mjpegServerFramerate = self.originalFramerate;
103
123
  [self.server stopStreaming];
104
124
  [super tearDown];
105
125
  }
@@ -169,34 +189,34 @@ typedef void (^FBFrameCompletion)(NSData * _Nullable, NSError * _Nullable);
169
189
  - (void)testSendsAnsweredFrameAndRequestsNext
170
190
  {
171
191
  [self connectClient];
172
- XCTAssertTrue([self waitUntil:^BOOL { return self.requestsCount >= 1; } timeout:2]);
192
+ XCTAssertTrue([self waitUntil:^BOOL { return self.requestsCount >= 1; } timeout:FBMjpegTestWaitTimeout]);
173
193
  [self requestAtIndex:0](self.frameData, nil);
174
194
 
175
- XCTAssertTrue([self waitUntil:^BOOL { return self.socket.framesCount >= 1; } timeout:5]);
176
- XCTAssertTrue([self waitUntil:^BOOL { return self.requestsCount >= 2; } timeout:2],
195
+ XCTAssertTrue([self waitUntil:^BOOL { return self.socket.framesCount >= 1; } timeout:FBMjpegTestWaitTimeout]);
196
+ XCTAssertTrue([self waitUntil:^BOOL { return self.requestsCount >= 2; } timeout:FBMjpegTestWaitTimeout],
177
197
  @"The next frame must be requested after an answer within the timeout");
178
198
  }
179
199
 
180
200
  - (void)testLateFrameIsSentAfterTimeoutWithoutBackoff
181
201
  {
182
202
  [self connectClient];
183
- XCTAssertTrue([self waitUntil:^BOOL { return self.requestsCount >= 1; } timeout:2]);
203
+ XCTAssertTrue([self waitUntil:^BOOL { return self.requestsCount >= 1; } timeout:FBMjpegTestWaitTimeout]);
184
204
  // Several frame timeouts pass with no answer.
185
205
  [self waitFor:0.4];
186
206
  XCTAssertEqual(0, self.socket.framesCount);
187
207
 
188
208
  [self requestAtIndex:0](self.frameData, nil);
189
- XCTAssertTrue([self waitUntil:^BOOL { return self.socket.framesCount >= 1; } timeout:1],
209
+ XCTAssertTrue([self waitUntil:^BOOL { return self.socket.framesCount >= 1; } timeout:FBMjpegTestWaitTimeout],
190
210
  @"The late answer must go out as a frame");
191
- // A backoff would keep the next request away for 2 s.
192
- XCTAssertTrue([self waitUntil:^BOOL { return self.requestsCount >= 2; } timeout:1],
211
+ // A backoff would keep the next request away for 10 s.
212
+ XCTAssertTrue([self waitUntil:^BOOL { return self.requestsCount >= 2; } timeout:FBMjpegTestWaitTimeout],
193
213
  @"The loop must go on at once after the late frame");
194
214
  }
195
215
 
196
216
  - (void)testSendsNoOtherRequestWhileFrameIsUnanswered
197
217
  {
198
218
  [self connectClient];
199
- XCTAssertTrue([self waitUntil:^BOOL { return self.requestsCount >= 1; } timeout:2]);
219
+ XCTAssertTrue([self waitUntil:^BOOL { return self.requestsCount >= 1; } timeout:FBMjpegTestWaitTimeout]);
200
220
  [self waitFor:0.5];
201
221
  XCTAssertEqual(1, self.requestsCount);
202
222
  XCTAssertEqual(0, self.socket.framesCount);
@@ -206,7 +226,7 @@ typedef void (^FBFrameCompletion)(NSData * _Nullable, NSError * _Nullable);
206
226
  {
207
227
  self.server.lateFrameLimit = 0.2;
208
228
  [self connectClient];
209
- XCTAssertTrue([self waitUntil:^BOOL { return self.requestsCount >= 1; } timeout:2]);
229
+ XCTAssertTrue([self waitUntil:^BOOL { return self.requestsCount >= 1; } timeout:FBMjpegTestWaitTimeout]);
210
230
  [self waitFor:1.0];
211
231
  XCTAssertEqual(1, self.requestsCount, @"The failed frame must back off before the next request");
212
232
 
@@ -219,7 +239,7 @@ typedef void (^FBFrameCompletion)(NSData * _Nullable, NSError * _Nullable);
219
239
  - (void)testErrorAnswerBacksOff
220
240
  {
221
241
  [self connectClient];
222
- XCTAssertTrue([self waitUntil:^BOOL { return self.requestsCount >= 1; } timeout:2]);
242
+ XCTAssertTrue([self waitUntil:^BOOL { return self.requestsCount >= 1; } timeout:FBMjpegTestWaitTimeout]);
223
243
  NSError *error = [NSError errorWithDomain:@"test" code:1 userInfo:nil];
224
244
  [self requestAtIndex:0](nil, error);
225
245
  [self waitFor:1.0];
@@ -231,7 +251,7 @@ typedef void (^FBFrameCompletion)(NSData * _Nullable, NSError * _Nullable);
231
251
  {
232
252
  self.requestError = [NSError errorWithDomain:@"test" code:2 userInfo:nil];
233
253
  [self connectClient];
234
- XCTAssertTrue([self waitUntil:^BOOL { return self.requestsCount >= 1; } timeout:2]);
254
+ XCTAssertTrue([self waitUntil:^BOOL { return self.requestsCount >= 1; } timeout:FBMjpegTestWaitTimeout]);
235
255
  [self waitFor:1.0];
236
256
  XCTAssertEqual(1, self.requestsCount);
237
257
  XCTAssertEqual(0, self.socket.framesCount);
@@ -240,7 +260,7 @@ typedef void (^FBFrameCompletion)(NSData * _Nullable, NSError * _Nullable);
240
260
  - (void)testDropsPendingFrameWhenLastClientLeaves
241
261
  {
242
262
  nw_connection_t client = [self connectClient];
243
- XCTAssertTrue([self waitUntil:^BOOL { return self.requestsCount >= 1; } timeout:2]);
263
+ XCTAssertTrue([self waitUntil:^BOOL { return self.requestsCount >= 1; } timeout:FBMjpegTestWaitTimeout]);
244
264
  [self.server didClientDisconnect:client];
245
265
  // Let the loop notice that nobody listens.
246
266
  [self waitFor:0.4];
@@ -250,35 +270,35 @@ typedef void (^FBFrameCompletion)(NSData * _Nullable, NSError * _Nullable);
250
270
  XCTAssertEqual(0, self.socket.framesCount, @"A frame for a vanished audience must not be kept");
251
271
 
252
272
  [self connectClient];
253
- XCTAssertTrue([self waitUntil:^BOOL { return self.requestsCount >= 2; } timeout:2],
273
+ XCTAssertTrue([self waitUntil:^BOOL { return self.requestsCount >= 2; } timeout:FBMjpegTestWaitTimeout],
254
274
  @"A returning client gets a fresh request");
255
275
  [self requestAtIndex:1](self.frameData, nil);
256
- XCTAssertTrue([self waitUntil:^BOOL { return self.socket.framesCount >= 1; } timeout:5]);
276
+ XCTAssertTrue([self waitUntil:^BOOL { return self.socket.framesCount >= 1; } timeout:FBMjpegTestWaitTimeout]);
257
277
  }
258
278
 
259
279
  - (void)testDoesNotReuseFrameRequestedForPreviousListener
260
280
  {
261
281
  nw_connection_t first = [self connectClient];
262
- XCTAssertTrue([self waitUntil:^BOOL { return self.requestsCount >= 1; } timeout:2]);
282
+ XCTAssertTrue([self waitUntil:^BOOL { return self.requestsCount >= 1; } timeout:FBMjpegTestWaitTimeout]);
263
283
  // Swap the clients at once, before the loop sees that nobody listens.
264
284
  [self.server didClientDisconnect:first];
265
285
  [self connectClient];
266
- XCTAssertTrue([self waitUntil:^BOOL { return self.requestsCount >= 2; } timeout:2],
286
+ XCTAssertTrue([self waitUntil:^BOOL { return self.requestsCount >= 2; } timeout:FBMjpegTestWaitTimeout],
267
287
  @"The new client must not wait for a frame requested for the previous one");
268
288
 
269
289
  [self requestAtIndex:0](self.frameData, nil);
270
290
  [self waitFor:0.2];
271
291
  XCTAssertEqual(0, self.socket.framesCount);
272
292
  [self requestAtIndex:1](self.frameData, nil);
273
- XCTAssertTrue([self waitUntil:^BOOL { return self.socket.framesCount >= 1; } timeout:5]);
293
+ XCTAssertTrue([self waitUntil:^BOOL { return self.socket.framesCount >= 1; } timeout:FBMjpegTestWaitTimeout]);
274
294
  }
275
295
 
276
296
  - (void)testDoesNotReuseFrameRequestedForPreviousDisplay
277
297
  {
278
298
  [self connectClient];
279
- XCTAssertTrue([self waitUntil:^BOOL { return self.requestsCount >= 1; } timeout:2]);
299
+ XCTAssertTrue([self waitUntil:^BOOL { return self.requestsCount >= 1; } timeout:FBMjpegTestWaitTimeout]);
280
300
  FBConfiguration.sharedInstance.currentDisplayId = @1;
281
- XCTAssertTrue([self waitUntil:^BOOL { return self.requestsCount >= 2; } timeout:2],
301
+ XCTAssertTrue([self waitUntil:^BOOL { return self.requestsCount >= 2; } timeout:FBMjpegTestWaitTimeout],
282
302
  @"A display switch must request the frame again");
283
303
 
284
304
  [self requestAtIndex:0](self.frameData, nil);
@@ -289,7 +309,7 @@ typedef void (^FBFrameCompletion)(NSData * _Nullable, NSError * _Nullable);
289
309
  - (void)testDropsFrameAnsweredAfterListenerSwitchedWhileWaiting
290
310
  {
291
311
  nw_connection_t first = [self connectClient];
292
- XCTAssertTrue([self waitUntil:^BOOL { return self.requestsCount >= 1; } timeout:2]);
312
+ XCTAssertTrue([self waitUntil:^BOOL { return self.requestsCount >= 1; } timeout:FBMjpegTestWaitTimeout]);
293
313
  [self waitFor:0.2];
294
314
  // The frame is late now, so the next wait is a long one.
295
315
  self.server.frameTimeout = 2;
@@ -300,14 +320,14 @@ typedef void (^FBFrameCompletion)(NSData * _Nullable, NSError * _Nullable);
300
320
  [self requestAtIndex:0](self.frameData, nil);
301
321
  [self waitFor:0.3];
302
322
  XCTAssertEqual(0, self.socket.framesCount, @"The answer was requested for the previous listener");
303
- XCTAssertTrue([self waitUntil:^BOOL { return self.requestsCount >= 2; } timeout:2],
323
+ XCTAssertTrue([self waitUntil:^BOOL { return self.requestsCount >= 2; } timeout:FBMjpegTestWaitTimeout],
304
324
  @"Dropping the stale answer is not a failure, no backoff");
305
325
  }
306
326
 
307
327
  - (void)testDropsFrameAnsweredAfterDisplaySwitchedWhileWaiting
308
328
  {
309
329
  [self connectClient];
310
- XCTAssertTrue([self waitUntil:^BOOL { return self.requestsCount >= 1; } timeout:2]);
330
+ XCTAssertTrue([self waitUntil:^BOOL { return self.requestsCount >= 1; } timeout:FBMjpegTestWaitTimeout]);
311
331
  [self waitFor:0.2];
312
332
  self.server.frameTimeout = 2;
313
333
  [self waitFor:0.2];
@@ -316,7 +336,7 @@ typedef void (^FBFrameCompletion)(NSData * _Nullable, NSError * _Nullable);
316
336
  [self requestAtIndex:0](self.frameData, nil);
317
337
  [self waitFor:0.3];
318
338
  XCTAssertEqual(0, self.socket.framesCount, @"The answer was requested for the previous display");
319
- XCTAssertTrue([self waitUntil:^BOOL { return self.requestsCount >= 2; } timeout:2]);
339
+ XCTAssertTrue([self waitUntil:^BOOL { return self.requestsCount >= 2; } timeout:FBMjpegTestWaitTimeout]);
320
340
  }
321
341
 
322
342
  - (void)testDoesNotSendFrameThatWentStaleDuringScaling
@@ -336,7 +356,7 @@ typedef void (^FBFrameCompletion)(NSData * _Nullable, NSError * _Nullable);
336
356
  - (void)testEmptyAnswerBacksOff
337
357
  {
338
358
  [self connectClient];
339
- XCTAssertTrue([self waitUntil:^BOOL { return self.requestsCount >= 1; } timeout:2]);
359
+ XCTAssertTrue([self waitUntil:^BOOL { return self.requestsCount >= 1; } timeout:FBMjpegTestWaitTimeout]);
340
360
  [self requestAtIndex:0](nil, nil);
341
361
  [self waitFor:1.0];
342
362
  XCTAssertEqual(1, self.requestsCount);
@@ -346,7 +366,7 @@ typedef void (^FBFrameCompletion)(NSData * _Nullable, NSError * _Nullable);
346
366
  - (void)testStopsRequestingAfterStopStreaming
347
367
  {
348
368
  [self connectClient];
349
- XCTAssertTrue([self waitUntil:^BOOL { return self.requestsCount >= 1; } timeout:2]);
369
+ XCTAssertTrue([self waitUntil:^BOOL { return self.requestsCount >= 1; } timeout:FBMjpegTestWaitTimeout]);
350
370
  [self.server stopStreaming];
351
371
  [self requestAtIndex:0](self.frameData, nil);
352
372
  [self waitFor:0.3];
@@ -12,6 +12,8 @@
12
12
  #import "FBSession-Private.h"
13
13
  #import "FBExceptions.h"
14
14
  #import "FBConfiguration.h"
15
+ #import "FBScreenRecordingContainer.h"
16
+ #import "FBScreenRecordingPromise.h"
15
17
  #import "XCUIApplicationDouble.h"
16
18
 
17
19
  @interface FBSession (SystemApplicationTests)
@@ -70,6 +72,39 @@ static id (^FBSystemApplicationLookup)(void);
70
72
  }
71
73
  @end
72
74
 
75
+ @interface FBTestScreenRecordingPromise : FBScreenRecordingPromise
76
+ @property (nonatomic, strong) NSUUID *testIdentifier;
77
+ @property (nonatomic, copy, nullable) id (^onNativePromiseAccess)(void);
78
+ - (instancetype)initWithUUID:(NSUUID *)uuid
79
+ onNativePromiseAccess:(nullable id (^)(void))onNativePromiseAccess;
80
+ @end
81
+
82
+ @implementation FBTestScreenRecordingPromise
83
+ - (instancetype)initWithUUID:(NSUUID *)uuid
84
+ onNativePromiseAccess:(nullable id (^)(void))onNativePromiseAccess
85
+ {
86
+ XCTAttachment *attachment = [XCTAttachment attachmentWithString:@"video"];
87
+ if ((self = [super initWithNativePromise:attachment])) {
88
+ _testIdentifier = uuid;
89
+ _onNativePromiseAccess = [onNativePromiseAccess copy];
90
+ }
91
+ return self;
92
+ }
93
+
94
+ - (NSUUID *)identifier
95
+ {
96
+ return self.testIdentifier;
97
+ }
98
+
99
+ - (id)nativePromise
100
+ {
101
+ if (self.onNativePromiseAccess) {
102
+ return self.onNativePromiseAccess();
103
+ }
104
+ return [super nativePromise];
105
+ }
106
+ @end
107
+
73
108
  @interface FBSessionTests : XCTestCase
74
109
  @property (nonatomic, strong) FBSession *session;
75
110
  @property (nonatomic, strong) XCUIApplication *testedApplication;
@@ -93,6 +128,7 @@ static id (^FBSystemApplicationLookup)(void);
93
128
  ((FBAUTLaunchSession *)self.session).launchApplication.duringLaunch = nil;
94
129
  }
95
130
  FBSystemApplicationLookup = nil;
131
+ [FBScreenRecordingContainer.sharedInstance reset];
96
132
  [self.session kill];
97
133
  FBConfiguration.sharedInstance.shouldTerminateApp = self.shouldTerminateAppValue;
98
134
  [super tearDown];
@@ -265,4 +301,103 @@ static id (^FBSystemApplicationLookup)(void);
265
301
  }
266
302
  }
267
303
 
304
+ - (void)testScreenRecordingContainerResetClearsStateWhenCleanupThrows
305
+ {
306
+ FBScreenRecordingContainer *container = FBScreenRecordingContainer.sharedInstance;
307
+ FBTestScreenRecordingPromise *promise = [[FBTestScreenRecordingPromise alloc] initWithUUID:NSUUID.UUID
308
+ onNativePromiseAccess:^id{
309
+ @throw [NSException exceptionWithName:@"CleanupFailure" reason:@"Simulated attachment failure" userInfo:nil];
310
+ }];
311
+ [container storeScreenRecordingPromise:promise fps:24 codec:0];
312
+
313
+ XCTAssertNoThrow([container reset]);
314
+ XCTAssertNil(container.screenRecordingPromise);
315
+ XCTAssertNil(container.startedAt);
316
+ XCTAssertEqual(container.fps, 0U);
317
+ XCTAssertEqual(container.codec, 0LL);
318
+ XCTAssertNil([container toDictionary]);
319
+ }
320
+
321
+ - (void)testScreenRecordingContainerStateIsClearedDuringCleanup
322
+ {
323
+ FBScreenRecordingContainer *container = FBScreenRecordingContainer.sharedInstance;
324
+ __block FBScreenRecordingPromise *promiseDuringCleanup = nil;
325
+ __block NSNumber *startedAtDuringCleanup = nil;
326
+ __block NSDictionary *dictionaryDuringCleanup = nil;
327
+ XCTAttachment *attachment = [XCTAttachment attachmentWithString:@"video"];
328
+ FBTestScreenRecordingPromise *promise = [[FBTestScreenRecordingPromise alloc] initWithUUID:NSUUID.UUID
329
+ onNativePromiseAccess:^id{
330
+ promiseDuringCleanup = container.screenRecordingPromise;
331
+ startedAtDuringCleanup = container.startedAt;
332
+ dictionaryDuringCleanup = [container toDictionary];
333
+ return attachment;
334
+ }];
335
+ [container storeScreenRecordingPromise:promise fps:24 codec:1];
336
+
337
+ [container reset];
338
+ XCTAssertNil(promiseDuringCleanup);
339
+ XCTAssertNil(startedAtDuringCleanup);
340
+ XCTAssertNil(dictionaryDuringCleanup);
341
+ }
342
+
343
+ - (void)testScreenRecordingContainerResetAllowsConcurrentReplacementDuringCleanup
344
+ {
345
+ FBScreenRecordingContainer *container = FBScreenRecordingContainer.sharedInstance;
346
+ FBTestScreenRecordingPromise *replacement = [[FBTestScreenRecordingPromise alloc] initWithUUID:NSUUID.UUID
347
+ onNativePromiseAccess:nil];
348
+ XCTAttachment *attachment = [XCTAttachment attachmentWithString:@"video"];
349
+ FBTestScreenRecordingPromise *initial = [[FBTestScreenRecordingPromise alloc] initWithUUID:NSUUID.UUID
350
+ onNativePromiseAccess:^id{
351
+ XCTestExpectation *replacementStored = [self expectationWithDescription:@"Replacement stored during cleanup"];
352
+ dispatch_async(dispatch_get_global_queue(QOS_CLASS_USER_INITIATED, 0), ^{
353
+ [container storeScreenRecordingPromise:replacement fps:60 codec:1];
354
+ [replacementStored fulfill];
355
+ });
356
+ [self waitForExpectationsWithTimeout:2. handler:nil];
357
+ return attachment;
358
+ }];
359
+ [container storeScreenRecordingPromise:initial fps:24 codec:0];
360
+
361
+ XCTAssertTrue([container resetIfPromiseIs:initial]);
362
+ XCTAssertEqual(container.screenRecordingPromise, replacement);
363
+ XCTAssertEqual(container.fps, 60U);
364
+ XCTAssertEqual(container.codec, 1LL);
365
+ XCTAssertEqualObjects([container toDictionary][@"uuid"], replacement.identifier.UUIDString);
366
+ }
367
+
368
+ - (void)testScreenRecordingContainerStaleResetPreservesActiveRecording
369
+ {
370
+ FBScreenRecordingContainer *container = FBScreenRecordingContainer.sharedInstance;
371
+ __block BOOL didRunCleanup = NO;
372
+ XCTAttachment *attachment = [XCTAttachment attachmentWithString:@"video"];
373
+ FBTestScreenRecordingPromise *active = [[FBTestScreenRecordingPromise alloc] initWithUUID:NSUUID.UUID
374
+ onNativePromiseAccess:^id{
375
+ didRunCleanup = YES;
376
+ return attachment;
377
+ }];
378
+ FBTestScreenRecordingPromise *stale = [[FBTestScreenRecordingPromise alloc] initWithUUID:NSUUID.UUID
379
+ onNativePromiseAccess:nil];
380
+ [container storeScreenRecordingPromise:active fps:30 codec:1];
381
+
382
+ XCTAssertFalse([container resetIfPromiseIs:stale]);
383
+ XCTAssertFalse(didRunCleanup);
384
+ XCTAssertEqual(container.screenRecordingPromise, active);
385
+ XCTAssertEqual(container.fps, 30U);
386
+ XCTAssertEqual(container.codec, 1LL);
387
+ }
388
+
389
+ - (void)testScreenRecordingContainerResetOnEmptyContainer
390
+ {
391
+ FBScreenRecordingContainer *container = FBScreenRecordingContainer.sharedInstance;
392
+ [container reset];
393
+ FBTestScreenRecordingPromise *stale = [[FBTestScreenRecordingPromise alloc] initWithUUID:NSUUID.UUID
394
+ onNativePromiseAccess:nil];
395
+
396
+ XCTAssertNil([container toDictionary]);
397
+ XCTAssertNoThrow([container reset]);
398
+ XCTAssertFalse([container resetIfPromiseIs:stale]);
399
+ XCTAssertNil(container.screenRecordingPromise);
400
+ XCTAssertNil(container.startedAt);
401
+ }
402
+
268
403
  @end
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "appium-webdriveragent",
3
- "version": "17.0.7",
3
+ "version": "17.0.9",
4
4
  "description": "Package bundling WebDriverAgent",
5
5
  "keywords": [
6
6
  "Appium",
@@ -83,5 +83,5 @@
83
83
  "node": "^22.22.2 || ^24.15.0 || >=26.0.0",
84
84
  "npm": ">=10"
85
85
  },
86
- "gitHead": "d7d177f55102776f22794034ff7337b9213610dd"
86
+ "gitHead": "d8daebd03095d25df6ea64e7ab409e4e6b0705ab"
87
87
  }