Ignored capability deviceName when using with appium 3.

[scharfi49]

Environment (please complete the following information):

• Node.js version: v24.5.0
• NPM version: 11.5.1
• Platform name and version: MAC OS 26
• WebdriverIO version: 9.18.4
• @wdio/visual-service version: 9.1.3

Config of WebdriverIO + @wdio/visual-service
.ENVS:

APPIUM_HOME=../../node_modules/
PACKAGE_NAME=*****
OS_PLATFORM=android

AVD_NAME=Pixel_6_API_34

ROLE=admin

API_URL=http://10.0.2.2:4949

DISABLE_RETRY=true

WDIO:

services: [
   [
     'visual',
     {
       formatImageName: '{tag}',
       screenshotPath: path.join(process.cwd(), 'tmp'),
       savePerInstance: true,
       autoSaveBaseline: true,
       clearRuntimeFolder: true,
       autoElementScroll: true,
       blockOutStatusBar: true,
       blockOutToolBar: true,
       blockOutSideBar: true,
     } satisfies VisualServiceOptions,
   ],
 ],

Android capabilities:

capabilities: [
    {
      platformName: 'Android',
      port: Number(process.env.APPIUM_PORT) || 4723,
      'appium:options': {
        automationName: 'UiAutomator2',
        avd: `${process.env.AVD_NAME}`,
        deviceName: `${process.env.AVD_NAME}`,
        platformVersion: '14.0',
        newCommandTimeout: 300,
        noReset: !isCI(),
        fullReset: isCI(),
        disableWindowAnimation: true,
        appWaitActivity: *****
      },

      ...(isApk() && {
        'appium:app': process.env.APP_FILE_PATH,
      }),
    },
  ],

Describe the bug
At appium 2.0 setting up deviceName capability with savePerInstance: true in visual service forced snaps to be stored in eg.:
packages/mobile-app-e2e/appium/e2e/01-unauthorized/01-onboarding/__snapshots__/pixel_6_api_34
where dir pixel_6_api_34 was created via appium:deviceName: ${process.env.AVD_NAME},.

In appium 3 setting it up does nothing, according to appium documentatnion users should use appium:avd instead.
even with setting up appium:deviceName and appium:avd the dir is created as: emulator-5554.
There is no option to change it.

According to:

[127] % adb devices -l
List of devices attached
emulator-5554          device product:sdk_gphone64_arm64 model:sdk_gphone64_arm64 device:emu64a transport_id:1

This problem exists only on android devices. Ios devices still creates correct folders after migration from appium 2 > 3

Expected behavior
Allow users option to use custom name for savePerInstance.
eg.

[1] % avdmanager list avd
Available Android Virtual Devices:
    Name: Pixel_6_API_34
  Device: pixel_6 (Google)
    Path: /Users/patryk/.android/avd/Pixel_6.avd
  Target: Google APIs (Google Inc.)
          Based on: Android API 34 Tag/ABI: google_apis/arm64-v8a
    Skin: pixel_6
  Sdcard: 512M

[wswebcreation]

Hi @scharfi49 ,

Thanks for filing an issue. I've been looking into it and I can't find any docs about this "statement"

In appium 3 setting it up does nothing, according to appium documentatnion users should use appium:avd instead.
even with setting up appium:deviceName and appium:avd the dir is created as: emulator-5554.

The appium:avd capability has always been optional.

Having said that, I believe the issue is in the fact that you deliver appium:options and then provide the device info there. This is not handled properly by the module and from what I can see now that is the bug.

In my sample

[0-0] requestedCapabilities >>>  {
[0-0]   "browserName": "Chrome",
[0-0]   "platformName": "Android",
[0-0]   "appium:automationName": "UIAutomator2",
[0-0]   "appium:deviceName": "Pixel_8_Pro_Android_15_API_35",
[0-0]   "appium:platformVersion": "15.0",
[0-0]   "appium:orientation": "PORTRAIT",
[0-0]   "appium:newCommandTimeout": 240,
[0-0]   "appium:nativeWebScreenshot": true,
[0-0]   "wdio:enforceWebDriverClassic": true,
[0-0]   "wdio-ics:options": {
[0-0]     "logName": "Pixel_8_pro_android_15_api_35_NativeWebScreenshot_Portrait15",
[0-0]     "commands": [
[0-0]       "checkScreen"
[0-0]     ]
[0-0]   }
[0-0] }

Results in storing the file in /Git/wdio/visual-testing/.tmp/actual/pixel_8_pro_android_15_api_35

and this

[0-0] requestedCapabilities >>>  {
[0-0]   "browserName": "Chrome",
[0-0]   "platformName": "Android",
[0-0]   "appium:options": {
[0-0]     "automationName": "UIAutomator2",
[0-0]     "deviceName": "Pixel_8_Pro_Android_15_API_35",
[0-0]     "platformVersion": "15.0",
[0-0]     "orientation": "PORTRAIT",
[0-0]     "newCommandTimeout": 240,
[0-0]     "nativeWebScreenshot": true
[0-0]   },
[0-0]   "wdio:enforceWebDriverClassic": true,
[0-0]   "wdio-ics:options": {
[0-0]     "logName": "Pixel_8_pro_android_15_api_35_NativeWebScreenshot_Portrait15",
[0-0]     "commands": [
[0-0]       "checkScreen"
[0-0]     ]
[0-0]   }
[0-0] }

results in storing the file in /Git/wdio/visual-testing/.tmp/actual/emulator-5554.

Conclusion:
The fix needs to be that I need to support appium:options. I also see that I'm not falling back to avd, so I'll also implement that.

[wswebcreation]

Will be fixed in #1119 and will close this issue now

[wswebcreation]

Released a new version 9.1.5, can you check it out?

[scharfi49]

Sure ill, but currently i do not have opportunity to do so. Will give u feedback at 03 march :)

[wswebcreation]

Sure, np

[scharfi49]

@wswebcreation I tested it out, seems like everything is working well.
Tested it via avd and deviceName capability.
Thanks for fast help!, i appreciate this 😄

[wswebcreation]

Great to hear and you're welcome