Skip to content

docs: Add v7->v8 migration guide#1542

Merged
mykola-mokhnach merged 5 commits intoappium:masterfrom
mykola-mokhnach:migration_guide
Nov 1, 2021
Merged

docs: Add v7->v8 migration guide#1542
mykola-mokhnach merged 5 commits intoappium:masterfrom
mykola-mokhnach:migration_guide

Conversation

@mykola-mokhnach
Copy link
Copy Markdown
Contributor

@mykola-mokhnach mykola-mokhnach commented Oct 23, 2021

Change list

The document describes main pitfalls of the client codebase migration to a new major version of Appium java client.

Types of changes

  • 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)

@valfirst
Copy link
Copy Markdown
Collaborator

Is it worth adding some notes regarding this commit: 5063baf? It's more about Selenium changes, but it could save time for users.

@mykola-mokhnach
Copy link
Copy Markdown
Contributor Author

I did add some. Feel free to mention more if I forgot something.

[java.time.Duration](https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html)
class.
- The current event firing mechanism that Appium java client uses
has been deprecated in favour of the one that Selenium4 provides
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
has been deprecated in favour of the one that Selenium4 provides
has been deprecated in favour of the one that Selenium 4 provides

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

changed

Comment on lines +38 to +39
is called now `replaceElementValue`; `setValue` has been moved to the driver
instance and is called now `setElementValue`.
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
is called now `replaceElementValue`; `setValue` has been moved to the driver
instance and is called now `setElementValue`.
is called now `replaceElementValue`; `setValue` is replaced with `sendKeys`.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

changed

Comment on lines +49 to +50
[AppiumBy](TBD)
instead.
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is it expected to be added something instead of TBD?

Suggested change
[AppiumBy](TBD)
instead.
[AppiumBy] instead.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

added the link

instead.
Also, all locator names in `AppiumBy` have been aligned to follow the common
(camelCase) naming strategy, e.g. `MobileBy.AccessibilityId` was changed
to `AppiumBy.accessibilityId`.
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would also put the note like:

The change made in Selenium 4 broke Appium `class name` selector strategy: `AppiumBy.className` should be used instead of Selenium `By.className` now.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added

@mykola-mokhnach mykola-mokhnach changed the title [WIP] docs: Add v7->v8 migration guide docs: Add v7->v8 migration guide Nov 1, 2021
- Removed the obsolete `HasSessionDetails` extensions as it was using legacy
JWP calls to retrieve session details.
`MobileBy` class has been deprecated. Consider using
[AppiumBy](TBD)
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

AppiumBy instead of TBD?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this must be already solved

@mykola-mokhnach mykola-mokhnach merged commit 087df20 into appium:master Nov 1, 2021
@mykola-mokhnach mykola-mokhnach deleted the migration_guide branch November 1, 2021 16:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants