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.

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

feat: Allow extension capability keys to contain dot characters #2271

Merged
merged 4 commits into from
Feb 25, 2025

Conversation

alexanderkaiser
Copy link
Contributor

@alexanderkaiser alexanderkaiser commented Feb 24, 2025

Change list

Extend the ACCEPTED_W3C_PATTERNS from ^[\\w-]+:.*$ to ^[\\w-\\.]+:.*$

Types of changes

What types of changes are you proposing/introducing to Java client?
Put an x in the boxes that apply

  • No changes in production code.
  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)

Details

I'm running an Appium-based test suite in a device cloud. This device cloud has some vendor specific capabilities and I have the option to provide these either with the prefix digital.ai or without any prefix.

I used to just use the second option and the following capability statement was no big deal:

{
  "accessKey" : "eyJ...k",
  "appiumVersion" : "2.11.3",
  "app" : "cloud:my-App-Name",
  ...
}

But I have the problem that the second option does not work anymore since a few weeks. The actual capabilities look like this

{
  "appium:accessKey" : "eyJ...k",
  "appium:appiumVersion" : "2.11.3",
  "app" : "cloud:my-App-Name",
  ...
}

And when I switch to the first option by using the vendor-specific key digital.ai I get this:

{
  "appium:digital.ai:accessKey" : "eyJ...k",
  "appium:digital.ai:appiumVersion" : "2.11.3",
  "app" : "cloud:my-App-Name",
  ...
}

leading to the point, that the device cloud cannot find the accessKey for auth.

A . DOT is not allowed, but a - DASH is. I could not find any restrictions in the spec for this behavior.

Copy link

linux-foundation-easycla bot commented Feb 24, 2025

CLA Signed

The committers listed above are authorized under a signed CLA.

@valfirst
Copy link
Collaborator

@alexanderkaiser could you please sign CLA?

@alexanderkaiser alexanderkaiser changed the title feat: Allow extension capability keys to contain special characters feat: Allow extension capability keys to contain dot characters Feb 25, 2025
@valfirst valfirst merged commit eff2b60 into appium:master Feb 25, 2025
7 checks passed
@KazuCocoa KazuCocoa added the size:S contribution size: S label Mar 2, 2025
@jlipps
Copy link
Member

jlipps commented Mar 6, 2025

Hi @alexanderkaiser, congrats: the Appium project wants to compensate you for this contribution! Please reply to this comment mentioning @jlipps and @KazuCocoa and sharing your OpenCollective account name, so that we can initiate payment! Or let us know if you decline to receive compensation via OpenCollective. Thank you!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
size:S contribution size: S
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants