appium-webdriveragent 9.0.5 → 9.0.6

package/CHANGELOG.md

@@ -1,3 +1,9 @@
+## [9.0.6](https://github.com/appium/WebDriverAgent/compare/v9.0.5...v9.0.6) (2025-02-28)
+
+### Bug Fixes
+
+* optimize LRU cache ([#985](https://github.com/appium/WebDriverAgent/issues/985)) ([46dc417](https://github.com/appium/WebDriverAgent/commit/46dc417da9f4a843838b414c0b154d6f478dbc0b))
+
 ## [9.0.5](https://github.com/appium/WebDriverAgent/compare/v9.0.4...v9.0.5) (2025-02-26)
 
 ### Bug Fixes

package/WebDriverAgentLib/Info.plist

@@ -15,11 +15,11 @@
     <key>CFBundlePackageType</key>
     <string>FMWK</string>
     <key>CFBundleShortVersionString</key>
-    <string>9.0.5</string>
+    <string>9.0.6</string>
     <key>CFBundleSignature</key>
     <string>????</string>
     <key>CFBundleVersion</key>
-    <string>9.0.5</string>
+    <string>9.0.6</string>
     <key>NSPrincipalClass</key>
     <string/>
   </dict>

package/WebDriverAgentLib/Routing/FBElementCache.m

@@ -73,7 +73,17 @@ const int ELEMENT_CACHE_SIZE = 1024;
     @throw [NSException exceptionWithName:FBStaleElementException reason:reason userInfo:@{}];
   }
   if (checkStaleness) {
-    [element fb_takeSnapshot:NO];
+    @try {
+      [element fb_takeSnapshot:NO];
+    } @catch (NSException *exception) {
+      //  if the snapshot method threw FBStaleElementException (implying the element is stale) we need to explicitly remove it from the cache, PR: https://github.com/appium/WebDriverAgent/pull/985
+      if ([exception.name isEqualToString:FBStaleElementException]) {
+        @synchronized (self.elementCache) {
+          [self.elementCache removeObjectForKey:uuid];
+        }
+      }
+      @throw exception;
+    }
   }
   return element;
 }

package/WebDriverAgentLib/Utilities/LRUCache/LRUCache.h

@@ -54,6 +54,13 @@ NS_ASSUME_NONNULL_BEGIN
  */
 - (NSArray *)allObjects;
 
+/**
+ Removes the object associated with the specified key from the cache.
+
+ @param key The key identifying the object to remove.
+ */
+- (void)removeObjectForKey:(id<NSCopying>)key;
+
 @end
 
 NS_ASSUME_NONNULL_END

package/WebDriverAgentLib/Utilities/LRUCache/LRUCache.m

@@ -135,4 +135,12 @@
   }
 }
 
+- (void)removeObjectForKey:(id<NSCopying>)key
+{
+  LRUCacheNode *node = self.store[key];
+  if (node != nil) {
+    [self removeNode:node];
+  }
+}
+
 @end

package/WebDriverAgentTests/UnitTests/FBLRUCacheTests.m

@@ -96,4 +96,33 @@
   XCTAssertEqualObjects(@[@(count)], cache.allObjects);
 }
 
+- (void)testRemoveExistingObjectForKey {
+    LRUCache *cache = [[LRUCache alloc] initWithCapacity:3];
+    [cache setObject:@"foo" forKey:@"bar"];
+    [cache setObject:@"foo2" forKey:@"bar2"];
+    [cache setObject:@"foo3" forKey:@"bar3"];
+    [self assertArray:@[@"foo3", @"foo2", @"foo"] equalsTo:cache.allObjects];
+    [cache removeObjectForKey:@"bar2"];
+    XCTAssertNil([cache objectForKey:@"bar2"]);
+    [self assertArray:@[@"foo3", @"foo"] equalsTo:cache.allObjects];
+}
+
+- (void)testRemoveNonExistingObjectForKey {
+    LRUCache *cache = [[LRUCache alloc] initWithCapacity:2];
+    [cache setObject:@"foo" forKey:@"bar"];
+    [cache removeObjectForKey:@"nonExisting"];
+    XCTAssertNotNil([cache objectForKey:@"bar"]);
+    [self assertArray:@[@"foo"] equalsTo:cache.allObjects];
+}
+
+- (void)testRemoveAndInsertFlow {
+    LRUCache *cache = [[LRUCache alloc] initWithCapacity:2];
+    [cache setObject:@"foo" forKey:@"bar"];
+    [cache setObject:@"foo2" forKey:@"bar2"];
+    [cache removeObjectForKey:@"bar"];
+    XCTAssertNil([cache objectForKey:@"bar"]);
+    [cache setObject:@"foo3" forKey:@"bar3"];
+    [self assertArray:@[@"foo3", @"foo2"] equalsTo:cache.allObjects];
+}
+
 @end

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "appium-webdriveragent",
-  "version": "9.0.5",
+  "version": "9.0.6",
   "description": "Package bundling WebDriverAgent",
   "main": "./build/index.js",
   "types": "./build/index.d.ts",